REST Resource: advertisers.youtubeAdGroups

Recurso: YoutubeGroup

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 de recurso do grupo de anúncios.

advertiserId

string (int64 format)

O ID exclusivo do anunciante ao qual 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 a que 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 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 de anúncios.

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 seu orçamento e dar lances no inventário.

Se o item de linha pai 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)

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

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

productFeedData

object (ProductFeedData)

Configurações do feed de produtos deste 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 de alcance efetivo, incluindo anúncios in-stream e bumper.
YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_MASTHEAD anúncio de masthead que é exibido no espaço superior da página inicial do YouTube.

ProductFeedData

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

Indica se a exibição de produtos foi desativada no feed de produtos.

ProductMatchType

As formas de correspondência dos 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 foram selecionados.
PRODUCT_MATCH_TYPE_CUSTOM_LABEL Relacione os 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 com que fazer a correspondência com o produto. dimension pode ser apenas de um dos tipos a seguir:
productOfferId

string

O ID da oferta do produto para corresponder a um produto com o mesmo ID.

customLabel

object (CustomLabel)

O rótulo personalizado para combinar todos os produtos com ele.

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 chave 0.
CUSTOM_LABEL_KEY_1 Índice de chave 1.
CUSTOM_LABEL_KEY_2 Índice de chave 2.
CUSTOM_LABEL_KEY_3 Índice de chave 3.
CUSTOM_LABEL_KEY_4 Índice de chave 4.

Métodos

bulkListAdGroupAssignedTargetingOptions

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

get

Recebe um grupo de anúncios do YouTube.

list

Lista os grupos de anúncios do YouTube.