REST Resource: advertisers.youtubeAdGroups

Recurso: YoutubeAdGroup

Um único grupo de anúncios do YouTube associado a um item de linha do YouTube e parceiros.

Representação JSON
{
  "name": string,
  "advertiserId": string,
  "adGroupId": string,
  "lineItemId": string,
  "displayName": string,
  "youtubeAdIds": [
    string
  ],
  "adGroupFormat": enum (YoutubeAndPartnersAdGroupFormat),
  "biddingStrategy": {
    object (YoutubeAndPartnersBiddingStrategy)
  },
  "entityStatus": enum (EntityStatus),
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "productFeedData": {
    object (ProductFeedData)
  }
}
Campos
name

string

O nome do recurso do grupo de anúncios.

advertiserId

string (int64 format)

O ID exclusivo do anunciante a que o grupo de anúncios pertence.

adGroupId

string (int64 format)

O ID exclusivo do grupo de anúncios. Atribuído pelo sistema.

lineItemId

string (int64 format)

O ID exclusivo do item de linha ao qual o grupo de anúncios pertence.

displayName

string

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

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

youtubeAdIds[]

string (int64 format)

Os IDs dos recursos [youtube_ad_group_ad][] associados ao grupo de anúncios.

adGroupFormat

enum (YoutubeAndPartnersAdGroupFormat)

O formato dos anúncios no grupo.

biddingStrategy

object (YoutubeAndPartnersBiddingStrategy)

A estratégia de lances usada pelo grupo de anúncios.

entityStatus

enum (EntityStatus)

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

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

targetingExpansion

object (TargetingExpansionConfig)

As configurações de expansão da segmentação do grupo de anúncios.

Essa configuração só é aplicável quando a segmentação por lista de público-alvo qualificada é atribuída ao grupo de anúncios.

productFeedData

object (ProductFeedData)

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

YoutubeAndPartnersAdGroupFormat

O formato do grupo de anúncios do YouTube.

Enums
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_UNSPECIFIED O valor do formato não foi especificado ou é desconhecido nesta versão.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM Anúncios in-stream.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_VIDEO_DISCOVERY Anúncios In-feed.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_BUMPER Anúncios bumper.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM Anúncios in-stream não puláveis.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_AUDIO Anúncios em áudio in-stream não puláveis.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_ACTION Anúncios responsivos para campanhas de ação em vídeo.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_REACH Grupos de anúncios com alcance efetivo, incluindo anúncios in-stream e bumper.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_MASTHEAD Anúncio de masthead que aparece no espaço principal da página inicial do YouTube.

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 produtos.

isFeedDisabled

boolean

Se o feed de produtos está desativado para mostrar produtos.

ProductMatchType

Os tipos de maneiras de corresponder produtos.

Enums
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 são selecionados.
PRODUCT_MATCH_TYPE_CUSTOM_LABEL Combine produtos por rótulos personalizados.

ProductMatchDimension

Uma dimensão usada para fazer correspondência de 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 que correspondem ao produto. dimension pode ser apenas de um dos tipos a seguir:
productOfferId

string

O ID da oferta de produto que precisa corresponder a um produto com o mesmo ID de oferta.

customLabel

object (CustomLabel)

O rótulo personalizado que corresponde 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

Enums
CUSTOM_LABEL_KEY_UNSPECIFIED Não especificado ou desconhecido.
CUSTOM_LABEL_KEY_0 Índice de chaves 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.

Métodos

bulkListAdGroupAssignedTargetingOptions

Lista as opções de segmentação atribuídas para vários grupos de anúncios do YouTube em todos os tipos de segmentação.

get

Recebe um grupo de anúncios do YouTube.

list

Lista grupos de anúncios do YouTube.