您可以使用JavaScript客户端库与Web应用程序中的Google API(例如,人物,日历和云端硬盘)进行交互。请按照此页面上的说明进行操作。
有几种方法可以使用JavaScript客户端库发出API请求,但是它们都遵循相同的基本模式:
以下各节显示了使用JavaScript客户端库的3种常用方法。
以下示例假定用户已经登录。有关如何登录用户的完整示例,请参见完整的auth示例。
<script src="https://apis.google.com/js/api.js"></script>
<script>
function start() {
// 2. Initialize the JavaScript client library.
gapi.client.init({
'apiKey': 'YOUR_API_KEY',
// Your API key will be automatically added to the Discovery Document URLs.
'discoveryDocs': ['https://people.googleapis.com/$discovery/rest'],
// clientId and scope are optional if auth is not required.
'clientId': 'YOUR_WEB_CLIENT_ID.apps.googleusercontent.com',
'scope': 'profile',
}).then(function() {
// 3. Initialize and make the API request.
return gapi.client.people.people.get({
'resourceName': 'people/me',
'requestMask.includeField': 'person.names'
});
}).then(function(response) {
console.log(response.result);
}, function(reason) {
console.log('Error: ' + reason.result.error.message);
});
};
// 1. Load the JavaScript client library.
gapi.load('client', start);
</script>
gapi.client.request
发出请求的更一般的方法是使用gapi.client.request
。您的应用程序不必像第一个选项那样加载“发现文档”,但是它仍必须设置API密钥(并对某些API进行身份验证)。当您需要使用此选项手动填写REST参数时,它可以节省一个网络请求并减小应用程序大小。
<script src="https://apis.google.com/js/api.js"></script>
<script>
function start() {
// 2. Initialize the JavaScript client library.
gapi.client.init({
'apiKey': 'YOUR_API_KEY',
// clientId and scope are optional if auth is not required.
'clientId': 'YOUR_WEB_CLIENT_ID.apps.googleusercontent.com',
'scope': 'profile',
}).then(function() {
// 3. Initialize and make the API request.
return gapi.client.request({
'path': 'https://people.googleapis.com/v1/people/me?requestMask.includeField=person.names',
})
}).then(function(response) {
console.log(response.result);
}, function(reason) {
console.log('Error: ' + reason.result.error.message);
});
};
// 1. Load the JavaScript client library.
gapi.load('client', start);
</script>
Google API支持CORS。如果您的应用程序需要进行媒体上载和下载,则应使用CORS。有关详细信息,请参见CORS支持页面。
JavaScript客户端库可与Google Apps支持的浏览器一起使用,但当前不完全支持移动浏览器。它仅在具有<body>
使用https
(首选)和http
协议提供元素的HTML文档中起作用。但是,<iframe sandbox>
不支持元素和其他受限制的执行上下文。
首先,如果您还没有Google帐户,请注册一个。
转到Google API控制台。单击创建项目,输入名称,然后单击创建。
接下来,确定您的应用程序需要使用哪些Google API,并为您的项目启用它们。使用API资源管理器浏览JavaScript客户端库可以使用的Google API。
要为您的项目启用API,请执行以下操作:
Google定义了两个级别的API访问权限:
水平 | 描述 | 要求: |
---|---|---|
简单 | API调用不会访问任何私人用户数据 | API密钥 |
已授权 | API调用可以读写私有用户数据或应用程序自己的数据 | OAuth 2.0凭证 |
要获取用于简单访问的API密钥,请执行以下操作:
为了确保您的API密钥安全,请遵循最佳实践以安全使用API密钥。
要获取OAuth 2.0凭据以进行授权访问,请执行以下操作:
有关使用OAuth 2.0凭据的信息,请参阅“ 身份验证”页面。