Получение объектов

GoogleAdsService – это унифицированная служба поиска объектов и создания отчетов Google Ads API. У сервиса есть методы, которые:

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

GoogleAdsService может возвращать результаты двумя способами:

  • GoogleAdsService.SearchStream возвращает все строки в одном потоковом ответе, что более эффективно для больших (более 10 000 строк) наборов результатов. Это может быть более подходящим, если ваше пакетное приложение хочет загрузить как можно больше данных как можно быстрее.
  • GoogleAdsService.Search разбивает большие ответы на управляемые страницы результатов. Это может быть более подходящим, если ваше интерактивное приложение одновременно отображает страницу результатов.

Узнайте больше о пейджинговой передаче и потоковой передаче .

Обратиться с просьбой

Для метода поиска требуется SearchGoogleAdsRequest , который состоит из следующих атрибутов:

  • customer_id
  • query на языке запросов Google Рекламы, который указывает, какой ресурс запрашивать, атрибуты, сегменты и показатели, которые нужно получить, а также условия, которые следует использовать для ограничения возвращаемых объектов.
  • (Только GoogleAdsService.Search ) page_size , указывающий, сколько объектов должно быть возвращено в одном ответе при использовании пейджинга .
  • (Только GoogleAdsService.Search ) Необязательный page_token для получения следующего пакета результатов при использовании пейджинга .

Дополнительную информацию о языке запросов Google Рекламы можно найти в руководстве по языку запросов Google Рекламы .

Обработать ответ

GoogleAdsService возвращает список объектов GoogleAdsRow .

Каждая строка GoogleAdsRow представляет объект, возвращаемый запросом, и состоит из набора атрибутов, заполняемых на основе полей, запрошенных в предложении SELECT . Атрибуты, не включенные в предложение SELECT , не заполняются в объектах GoogleAdsRow в ответе.

Например, хотя ad_group_criterion имеет атрибут status , поле status атрибута ad_group_criterion строки не заполняется в ответе на запрос, где предложение SELECT не включает ad_group_criterion.status . Аналогично, атрибут campaign строки не заполняется, если предложение SELECT не включает в себя какие-либо поля из ресурса campaign .

Каждая строка GoogleAdsRow может иметь разные атрибуты и показатели из другой строки в том же наборе результатов; поэтому строки следует рассматривать как объекты, а не как фиксированные строки таблицы.

НЕИЗВЕСТНЫЕ типы перечислений

Ресурсы, возвращаемые с типом UNKNOWN не полностью поддерживаются в этой версии API. Эти ресурсы можно было создать с помощью других интерфейсов, например пользовательского интерфейса Google Рекламы. Вы можете выбрать метрики, если ресурс имеет тип UNKNOWN , но не можете изменить ресурс через API. Примером этого может быть новая кампания или объявление, представленное в пользовательском интерфейсе, но не поддерживаемое в запрашиваемой версии API.

Вот некоторые соображения, которые следует иметь в виду:

  • Ресурс типа UNKNOWN может поддерживаться позже или оставаться UNKNOWN на неопределенный срок.
  • Новые объекты типа UNKNOWN могут появиться в любое время. Эти объекты обратно совместимы, поскольку значение перечисления уже доступно. Ресурсы представлены вместе с этим изменением по мере их доступности, чтобы у вас было точное представление о вашей учетной записи. UNKNOWN ресурс может появиться из-за новых действий в вашей учетной записи через другие интерфейсы или в случае, если ресурс больше не поддерживается.
  • UNKNOWN ресурсы могут иметь прикрепленные к ним подробные метрики, которые можно запрашивать.
  • UNKNOWN ресурсы обычно полностью видны в интерфейсе Google Рекламы.
  • UNKNOWN ресурсы, как правило, не могут быть изменены.

Сегментация

Ответ будет содержать одну строку GoogleAdsRow для каждой комбинации следующих элементов:

  • Экземпляр основного ресурса, указанного в предложении FROM .
  • Значение каждого выбранного поля segment

Например, ответ на запрос, который выбирает FROM campaign и имеет в предложении SELECT segments.ad_network_type и segments.date , будет содержать по одной строке для каждой комбинации следующих значений:

  • campaign
  • segments.ad_network_type
  • segments.date

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

SELECT campaign.status, metrics.impressions
FROM campaign
WHERE segments.date DURING LAST_14_DAYS

в результате получается одна строка на кампанию , а не одна строка на отдельное значение поля campaign.status .