Фон

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

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

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

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

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

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

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

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

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

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

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

Помимо ресурса и коллекции учетных записей, 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, как описано в следующей таблице. Все операции требуют авторизации .

Операция Описание Сопоставления REST HTTP
список Перечисляет все учетные записи, к которым может получить доступ текущий аутентифицированный пользователь. 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 имеют уникальные URI, доступные по HTTP, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной инфраструктурой Интернета.

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

REST в Ad Exchange Buyer API

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

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

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 .