Внимание! Вы просматриваете документацию по интерфейсу REST API. Большинство наших официальных клиентских библиотек используют gRPC. Подробнее см. в разделе Введение в REST .

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

Иерархия имен

Имена ресурсов, используемые в Google Ads API, являются иерархическими, отражая организацию объектов в Google Ads. Почти все ресурсы являются подресурсами ресурса Customer , что отражает тот факт, что почти каждый вызов API должен быть нацелен на конкретную учетную запись Google Ads. Например, кампании, группы объявлений, объявления и ключевые слова — все это подресурсы корневого ресурса клиента.

Ресурс Имя ресурса
Клиент customers/1234567890
Кампания customers/1234567890/campaigns/8765432109
Группа объявлений customers/1234567890/adGroups/54321098765
Группа объявленийОбъявление customers/1234567890/adGroupAds/54321098765~2109876543210

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

Объекты Google Реклама (клиенты, кампании и т. д.) упоминаются в API по именам их ресурсов. Однако важно отметить, что сами имена ресурсов могут иметь уникальные числовые идентификаторы ресурсов , которые идентифицируют каждый объект в иерархии. В этих случаях может быть полезно проанализировать имя ресурса, чтобы извлечь эти идентификаторы ресурсов и собрать новый.

Например, проверьте имя ресурса AdGroupAd из предыдущей таблицы:

customers/1234567890/adGroupAds/54321098765~2109876543210

Его можно разбить на отдельные идентификаторы ресурсов (разделенные идентификаторами коллекций ) следующим образом:

Компоненты имени ресурса
Идентификаторы ресурсов
Пользовательский ИД:
"1234567890"
идентификатор группы объявлений:
"54321098765"
Идентификатор объявления группы объявлений:
"2109876543210"
Идентификаторы коллекций
"customers"
"adGroupAds"

Анализ отдельных идентификаторов позволяет получить новые имена ресурсов для ссылки на клиента объявления группы объявлений ( customers/1234567890 ) или его группу объявлений ( customers/1234567890/adGroupAds/54321098765 ).

Идентификаторы общих объектов

Большинство объектов в API связаны с одним конкретным клиентом Google Реклама. Однако есть некоторые типы объектов, которые могут использоваться несколькими учетными записями. На практике это такие вещи, как списки минус-слов или действия-конверсии между аккаунтами , которые обычно создаются менеджерами, а затем передаются многим клиентским аккаунтам.

Имена ресурсов таких объектов будут различаться в зависимости от того, в какую учетную запись вы отправляете вызов API.

Пример: действия-конверсии в нескольких аккаунтах

Предположим, у нас есть управляющий аккаунт 987-654-3210 , который использует действие-конверсию в нескольких аккаунтах совместно с одним из своих клиентских аккаунтов 123-456-7890 :

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

Вызов API управляющего аккаунта, чтобы, например, обновить период ретроспективного анализа действия-конверсии, будет ссылаться на общий объект, используя имя ресурса: customers/9876543210/conversionActions/257733534 .

Вызов API-интерфейса учетной записи клиента для согласия на использование общего действия-конверсии будет ссылаться на него с использованием имени ресурса: customers/1234567890/conversionActions/257733534 .

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