Практическое руководство

На этой странице рассказывается, как выполнять распространенные задачи с помощью API.

Создание пользователей

UserService позволяет пользователю с правами администратора создавать пользователей непосредственно в своей сети. Это может сделать любой разработчик, не дожидаясь, пока новый пользователь зарегистрируется. Например, если вы только начинаете работать с API, то вместо того, чтобы выполнять все вызовы API от имени администратора (по умолчанию для вашего адреса электронной почты), вы можете создать несколько пользователей с ролями "Продавец", "Трафик-менеджер" или "Рекламодатель", чтобы протестировать реальные рабочие процессы.

  1. Создайте новые адреса Gmail, например my.name.salesperson@gmail.com. Вы также можете зарегистрировать существующий адрес электронной почты, не относящийся к Gmail, в качестве нового аккаунта Google.
  2. Вызовите createUsers с новым адресом и выбранным Role.
  3. Вы можете выполнить аутентификацию от имени этого нового пользователя, используя OAuth 2.0 для создания токена доступа.

Как получить корневой рекламный блок

Максимальное количество дочерних узлов, которые можно добавить в AdUnit, и допустимая глубина иерархии зависят от типа аккаунта (Менеджер рекламы для малого бизнеса или Менеджер рекламы 360). Верхний узел AdUnit, который поддерживает изменение дочерних узлов, называется эффективным корневым узлом AdUnit.

Чтобы получить эффективный корневой домен, вызовите NetworkService.getCurrentNetwork() и проверьте поле effectiveRootAdUnitId в возвращенном объекте Network.

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

Запрос объекта

Для поиска объектов по критериям используется метод getObjectsByStatement(), который поддерживается многими сервисами. Здесь Object – это определенный тип объекта. Этот метод принимает запрос PQL, который похож на SQL-запрос тем, что позволяет указывать поля для поиска (где названия полей сопоставляются со свойствами объекта), сортировать, ограничивать и смещать результаты поиска. Подробную информацию о языке PQL и о том, по каким полям объектов можно выполнять фильтрацию, вы найдете в руководстве по PQL.

Как создать заказ

Чтобы создать заказ, просто создайте объект Order и укажите идентификаторы рекламодателя, продавца и трафик-менеджера, назначьте уникальное название и вызовите createOrders(). В результате будет создан новый объект Order или появится сообщение об ошибке.

Пример

Ознакомьтесь с примером кода Java для создания заказа.

Как создать позицию

Чтобы создать позицию, выполните следующие действия:

  1. Создайте новый объект Order или используйте существующий.
  2. Создайте новый объект LineItem и задайте тип ротации, массив размеров объявлений, даты начала и окончания, а также другие свойства.
  3. Создайте новый объект InventoryTargeting и укажите, на какие объекты Placement или AdUnit нужно настроить таргетинг или какие из них нужно исключить.
  4. Поместите объект InventoryTargeting в новый объект Targeting и назначьте его свойству таргетинга LineItem.
  5. Вызовите метод createLineItems() сервиса LineItemService с новым объектом и проверьте результат, чтобы узнать, был ли создан объект.

Пример

Ознакомьтесь с примером кода Java для создания позиции.

Как создать креатив

Разные типы креативов поддерживают разные компоненты. Например, графический креатив поддерживает один исходный графический файл, а креатив Flash – два файла объектов: файл Flash и файл резервного изображения, который используется, если файл Flash не может быть показан. Если креативы размещены на сторонних сайтах, вам нужно будет загрузить только фрагмент HTML-кода, который ссылается на файл на стороннем сервере. Чтобы узнать, какие объекты нужно загрузить для создания креатива, ознакомьтесь с информацией о подклассе Creative.

Пример

Ознакомьтесь с примером кода Java для создания графического креатива.

Как изменить существующий объект

Чтобы изменить существующий объект, запросите его, вызвав метод getObjectsByStatement(), обновите значения в возвращенных объектах, а затем вызовите метод updateObjects().

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

Как изменить статус объекта

Статус объекта изменяется путем вызова метода performObjectAction(), предоставляемого вашим сервисом. Этот метод принимает два параметра:

  • Экземпляр объекта действия, который описывает, что вы хотите сделать. Например, сервис OrderService поддерживает несколько действий, в том числе ApproveOrders, PauseOrders и ArchiveOrders. Все объекты действий являются производными от базового класса действий, подходящего для вашего сервиса.
  • Запрос PQL, описывающий объекты, которые нужно изменить. Вы можете изменить статус одного или нескольких объектов одновременно, указав соответствующее выражение PQL.

Создание тегов объявлений

Создавать теги объявлений с помощью API нельзя. Для этого нужно использовать сайт Google Менеджера рекламы. Дополнительную информацию можно найти в разделе Теги Справочного центра.

Другие примеры

Вы можете найти множество других примеров на разных языках программирования в образце кода клиентской библиотеки. Ссылки на примеры для разных языков программирования можно найти на странице Клиентские библиотеки и примеры кода.