Фон

Прежде чем ты начнешь

  1. Попросите своего представителя по работе с клиентами настроить надлежащие разрешения для учетных записей, к которым будет иметь доступ ваше приложение.
  2. Если вы не знакомы с концепциями Авторизованных покупателей, посетите Справочный центр Авторизованных покупателей и поэкспериментируйте с пользовательским интерфейсом . Если предполагается, что ваше приложение будет выполнять ставки в реальном времени, прочтите документацию по протоколу RTB .
  3. Посетите консоль API , чтобы настроить новый проект. Либо войдите в свою учетную запись Google разработчика, либо создайте учетную запись. Затем вам будет предложено создать проект и подписать несколько Условий обслуживания.

Родительские и дочерние учетные записи

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

Дочерние аккаунты

Пользователь с учетными данными, предоставляющими доступ к дочерней учетной записи, может только просматривать и изменять ресурсы, связанные с его учетной записью. Дочерние учетные записи не могут просматривать или изменять ресурсы, принадлежащие другим дочерним или родительским учетным записям.

Родительские аккаунты

Пользователь с учетными данными, которые предоставляют доступ к родительской учетной записи, может просматривать и изменять ресурсы для родительской учетной записи в дополнение ко всем связанным дочерним учетным записям. Для операций со списком всех заданных ресурсов этот пользователь получит ответ, включающий данные для его учетной записи и всех его дочерних учетных записей. Обратите внимание, что для других типов запросов, нацеленных на ресурсы для дочерних мест, родительская учетная запись должна будет указать параметр пути accountId для дочерней учетной записи, а не свой собственный accountId .

Модель данных REST API

Ресурс — это отдельный объект данных с уникальным идентификатором. Ресурс Accounts представляет запись аккаунта Авторизованных покупателей и является корневым классом данных для Ad Exchange Buyer API. Методы API работают с отдельными ресурсами учетных записей и коллекциями ресурсов учетных записей.

Ресурс учетных записей включает в себя: идентификатор учетной записи, информацию, используемую для сопоставления файлов cookie, местоположения участников торгов, URL-адрес, на который отправляются запросы ставок, и запрос на указание максимального количества запросов в секунду, отправляемых рекламным обменом.

Помимо ресурса и коллекции Accounts, Ad Exchange Buyer API определяет следующие структуры данных:

Местоположение участника торгов

Расположение участников торгов — это структуры, которые возвращаются вместе с ресурсами учетных записей для предоставления URL-адреса, на который рекламный обмен должен отправлять запросы ставок, и максимального количества запросов в секунду, которые должен отправлять рекламный обмен. Вот пример местоположения участника торгов, выраженный в формате JSON:

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],
.

Предметы

Элементы предоставляют список учетных записей. Вот пример элементов, выраженных в JSON:

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

Поддерживаемые операции

Вы можете вызывать три разных метода для коллекций и ресурсов в Ad Exchange Buyer API, как описано в следующей таблице. Все операции требуют авторизации .

Операция Описание HTTP-сопоставления REST
список Список всех учетных записей, к которым может получить доступ текущий аутентифицированный пользователь. GET для коллекции URI.
получить Получает определенный ресурс учетных записей. GET для URI ресурса.
Обновить Обновляет определенный ресурс учетных записей. PUT в URI ресурса, где вы передаете данные для обновленного ресурса.

Стиль вызова

REST — это стиль архитектуры программного обеспечения, обеспечивающий удобный и последовательный подход к запросу и изменению данных.

Термин REST является сокращением от « Передача репрезентативного состояния ». В контексте API Google это относится к использованию глаголов HTTP для извлечения и изменения представлений данных, хранящихся в Google.

В системе RESTful ресурсы хранятся в хранилище данных; клиент отправляет запрос серверу на выполнение определенного действия (например, создание, извлечение, обновление или удаление ресурса), а сервер выполняет действие и отправляет ответ, часто в форме представления указанного ресурса.

В RESTful API Google клиент указывает действие с помощью команды HTTP, такой как POST , GET , PUT или DELETE . Он определяет ресурс с помощью глобально уникального URI следующего вида:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Поскольку все ресурсы API имеют уникальные доступные по HTTP URI, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной сетевой инфраструктурой.

Вы можете найти полезными определения методов в документации по стандартам HTTP 1.1; они включают спецификации для GET , POST , PUT и DELETE .

REST в Ad Exchange Buyer API

Поддерживаемые операции напрямую сопоставляются с HTTP-командами REST, как описано в разделе Операции API .

Конкретный формат для API URI:

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

где resourceID – это идентификатор ресурса Accounts, а parameters – любые параметры, применяемые к запросу. Дополнительные сведения см. в стандартных параметрах запроса и справочной документации .

Формат расширений пути resourceID позволяет определить ресурс, с которым вы сейчас работаете, например:

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

Полный набор URI, используемых для каждой поддерживаемой операции в API, приведен в справочной документации .

Вот пример того, как это работает в Ad Exchange Buyer API.

Получите список учетных записей аутентифицированного пользователя:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

Формат данных

JSON

JSON (нотация объектов JavaScript) — это распространенный независимый от языка формат данных, обеспечивающий простое текстовое представление произвольных структур данных. Для получения дополнительной информации см. json.org .