REST Resource: advertisers.adGroups

Recurso: AdGroup

Um único grupo de anúncios associado a um item de linha.

Representação 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)
  }
}
Campos
name

string

Apenas saída. Identificador. O nome do recurso do grupo de anúncios.
advertiserId

string (int64 format)

Apenas saída. O ID exclusivo do anunciante a que o grupo de anúncios pertence.
adGroupId

string (int64 format)

Apenas saída. O ID exclusivo do grupo de anúncios. Atribuído pelo sistema.
lineItemId

string (int64 format)

Obrigatório. Imutável. O ID exclusivo do item de linha a que o grupo de anúncios pertence.
displayName

string

Obrigatório. O nome de exibição do grupo de anúncios.

Precisa ser codificado em UTF-8 com um tamanho máximo de 255 bytes.
adGroupFormat

enum (AdGroupFormat)

Obrigatório. Imutável. O formato dos anúncios no grupo de anúncios.
bidStrategy

object (BiddingStrategy)

Opcional. A estratégia de lances usada pelo grupo de anúncios. Somente os campos youtubeAndPartnersBid e demandGenBid podem ser usados na estratégia de lances.
entityStatus

enum (EntityStatus)

Obrigatório. Controla se o grupo de anúncios pode gastar o orçamento e fazer lances no inventário.

Se o item de linha principal do grupo de anúncios não estiver ativo, o grupo não poderá gastar o orçamento, mesmo que o status dele seja ENTITY_STATUS_ACTIVE.
targetingExpansion

object (TargetingExpansionConfig)

Opcional. As configurações de segmentação otimizada do grupo de anúncios.
productFeedData

object (ProductFeedData)

Opcional. As configurações do feed de produtos neste grupo de anúncios.
adGroupInventoryControl

object (AdGroupInventoryControl)

Opcional. Obrigatório para grupos de anúncios da Geração de demanda. Especifica o controle de inventário do grupo de anúncios.

AdGroupFormat

O formato do grupo de anúncios.

Tipos enumerados
AD_GROUP_FORMAT_UNSPECIFIED O valor do formato não foi especificado ou é desconhecido nesta versão.
AD_GROUP_FORMAT_IN_STREAM Anúncios in-stream.
AD_GROUP_FORMAT_VIDEO_DISCOVERY Anúncios in-feed.
AD_GROUP_FORMAT_BUMPER Anúncios bumper.
AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM Anúncios in-stream não puláveis.
AD_GROUP_FORMAT_AUDIO Anúncios em áudio in-stream não puláveis.
AD_GROUP_FORMAT_RESPONSIVE Anúncios responsivos.
AD_GROUP_FORMAT_REACH Grupos de anúncios de alcance efetivo, incluindo anúncios in-stream e bumper.
AD_GROUP_FORMAT_MASTHEAD Anúncio de masthead que aparece no espaço superior da página inicial do YouTube.
AD_GROUP_FORMAT_DEMAND_GEN

Anúncios da Geração de demanda.

ProductFeedData

Os detalhes do feed de produtos.

Representação JSON 
{
  "productMatchType": enum (ProductMatchType),
  "productMatchDimensions": [
    {
      object (ProductMatchDimension)
    }
  ],
  "isFeedDisabled": boolean
}
Campos
productMatchType

enum (ProductMatchType)

Como os produtos são selecionados pelo feed de produtos.
productMatchDimensions[]

object (ProductMatchDimension)

Uma lista de dimensões usadas para corresponder a produtos.
isFeedDisabled

boolean

Se o feed de produtos desativou a exibição de produtos.

ProductMatchType

Os tipos de maneiras de corresponder produtos.

Tipos enumerados
PRODUCT_MATCH_TYPE_UNSPECIFIED Não especificado ou desconhecido.
PRODUCT_MATCH_TYPE_ALL_PRODUCTS Todos os produtos são correspondentes.
PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS Produtos específicos estão selecionados.
PRODUCT_MATCH_TYPE_CUSTOM_LABEL Combine produtos pelos rótulos personalizados.

ProductMatchDimension

Uma dimensão usada para corresponder produtos.

Representação JSON 
{

  // Union field dimension can be only one of the following:
  "productOfferId": string,
  "customLabel": {
    object (CustomLabel)
  }
  // End of list of possible types for union field dimension.
}
Campos
Campo de união dimension. A dimensão e o valor em que o produto será correspondido. dimension pode ser apenas de um dos tipos a seguir:
productOfferId

string

O ID da oferta de produto a ser correspondida com um produto com o mesmo ID de oferta.
customLabel

object (CustomLabel)

O rótulo personalizado para corresponder a todos os produtos com o rótulo.

CustomLabel

A chave e o valor de um rótulo personalizado.

Representação JSON 
{
  "key": enum (CustomLabelKey),
  "value": string
}
Campos
key

enum (CustomLabelKey)

A chave do rótulo.
value

string

O valor do rótulo.

CustomLabelKey

A chave do rótulo personalizado

Tipos enumerados
CUSTOM_LABEL_KEY_UNSPECIFIED Não especificado ou desconhecido.
CUSTOM_LABEL_KEY_0 Índice de chave 0.
CUSTOM_LABEL_KEY_1 Índice de chaves 1.
CUSTOM_LABEL_KEY_2 Índice de chaves 2.
CUSTOM_LABEL_KEY_3 Índice de chaves 3.
CUSTOM_LABEL_KEY_4 Índice de chaves 4.

AdGroupInventoryControl

O controle de inventário do grupo de anúncios.

Representação JSON 
{

  // Union field inventory_controls can be only one of the following:
  "adGroupInventoryStrategy": enum (AdGroupInventoryStrategy),
  "selectedInventories": {
    object (SelectedInventories)
  }
  // End of list of possible types for union field inventory_controls.
}
Campos
Campo de união inventory_controls. O controle de inventário do grupo de anúncios. inventory_controls pode ser apenas de um dos tipos a seguir:
adGroupInventoryStrategy

enum (AdGroupInventoryStrategy)

A estratégia de inventário.
selectedInventories

object (SelectedInventories)

Os inventários selecionados.

AdGroupInventoryStrategy

A estratégia de inventário do grupo de anúncios.

Tipos enumerados
AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED Não especificado ou desconhecido.
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY O grupo de anúncios está ativado em todo o inventário do Google e da Rede de Display.
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY O grupo de anúncios está ativado em todo o inventário do Google.

SelectedInventories

O controle de inventário do grupo de anúncios.

Representação JSON 
{
  "allowYoutubeStream": boolean,
  "allowYoutubeShorts": boolean,
  "allowYoutubeFeed": boolean,
  "allowDiscover": boolean,
  "allowGmail": boolean,
  "allowGoogleDisplayNetwork": boolean
}
Campos
allowYoutubeStream

boolean

Se o grupo de anúncios está ativado para o inventário in-stream do YouTube.
allowYoutubeShorts

boolean

Se o grupo de anúncios está ativado para o inventário do YouTube Shorts.
allowYoutubeFeed

boolean

Se o grupo de anúncios está ativado para o inventário in-feed do YouTube.
allowDiscover

boolean

Indica se o grupo de anúncios está ativado para o inventário do Discover.
allowGmail

boolean

Indica se o grupo de anúncios está ativado para o inventário do Gmail.
allowGoogleDisplayNetwork

boolean

Indica se o grupo de anúncios está ativado para o inventário da Rede de Display do Google.

Métodos

bulkEditAssignedTargetingOptions

 Edita em massa as opções de segmentação de vários grupos de anúncios.

bulkListAssignedTargetingOptions

 Lista as opções de segmentação atribuídas a vários grupos de anúncios em diferentes tipos de segmentação.

create

 Cria um novo grupo de anúncios.

delete

 Exclui um grupo de anúncios.

get

 Recebe um grupo de anúncios.

list

 Lista os grupos de anúncios.

patch

 Atualiza um grupo de anúncios existente.