Выполнение примеров кода

cURL

Настраивать

1. Следуйте инструкциям в документации API, чтобы создать или выбрать проект для вашего приложения и включить API.
2. В консоли облака создайте ключ API.
3. В облачной консоли создайте учетные данные клиента OAuth для веб-приложения и используйте https://developers.google.com/oauthplayground в качестве URI перенаправления.
4. В среде OAuth 2.0 Playground нажмите settings конфигурации OAuth 2.0» .
5. Установите флажок « Использовать свои учетные данные» .
6. Введите идентификатор клиента и секретный ключ клиента, сгенерированные на шаге 3.
7. В поле «Области действия» введите область действия, которую вы хотите использовать с вашим методом, и нажмите «Авторизовать API» .
8. (необязательно) Если появится экран входа в систему, выберите учетную запись для использования.
9. (Необязательно) Если появится экран авторизации, нажмите «Принять» .
10. Нажмите «Код авторизации биржи для получения токенов» . Будет возвращен токен.
11. В приведенном примере кода cURL замените [YOUR_API_KEY] на ключ API, сгенерированный на шаге 2: 'https://www.googleapis.com/drive/v3/files?key= [YOUR_API_KEY] ' \
12. В приведенном примере кода cURL замените [YOUR_ACCESS_TOKEN] на токен доступа, сгенерированный на шаге 10: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN] ' \

Выполните пример кода

В командной строке выполните команду cURL. Команда должна выглядеть примерно так:

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. В консоли облака создайте ключ API.
3. В облачной консоли создайте учетные данные OAuth-клиента для «Веб-приложения» и укажите авторизованные источники JavaScript, чтобы идентифицировать URL-адрес, с которого будут отправляться запросы, например, http://localhost .
4. Скопируйте полный пример кода в локальный файл, доступный вашему веб-серверу, например, /var/www/html/example.html .

5. Найдите в приведенном примере кода строку, которая устанавливает ключ API или идентификатор клиента, и замените ее значением, сгенерированным на шагах 2 и 3:

   • Ключ API: gapi.client.setApiKey( YOUR_API_KEY );
   • Идентификатор клиента OAuth 2.0: gapi.client.init({ 'clientId': ' YOUR_CLIENT_ID ',

Выполните пример кода

1. Откройте файл в браузере, например, по адресу http://localhost/example.html . Мы рекомендуем использовать браузер с консолью отладки, например, Google Chrome.
2. (необязательно) Если появится экран входа в систему, выберите учетную запись для использования.
3. (необязательно) Если появится экран авторизации, нажмите «Принять» . В консоли отладки должен отобразиться ответ метода в виде объекта JSON.

Java

Предварительные требования

• Java 1.7 или более поздняя версия.
• 7 класс или выше.

Настраивать

1. Следуйте инструкциям в документации API, чтобы создать или выбрать проект для вашего приложения и включить API.
2. В зависимости от типа данных, к которым обращается метод, создайте ключ API (для общедоступных данных) или идентификатор клиента OAuth 2.0 (для закрытых данных).
3. Установите тип приложения на «Настольное приложение» .
4. Если вы создали идентификатор клиента OAuth 2.0, загрузите JSON-файл, содержащий ваши учетные данные OAuth 2.0. Этот файл называется примерно так: client_secret_ CLIENTID .json , где CLIENTID — это идентификатор клиента для вашего проекта.

5. В рабочей директории выполните следующие команды для создания новой структуры проекта:

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

6. Если вы создали идентификатор клиента OAuth 2.0 на шаге 2, переименуйте загруженный JSON-файл в client_secret.json .

7. Сохраните переименованный файл в каталоге src/main/resources , который вы создали на шаге 5.

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. Вот пример для API YouTube Analytics:

   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 — это имя API, указанное на GitHub для данного API. Чтобы узнать имя, щелкните ссылку версии рядом с вашим API на странице «Поддерживаемые API Google» . Ссылка версии ведет на GitHub. Имя API находится в верхней центральной части страницы и предшествует googleapis/google-apis-services- . Например, для версии 3 API Drive API_NAME — drive .
• API_VERSION — это версия API, указанная под названием API на странице «Поддерживаемые API Google».
• REVISION — это номер ревизии, указанный в справочной документации JavaDoc для API. Справочную документацию 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

• Клиентская библиотека Google API для Node.js:

  • Если вы ранее не устанавливали клиентскую библиотеку, выполните команду:

  npm install googleapis --save
  

  • Если вы ранее устанавливали клиентскую библиотеку, рекомендуем обновить её, чтобы убедиться, что у вас установлены самые актуальные классы для тестируемой библиотеки. Для обновления клиентской библиотеки выполните команду:

  npm update googleapis --save
  

Настраивать

1. Следуйте инструкциям в документации API, чтобы создать или выбрать проект для вашего приложения и включить API.
2. В зависимости от типа данных, к которым обращается метод, создайте ключ API (для общедоступных данных) или идентификатор клиента OAuth 2.0 (для закрытых данных).
3. Установите тип приложения на «Настольное приложение» .
4. Если вы создали идентификатор клиента OAuth 2.0, загрузите JSON-файл, содержащий ваши учетные данные OAuth 2.0. Этот файл называется примерно так: client_secret_ CLIENTID .json , где CLIENTID — это идентификатор клиента для вашего проекта.
5. Скопируйте пример кода в локальный файл и измените его, чтобы он правильно определял ваш API-ключ или файл с секретами клиента. В примере значение API-ключа — YOUR_API_KEY , а расположение файла с секретами клиента — YOUR_CLIENT_SECRET_FILE.json .

Выполните пример кода

Для запуска примера используйте следующую команду:

  node sample.js

В большинстве примеров в STDOUT выводится ответ API (или что-то еще).

PHP

Предварительные требования

• PHP 5.4 или выше с интерфейсом командной строки (CLI) и расширением JSON.
• Инструмент управления зависимостями Composer устанавливается глобально.

• Клиентская библиотека Google API для PHP:

  • Если вы ранее не устанавливали клиентскую библиотеку, выполните команду:

    composer require google/apiclient:^2.0
    

  • Если вы ранее устанавливали клиентскую библиотеку, рекомендуем обновить её, чтобы убедиться, что у вас установлены самые актуальные классы для тестируемой библиотеки. Для обновления клиентской библиотеки выполните команду:

    composer update google/apiclient --with-dependencies
    

Выполните пример кода

Для запуска примера используйте следующую команду:

  php sample.php

В большинстве примеров в STDOUT выводится ответ API (или что-то еще).

Python

Предварительные требования

• Python 2.7 или Python 3.5+
• Инструмент управления пакетами pip

• Клиентская библиотека Google API для Python:

  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 (для закрытых данных).
3. Установите тип приложения на «Настольное приложение» .
4. Если вы создали идентификатор клиента OAuth 2.0, загрузите JSON-файл, содержащий ваши учетные данные OAuth 2.0. Этот файл называется примерно так: client_secret_ CLIENTID .json , где CLIENTID — это идентификатор клиента для вашего проекта.
5. Скопируйте пример кода в локальный файл и измените его, чтобы он правильно определял ваш API-ключ или файл с секретами клиента. В примере значение API-ключа — YOUR_API_KEY , а расположение файла с секретами клиента — YOUR_CLIENT_SECRET_FILE.json .

Выполните пример кода

Для запуска примера используйте следующую команду:

  python sample.py

В большинстве примеров в STDOUT выводится ответ API (или что-то еще).

Руби

Предварительные требования

• Ruby 2.0 или выше

• Клиентская библиотека Google API для Ruby:

  gem install google-api-client`
  

Настраивать

1. Следуйте инструкциям в документации API, чтобы создать или выбрать проект для вашего приложения и включить API.
2. В зависимости от типа данных, к которым обращается метод, создайте ключ API (для общедоступных данных) или идентификатор клиента OAuth 2.0 (для закрытых данных).
3. Установите тип приложения на «Настольное приложение» .
4. Если вы создали идентификатор клиента OAuth 2.0, загрузите JSON-файл, содержащий ваши учетные данные OAuth 2.0. Этот файл называется примерно так: client_secret_ CLIENTID .json , где CLIENTID — это идентификатор клиента для вашего проекта.
5. Скопируйте пример кода в локальный файл и измените его, чтобы он правильно определял ваш API-ключ или файл с секретами клиента. В примере значение API-ключа — YOUR_API_KEY , а расположение файла с секретами клиента — YOUR_CLIENT_SECRET_FILE.json .

Выполните пример кода

Для запуска примера используйте следующую команду:

  ruby sample.rb

В большинстве примеров в STDOUT выводится ответ API (или что-то еще).