Execute code samples

cURL

Set up

1. Follow instructions in the API documentation to create or select a project for your app and enable the API.
2. In the cloud console, create an API key.
3. In the cloud console, create an OAuth client ID credential for a Web application and use https://developers.google.com/oauthplayground as the redirect URI.
4. In the OAuth 2.0 Playground, click OAuth 2.0 Configuration settings.
5. Check Use your own credentials.
6. Enter the client ID and client secret generated in step 3.
7. In the scopes field, type the scope to use with your method and click Authorize APIs.
8. (optional) If presented with a Sign in screen, select the account to use.
9. (optional) If presented with an authorization screen, click Accept.
10. Click Exchange authorization code for tokens. A token is returned.
11. In the cURL code sample, replace [YOUR_API_KEY] with the API key generated in step 2: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
12. In the cURL code sample, replace [YOUR_ACCESS_TOKEN] with the access token generated in step 10: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

Execute code sample

From the command line, execute the cURL command. The command should be similar to this:

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

JavaScript

Set up

1. Follow instructions in the API documentation to create or select a project for your app and enable the API.
2. In the cloud console, create an API key.
3. In the cloud console, create an OAuth client ID credential for a "Web application" and set the authorized JavaScript origins to identify the URL from which you'll be sending requests, such as http://localhost.
4. Copy the full code sample to a local file accessible to your web server, such as /var/www/html/example.html.

5. Find the line in the code sample that sets the API key or client ID and replace the value with the values generated in step 2 and 3:

   • API key: gapi.client.setApiKey(YOUR_API_KEY);
   • OAuth 2.0 client ID: gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

Execute code sample

1. Open the file in your browser, such as http://localhost/example.html. We recommend using a browser with a debugging console, such as Google Chrome.
2. (optional) If presented with a Sign in screen, select the account to use.
3. (optional) If presented with an authorization screen, click Accept. The debugging console should display the method response as a JSON object.

Java

Prerequisites

• Java 1.7 or greater.
• Gradle 7 or greater.

Set up

1. Follow instructions in the API documentation to create or select a project for your app and enable the API.
2. Depending on the type of data the method is accessing, create an API key (public data) or create an OAuth 2.0 client ID (private data).
3. Set the application type to Desktop app.
4. If you created an OAuth 2.0 client ID, download the JSON file containing your OAuth 2.0 credentials. This file is named something similar to client_secret_CLIENTID.json, where CLIENTID is the client ID for your project.

5. In your working directory, run the following commands to create a new project structure:

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

6. If you created an OAuth 2.0 client ID in step 2, rename the JSON file that you downloaded to client_secret.json.

7. Save the renamed file in the src/main/resources directory that you created in step 5.

8. In your working directory, open the build.gradle file and replace its contents with the following:

   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. In the build.gradle file, replace the line that says API_SPECIFIC_DEPENDENCY with an instruction to compile code for the API you're calling. Here is a sample for the YouTube Analytics API:

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

   The instruction follows this template:

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

Where:

• API_NAME is the API name listed on GitHub for the API. To find the name, click on the version link next to your API on the Supported Google APIs page. The version link navigates to GitHub. The API name is in the upper-middle of the page and is preceded by googleapis/google-apis-services-. For example, for the v3 of the Drive API, the API_NAME is drive.
• API_VERSION is the API version listed for the API below the API name on the Supported Google APIs page.
• REVISION is the revision number listed in the JavaDoc reference for the API. The JavaDoc reference can be found at https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
• CL_VERSION is the client library version. This value also appears in the JavaDoc reference.
• From your working directory, copy the code sample from APIs Explorer to src/main/java/ApiExample.java. (The class name in each sample is ApiExample so that you do not need to modify the build.gradle file to run different samples.

Execute code sample

Use the following command to run the example:

  gradle -q run

The sample should execute your API request and print the response to STDOUT. You can also check the service you are calling to see the effects of requests that write data.

Node.js

Prerequisites

• Node.js

• The Google APIs Client Library for Node.js:

  • If you have not previously installed the client library, run the command:

  npm install googleapis --save
  

  • If you previously installed the client library, we recommend updating it to ensure that you have the most up-to-date classes for the library you are testing. To update the client library, run the command:

  npm update googleapis --save
  

Set up

1. Follow instructions in the API documentation to create or select a project for your app and enable the API.
2. Depending on the type of data the method is accessing, create an API key (public data) or create an OAuth 2.0 client ID (private data).
3. Set the application type to Desktop app.
4. If you created an OAuth 2.0 client ID, download the JSON file containing your OAuth 2.0 credentials. This file is named something similar to client_secret_CLIENTID.json, where CLIENTID is the client ID for your project.
5. Copy the code sample to a local file and modify the sample to correctly identify your API key or client secrets file. In the sample, the API key value is YOUR_API_KEY, and the client secrets file location is YOUR_CLIENT_SECRET_FILE.json.

Execute code sample

Use the following command to run the example:

  node sample.js

Most samples print an API response (or something else) to STDOUT.

PHP

Prerequisites

• PHP 5.4 or greater with the command-line interface (CLI) and JSON extension.
• The Composer dependency management tool installed globally.

• The Google APIs Client Library for PHP:

  • If you have not previously installed the client library, run the command:

    composer require google/apiclient:^2.0
    

  • If you previously installed the client library, we recommend updating it to ensure that you have the most up-to-date classes for the library you're testing. To update the client library, run the command:

    composer update google/apiclient --with-dependencies
    

Execute code sample

Use the following command to run the example:

  php sample.php

Most samples print an API response (or something else) to STDOUT.

Python

Prerequisites

• Python 2.7 or Python 3.5+
• The pip package management tool

• The Google APIs Client Library for Python:

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

• The google-auth-oauthlib and google-auth-httplib2 libraries for user authorization:

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

Set up

1. Follow instructions in the API documentation to create or select a project for your app and enable the API.
2. Depending on the type of data the method is accessing, create an API key (public data) or create an OAuth 2.0 client ID (private data).
3. Set the application type to Desktop app.
4. If you created an OAuth 2.0 client ID, download the JSON file containing your OAuth 2.0 credentials. This file is named something similar to client_secret_CLIENTID.json, where CLIENTID is the client ID for your project.
5. Copy the code sample to a local file and modify the sample to correctly identify your API key or client secrets file. In the sample, the API key value is YOUR_API_KEY, and the client secrets file location is YOUR_CLIENT_SECRET_FILE.json.

Execute code sample

Use the following command to run the example:

  python sample.py

Most samples print an API response (or something else) to STDOUT.

Ruby

Prerequisites

• Ruby 2.0 or greater

• The Google APIs Client Library for Ruby:

  gem install google-api-client`
  

Set up

1. Follow instructions in the API documentation to create or select a project for your app and enable the API.
2. Depending on the type of data the method is accessing, create an API key (public data) or create an OAuth 2.0 client ID (private data).
3. Set the application type to Desktop app.
4. If you created an OAuth 2.0 client ID, download the JSON file containing your OAuth 2.0 credentials. This file is named something similar to client_secret_CLIENTID.json, where CLIENTID is the client ID for your project.
5. Copy the code sample to a local file and modify the sample to correctly identify your API key or client secrets file. In the sample, the API key value is YOUR_API_KEY, and the client secrets file location is YOUR_CLIENT_SECRET_FILE.json.

Execute code sample

Use the following command to run the example:

  ruby sample.rb

Most samples print an API response (or something else) to STDOUT.