Структура вызова API

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

В этом руководстве описывается общая структура всех вызовов API.

Если вы используете клиентскую библиотеку для взаимодействия с API, вам не нужно беспокоиться о базовых деталях запроса. Однако некоторые знания о них могут пригодиться при тестировании и отладке.

Google Ads API – это gRPC API с привязками REST. Это означает, что есть два способа вызова API.

  1. [Предпочтительно] Создайте тело запроса в виде буфера протокола , отправьте его на сервер с помощью HTTP/2 , десериализуйте ответ в буфер протокола и интерпретируйте результаты. Большая часть нашей документации описывает использование gRPC.

  2. [Необязательно] Создайте тело запроса как объект JSON , отправьте его на сервер с помощью HTTP 1.1, десериализуйте ответ как объект JSON и интерпретируйте результаты. Дополнительные сведения об использовании REST см. в руководстве по интерфейсу REST.

Имена ресурсов

Большинство объектов в API идентифицируются по строкам имени ресурса. Эти строки также служат URL-адресами при использовании интерфейса REST. См. Имена ресурсов интерфейса REST для их структуры.

Составные идентификаторы

Если идентификатор объекта не является глобально уникальным, составной идентификатор для этого объекта создается путем добавления его родительского идентификатора и тильды (~).

Например, поскольку идентификатор объявления группы объявлений не является глобально уникальным, мы добавляем к нему идентификатор родительского объекта (группы объявлений), чтобы создать уникальный составной идентификатор:

  • AdGroupId из 123 + ~ + AdGroupAdId из 45678 = составной идентификатор объявления группы объявлений из 123~45678 .

Заголовки запроса

Это заголовки HTTP (или метаданные grpc ), которые сопровождают тело запроса:

Авторизация

Вам необходимо включить токен доступа OAuth2 в форме Authorization: Bearer YOUR_ACCESS_TOKEN , который идентифицирует либо управляющую учетную запись, действующую от имени клиента, либо рекламодателя, непосредственно управляющего своей учетной записью. Инструкции по получению токена доступа можно найти в руководстве по OAuth2 . Маркер доступа действителен в течение часа после его получения; когда срок его действия истечет, обновите токен доступа, чтобы получить новый. Обратите внимание, что наши клиентские библиотеки автоматически обновляют токены с истекшим сроком действия.

токен разработчика

Идентификатор разработчика – это строка из 22 символов, которая однозначно идентифицирует разработчика Google Ads API. Пример строки токена разработчика: ABcdeFGH93KL-NOPQ_STUv . Токен разработчика должен быть включен в виде developer-token : ABcdeFGH93KL-NOPQ_STUv .

логин-идентификатор клиента

Это идентификатор авторизованного клиента для использования в запросе без дефисов ( - ). Если вы получаете доступ к учетной записи клиента через управляющую учетную запись, этот заголовок является обязательным и должен быть установлен на идентификатор клиента управляющей учетной записи.

https://googleads.googleapis.com/v13/customers/1234567890/campaignBudgets:mutate

Установка login-customer-id эквивалентна выбору учетной записи в пользовательском интерфейсе Google Ads после входа в систему или нажатия на изображение своего профиля в правом верхнем углу. Если вы не включаете этот заголовок, по умолчанию используется действующий клиент .

идентификатор связанного клиента

Этот заголовок используется только сторонними поставщиками аналитики приложений при загрузке данных о конверсиях в связанный аккаунт Google Реклама .

Рассмотрим сценарий, в котором пользователи учетной записи A предоставляют доступ для чтения и редактирования к своим сущностям учетной записи B через ThirdPartyAppAnalyticsLink . После установления связи пользователь учетной записи B может выполнять вызовы API для учетной записи A в соответствии с разрешениями, предоставляемыми ссылкой. В этом случае разрешения на вызовы API для учетной записи A определяются сторонней ссылкой на учетную запись B , а не отношением менеджера и учетной записи, которое используется в других вызовах API.

Сторонний поставщик аналитики приложений выполняет вызов API следующим образом:

  • linked-customer-id : учетная запись сторонней аналитики приложений, которая загружает данные (учетная запись B ).
  • customer-id : аккаунт Google Ads, в который загружаются данные (аккаунт A ).
  • login-customer-id и Authorization header: комбинация значений для идентификации пользователя, имеющего доступ к учетной записи B .

Заголовки ответа

Следующие заголовки (или конечные метаданные grpc ) возвращаются вместе с телом ответа. Мы рекомендуем вам регистрировать эти значения в целях отладки.

идентификатор запроса

Идентификатор request-id — это строка, которая однозначно идентифицирует этот запрос.

Назад
Метаданные ресурса