执行代码示例

cURL

设置

1. 按照 API 文档中的说明为您的应用创建或选择项目，然后启用该 API。
2. 在 Cloud 控制台中，创建一个 API 密钥。
3. 在 Cloud 控制台中，为 Web 应用创建 OAuth 客户端 ID 凭据，并使用 https://developers.google.com/oauthplayground 作为重定向 URI。
4. 在 OAuth 2.0 Playground 中，点击 OAuth 2.0 配置 settings。
5. 选中使用您自己的凭据。
6. 输入第 3 步生成的客户端 ID 和客户端密钥。
7. 在“scopes”字段中，输入要与方法搭配使用的范围，然后点击 Authorize APIs。
8. （可选）如果系统显示登录界面，请选择要使用的账号。
9. （可选）如果系统显示授权界面，请点击接受。
10. 点击 Exchange authorization code for tokens。系统会返回一个令牌。
11. 在 c网址 代码示例中，将 [YOUR_API_KEY] 替换为第 2 步生成的 API 密钥：'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
12. 在 c网址 代码示例中，将 [YOUR_ACCESS_TOKEN] 替换为第 10 步中生成的访问令牌：--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

执行代码示例

在命令行中，执行 c网址 命令。该命令应类似如下所示：

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

设置

1. 按照 API 文档中的说明为您的应用创建或选择项目，然后启用该 API。
2. 在 Cloud 控制台中，创建一个 API 密钥。
3. 在 Cloud 控制台中，为“网站应用”创建 OAuth 客户端 ID 凭据，并设置已获授权的 JavaScript 来源，以标识您将发送请求的网址，例如 http://localhost。
4. 将完整的代码示例复制到您的网络服务器可以访问的本地文件（例如 /var/www/html/example.html）。

5. 在代码示例中找到用于设置 API 密钥或客户端 ID 的行，并将相应值替换为在第 2 步和第 3 步中生成的值：

   • API 密钥：gapi.client.setApiKey(YOUR_API_KEY);
   • OAuth 2.0 客户端 ID：gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

执行代码示例

1. 在浏览器（例如 http://localhost/example.html）中打开该文件。我们建议使用带有调试控制台的浏览器，例如 Google Chrome。
2. （可选）如果系统显示登录界面，请选择要使用的账号。
3. （可选）如果系统显示授权界面，请点击接受。调试控制台应将方法响应显示为 JSON 对象。

Java

前提条件

• Java 1.7 或更高版本。
• Gradle 7 或更高版本。

设置

1. 按照 API 文档中的说明为您的应用创建或选择项目，然后启用该 API。
2. 根据该方法要访问的数据类型，创建 API 密钥（公开数据）或创建 OAuth 2.0 客户端 ID（私密数据）。
3. 将应用类型设置为桌面应用。
4. 如果您创建了 OAuth 2.0 客户端 ID，请下载包含 OAuth 2.0 凭据的 JSON 文件。此文件的名称类似于 client_secret_CLIENTID.json，其中 CLIENTID 是项目的客户端 ID。

5. 在您的工作目录中，运行以下命令以创建新的项目结构：

   $ gradle init --type basic
   $ mkdir -p src/main/java src/main/resources
   

6. 如果您在第 2 步中创建了 OAuth 2.0 客户端 ID，请将下载的 JSON 文件重命名为 client_secret.json。

7. 将重命名的文件保存在您在第 5 步中创建的 src/main/resources 目录中。

8. 在工作目录中，打开 build.gradle 文件，并将其内容替换为以下内容：

   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'ApiExample'
   sourceCompatibility = 1.7
   targetCompatibility = 1.7
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       compile 'com.google.api-client:google-api-client:1.23.0'
       compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
       API_SPECIFIC_DEPENDENCY
   }
   

9. 在 build.gradle 文件中，将显示 API_SPECIFIC_DEPENDENCY 的行替换为用于为您要调用的 API 编译代码的指令。以下是 YouTube Analytics API 的示例：

   compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'
   

   该说明遵循以下模板：

   compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'
   

其中：

• API_NAME 是 GitHub 上列出的 API 名称。如需查找该名称，请在受支持的 Google API 页面上点击相应 API 旁边的版本链接。版本链接会打开 GitHub。API 名称位于页面中上部，前面带有 googleapis/google-apis-services-。例如，对于云端硬盘 API 的 v3，API_NAME 为 drive。
• API_VERSION 是“支持的 Google API”页面上 API 名称下方为该 API 列出的 API 版本。
• REVISION 是 API 的 JavaDoc 参考文档中列出的修订版本号。JavaDoc 参考文档位于 https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
• CL_VERSION 是客户端库版本。此值也显示在 JavaDoc 参考文档中。
• 在您的工作目录中，将 API Explorer 中的代码示例复制到 src/main/java/ApiExample.java。（每个示例中的类名称均为 ApiExample，因此您无需修改 build.gradle 文件即可运行不同的示例。

执行代码示例

使用以下命令运行该示例：

  gradle -q run

该示例应执行您的 API 请求，并将响应输出到 STDOUT。您还可以检查您正在调用的服务，了解写入数据的请求的影响。

Node.js

前提条件

• Node.js

• Node.js 版 Google API 客户端库：

  • 如果您之前未安装客户端库，请运行以下命令：

  npm install googleapis --save
  

  • 如果您之前安装了客户端库，我们建议您更新该库，以确保您拥有要测试的库的最新类。如需更新客户端库，请运行以下命令：

  npm update googleapis --save
  

设置

1. 按照 API 文档中的说明为您的应用创建或选择项目，然后启用该 API。
2. 根据该方法要访问的数据类型，创建 API 密钥（公开数据）或创建 OAuth 2.0 客户端 ID（私密数据）。
3. 将应用类型设置为桌面应用。
4. 如果您创建了 OAuth 2.0 客户端 ID，请下载包含 OAuth 2.0 凭据的 JSON 文件。此文件的名称类似于 client_secret_CLIENTID.json，其中 CLIENTID 是项目的客户端 ID。
5. 将代码示例复制到本地文件，并修改该示例以正确识别您的 API 密钥或客户端密钥文件。在示例中，API 密钥值为 YOUR_API_KEY，客户端密钥文件位置为 YOUR_CLIENT_SECRET_FILE.json。

执行代码示例

使用以下命令运行该示例：

  node sample.js

大多数示例都会将 API 响应（或其他内容）输出到 STDOUT。

PHP

前提条件

• 具有命令行界面 (CLI) 和 JSON 扩展的 PHP 5.4 或更高版本。
• 已全局安装 Composer 依赖项管理工具。

• PHP 版 Google API 客户端库：

  • 如果您之前未安装客户端库，请运行以下命令：

    composer require google/apiclient:^2.0
    

  • 如果您之前安装了客户端库，我们建议您更新该库，以确保您拥有要测试的库的最新类。如需更新客户端库，请运行以下命令：

    composer update google/apiclient --with-dependencies
    

执行代码示例

使用以下命令运行该示例：

  php sample.php

大多数示例都会将 API 响应（或其他内容）输出到 STDOUT。

Python

前提条件

• Python 2.7 或 Python 3.5 及更高版本
• pip 软件包管理工具

• Python 版 Google API 客户端库：

  pip install --upgrade google-api-python-client
  

• 用于用户授权的 google-auth-oauthlib 和 google-auth-httplib2 库：

  pip install --upgrade google-auth-oauthlib google-auth-httplib2
  

设置

1. 按照 API 文档中的说明为您的应用创建或选择项目，然后启用该 API。
2. 根据该方法要访问的数据类型，创建 API 密钥（公开数据）或创建 OAuth 2.0 客户端 ID（私密数据）。
3. 将应用类型设置为桌面应用。
4. 如果您创建了 OAuth 2.0 客户端 ID，请下载包含 OAuth 2.0 凭据的 JSON 文件。此文件的名称类似于 client_secret_CLIENTID.json，其中 CLIENTID 是项目的客户端 ID。
5. 将代码示例复制到本地文件，并修改该示例以正确识别您的 API 密钥或客户端密钥文件。在示例中，API 密钥值为 YOUR_API_KEY，客户端密钥文件位置为 YOUR_CLIENT_SECRET_FILE.json。

执行代码示例

使用以下命令运行该示例：

  python sample.py

大多数示例都会将 API 响应（或其他内容）输出到 STDOUT。

Ruby

前提条件

• Ruby 2.0 或更高版本

• Ruby 版 Google API 客户端库：

  gem install google-api-client`
  

设置

1. 按照 API 文档中的说明为您的应用创建或选择项目，然后启用该 API。
2. 根据该方法要访问的数据类型，创建 API 密钥（公开数据）或创建 OAuth 2.0 客户端 ID（私密数据）。
3. 将应用类型设置为桌面应用。
4. 如果您创建了 OAuth 2.0 客户端 ID，请下载包含 OAuth 2.0 凭据的 JSON 文件。此文件的名称类似于 client_secret_CLIENTID.json，其中 CLIENTID 是项目的客户端 ID。
5. 将代码示例复制到本地文件，并修改该示例以正确识别您的 API 密钥或客户端密钥文件。在示例中，API 密钥值为 YOUR_API_KEY，客户端密钥文件位置为 YOUR_CLIENT_SECRET_FILE.json。

执行代码示例

使用以下命令运行该示例：

  ruby sample.rb

大多数示例都会将 API 响应（或其他内容）输出到 STDOUT。