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

Эта страница переведена с помощью Cloud Translation API.

AdGroup

JSON-представление
Статус группы объявлений
Группа объявленийРежим ротации объявлений
Настройка аудитории
- JSON-представление
Группа объявленийОсновной статус
Группа объявленийПервичныйстатусПричина

Группа объявлений.

JSON-представление

JSON-представление
{ "resourceName": string, "status": enum (`AdGroupStatus`), "type": enum (`AdGroupType`), "adRotationMode": enum (`AdGroupAdRotationMode`), "urlCustomParameters": [ { object (`CustomParameter`) } ], "optimizedTargetingEnabled": boolean, "displayCustomBidDimension": enum (`TargetingDimension`), "targetingSetting": { object (`TargetingSetting`) }, "audienceSetting": { object (`AudienceSetting`) }, "effectiveTargetCpaSource": enum (`BiddingSource`), "effectiveTargetRoasSource": enum (`BiddingSource`), "labels": [ string ], "excludedParentAssetFieldTypes": [ enum (`AssetFieldType`) ], "excludedParentAssetSetTypes": [ enum (`AssetSetType`) ], "primaryStatus": enum (`AdGroupPrimaryStatus`), "primaryStatusReasons": [ enum (`AdGroupPrimaryStatusReason`) ], "id": string, "name": string, "baseAdGroup": string, "trackingUrlTemplate": string, "campaign": string, "cpcBidMicros": string, "effectiveCpcBidMicros": string, "cpmBidMicros": string, "targetCpaMicros": string, "cpvBidMicros": string, "targetCpmMicros": string, "targetRoas": number, "percentCpcBidMicros": string, "finalUrlSuffix": string, "effectiveTargetCpaMicros": string, "effectiveTargetRoas": number }

{
  "resourceName": string,
  "status": enum (AdGroupStatus),
  "type": enum (AdGroupType),
  "adRotationMode": enum (AdGroupAdRotationMode),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "optimizedTargetingEnabled": boolean,
  "displayCustomBidDimension": enum (TargetingDimension),
  "targetingSetting": {
    object (TargetingSetting)
  },
  "audienceSetting": {
    object (AudienceSetting)
  },
  "effectiveTargetCpaSource": enum (BiddingSource),
  "effectiveTargetRoasSource": enum (BiddingSource),
  "labels": [
    string
  ],
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "excludedParentAssetSetTypes": [
    enum (AssetSetType)
  ],
  "primaryStatus": enum (AdGroupPrimaryStatus),
  "primaryStatusReasons": [
    enum (AdGroupPrimaryStatusReason)
  ],
  "id": string,
  "name": string,
  "baseAdGroup": string,
  "trackingUrlTemplate": string,
  "campaign": string,
  "cpcBidMicros": string,
  "effectiveCpcBidMicros": string,
  "cpmBidMicros": string,
  "targetCpaMicros": string,
  "cpvBidMicros": string,
  "targetCpmMicros": string,
  "targetRoas": number,
  "percentCpcBidMicros": string,
  "finalUrlSuffix": string,
  "effectiveTargetCpaMicros": string,
  "effectiveTargetRoas": number
}

Поля
`resourceName`	`string` Неизменный. Имя ресурса группы объявлений. Названия ресурсов группы объявлений имеют вид: `customers/{customerId}/adGroups/{adGroupId}`
`status`	`enum ( AdGroupStatus )` Статус группы объявлений.
`type`	`enum ( AdGroupType )` Неизменный. Тип группы объявлений.
`adRotationMode`	`enum ( AdGroupAdRotationMode )` Режим ротации объявлений в группе объявлений.
`urlCustomParameters[]`	`object ( CustomParameter )` Список сопоставлений, используемых для замены тегов пользовательских параметров в `trackingUrlTemplate` , `finalUrls` или `mobile_final_urls` .
`optimizedTargetingEnabled`	`boolean` True, если включен оптимизированный таргетинг. Оптимизированный таргетинг заменяет расширение аудитории.
`displayCustomBidDimension`	`enum ( TargetingDimension )` Позволяет рекламодателям указать параметр таргетинга, по которому будут устанавливаться абсолютные ставки. Это применимо только к кампаниям, ориентированным только на контекстно-медийную сеть, а не на поиск.
`targetingSetting`	`object ( TargetingSetting )` Настройка таргетинга на связанные функции.
`audienceSetting`	`object ( AudienceSetting )` Неизменный. Настройка функций, связанных с аудиторией.
`effectiveTargetCpaSource`	`enum ( BiddingSource )` Только вывод. Источник эффективной целевой цены за конверсию. Это поле доступно только для чтения.
`effectiveTargetRoasSource`	`enum ( BiddingSource )` Только вывод. Источник эффективной целевой рентабельности инвестиций в рекламу. Это поле доступно только для чтения.
`labels[]`	`string` Только вывод. Имена ресурсов ярлыков, прикрепленных к этой группе объявлений.
`excludedParentAssetFieldTypes[]`	`enum ( AssetFieldType )` Типы полей объектов, которые следует исключить из этой группы объявлений. Ссылки на объекты с этими типами полей не будут унаследованы этой группой объявлений с верхних уровней.
`excludedParentAssetSetTypes[]`	`enum ( AssetSetType )` Типы наборов объектов, которые следует исключить из этой группы объявлений. Ссылки на наборы объектов этих типов не будут унаследованы этой группой объявлений с верхних уровней. Типы групп местоположений (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP и STATIC_LOCATION_GROUP) являются дочерними типами LOCATION_SYNC. Таким образом, если для этого поля задано значение LOCATION_SYNC, все наборы объектов группы местоположений не могут быть связаны с этой группой объявлений, и все расширения местоположений (LE) и партнерские расширения местоположений (ALE) не будут обслуживаться в этой группе объявлений. В настоящее время поддерживается только LOCATION_SYNC.
`primaryStatus`	`enum ( AdGroupPrimaryStatus )` Только вывод. Предоставляет сводное представление о том, почему группа объявлений не показывается или показывается неоптимально.
`primaryStatusReasons[]`	`enum ( AdGroupPrimaryStatusReason )` Только вывод. Содержит причины, по которым группа объявлений не показывается или показывается неоптимально.
`id`	`string ( int64 format)` Только вывод. Идентификатор группы объявлений.
`name`	`string` Название группы объявлений. Это поле является обязательным и не должно быть пустым при создании новых групп объявлений. Он должен содержать менее 255 символов полной ширины UTF-8. Он не должен содержать нулевых символов (кодовая точка 0x0), перевода строки NL (кодовая точка 0xA) или возврата каретки (кодовая точка 0xD).
`baseAdGroup`	`string` Только вывод. Для проектов или экспериментальных групп объявлений это поле представляет собой имя ресурса базовой группы объявлений, на основе которой эта группа объявлений была создана. Если в проекте или экспериментальной группе объявлений нет базовой группы объявлений, это поле имеет значение null. Для базовых групп объявлений это поле соответствует названию ресурса группы объявлений. Это поле доступно только для чтения.
`trackingUrlTemplate`	`string` Шаблон URL-адреса для создания URL-адреса отслеживания.
`campaign`	`string` Неизменный. Кампания, к которой принадлежит группа объявлений.
`cpcBidMicros`	`string ( int64 format)` Максимальная ставка CPC (цена за клик).
`effectiveCpcBidMicros`	`string ( int64 format)` Только вывод. Значение будет таким же, как значение ставки CPC (цена за клик), если выбрана стратегия назначения ставок: цена за клик вручную, расширенная цена за клик, продвижение первой страницы или целевая доля превосходящих позиций; в противном случае значение будет равно нулю.
`cpmBidMicros`	`string ( int64 format)` Максимальная ставка CPM (цена за тысячу показов в видимой области экрана).
`targetCpaMicros`	`string ( int64 format)` Целевая цена за конверсию (цена за приобретение). Если стратегией назначения ставок кампании группы объявлений является TargetCpa или MaximizeConversions (с установленным полем targetCpa), то это поле переопределяет целевую цену за конверсию, указанную в стратегии назначения ставок кампании. В противном случае это значение игнорируется.
`cpvBidMicros`	`string ( int64 format)` Ставка CPV (цена за просмотр).
`targetCpmMicros`	`string ( int64 format)` Средняя сумма в микронах, которую рекламодатель готов платить за каждую тысячу показов объявления.
`targetRoas`	`number` Целевой ROAS (рентабельность расходов на рекламу) переопределяется. Если стратегией назначения ставок кампании группы объявлений является TargetRoas или MaximizeConversionValue (с установленным полем targetRoas), то это поле переопределяет целевую рентабельность инвестиций в рекламу, указанную в стратегии назначения ставок кампании. В противном случае это значение игнорируется.
`percentCpcBidMicros`	`string ( int64 format)` Сумма ставки в процентах за клик, выраженная как доля рекламируемой цены на какой-либо товар или услугу. Допустимый диапазон дроби — [0,1), а хранимое здесь значение — 1 000 000 * [фракция].
`finalUrlSuffix`	`string` Шаблон URL-адреса для добавления параметров к конечному URL-адресу.
`effectiveTargetCpaMicros`	`string ( int64 format)` Только вывод. Эффективная целевая цена за конверсию (цена за приобретение). Это поле доступно только для чтения.
`effectiveTargetRoas`	`number` Только вывод. Эффективная целевая рентабельность инвестиций в рекламу (рентабельность расходов на рекламу). Это поле доступно только для чтения.

Статус группы объявлений

Возможные статусы группы объявлений.

Перечисления
`UNSPECIFIED`	Статус не указан.
`UNKNOWN`	Полученное значение в этой версии неизвестно. Это значение только для ответа.
`ENABLED`	Группа объявлений включена.
`PAUSED`	Группа объявлений приостановлена.
`REMOVED`	Группа объявлений удалена.

Группа объявленийРежим ротации объявлений

Возможные режимы ротации объявлений в группе объявлений.

Перечисления
`UNSPECIFIED`	Не указан режим ротации объявлений.
`UNKNOWN`	Полученное значение в этой версии неизвестно. Это значение только для ответа.
`OPTIMIZE`	Оптимизируйте объявления группы объявлений на основе кликов или конверсий.
`ROTATE_FOREVER`	Вращайте равномерно навсегда.

Настройка аудитории

Настройки таргетинга аудитории.

JSON-представление
{ "useAudienceGrouped": boolean }

Поля

Поля
`useAudienceGrouped`	`boolean` Неизменный. Если это правда, эта группа объявлений использует ресурс «Аудитория» для таргетинга на аудиторию. Если указано значение false, вместо этого в этой группе объявлений могут использоваться критерии сегмента аудитории.

useAudienceGrouped

boolean

Неизменный. Если это правда, эта группа объявлений использует ресурс «Аудитория» для таргетинга на аудиторию. Если указано значение false, вместо этого в этой группе объявлений могут использоваться критерии сегмента аудитории.

Группа объявленийОсновной статус

Возможные статусы группы объявлений.

Перечисления
`UNSPECIFIED`	Не указан.
`UNKNOWN`	Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
`ELIGIBLE`	Группа объявлений допущена к показу.
`PAUSED`	Группа объявлений приостановлена.
`REMOVED`	Группа объявлений удалена.
`PENDING`	Группа объявлений может появиться в будущем.
`NOT_ELIGIBLE`	Группа объявлений не допущена к показу.
`LIMITED`	Группа объявлений имеет ограниченную возможность обслуживания.

Группа объявленийПервичныйстатусПричина

Возможные причины статуса группы объявлений.

Перечисления
`UNSPECIFIED`	Не указан.
`UNKNOWN`	Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
`CAMPAIGN_REMOVED`	Статус кампании, указанный пользователем, удаляется. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`CAMPAIGN_PAUSED`	Статус кампании, указанный пользователем, приостановлен. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`CAMPAIGN_PENDING`	Указанное пользователем время запуска этой кампании находится в будущем. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`CAMPAIGN_ENDED`	Указанное пользователем время завершения этой кампании прошло. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_PAUSED`	Статус группы объявлений, указанный пользователем, приостановлен. Участвует в AdGroupPrimaryStatus.PAUSED.
`AD_GROUP_REMOVED`	Статус группы объявлений, указанный пользователем, удаляется. Участвует в AdGroupPrimaryStatus.REMOVED.
`AD_GROUP_INCOMPLETE`	Создание этой группы объявлений еще не завершено. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`KEYWORDS_PAUSED`	Все указанные пользователем статусы ключевых слов в этой группе объявлений приостановлены. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`NO_KEYWORDS`	В этой группе объявлений нет подходящих ключевых слов. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_ADS_PAUSED`	Все указанные пользователем статусы объявлений в этой группе объявлений приостановлены. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`NO_AD_GROUP_ADS`	В этой группе объявлений нет подходящих объявлений. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`HAS_ADS_DISAPPROVED`	Причина статуса политики, когда хотя бы одно объявление отклонено. Участвует в нескольких AdGroupPrimaryStatus.
`HAS_ADS_LIMITED_BY_POLICY`	Причина статуса политики, когда хотя бы одно объявление ограничено политикой. Участвует в нескольких AdGroupPrimaryStatus.
`MOST_ADS_UNDER_REVIEW`	Причина статуса политики, когда большинство объявлений ожидают проверки. Участвует в AdGroupPrimaryStatus.PENDING.
`CAMPAIGN_DRAFT`	Группа объявлений принадлежит к черновой кампании. Участвует в AdGroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY`	Группа объявлений приостановлена из-за длительного низкого уровня активности в показах. Участвует в AdGroupPrimaryStatus.PAUSED.