REST Resource: advertisers.adGroups

Ресурс: AdGroup

Одна группа объявлений, связанная с позицией.

JSON-представление 
{
  "name": string,
  "advertiserId": string,
  "adGroupId": string,
  "lineItemId": string,
  "displayName": string,
  "adGroupFormat": enum (AdGroupFormat),
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "entityStatus": enum (EntityStatus),
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "productFeedData": {
    object (ProductFeedData)
  },
  "adGroupInventoryControl": {
    object (AdGroupInventoryControl)
  },
  "adSource": enum (AdSource),
  "creativeAssignments": [
    {
      object (CreativeAssignment)
    }
  ]
}
Поля
name

string

Только для вывода. Идентификатор. Название ресурса группы объявлений.
advertiserId

string (int64 format)

Только для вывода. Уникальный идентификатор рекламодателя, которому принадлежит группа объявлений.
adGroupId

string (int64 format)

Только для вывода. Уникальный идентификатор группы объявлений. Назначается системой.
lineItemId

string (int64 format)

Обязательно. Не меняется. Уникальный идентификатор позиции, к которой относится группа объявлений.
displayName

string

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

Должен быть закодирован в UTF-8 и иметь максимальный размер 255 байт.
adGroupFormat

enum (AdGroupFormat)

Обязательно. Не меняется. Формат объявлений в группе.
bidStrategy

object (BiddingStrategy)

Необязательное поле. Стратегия назначения ставок, используемая группой объявлений. В стратегии назначения ставок можно использовать только поля youtubeAndPartnersBid и demandGenBid.
entityStatus

enum (EntityStatus)

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

Если родительская позиция группы объявлений неактивна, то бюджет группы не будет расходоваться, даже если у нее статус ENTITY_STATUS_ACTIVE.
targetingExpansion

object (TargetingExpansionConfig)

Необязательное поле. Настройки оптимизированного таргетинга группы объявлений.
productFeedData

object (ProductFeedData)

Необязательное поле. Настройки фида товаров в этой группе объявлений.
adGroupInventoryControl

object (AdGroupInventoryControl)

Необязательное поле. Обязательно для групп объявлений в кампаниях для создания спроса. Указывает на систему управления инвентарем группы объявлений.
adSource

enum (AdSource)

Необязательное поле. Источник объявлений в этой группе. Это поле используется, только если объявления создаются автоматически из заданного источника.
creativeAssignments[]

object (CreativeAssignment)

Необязательное поле. Креативы, используемые для создания объявлений в группе.

Это поле можно назначить, только если adSource – AD_SOURCE_DV360_CREATIVE.

AdGroupFormat

Формат группы объявлений.

Перечисления
AD_GROUP_FORMAT_UNSPECIFIED Значение формата не указано или неизвестно в этой версии.
AD_GROUP_FORMAT_IN_STREAM Объявления In-Stream.
AD_GROUP_FORMAT_VIDEO_DISCOVERY Объявления в фиде.
AD_GROUP_FORMAT_BUMPER Объявления-заставки
AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM Объявления In-Stream без возможности пропуска.
AD_GROUP_FORMAT_AUDIO Аудиообъявления In-Stream без возможности пропуска.
AD_GROUP_FORMAT_RESPONSIVE Адаптивные объявления.
AD_GROUP_FORMAT_REACH Группы объявлений с эффективным охватом, в том числе объявления In-Stream и объявления-заставки.
AD_GROUP_FORMAT_MASTHEAD Объявление Masthead, которое показывается в верхней части главной страницы YouTube.
AD_GROUP_FORMAT_DEMAND_GEN Объявления для создания спроса.

ProductFeedData

Сведения о фиде товаров.

JSON-представление 
{
  "productMatchType": enum (ProductMatchType),
  "productMatchDimensions": [
    {
      object (ProductMatchDimension)
    }
  ],
  "isFeedDisabled": boolean
}
Поля
productMatchType

enum (ProductMatchType)

Как выбираются товары из фида.
productMatchDimensions[]

object (ProductMatchDimension)

Список параметров, используемых для сопоставления товаров.
isFeedDisabled

boolean

Отключен ли показ товаров из фида товаров.

ProductMatchType

Типы способов сопоставления товаров.

Перечисления
PRODUCT_MATCH_TYPE_UNSPECIFIED Не указано или неизвестно.
PRODUCT_MATCH_TYPE_ALL_PRODUCTS Все товары сопоставлены.
PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS Выбраны определенные товары.
PRODUCT_MATCH_TYPE_CUSTOM_LABEL Сопоставление товаров по меткам продавца.

ProductMatchDimension

Параметр, используемый для сопоставления товаров.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "productOfferId": string,
  "customLabel": {
    object (CustomLabel)
  }
  // End of mutually exclusive fields.
}
Поля
Параметр и значение, по которым сопоставляется товар. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
productOfferId

string

Идентификатор предложения, который должен совпадать с идентификатором товара.
customLabel

object (CustomLabel)

Метка продавца, которая будет сопоставляться со всеми товарами с этой меткой.
Конец взаимоисключающих полей.

CustomLabel

Ключ и значение специального ярлыка.

JSON-представление 
{
  "key": enum (CustomLabelKey),
  "value": string
}
Поля
key

enum (CustomLabelKey)

Ключ ярлыка.
value

string

Значение ярлыка.

CustomLabelKey

Ключ пользовательского ярлыка.

Перечисления
CUSTOM_LABEL_KEY_UNSPECIFIED Не указано или неизвестно.
CUSTOM_LABEL_KEY_0 Индекс ключа 0.
CUSTOM_LABEL_KEY_1 Индекс ключа 1.
CUSTOM_LABEL_KEY_2 Индекс ключа 2.
CUSTOM_LABEL_KEY_3 Индекс ключа 3.
CUSTOM_LABEL_KEY_4 Индекс ключа 4.

AdGroupInventoryControl

Управление инвентарем группы объявлений.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adGroupInventoryStrategy": enum (AdGroupInventoryStrategy),
  "selectedInventories": {
    object (SelectedInventories)
  }
  // End of mutually exclusive fields.
}
Поля
Управление инвентарем группы объявлений. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
adGroupInventoryStrategy

enum (AdGroupInventoryStrategy)

Стратегия инвентаря.
selectedInventories

object (SelectedInventories)

Выбранный инвентарь.
Конец взаимоисключающих полей.

AdGroupInventoryStrategy

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

Перечисления
AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED Не указано или неизвестно.
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY Группа объявлений включена для всего инвентаря Google и контекстно-медийной сети.
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY Группа объявлений включена для всего инвентаря Google.

SelectedInventories

Управление инвентарем группы объявлений.

JSON-представление 
{
  "allowYoutubeStream": boolean,
  "allowYoutubeShorts": boolean,
  "allowYoutubeFeed": boolean,
  "allowDiscover": boolean,
  "allowGmail": boolean,
  "allowGoogleDisplayNetwork": boolean
}
Поля
allowYoutubeStream

boolean

Включен ли в группе объявлений инвентарь In-Stream на YouTube.
allowYoutubeShorts

boolean

Включен ли в группе объявлений инвентарь YouTube Shorts.
allowYoutubeFeed

boolean

Включен ли в группе объявлений инвентарь в фиде YouTube.
allowDiscover

boolean

Включен ли в группе объявлений инвентарь рекомендаций.
allowGmail

boolean

Включен ли в группе объявлений инвентарь Gmail.
allowGoogleDisplayNetwork

boolean

Включен ли в группе объявлений инвентарь контекстно-медийной сети Google.

AdSource

Источник объявлений в этой группе.

Перечисления
AD_SOURCE_UNSPECIFIED Не указано или неизвестно. По умолчанию используется обычный источник объявлений.
AD_SOURCE_DV360_CREATIVE Источник – креатив DV360.

CreativeAssignment

Сведения о креативе, назначенном группе объявлений.

JSON-представление 
{
  "creativeId": string
}
Поля
creativeId

string (int64 format)

Обязательно. Идентификатор креатива Дисплея и Видео 360, назначенного группе объявлений.

Методы

bulkEditAssignedTargetingOptions

 Массовое изменение настроек таргетинга для нескольких групп объявлений.

bulkListAssignedTargetingOptions

 Возвращает список назначенных параметров таргетинга для нескольких групп объявлений по типам таргетинга.

create

 Создает новую группу объявлений.

delete

 Удаляет группу объявлений.

get

 Возвращает группу объявлений.

list

 Список групп объявлений.

patch

 Обновляет существующую группу объявлений.