Cuidado: você está vendo a documentação da interface REST da API. A maioria das nossas bibliotecas de cliente oficiais usa o gRPC. Consulte Introdução ao REST para ver mais detalhes.

Esta página foi traduzida pela API Cloud Translation.

AdGroup

Representação JSON
AdGroupStatus
AdGroupType
AdGroupAdRotationMode
AudienceSetting
- Representação JSON

Um grupo de anúncios.

Representação JSON

Representação 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`) ], "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)
  ],
  "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
}

Campos
`resourceName`	`string` Imutável. O nome do recurso do grupo de anúncios. Os nomes dos recursos do grupo de anúncios têm o formato: `customers/{customerId}/adGroups/{adGroupId}`
`status`	`enum (AdGroupStatus)` O status do grupo de anúncios.
`type`	`enum (AdGroupType)` Imutável. O tipo do grupo de anúncios.
`adRotationMode`	`enum (AdGroupAdRotationMode)` Modo de rotação de anúncios do grupo de anúncios.
`urlCustomParameters[]`	`object (CustomParameter)` A lista de mapeamentos usados para substituir tags de parâmetros personalizados em `trackingUrlTemplate`, `finalUrls` ou `mobile_final_urls`.
`optimizedTargetingEnabled`	`boolean` Verdadeiro se a segmentação otimizada estiver ativada. A segmentação otimizada substitui a expansão de público-alvo.
`displayCustomBidDimension`	`enum (TargetingDimension)` Permite que os anunciantes especifiquem uma dimensão de segmentação para definir lances absolutos. Isso se aplica apenas a campanhas que segmentam somente a Rede de Display, e não a pesquisa.
`targetingSetting`	`object (TargetingSetting)` Configuração para recursos relacionados à segmentação.
`audienceSetting`	`object (AudienceSetting)` Imutável. Configuração para recursos relacionados ao público-alvo.
`effectiveTargetCpaSource`	`enum (BiddingSource)` Apenas saída. Origem do CPA desejado efetivo. Este campo é somente leitura.
`effectiveTargetRoasSource`	`enum (BiddingSource)` Apenas saída. Origem do ROAS desejado efetivo. Este campo é somente leitura.
`labels[]`	`string` Apenas saída. Os nomes de recursos dos rótulos anexados a este grupo de anúncios.
`excludedParentAssetFieldTypes[]`	`enum (AssetFieldType)` Os tipos de campo de recurso que devem ser excluídos desse grupo de anúncios. Os vínculos de recursos com esses tipos de campo não serão herdados por esse grupo de anúncios dos níveis superiores.
`excludedParentAssetSetTypes[]`	`enum (AssetSetType)` Os tipos de conjunto de recursos que devem ser excluídos desse grupo de anúncios. Os vínculos do conjunto de recursos com esses tipos não serão herdados por este grupo de anúncios dos níveis superiores. Os tipos de grupo de locais (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP e STATIC_LOCATION_GROUP) são tipos secundários de LOCATION_SYNC. Portanto, se LOCATION_SYNC estiver definido para esse campo, todos os conjuntos de recursos de grupos de locais não poderão ser vinculados a esse grupo de anúncios, e nenhuma extensão de local (LE) e extensão de local de afiliado (ALE) será veiculada nesse grupo de anúncios. No momento, apenas LOCATION_SYNC é compatível.
`id`	`string (int64 format)` Apenas saída. O ID do grupo de anúncios.
`name`	`string` O nome do grupo de anúncios. Este campo é obrigatório e não deve ficar vazio ao criar novos grupos de anúncios. Ele precisa ter menos de 255 caracteres UTF-8 de largura total. Ele não pode conter nenhum caractere nulo (ponto de código 0x0), feed de linha NL (ponto de código 0xA) nem retorno de carro (ponto de código 0xD).
`baseAdGroup`	`string` Apenas saída. Para os grupos de anúncios de rascunho ou experimentais, esse campo é o nome do recurso do grupo de anúncios base que criou o grupo de anúncios. Se um grupo de anúncios de rascunho ou experimental não tiver um grupo de anúncios base, esse campo será nulo. Para grupos de anúncios base, esse campo é igual ao nome do recurso do grupo de anúncios. Este campo é somente leitura.
`trackingUrlTemplate`	`string` O modelo de URL para criar um URL de rastreamento.
`campaign`	`string` Imutável. A campanha à qual o grupo de anúncios pertence.
`cpcBidMicros`	`string (int64 format)` É o lance máximo de CPC (custo por clique).
`effectiveCpcBidMicros`	`string (int64 format)` Apenas saída. O valor será igual ao do lance de CPC (custo por clique) quando a estratégia de lances for CPC manual, CPC otimizado, página um promovida ou parcela de superação desejada. Caso contrário, o valor será nulo.
`cpmBidMicros`	`string (int64 format)` É o lance máximo de CPM (custo por mil impressões visíveis).
`targetCpaMicros`	`string (int64 format)` O custo por aquisição (CPA) desejado. Se a estratégia de lances da campanha do grupo de anúncios for "TargetCpa" ou "Maximizar conversões" (com o campo "targetCpa" definido), esse campo modificará o CPA desejado especificado na estratégia de lances da campanha. Caso contrário, esse valor é ignorado.
`cpvBidMicros`	`string (int64 format)` É o lance de CPV (custo por visualização).
`targetCpmMicros`	`string (int64 format)` Valor médio em micros que o anunciante está disposto a pagar a cada mil vezes que o anúncio é exibido.
`targetRoas`	`number` A substituição do ROAS (retorno do investimento em publicidade) desejado. Se a estratégia de lances da campanha do grupo de anúncios for "TargetRoas" ou "Maximizar ConversionValue" (com o campo "targetRoas" definido), esse campo modificará o ROAS desejado especificado na estratégia de lances da campanha. Caso contrário, esse valor é ignorado.
`percentCpcBidMicros`	`string (int64 format)` O valor da porcentagem do lance de CPC expresso como uma fração do preço anunciado de um produto ou serviço. O intervalo válido para a fração é [0,1) e o valor armazenado aqui é 1.000.000 * [fração].
`finalUrlSuffix`	`string` Modelo de URL para anexar parâmetros ao URL final.
`effectiveTargetCpaMicros`	`string (int64 format)` Apenas saída. O custo por aquisição (CPA) desejado efetivo. Este campo é somente leitura.
`effectiveTargetRoas`	`number` Apenas saída. O retorno do investimento em publicidade (ROAS) desejado. Este campo é somente leitura.

AdGroupStatus

Os status possíveis de um grupo de anúncios.

Enums
`UNSPECIFIED`	O status não foi especificado.
`UNKNOWN`	O valor recebido não é conhecido nesta versão. Esse é um valor somente de resposta.
`ENABLED`	O grupo de anúncios está ativado.
`PAUSED`	O grupo de anúncios está pausado.
`REMOVED`	O grupo de anúncios foi removido.

AdGroupType

Enumeração que lista os tipos possíveis de um grupo de anúncios.

Enums
`UNSPECIFIED`	O tipo não foi especificado.
`UNKNOWN`	O valor recebido não é conhecido nesta versão. Esse é um valor somente de resposta.
`SEARCH_STANDARD`	É o tipo de grupo de anúncios padrão para campanhas de pesquisa.
`DISPLAY_STANDARD`	É o tipo de grupo de anúncios padrão para campanhas de display.
`SHOPPING_PRODUCT_ADS`	É o tipo de grupo para as campanhas do Shopping que veiculam anúncios de produto padrão.
`HOTEL_ADS`	O tipo de grupo de anúncios padrão para campanhas de hotel.
`SHOPPING_SMART_ADS`	É o tipo de grupo de anúncios nas campanhas inteligentes do Shopping.
`VIDEO_BUMPER`	Anúncios em vídeo in-stream curtos e não puláveis.
`VIDEO_TRUE_VIEW_IN_STREAM`	Anúncios em vídeo in-stream TrueView (puláveis).
`VIDEO_TRUE_VIEW_IN_DISPLAY`	Anúncios em vídeo TrueView in-display.
`VIDEO_NON_SKIPPABLE_IN_STREAM`	Anúncios em vídeo in-stream não puláveis.
`VIDEO_OUTSTREAM`	Anúncios em vídeo out-stream.
`SEARCH_DYNAMIC_ADS`	Tipo de grupo de anúncios para anúncios dinâmicos de pesquisa.
`SHOPPING_COMPARISON_LISTING_ADS`	O tipo de grupo de anúncios em campanhas de comparadores do Shopping.
`PROMOTED_HOTEL_ADS`	O tipo de grupo de anúncios para os grupos de anúncios de hotéis promovidos.
`VIDEO_RESPONSIVE`	Grupos de anúncios responsivos em vídeo.
`VIDEO_EFFICIENT_REACH`	Grupos de anúncios de alcance eficiente em vídeo.
`SMART_CAMPAIGN_ADS`	Tipo de grupo de anúncios para campanhas inteligentes.
`TRAVEL_ADS`	Tipo de grupo de anúncios para campanhas de viagens.

AdGroupAdRotationMode

Os possíveis modos de rotação de anúncios de um grupo de anúncios.

Enums
`UNSPECIFIED`	O modo de rotação de anúncios não foi especificado.
`UNKNOWN`	O valor recebido não é conhecido nesta versão. Esse é um valor somente de resposta.
`OPTIMIZE`	Otimize os anúncios de grupos de anúncios com base em cliques ou conversões.
`ROTATE_FOREVER`	Alternar uniformemente de forma permanente.

AudienceSetting

Configurações da segmentação por público-alvo.

Representação JSON
{ "useAudienceGrouped": boolean }

Campos

Campos
`useAudienceGrouped`	`boolean` Imutável. Se for verdadeiro, o grupo de anúncios usará um recurso de público-alvo para a segmentação por público-alvo. Se for falso, esse grupo de anúncios poderá usar critérios de segmento de público-alvo.

useAudienceGrouped

boolean

Imutável. Se for verdadeiro, o grupo de anúncios usará um recurso de público-alvo para a segmentação por público-alvo. Se for falso, esse grupo de anúncios poderá usar critérios de segmento de público-alvo.