OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef GOOGLE_APIS_GOOGLE_API_KEYS_H_ | 5 #ifndef GOOGLE_APIS_GOOGLE_API_KEYS_H_ |
6 #define GOOGLE_APIS_GOOGLE_API_KEYS_H_ | 6 #define GOOGLE_APIS_GOOGLE_API_KEYS_H_ |
7 | 7 |
8 // If you add more includes to this file, you also need to add them to | 8 // If you add more includes to this file, you also need to add them to |
9 // google_api_keys_unittest.cc. | 9 // google_api_keys_unittest.cc. |
10 #include <string> | 10 #include <string> |
11 | 11 |
12 // These functions enable you to retrieve keys to use for Google APIs | 12 // These functions enable you to retrieve keys to use for Google APIs |
13 // such as Translate and Safe Browsing. | 13 // such as Translate and Safe Browsing. |
14 // | 14 // |
15 // You can retrieve either an "API key" (sometimes called a developer | 15 // You can retrieve either an "API key" (sometimes called a developer |
16 // key) which identifies you (or the company you work for) as a | 16 // key) which identifies you (or the company you work for) as a |
17 // developer, or you can retrieve the "client ID" and "client secret" | 17 // developer, or you can retrieve the "client ID" and "client secret" |
18 // used by you (or the company you work for) to generate OAuth2 | 18 // used by you (or the company you work for) to generate OAuth2 |
19 // requests. | 19 // requests. |
20 // | 20 // |
21 // Each developer (or group of developers working together for a | 21 // Each developer (or group of developers working together for a |
22 // single company) must request a Google API key and the client ID and | 22 // single company) must request a Google API key and the client ID and |
23 // client secret for OAuth2. See | 23 // client secret for OAuth2. See |
24 // https://developers.google.com/console/help/ and | 24 // https://developers.google.com/console/help/ and |
25 // https://developers.google.com/console/. | 25 // https://developers.google.com/console/. |
26 // | 26 // |
27 // The keys must either be provided using preprocessor variables (set | 27 // The keys must either be provided using preprocessor variables (set |
28 // via e.g. ~/.gyp/include.gypi). Alternatively, they can be | 28 // via e.g. ~/.gyp/include.gypi). Alternatively, in Chromium builds, they can be |
29 // overridden at runtime using environment variables of the same name. | 29 // overridden at runtime using environment variables of the same name. |
| 30 // Environment variable overrides will be ignored for official Google Chrome |
| 31 // builds. |
30 // | 32 // |
31 // The names of the preprocessor variables (or environment variables | 33 // The names of the preprocessor variables (or environment variables |
32 // to override them at runtime) are as follows: | 34 // to override them at runtime in Chromium builds) are as follows: |
33 // - GOOGLE_API_KEY: The API key, a.k.a. developer key. | 35 // - GOOGLE_API_KEY: The API key, a.k.a. developer key. |
34 // - GOOGLE_DEFAULT_CLIENT_ID: If set, this is used as the default for | 36 // - GOOGLE_DEFAULT_CLIENT_ID: If set, this is used as the default for |
35 // all client IDs not otherwise set. This is intended only for | 37 // all client IDs not otherwise set. This is intended only for |
36 // development. | 38 // development. |
37 // - GOOGLE_DEFAULT_CLIENT_SECRET: If set, this is used as the default | 39 // - GOOGLE_DEFAULT_CLIENT_SECRET: If set, this is used as the default |
38 // for all client secrets. This is intended only for development. | 40 // for all client secrets. This is intended only for development. |
39 // - GOOGLE_CLIENT_ID_[client name] | 41 // - GOOGLE_CLIENT_ID_[client name] |
40 // (e.g. GOOGLE_CLIENT_ID_CLOUD_PRINT, i.e. one for each item in the | 42 // (e.g. GOOGLE_CLIENT_ID_CLOUD_PRINT, i.e. one for each item in the |
41 // OAuth2Client enumeration below) | 43 // OAuth2Client enumeration below) |
42 // - GOOGLE_CLIENT_SECRET_[client name] | 44 // - GOOGLE_CLIENT_SECRET_[client name] |
(...skipping 73 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
116 // Returns the auth token for the data reduction proxy. | 118 // Returns the auth token for the data reduction proxy. |
117 std::string GetSpdyProxyAuthValue(); | 119 std::string GetSpdyProxyAuthValue(); |
118 | 120 |
119 // Returns if the API key using in the current build is the one for official | 121 // Returns if the API key using in the current build is the one for official |
120 // Google Chrome. | 122 // Google Chrome. |
121 bool IsGoogleChromeAPIKeyUsed(); | 123 bool IsGoogleChromeAPIKeyUsed(); |
122 | 124 |
123 } // namespace google_apis | 125 } // namespace google_apis |
124 | 126 |
125 #endif // GOOGLE_APIS_GOOGLE_API_KEYS_H_ | 127 #endif // GOOGLE_APIS_GOOGLE_API_KEYS_H_ |
OLD | NEW |