Package google.ads.searchads360.v0.resources

Índice

AccessibleBiddingStrategy

Representa uma visualização das estratégias de lances que pertencem ao cliente e foram compartilhadas com ele.

Em contraste com a BiddingStrategy, esse recurso inclui estratégias de propriedade dos gerentes do cliente e compartilhadas com ele, além das estratégias dele. Esse recurso não oferece métricas e expõe apenas um subconjunto limitado dos atributos BiddingStrategy.

Campos
resource_name

string

O nome do recurso da estratégia de lances acessível. Os nomes dos recursos AccessibleBiddingStrategy têm o seguinte formato:

customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}

id

int64

O ID da estratégia de lances.

name

string

É o nome da estratégia de lances.

type

BiddingStrategyType

É o tipo de estratégia de lances.

owner_customer_id

int64

O ID do cliente proprietário da estratégia de lances.

owner_descriptive_name

string

description_name do cliente proprietário da estratégia de lances.

Campo de união scheme. O esquema de lances.

Somente um pode ser definido. scheme pode ser apenas de um dos tipos a seguir:

maximize_conversion_value

MaximizeConversionValue

Uma estratégia de lances automáticos para ajudar a gerar o maior valor de conversão para suas campanhas sem exceder o orçamento.

maximize_conversions

MaximizeConversions

Uma estratégia de lances automáticos para ajudar a gerar o maior número de conversões para suas campanhas sem exceder o orçamento.

target_cpa

TargetCpa

Uma estratégia que define lances para gerar o maior número possível de conversões sem exceder o custo por aquisição (CPA) desejado que você definiu.

target_impression_share

TargetImpressionShare

Uma estratégia de lances que otimiza automaticamente para uma determinada porcentagem de impressões.

target_roas

TargetRoas

Uma estratégia de lances que ajuda a maximizar a receita enquanto calcula a média de um retorno do investimento em publicidade (ROAS) desejado específico.

target_spend

TargetSpend

Uma estratégia de lances que define seus lances para conseguir o máximo de cliques possível com o orçamento disponível.

MaximizeConversionValue

Uma estratégia de lances automáticos para ajudar a gerar o maior valor de conversão para suas campanhas sem exceder o orçamento.

Campos
target_roas

double

Opção de retorno do investimento em publicidade (ROAS) desejado Se definida, a estratégia de lances maximizará a receita ao calcular a média do retorno do investimento em publicidade desejado. Se o ROAS desejado for alto, talvez a estratégia de lances não gaste todo o orçamento. Se o ROAS desejado não estiver definido, a estratégia de lances tentará atingir o maior ROAS possível para o orçamento.

MaximizeConversions

Uma estratégia de lances automáticos para ajudar a gerar o maior número de conversões para suas campanhas sem exceder o orçamento.

Campos
target_cpa

int64

A opção de custo por aquisição (CPA) desejado. Esse é o valor médio que você quer gastar por aquisição.

target_cpa_micros

int64

A opção de custo por aquisição (CPA) desejado. Esse é o valor médio que você quer gastar por aquisição.

TargetCpa

Uma estratégia de lances automáticos que define lances para gerar o maior número possível de conversões sem exceder o custo por aquisição (CPA) desejado que você definiu.

Campos
target_cpa_micros

int64

Meta de CPA médio. Essa meta deve ser maior ou igual ao mínimo de unidades faturáveis baseadas na moeda da conta.

TargetImpressionShare

Uma estratégia de lances automáticos que define lances para que uma determinada porcentagem dos anúncios de pesquisa seja exibida na parte superior da primeira página (ou em outra região de segmentação).

Campos
location

TargetImpressionShareLocation

A região de segmentação na página de resultados da pesquisa.

location_fraction_micros

int64

A fração escolhida de anúncios a ser exibida na região de segmentação, em micros. Por exemplo, 1% é igual a 10.000.

cpc_bid_ceiling_micros

int64

O lance de CPC mais alto que o sistema de lances automáticos pode especificar. É um campo obrigatório inserido pelo anunciante que estabelece o limite e é especificado nos micros locais.

TargetRoas

Uma estratégia de lances automáticos que ajuda a maximizar a receita enquanto calcula a média de um retorno do investimento em publicidade (ROAS) desejado específico.

Campos
target_roas

double

Receita escolhida (com base nos dados de conversão) por unidade de gasto.

TargetSpend

Uma estratégia de lances automáticos que define seus lances para conseguir o máximo de cliques possível com o orçamento disponível.

Campos
target_spend_micros
(deprecated)

int64

A meta de gastos na qual maximizar os cliques. Um bidder TargetSpend tentará gastar o menor valor desse montante ou o valor de gasto de limitação natural. Se não for especificado, o orçamento será usado como a meta de gastos. Este campo foi descontinuado e não deve mais ser usado. Consulte https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html para mais detalhes.

cpc_bid_ceiling_micros

int64

Limite de lance máximo que pode ser definido pela estratégia de lances. O limite se aplica a todas as palavras-chave gerenciadas pela estratégia.

Anúncio

Campos
resource_name

string

O nome de recurso do anúncio. Os nomes de recursos de anúncio têm o seguinte formato:

customers/{customer_id}/ads/{ad_id}

final_urls[]

string

A lista dos possíveis URLs finais após todos os redirecionamentos de vários domínios do anúncio.

type

AdType

O tipo de anúncio.

id

int64

O ID do anúncio.

display_url

string

É o URL exibido na descrição de alguns formatos de anúncio.

name

string

É o nome do anúncio. Isso é usado apenas para identificar o anúncio. Ele não precisa ser único e não afeta o anúncio veiculado. No momento, o campo de nome só é compatível com DisplayUploadAd, ImageAd, ShoppingComparisonListingAd e VideoAd.

Campo de união ad_data. Detalhes pertinentes ao tipo de anúncio. Exatamente um valor precisa ser definido. ad_data pode ser apenas de um dos tipos a seguir:
text_ad

SearchAds360TextAdInfo

Detalhes relacionados a um anúncio de texto.

expanded_text_ad

SearchAds360ExpandedTextAdInfo

Detalhes relacionados a anúncios de texto expandidos.

responsive_search_ad

SearchAds360ResponsiveSearchAdInfo

Detalhes relacionados a um anúncio responsivo de pesquisa.

product_ad

SearchAds360ProductAdInfo

Detalhes relacionados a um anúncio de produto.

expanded_dynamic_search_ad

SearchAds360ExpandedDynamicSearchAdInfo

Detalhes relacionados a um anúncio dinâmico expandido de pesquisa.

Grupo de anúncios

Um grupo de anúncios.

Campos
resource_name

string

O nome de recurso do grupo de anúncios. Os nomes de recursos do grupo de anúncios têm o seguinte formato:

customers/{customer_id}/adGroups/{ad_group_id}

status

AdGroupStatus

O status do grupo de anúncios.

type

AdGroupType

O tipo do grupo de anúncios.

ad_rotation_mode

AdGroupAdRotationMode

Modo de rotação de anúncios do grupo de anúncios.

creation_time

string

O carimbo de data/hora em que este ad_group foi criado. O carimbo de data/hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss".

targeting_setting

TargetingSetting

Configuração para recursos relacionados à segmentação.

labels[]

string

Os nomes de recursos dos rótulos anexados a este grupo de anúncios.

engine_id

string

ID do grupo de anúncios na conta de mecanismo externo. Esse campo é somente para contas que não são do Google Ads (por exemplo, Yahoo Japan, Microsoft, Baidu etc.). Para a entidade do Google Ads, use "ad_group.id".

start_date

string

Data em que o grupo de anúncios começa a veicular anúncios. Por padrão, o grupo de anúncios começa agora ou na data de início do grupo de anúncios, o que for posterior. Se esse campo for definido, o grupo de anúncios começará no início da data especificada no fuso horário do cliente. Esse campo só está disponível para contas de gateway do Microsoft Advertising e do Facebook.

Formato: AAAA-MM-DD Exemplo: 2019-03-14

end_date

string

Data em que o grupo de anúncios termina de veicular anúncios. Por padrão, o grupo de anúncios termina na data de término do grupo de anúncios. Se esse campo for definido, o grupo de anúncios terminará no final da data especificada no fuso horário do cliente. Esse campo só está disponível para contas de gateway do Microsoft Advertising e do Facebook.

Formato: AAAA-MM-DD Exemplo: 2019-03-14

language_code

string

O idioma dos anúncios e das palavras-chave em um grupo de anúncios. Esse campo só está disponível para contas do Microsoft Advertising. Mais detalhes: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage

last_modified_time

string

A data e a hora em que esse grupo de anúncios foi modificado pela última vez. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

id

int64

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

cpc_bid_micros

int64

É o lance máximo de CPC (custo por clique).

engine_status

AdGroupEngineStatus

O status do mecanismo para o grupo de anúncios.

AdGroupAd

Um anúncio de grupo de anúncios.

Campos
resource_name

string

O nome de recurso do anúncio. Os nomes dos recursos de anúncios do grupo de anúncios têm o seguinte formato:

customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

status

AdGroupAdStatus

O status do anúncio.

ad

Ad

O anúncio.

creation_time

string

A data e a hora em que este ad_group_ad foi criado. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

labels[]

string

Os nomes dos recursos dos rótulos anexados ao anúncio do grupo de anúncios.

engine_id

string

É o ID do anúncio na conta de mecanismo externo. Este campo é somente para contas do Search Ads 360, por exemplo, Yahoo Japan, Microsoft, Baidu etc. Para entidades que não são do Search Ads 360, use "ad_group_ad.ad.id" como alternativa.

engine_status

AdGroupAdEngineStatus

Status adicional do anúncio na conta de mecanismo externo. Os status possíveis (dependendo do tipo de conta externa) incluem ativa, qualificada, revisão pendente etc.

last_modified_time

string

A data e a hora em que o anúncio desse grupo de anúncios foi modificado pela última vez. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

AdGroupAdLabel

Uma relação entre um anúncio de grupo de anúncios e um rótulo.

Campos
resource_name

string

Nome do recurso do rótulo do anúncio do grupo de anúncios. Os nomes dos recursos do rótulo do anúncio do grupo de anúncios têm o formato: customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}

ad_group_ad

string

O anúncio de grupo de anúncios ao qual o rótulo está anexado.

label

string

Rótulo atribuído ao anúncio do grupo de anúncios.

AdGroupAsset

Um vínculo entre um grupo de anúncios e um recurso.

Campos
resource_name

string

O nome do recurso do grupo de anúncios. Os nomes dos recursos de GroupAsset têm o seguinte formato:

customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}

ad_group

string

Obrigatório. O grupo de anúncios ao qual o recurso está vinculado.

asset

string

Obrigatório. O recurso que está vinculado ao grupo de anúncios.

status

AssetLinkStatus

Status do recurso do grupo de anúncios.

AdGroupAssetSet

"Grupo de recursos de anúncios" é o vínculo entre um grupo de anúncios e um conjunto de recursos. A criação de um GroupAssetSet vincula um conjunto de recursos a um grupo de anúncios.

Campos
resource_name

string

O nome do recurso do conjunto de recursos do grupo de anúncios. Os nomes dos recursos do conjunto de recursos do grupo de anúncios têm o seguinte formato:

customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}

ad_group

string

O grupo de anúncios ao qual esse conjunto de recursos está vinculado.

asset_set

string

O conjunto de recursos que está vinculado ao grupo de anúncios.

status

AssetSetLinkStatus

O status do conjunto de recursos do grupo de anúncios. Somente leitura.

AdGroupAudienceView

Uma visualização do público-alvo do grupo de anúncios. Inclui dados de desempenho de interesses e listas de remarketing para anúncios das Redes de Display e do YouTube, além de listas de remarketing para anúncios de pesquisa (RLSA), agregados no nível do público-alvo.

Campos
resource_name

string

O nome do recurso da visualização do público-alvo do grupo de anúncios. Os nomes dos recursos de visualização do público-alvo do grupo de anúncios têm o seguinte formato:

customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}

AdGroupBidModifier

Representa um modificador de lance de grupo de anúncios.

Campos
resource_name

string

O nome do recurso do modificador de lance do grupo de anúncios. Os nomes de recursos do modificador de lances de grupo de anúncios têm o seguinte formato:

customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}

bid_modifier

double

O modificador do lance quando o critério corresponde. O modificador precisa estar no intervalo: 0,1 a 10,0. O intervalo é de 1,0 a 6,0 para PreferredContent. Use 0 para desativar um tipo de dispositivo.

Campo de união criterion. O critério do modificador de lance do grupo de anúncios.

Obrigatório nas operações de criação a partir da V5. criterion pode ser apenas de um dos tipos a seguir:

device

DeviceInfo

Um critério de dispositivo.

AdGroupCriterion

Um critério de grupo de anúncios. O relatório ad_group_criterion retorna somente os critérios que foram explicitamente adicionados ao grupo de anúncios.

Campos
resource_name

string

O nome do recurso do critério do grupo de anúncios. Os nomes de recursos do critério do grupo de anúncios têm o seguinte formato:

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

creation_time

string

A data e a hora em que esse critério do grupo de anúncios foi criado. O carimbo de data/hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss".

status

AdGroupCriterionStatus

O status do critério.

Este é o status da entidade do critério do grupo de anúncios, definido pelo cliente. Observação: os relatórios da interface do usuário podem incorporar informações adicionais que afetam a qualificação de um critério para execução. Em alguns casos, um critério REMOVIDO na API ainda pode aparecer como ativado na IU. Por exemplo, as campanhas são exibidas por padrão para usuários de todas as faixas etárias, a menos que sejam excluídas. A interface vai mostrar cada faixa etária como "ativada", já que elas estão qualificadas para ver os anúncios. mas gclid.status mostrará "removido", já que nenhum critério positivo foi adicionado.

quality_info

QualityInfo

Informações sobre a qualidade do critério.

type

CriterionType

Tipo do critério.

labels[]

string

Os nomes dos recursos dos rótulos anexados a este critério do grupo de anúncios.

position_estimates

PositionEstimates

Estimativas de lances de critério em várias posições.

final_urls[]

string

A lista dos possíveis URLs finais após todos os redirecionamentos de vários domínios do anúncio.

engine_id

string

ID do critério do grupo de anúncios na conta de mecanismo externo. Esse campo é apenas para contas que não são do Google Ads, por exemplo, Yahoo Japan, Microsoft, Baidu etc. Para a entidade do Google Ads, use "ad_group_criterion.criterion_id" como alternativa.

last_modified_time

string

A data e a hora em que esse critério do grupo de anúncios foi modificado pela última vez. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

criterion_id

int64

ID do critério.

ad_group

string

O grupo de anúncios ao qual o critério pertence.

negative

bool

Define se o critério será segmentado (false) ou excluído (true).

Este campo não pode ser modificado. Para mudar um critério de positivo para negativo, remova-o e adicione-o novamente.

bid_modifier

double

O modificador do lance quando o critério corresponde. O modificador precisa estar no intervalo: 0,1 a 10,0. A maioria dos tipos de critérios segmentáveis são compatíveis com modificadores.

cpc_bid_micros

int64

Lance de CPC (custo por clique).

effective_cpc_bid_micros

int64

O lance de CPC (custo por clique) efetivo.

engine_status

AdGroupCriterionEngineStatus

O status do mecanismo para o critério do grupo de anúncios.

final_url_suffix

string

Modelo de URL para anexar parâmetros ao URL final.

tracking_url_template

string

O modelo de URL para criar um URL de rastreamento.

Campo de união criterion. O critério do grupo de anúncios.

Exatamente um deve ser definido. criterion pode ser apenas de um dos tipos a seguir:

keyword

KeywordInfo

Palavra-chave.

listing_group

ListingGroupInfo

Grupo de produtos anunciados.

age_range

AgeRangeInfo

Faixa etária.

gender

GenderInfo

Gênero.

user_list

UserListInfo

Lista de usuários.

webpage

WebpageInfo

Página da Web

location

LocationInfo

Local.

PositionEstimates

Estimativas de lances de critério em várias posições.

Campos
top_of_page_cpc_micros

int64

A estimativa do lance de CPC necessário para que o anúncio seja exibido na parte superior da primeira página dos resultados de pesquisa.

QualityInfo

Um contêiner para informações de qualidade do critério do grupo de anúncios.

Campos
quality_score

int32

Índice de qualidade.

Esse campo não será preenchido se o Google não tiver informações suficientes para determinar um valor.

AdGroupCriterionLabel

Uma relação entre um critério de grupo de anúncios e um rótulo.

Campos
resource_name

string

Nome do recurso do rótulo do critério do grupo de anúncios. Os nomes dos recursos do rótulo do critério do grupo de anúncios têm o seguinte formato: customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}

ad_group_criterion

string

O critério do grupo de anúncios ao qual o rótulo está anexado.

label

string

Rótulo atribuído ao critério do grupo de anúncios.

AdGroupLabel

Uma relação entre um grupo de anúncios e um rótulo.

Campos
resource_name

string

Nome do recurso do rótulo do grupo de anúncios. Os nomes dos recursos do rótulo do grupo de anúncios têm o formato: customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}

ad_group

string

O grupo de anúncios ao qual o rótulo está anexado.

label

string

Rótulo atribuído ao grupo de anúncios.

AgeRangeView

Uma visualização de faixa etária.

Campos
resource_name

string

O nome do recurso da visualização de faixa etária. Os nomes dos recursos de visualização de faixa etária têm o seguinte formato:

customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}

Recurso

O recurso faz parte de um anúncio que pode ser compartilhado entre vários anúncios. Pode ser uma imagem (ImageAsset), um vídeo (YoutubeVideoAsset) etc. Os recursos são imutáveis e não podem ser removidos. Para interromper a veiculação de um recurso, remova-o da entidade que o usa.

Campos
resource_name

string

O nome do recurso. Os nomes dos recursos de recursos têm o seguinte formato:

customers/{customer_id}/assets/{asset_id}

type

AssetType

Tipo do recurso.

final_urls[]

string

Uma lista de possíveis URLs finais após todos os redirecionamentos entre domínios.

status

AssetStatus

O status do recurso.

creation_time

string

O carimbo de data/hora em que o recurso foi criada. O carimbo de data/hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss".

last_modified_time

string

A data e a hora em que este recurso foi modificado pela última vez. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

id

int64

O ID do recurso.

name

string

Nome opcional do recurso.

tracking_url_template

string

Modelo de URL para criar um URL de rastreamento.

engine_status

AssetEngineStatus

O status do mecanismo de um recurso.

Campo de união asset_data. Tipo específico do recurso. asset_data pode ser apenas de um dos tipos a seguir:
youtube_video_asset

YoutubeVideoAsset

Um recurso de vídeo do YouTube.

image_asset

ImageAsset

Um recurso de imagem.

text_asset

TextAsset

Um recurso de texto.

callout_asset

UnifiedCalloutAsset

Um recurso de frase de destaque unificado.

page_feed_asset

UnifiedPageFeedAsset

Um recurso de feed de páginas unificado.

mobile_app_asset

MobileAppAsset

Um recurso de app para dispositivos móveis.

call_asset

UnifiedCallAsset

Um recurso de ligação unificado.

call_to_action_asset

CallToActionAsset

Um recurso de call-to-action.

location_asset

UnifiedLocationAsset

Um recurso de local unificado.

AssetGroup

Um grupo de recursos. AssetGroupAsset é usado para vincular um recurso ao grupo. AssetGroupSignal é usado para associar um indicador a um grupo de recursos.

Campos
resource_name

string

O nome do recurso do grupo de recursos. Os nomes dos recursos dos grupos de recursos têm o seguinte formato:

customers/{customer_id}/assetGroups/{asset_group_id}

id

int64

O ID do grupo de recursos.

campaign

string

A campanha à qual esse grupo de recursos está associado. O recurso que está vinculado ao grupo de recursos.

name

string

Obrigatório. Nome do grupo de recursos. Obrigatório. Ele deve ter comprimento mínimo de 1 e comprimento máximo de 128. Ele precisa ser exclusivo em uma campanha.

final_urls[]

string

Uma lista de URLs finais após todos os redirecionamentos entre domínios. Nas campanhas Performance Max, por padrão, os URLs são qualificados para expansão, a menos que sejam desativados.

final_mobile_urls[]

string

Uma lista de URLs finais para dispositivos móveis após todos os redirecionamentos entre domínios. Nas campanhas Performance Max, por padrão, os URLs são qualificados para expansão, a menos que sejam desativados.

status

AssetGroupStatus

O status do grupo de recursos.

path1

string

Primeira parte do texto que pode aparecer anexado ao URL exibido no anúncio.

path2

string

Segunda parte do texto que pode aparecer anexada ao URL exibido no anúncio. Esse campo só pode ser definido quando "path1" está definido.

ad_strength

AdStrength

Qualidade geral do anúncio desse grupo de recursos.

AssetGroupAsset

AssetGroupAsset é o vínculo entre um recurso e um grupo de recursos. Adicionar um AssetGroupAsset vincula um recurso a um grupo.

Campos
resource_name

string

O nome do recurso do grupo de recursos. O nome do recurso do grupo de recursos tem o seguinte formato:

customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}

asset_group

string

O grupo a que este recurso está sendo vinculado.

asset

string

O recurso que está sendo vinculado a este grupo de recursos.

field_type

AssetFieldType

A descrição da posição do recurso no grupo de recursos. Por exemplo: HEADLINE, YOUTUBE_VIDEO etc.

status

AssetLinkStatus

O status da vinculação entre um recurso e um grupo de recursos.

AssetGroupAssetCombinationData

Dados de combinação de recursos do grupo de recursos

Campos
asset_combination_served_assets[]

AssetUsage

Recursos veiculados.

AssetGroupListingGroupFilter

AssetGroupListingGroupFilter representa um nó da árvore de filtros do grupo de fichas em um grupo de recursos.

Campos
resource_name

string

O nome do recurso do filtro do grupo de produtos anunciados do grupo de recursos. O nome do recurso do filtro do grupo de produtos anunciados do grupo de recursos tem o seguinte formato:

customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}

asset_group

string

O grupo de recursos do qual este filtro do grupo de produtos anunciados do grupo de recursos faz parte.

id

int64

O ID do ListingGroupFilter.

type

ListingGroupFilterType

Tipo de nó de filtro do grupo de fichas.

vertical

ListingGroupFilterVertical

A vertical que a árvore de nós atual representa. Todos os nós na mesma árvore precisam pertencer à mesma indústria.

case_value

ListingGroupFilterDimension

Valor da dimensão com que esse grupo de produtos anunciados está refinando o pai/mãe. Indefinido para o grupo raiz.

parent_listing_group_filter

string

Nome do recurso da subdivisão do grupo de fichas da empresa principal. Nulo para o nó do filtro do grupo de fichas da empresa raiz.

path

ListingGroupFilterDimensionPath

O caminho das dimensões que definem o filtro do grupo de fichas.

AssetGroupSignal

AssetGroupSignal representa um indicador em um grupo de recursos. A existência de um indicador informa à campanha Performance Max quem está mais propenso a fazer uma conversão. A campanha Performance Max usa o indicador para procurar novas pessoas com intenção semelhante ou maior de encontrar conversões nas redes de pesquisa, Display, vídeo e muito mais.

Campos
resource_name

string

O nome do recurso do indicador do grupo de recursos. O nome do recurso do indicador do grupo de recursos tem o seguinte formato:

customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}

asset_group

string

O grupo de recursos a que este indicador pertence.

Campo de união signal. O indicador do grupo de recursos. signal pode ser apenas de um dos tipos a seguir:
audience

AudienceInfo

O indicador de público-alvo a ser usado pela campanha Performance Max.

AssetGroupTopCombinationView

Uma visão do uso da combinação de recursos de anúncio do grupo de anúncios.

Campos
resource_name

string

O nome do recurso da visualização de combinação da parte superior do grupo de recursos. Os nomes dos recursos da Visualização de combinação principal de AssetGroup têm o formato: `"customers/{customer_id}/assetGroupTopCombineViews/{asset_group_id}~{asset_ callout_category}"

asset_group_top_combinations[]

AssetGroupAssetCombinationData

As principais combinações de recursos que foram veiculados juntos.

AssetSet

Um conjunto de recursos que representa uma coleção de recursos. Use AssetSetAsset para vincular um recurso ao conjunto de recursos.

Campos
id

int64

O ID do conjunto de recursos.

resource_name

string

O nome do recurso do conjunto de recursos. Os nomes dos recursos do conjunto de recursos têm o seguinte formato:

customers/{customer_id}/assetSets/{asset_set_id}

AssetSetAsset

AssetSetAsset é o vínculo entre um recurso e um conjunto de recursos. Adicionar um AssetSetAsset vincula um recurso a um conjunto de recursos.

Campos
resource_name

string

O nome do recurso do conjunto de recursos. Os nomes dos recursos do conjunto de recursos têm o seguinte formato:

customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}

asset_set

string

O conjunto a que o recurso está vinculado.

asset

string

O recurso a que o recurso do conjunto está vinculado.

status

AssetSetAssetStatus

O status do recurso do conjunto de recursos. Somente leitura.

Público-alvo

O público-alvo é uma opção de segmentação eficaz que permite cruzar diferentes atributos de segmentos, como informações demográficas e afinidades detalhadas, para criar públicos-alvo que representam seções dos seus segmentos.

Campos
resource_name

string

O nome de recurso do público. Os nomes de público-alvo têm o seguinte formato:

customers/{customer_id}/audiences/{audience_id}

id

int64

ID do público-alvo.

name

string

Obrigatório. Nome do público-alvo. Ele deve ser único para todos os públicos-alvo. Ele deve ter comprimento mínimo de 1 e comprimento máximo de 255.

description

string

Descrição desse público-alvo.

BiddingStrategy

Uma estratégia de lances.

Campos
resource_name

string

O nome do recurso da estratégia de lances. Os nomes dos recursos da estratégia de lances têm o seguinte formato:

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

status

BiddingStrategyStatus

É o status da estratégia de lances.

Este campo é somente leitura.

type

BiddingStrategyType

É o tipo de estratégia de lances. Cria uma estratégia de lances definindo o esquema de lance.

Este campo é somente leitura.

currency_code

string

A moeda usada pela estratégia de lances (código de três letras do ISO 4217).

Para estratégias de lances em clientes administradores, essa moeda pode ser definida na criação, e o padrão é a moeda do cliente administrador. Para clientes atendidos, este campo não pode ser definido; Todas as estratégias em um cliente de veiculação usam implicitamente a moeda desse cliente. Em todos os casos, o campo effective_currency_code retorna a moeda usada pela estratégia.

id

int64

O ID da estratégia de lances.

name

string

É o nome da estratégia de lances. Todas as estratégias de lances em uma conta devem ter nomes diferentes.

A string precisa estar entre 1 e 255, inclusive, em bytes UTF-8 (cortados).

effective_currency_code

string

A moeda usada pela estratégia de lances (código de três letras do ISO 4217).

Para estratégias de lances para clientes administradores, essa é a moeda definida pelo anunciante ao criar a estratégia. Para clientes atendidos, este é o currency_code do cliente.

As métricas da estratégia de lances são informadas nessa moeda.

Este campo é somente leitura.

campaign_count

int64

O número de campanhas vinculadas a essa estratégia de lances.

Este campo é somente leitura.

non_removed_campaign_count

int64

O número de campanhas não removidas anexadas a essa estratégia de lances.

Este campo é somente leitura.

Campo de união scheme. O esquema de lances.

Somente um pode ser definido. scheme pode ser apenas de um dos tipos a seguir:

enhanced_cpc

EnhancedCpc

Uma estratégia de lances que aumenta os lances para cliques com maior probabilidade de gerar uma conversão e os reduz para cliques em áreas com menor probabilidade.

maximize_conversion_value

MaximizeConversionValue

Uma estratégia de lances automáticos para ajudar a gerar o maior valor de conversão para suas campanhas sem exceder o orçamento.

maximize_conversions

MaximizeConversions

Uma estratégia de lances automáticos para ajudar a gerar o maior número de conversões para suas campanhas sem exceder o orçamento.

target_cpa

TargetCpa

Uma estratégia que define lances para gerar o maior número possível de conversões sem exceder o custo por aquisição (CPA) desejado que você definiu.

target_impression_share

TargetImpressionShare

Uma estratégia de lances que otimiza automaticamente para uma determinada porcentagem de impressões.

target_outrank_share

TargetOutrankShare

Uma estratégia que define lances com base na fração desejada de leilões em que o anunciante deve superar um concorrente específico. Este campo está obsoleto. Não será possível criar uma nova estratégia de lances com esse campo ou anexar estratégias de lances com ele a uma campanha. As mutações em estratégias que já têm esse esquema preenchido são permitidas.

target_roas

TargetRoas

Uma estratégia de lances que ajuda a maximizar a receita enquanto calcula a média de um retorno do investimento em publicidade (ROAS) desejado específico.

target_spend

TargetSpend

Uma estratégia de lances que define seus lances para conseguir o máximo de cliques possível com o orçamento disponível.

Campanha

Uma campanha.

Campos
resource_name

string

O nome do recurso da campanha. Os nomes dos recursos da campanha têm o seguinte formato:

customers/{customer_id}/campaigns/{campaign_id}

status

CampaignStatus

É o status da campanha.

Quando uma nova campanha é adicionada, o status é ATIVADO.

serving_status

CampaignServingStatus

O status de veiculação de anúncios da campanha.

bidding_strategy_system_status

BiddingStrategySystemStatus

O status do sistema da estratégia de lances da campanha.

ad_serving_optimization_status

AdServingOptimizationStatus

O status de otimização da veiculação de anúncios da campanha.

advertising_channel_type

AdvertisingChannelType

É a principal meta de veiculação de anúncios na campanha. As opções de segmentação podem ser refinadas em network_settings.

Este campo é obrigatório e não deve ficar vazio ao criar novas campanhas.

Pode ser definido apenas ao criar campanhas. Depois que a campanha é criada, o campo não pode ser alterado.

advertising_channel_sub_type

AdvertisingChannelSubType

Refinamento opcional para advertising_channel_type. Precisa ser um subtipo válido do tipo de canal principal.

Pode ser definido apenas ao criar campanhas. Depois que a campanha é criada, o campo não pode ser alterado.

url_custom_parameters[]

CustomParameter

É a lista de mapeamentos usados para substituir tags de parâmetros personalizados em um tracking_url_template, final_urls ou mobile_final_urls.

real_time_bidding_setting

RealTimeBiddingSetting

Configurações para lances em tempo real, um recurso disponível somente para campanhas que segmentam a rede do Ad Exchange.

network_settings

NetworkSettings

As configurações de rede da campanha.

dynamic_search_ads_setting

DynamicSearchAdsSetting

A configuração para controlar os anúncios dinâmicos de pesquisa (DSA).

shopping_setting

ShoppingSetting

A configuração para controlar as Campanhas do Shopping.

geo_target_type_setting

GeoTargetTypeSetting

É a configuração da segmentação geográfica de anúncios.

labels[]

string

Os nomes dos recursos dos rótulos anexados a esta campanha.

bidding_strategy_type

BiddingStrategyType

É o tipo de estratégia de lances.

Para criar uma estratégia de lances, defina o esquema de lances para criar uma estratégia de lances padrão ou o campo bidding_strategy para criar uma estratégia de lances de portfólio.

Este campo é somente leitura.

accessible_bidding_strategy

string

Nome do recurso de AccessibleBiddingStrategy, uma visualização somente leitura dos atributos irrestritos da estratégia de lances de portfólio anexada identificada por "bid_strategy". Deixar em branco se a campanha não usar uma estratégia de portfólio. Os atributos irrestritos de estratégia estão disponíveis para todos os clientes com quem a estratégia é compartilhada e são lidos no recurso AccessibleBiddingStrategy. Por outro lado, os atributos restritos estão disponíveis apenas para o cliente proprietário da estratégia e seus gerentes. Os atributos restritos só podem ser lidos no recurso BiddingStrategy.

frequency_caps[]

FrequencyCapEntry

Uma lista que limita a frequência com que cada usuário verá os anúncios desta campanha.

selective_optimization

SelectiveOptimization

Configuração de otimização seletiva desta campanha, que inclui um conjunto de ações de conversão que serão otimizadas. Esse recurso só se aplica a campanhas para apps que usam MULTI_CHANNEL como AdvertisingChannelType e APP_CAMPAIGN ou APP_CAMPAIGN_FOR_ENGAGEMENT como AdvertisingChannelSubType.

optimization_goal_setting

OptimizationGoalSetting

Configuração da meta de otimização desta campanha, que inclui um conjunto de tipos de meta de otimização.

tracking_setting

TrackingSetting

Configurações no nível da campanha para informações de acompanhamento.

engine_id

string

ID da campanha na conta de mecanismo externo. Esse campo é somente para contas que não são do Google Ads, por exemplo, Yahoo Japan, Microsoft, Baidu etc. Para a entidade do Google Ads, use "campaign.id".

excluded_parent_asset_field_types[]

AssetFieldType

Os tipos de campo de recurso que devem ser excluídos dessa campanha. As vinculações de recursos com esses tipos de campo não serão herdadas do nível superior por esta campanha.

create_time

string

O carimbo de data/hora em que a campanha foi criada. O carimbo de data/hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss" . O uso de create_time será descontinuado na v1. Use create_time em vez disso.

creation_time

string

O carimbo de data/hora em que a campanha foi criada. O carimbo de data/hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss".

last_modified_time

string

A data e a hora em que essa campanha foi modificada pela última vez. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

id

int64

O ID da campanha.

name

string

O nome da campanha.

Este campo é obrigatório e não deve ficar vazio ao criar novas campanhas.

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

tracking_url_template

string

O modelo de URL para criar um URL de rastreamento.

campaign_budget

string

O orçamento da campanha.

start_date

string

A data em que a campanha começou a ser veiculada no fuso horário do cliente no formato AAAA-MM-DD.

end_date

string

O último dia da campanha no fuso horário da veiculação no formato AAAA-MM-DD. Na criação, o padrão é 2037-12-30, ou seja, a campanha será exibida indefinidamente. Para definir que uma campanha existente seja exibida indefinidamente, defina esse campo para 2037-12-30.

final_url_suffix

string

Sufixo usado para anexar parâmetros de consulta a páginas de destino veiculadas com o acompanhamento paralelo.

url_expansion_opt_out

bool

Representa a desativação da expansão de URL para URLs mais segmentados. Se desativado (verdadeiro), somente os URLs finais do grupo de recursos ou os URLs especificados nos feeds de dados da empresa ou do Google Merchant Center do anunciante serão segmentados. Se a opção for ativada (falso), todo o domínio será segmentado. Esse campo só pode ser definido para campanhas Performance Max, em que o valor padrão é "false".

Campo de união campaign_bidding_strategy. A estratégia de lances da campanha.

Precisa ser um portfólio (criado por meio do serviço BiddingStrategy) ou um padrão incorporado à campanha. campaign_bidding_strategy pode ser apenas de um dos tipos a seguir:

bidding_strategy

string

Estratégia de lances de portfólio usada pela campanha.

manual_cpa

ManualCpa

Estratégia de lances de CPA manual padrão. Estratégia de lances manuais que permite ao anunciante definir o lance por ação especificada pelo anunciante. Compatível apenas com campanhas dos Serviços Locais.

manual_cpc

ManualCpc

Estratégia de lances manuais padrão de CPC. Lance baseado em clique manual, no qual o usuário paga por clique.

manual_cpm

ManualCpm

Estratégia de lances de CPM manual padrão. Lance baseado em impressão manual, no qual o usuário paga por mil impressões.

maximize_conversions

MaximizeConversions

A estratégia de lances padrão "Maximizar conversões" que maximiza automaticamente o número de conversões sem exceder o orçamento.

maximize_conversion_value

MaximizeConversionValue

A estratégia de lances padrão "Maximizar o valor da conversão" que define automaticamente os lances para maximizar a receita gastando o orçamento.

target_cpa

TargetCpa

Estratégia de lances de CPA desejado padrão que define lances automaticamente para gerar o maior número possível de conversões sem exceder o custo por aquisição (CPA) desejado que você definiu.

target_impression_share

TargetImpressionShare

Estratégia de lances de parcela de impressões desejada. Uma estratégia de lances automáticos que define lances para atingir uma determinada porcentagem de impressões.

target_roas

TargetRoas

A estratégia de lances de ROAS desejado padrão que maximiza automaticamente a receita enquanto faz a média de um retorno do investimento em publicidade desejado (ROAS) específico.

target_spend

TargetSpend

A estratégia de lances de gasto desejado padrão que define automaticamente seus lances para conseguir o máximo de cliques possível com o orçamento disponível.

percent_cpc

PercentCpc

Estratégia de lances de porcentagem padrão de CPC em que os lances são uma fração do preço anunciado de um produto ou serviço.

target_cpm

TargetCpm

Uma estratégia de lances que otimiza automaticamente o custo por mil impressões.

DynamicSearchAdsSetting

A configuração para controlar os anúncios dinâmicos de pesquisa (DSA).

Campos
domain_name

string

Obrigatório. O nome de domínio da Internet que essa configuração representa, por exemplo, "google.com". ou "www.google.com".

language_code

string

Obrigatório. O código de idioma que especifica o idioma do domínio, por exemplo, "en".

use_supplied_urls_only

bool

Indica se a campanha usa exclusivamente URLs fornecidos pelo anunciante.

GeoTargetTypeSetting

Representa um conjunto de configurações relacionadas à segmentação geográfica de anúncios.

Campos
positive_geo_target_type

PositiveGeoTargetType

A configuração usada para a segmentação geográfica positiva nesta campanha específica.

negative_geo_target_type

NegativeGeoTargetType

A configuração usada para segmentação geográfica negativa nesta campanha específica.

NetworkSettings

As configurações de rede da campanha.

Campos
target_search_network

bool

Indica se os anúncios serão veiculados em sites parceiros na rede de pesquisa do Google (exige que target_google_search também seja true).

target_content_network

bool

Indica se os anúncios serão veiculados em canais específicos na Rede de Display do Google. Os canais são especificados usando o critério Canal.

target_partner_search_network

bool

Indica se os anúncios serão veiculados na rede de parceiros do Google. Esse recurso está disponível apenas para algumas contas de parceiros do Google selecionadas.

OptimizationGoalSetting

Configuração da meta de otimização desta campanha, que inclui um conjunto de tipos de meta de otimização.

Campos
optimization_goal_types[]

OptimizationGoalType

A lista de tipos de meta de otimização.

SelectiveOptimization

Configuração de otimização seletiva desta campanha, que inclui um conjunto de ações de conversão que serão otimizadas. Esse recurso só se aplica a campanhas para apps que usam MULTI_CHANNEL como AdvertisingChannelType e APP_CAMPAIGN ou APP_CAMPAIGN_FOR_ENGAGEMENT como AdvertisingChannelSubType.

Campos
conversion_actions[]

string

O conjunto selecionado de ações de conversão para otimizar esta campanha.

ShoppingSetting

A configuração das campanhas do Shopping. Define o universo de produtos que podem ser anunciados pela campanha e como ela interage com outras campanhas do Shopping.

Campos
feed_label

string

Rótulo do feed dos produtos a serem incluídos na campanha. Somente um feed_label ou sales_country pode ser definido. Se for usado em vez de sales_country, o campo feed_label aceitará códigos de países no mesmo formato, por exemplo, "XX". Caso contrário, pode ser qualquer string usada para o rótulo do feed no Google Merchant Center.

use_vehicle_inventory

bool

Define se o inventário de informações de veículos será segmentado.

merchant_id

int64

ID da conta do Merchant Center. Este campo é obrigatório para operações de criação. Esse campo não pode ser modificado nas campanhas do Shopping.

sales_country

string

País de vendas dos produtos a serem incluídos na campanha.

campaign_priority

int32

Prioridade da campanha. As campanhas com prioridades numericamente maiores têm precedência sobre as com prioridades mais baixas. Este campo é obrigatório para campanhas do Shopping, com valores entre 0 e 2. Esse campo é opcional para campanhas inteligentes do Shopping, mas precisa ser igual a "3" se definido.

enable_local

bool

Indica se produtos disponíveis na loja física serão incluídos.

TrackingSetting

Configurações no nível da campanha para informações de acompanhamento.

Campos
tracking_url

string

O URL usado para acompanhamento dinâmico.

CampaignAsset

Um vínculo entre uma campanha e um recurso.

Campos
resource_name

string

O nome do recurso da campanha. Os nomes dos recursos de CampaignAsset têm o seguinte formato:

customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}

status

AssetLinkStatus

Status do recurso da campanha.

campaign

string

A campanha à qual o recurso está vinculado.

asset

string

O recurso que está vinculado à campanha.

CampaignAssetSet

CampaignAssetSet é o vínculo entre uma campanha e um conjunto de recursos. Adicionar um CampaignAssetSet vincula um conjunto de recursos a uma campanha.

Campos
resource_name

string

O nome do recurso do conjunto de recursos da campanha. Os nomes dos recursos do conjunto de recursos têm o seguinte formato:

customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}

campaign

string

A campanha à qual esse conjunto de recursos está vinculado.

asset_set

string

O conjunto de recursos que está vinculado à campanha.

status

AssetSetLinkStatus

O status do recurso do conjunto de recursos da campanha. Somente leitura.

CampaignAudienceView

Uma visualização do público-alvo da campanha. Inclui dados de desempenho de interesses e listas de remarketing para anúncios das Redes de Display e do YouTube, além de listas de remarketing para anúncios de pesquisa (RLSA), agregados por critério de público-alvo e campanha. Essa visualização inclui apenas os públicos-alvo anexados no nível da campanha.

Campos
resource_name

string

O nome do recurso da visualização do público-alvo da campanha. Os nomes dos recursos de visualização do público-alvo da campanha têm o seguinte formato:

customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}

CampaignBudget

Um orçamento de campanha.

Campos
resource_name

string

O nome do recurso do orçamento da campanha. Os nomes dos recursos de orçamento da campanha têm o seguinte formato:

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

delivery_method

BudgetDeliveryMethod

O método de exibição que determina a taxa em que o orçamento da campanha é gasto.

O padrão será "STANDARD" se não for especificado em uma operação de criação.

period

BudgetPeriod

Período em que o orçamento será usado. O padrão será DIÁRIO se não for especificado.

amount_micros

int64

É o valor do orçamento, na moeda local da conta. O valor é especificado em micros, em que um milhão é equivalente a uma unidade monetária. O gasto mensal é limitado a 30,4 vezes esse valor.

CampaignCriterion

Um critério de campanha.

Campos
resource_name

string

O nome do recurso do critério da campanha. Os nomes dos recursos de critério da campanha têm o seguinte formato:

customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}

display_name

string

O nome de exibição do critério.

Este campo é ignorado para mutações.

type

CriterionType

Tipo do critério.

status

CampaignCriterionStatus

O status do critério.

last_modified_time

string

A data e a hora em que esse critério de campanha foi modificado pela última vez. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

criterion_id

int64

ID do critério.

Este campo é ignorado durante a modificação.

bid_modifier

float

O modificador dos lances quando o critério corresponde. O modificador precisa estar no intervalo: 0,1 a 10,0. A maioria dos tipos de critérios segmentáveis são compatíveis com modificadores. Use 0 para desativar um tipo de dispositivo.

negative

bool

Define se o critério será segmentado (false) ou excluído (true).

Campo de união criterion. O critério da campanha.

Exatamente um deve ser definido. criterion pode ser apenas de um dos tipos a seguir:

keyword

KeywordInfo

Palavra-chave.

location

LocationInfo

Local.

device

DeviceInfo

Dispositivo.

age_range

AgeRangeInfo

Faixa etária.

gender

GenderInfo

Gênero.

user_list

UserListInfo

Lista de usuários.

language

LanguageInfo

e linguagem Hashicorp.

webpage

WebpageInfo

página da Web.

location_group

LocationGroupInfo

Grupo por locais

CampaignLabel

Representa um relacionamento entre uma campanha e um rótulo.

Campos
resource_name

string

Nome do recurso. Os nomes dos recursos do rótulo da campanha têm o formato: customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}

campaign

string

A campanha a que o rótulo está anexado.

label

string

Rótulo atribuído à campanha.

CartDataSalesView

Visualização de vendas de dados do carrinho.

Campos
resource_name

string

O nome do recurso da vista de vendas de dados do carrinho. Os nomes dos recursos da visualização de vendas dos dados do carrinho têm o seguinte formato: customers/{customer_id}/cartDataSalesView

Conversão

Uma conversão.

Campos
resource_name

string

O nome de recurso da conversão. Os nomes dos recursos de conversão têm o seguinte formato:

customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}

id

int64

O ID da conversão.

criterion_id

int64

ID do critério do Search Ads 360. Um valor de 0 indica que o critério não foi atribuído.

merchant_id

int64

O ID da conta de inventário do Search Ads 360 que contém o produto que recebeu o clique. O Search Ads 360 gera esse ID quando você vincula uma conta de inventário nele.

ad_id

int64

ID do anúncio. Um valor de 0 indica que o anúncio não foi atribuído.

click_id

string

Uma string única para a visita à qual a conversão é atribuída, que é transmitida para a página de destino como o parâmetro de URL do ID de clique.

visit_id

int64

O ID de visita do Search Ads 360 a que a conversão é atribuída.

advertiser_conversion_id

string

Em conversões off-line, esse é um ID fornecido pelos anunciantes. Se um anunciante não especificar um ID, o Search Ads 360 vai gerar um. Em conversões on-line, ele é igual à coluna "id" ou à coluna floodlight_order_id, dependendo das instruções do Floodlight fornecidas pelo anunciante.

product_id

string

O ID do produto clicado.

product_channel

ProductChannel

O canal de vendas do produto que foi clicado: on-line ou local.

product_language_code

string

O idioma (ISO-639-1) definido para o feed do Merchant Center que contém dados sobre o produto.

product_store_id

string

A loja no anúncio de inventário local que foi clicada. Precisa corresponder aos IDs de loja usados no feed de produtos locais.

product_country_code

string

O país (formato ISO-3166) registrado no feed de inventário que contém o produto clicado.

attribution_type

AttributionType

A que a conversão é atribuída: visita ou palavra-chave + anúncio.

conversion_date_time

string

O carimbo de data/hora do evento de conversão.

conversion_last_modified_date_time

string

O carimbo de data/hora da última vez em que a conversão foi modificada.

conversion_visit_date_time

string

O carimbo de data/hora da visita à qual a conversão é atribuída.

conversion_quantity

int64

A quantidade de itens registrados pela conversão, conforme determinado pelo parâmetro "qty url". O anunciante é responsável por preencher o parâmetro de modo dinâmico (como o número de itens vendidos na conversão). Caso contrário, o padrão será 1.

conversion_revenue_micros

int64

A receita ajustada em micros para o evento de conversão. Estará sempre na moeda da conta de veiculação.

floodlight_original_revenue

int64

A receita original e inalterada associada ao evento do Floodlight (na moeda do relatório atual), antes das modificações na instrução de moeda do Floodlight.

floodlight_order_id

string

O ID do pedido do Floodlight fornecido pelo anunciante para a conversão.

status

ConversionStatus

O status da conversão, ATIVADO ou REMOVIDO.

asset_id

int64

ID do recurso que recebeu uma interação durante o evento de conversão.

asset_field_type

AssetFieldType

Tipo de campo do recurso do evento de conversão.

ConversionAction

Uma ação de conversão

Campos
resource_name

string

O nome do recurso da ação de conversão. Os nomes dos recursos de ação de conversão têm o seguinte formato:

customers/{customer_id}/conversionActions/{conversion_action_id}

creation_time

string

Carimbo de data/hora da criação da atividade do Floodlight, formatado em ISO 8601.

status

ConversionActionStatus

É o status desta ação de conversão para acúmulo de eventos de conversão.

type

ConversionActionType

O tipo dessa ação de conversão.

category

ConversionActionCategory

Categoria de conversões registradas para essa ação de conversão.

value_settings

ValueSettings

Configurações relacionadas ao valor dos eventos de conversão associados a essa ação de conversão.

attribution_model_settings

AttributionModelSettings

Configurações relacionadas ao modelo de atribuição desta ação de conversão.

floodlight_settings

FloodlightSettings

Configurações do Floodlight para os tipos de conversão do Floodlight.

id

int64

O ID da ação de conversão.

name

string

Nome da ação de conversão.

Este campo é obrigatório e não deve ficar em branco ao criar novas ações de conversão.

primary_for_goal

bool

Se o bit primary_for_goal de uma ação de conversão for falso, ela não poderá receber lances para todas as campanhas, independentemente da meta de conversão de cliente ou da campanha. No entanto, as metas de conversão personalizadas não respeitam a primary_for_goal. Portanto, se uma campanha tiver uma meta de conversão personalizada configurada com uma ação de conversão "primary_for_goal = falsa", essa ação ainda poderá receber lances. Por padrão, primary_for_goal será verdadeiro se não for definido. Na V9, primary_for_goal só pode ser definido como falso após a criação por meio de uma "atualização" porque ela não foi declarada como opcional.

owner_customer

string

O nome do recurso do cliente proprietário da ação de conversão ou nulo se essa for uma ação de conversão definida pelo sistema.

include_in_client_account_conversions_metric

bool

Se essa ação de conversão deve ser incluída na coluna "client_account_conversions" métrica.

include_in_conversions_metric

bool

Se essa ação de conversão deve ser incluída na coluna "conversões" métrica.

click_through_lookback_window_days

int64

O número máximo de dias entre uma interação (por exemplo, um clique) e um evento de conversão.

app_id

string

ID do app para uma ação de conversão de app.

AttributionModelSettings

Configurações relacionadas ao modelo de atribuição desta ação de conversão.

Campos
attribution_model

AttributionModel

O tipo de modelo de atribuição dessa ação de conversão.

data_driven_model_status

DataDrivenModelStatus

O status do modelo de atribuição baseada em dados para a ação de conversão.

FloodlightSettings

Configurações relacionadas a uma ação de conversão do Floodlight.

Campos
activity_group_tag

string

String usada para identificar um grupo de atividades do Floodlight ao registrar as conversões.

activity_tag

string

String usada para identificar uma atividade do Floodlight ao registrar conversões.

activity_id

int64

ID da atividade do Floodlight no DoubleClick Campaign Manager (DCM).

ValueSettings

Configurações relacionadas ao valor dos eventos de conversão associados a essa ação de conversão.

Campos
default_value

double

O valor a ser usado quando os eventos dessa ação de conversão forem enviados com um valor inválido, não permitido ou ausente, ou quando essa ação de conversão estiver configurada para usar sempre o valor padrão.

default_currency_code

string

O código da moeda a ser usado quando os eventos de conversão dessa ação de conversão forem enviados com um código de moeda inválido ou ausente ou quando essa ação de conversão estiver configurada para usar sempre o valor padrão.

always_use_default_value

bool

Controla se o valor e o código da moeda padrão são usados no lugar do valor e do código da moeda especificados nos eventos de conversão dessa ação de conversão.

ConversionCustomVariable

Uma variável personalizada de conversão. Consulte "Sobre dimensões e métricas personalizadas do Floodlight no novo Search Ads 360" em https://support.google.com/sa360/answer/13567857

Campos
resource_name

string

O nome do recurso da variável personalizada de conversão. Os nomes dos recursos de variáveis personalizadas de conversão têm o seguinte formato:

customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}

id

int64

O ID da variável personalizada de conversão.

name

string

Obrigatório. O nome da variável personalizada de conversão. O nome deve ser exclusivo. O tamanho máximo do nome é de 100 caracteres. Não deve haver espaços adicionais antes e depois.

tag

string

Obrigatório. A tag da variável personalizada de conversão. A tag deve ser única e consistir em um "u" caractere diretamente seguido por um número menor que ormigual a 100. Por exemplo: "u4".

status

ConversionCustomVariableStatus

O status da variável personalizada de conversão para o acúmulo de eventos de conversão.

owner_customer

string

O nome do recurso do cliente proprietário da variável personalizada de conversão.

family

ConversionCustomVariableFamily

Família da variável personalizada de conversão.

cardinality

ConversionCustomVariableCardinality

Cardinalidade da variável personalizada de conversão.

floodlight_conversion_custom_variable_info

FloodlightConversionCustomVariableInfo

Campos das variáveis personalizadas de conversão do Floodlight no Search Ads 360.

custom_column_ids[]

int64

Os IDs das colunas personalizadas que usam essa variável personalizada de conversão.

FloodlightConversionCustomVariableInfo

Informações sobre as variáveis personalizadas de conversão do Floodlight no Search Ads 360.

Campos
floodlight_variable_type

FloodlightVariableType

Tipo de variável do Floodlight definida no Search Ads 360.

floodlight_variable_data_type

FloodlightVariableDataType

Tipo de dados da variável do Floodlight definido no Search Ads 360.

ConversionTrackingSetting

Um conjunto de configurações de todo o cliente relacionadas ao acompanhamento de conversões do Search Ads 360.

Campos
accepted_customer_data_terms

bool

Se o cliente aceitou os termos de dados do cliente. Se você estiver usando o acompanhamento de conversões de várias contas, esse valor será herdado do administrador. Este campo é somente leitura. Para mais informações, consulte https://support.google.com/adspolicy/answer/7475709.

conversion_tracking_status

ConversionTrackingStatus

Status do acompanhamento de conversões. Ela indica se o cliente está usando o acompanhamento de conversões e quem é o proprietário do acompanhamento de conversões do cliente. Se esse cliente estiver usando o acompanhamento de conversões de várias contas, o valor retornado será diferente com base no login-customer-id da solicitação.

enhanced_conversions_for_leads_enabled

bool

Se o cliente ativou as conversões otimizadas para leads. Se você estiver usando o acompanhamento de conversões de várias contas, esse valor será herdado do administrador. Este campo é somente leitura.

google_ads_conversion_customer

string

O nome do recurso do cliente onde as conversões são criadas e gerenciadas. Este campo é somente leitura.

conversion_tracking_id

int64

O ID de acompanhamento de conversões usado para essa conta. Esse ID não indica se o cliente usa o acompanhamento de conversões (conversion_tracking_status faz). Este campo é somente leitura.

google_ads_cross_account_conversion_tracking_id

int64

O ID de acompanhamento de conversões do gerente do cliente. É definido quando o cliente ativa o acompanhamento de conversões e substitui "conversion_tracking_id". Só é possível gerenciar esse campo na interface do Google Ads. Este campo é somente leitura.

cross_account_conversion_tracking_id

int64

O ID de acompanhamento de conversões do gerente do cliente. Isso é definido quando o cliente ativa o acompanhamento de conversões de várias contas e substitui "conversion_tracking_id".

CustomColumn

Uma coluna personalizada. Consulte a coluna personalizada do Search Ads 360 em https://support.google.com/sa360/answer/9633916.

Campos
resource_name

string

O nome de recurso da coluna personalizada. Os nomes de recursos das colunas personalizadas têm o seguinte formato:

customers/{customer_id}/customColumns/{custom_column_id}

id

int64

ID da coluna personalizada.

name

string

Nome definido pelo usuário da coluna personalizada.

description

string

Descrição definida pelo usuário da coluna personalizada.

value_type

CustomColumnValueType

O tipo de valor de resultado da coluna personalizada.

references_attributes

bool

Verdadeiro quando a coluna personalizada se refere a um ou mais atributos.

references_metrics

bool

Verdadeiro quando a coluna personalizada se refere a uma ou mais métricas.

queryable

bool

Verdadeiro quando a coluna personalizada está disponível para ser usada na consulta do SearchAds360Service.Search e SearchAds360Service.SearchStream.

referenced_system_columns[]

string

A lista das colunas do sistema referenciadas desta coluna personalizada. Por exemplo, uma coluna personalizada "soma de impressões e cliques" fez referência a colunas do sistema de {"metrics.clicks", "metrics.impressions"}.

Cliente

Um cliente.

Campos
resource_name

string

O nome de recurso do cliente. Os nomes de recursos dos clientes têm o seguinte formato:

customers/{customer_id}

conversion_tracking_setting

ConversionTrackingSetting

Configuração do acompanhamento de conversões de um cliente.

account_type

AccountType

Tipo de conta de mecanismo, por exemplo: Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track etc.

double_click_campaign_manager_setting

DoubleClickCampaignManagerSetting

configuração do DoubleClick Campaign Manager para um cliente administrador.

account_status

AccountStatus

Status da conta, como "Ativada", "Pausada", "Removida" etc.

last_modified_time

string

A data e a hora em que o cliente foi modificado pela última vez. A data e hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss.ssssss".

engine_id

string

ID da conta na conta de mecanismo externo.

status

CustomerStatus

O status do cliente.

creation_time

string

O carimbo de data/hora em que o cliente foi criado. O carimbo de data/hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss".

id

int64

O ID do cliente.

descriptive_name

string

Nome descritivo opcional e não exclusivo do cliente.

currency_code

string

A moeda em que a conta opera. É compatível com um subconjunto dos códigos de moeda do padrão ISO 4217.

time_zone

string

O ID de fuso horário local do cliente.

tracking_url_template

string

O modelo de URL para criar um URL de rastreamento com base em parâmetros.

final_url_suffix

string

O modelo de URL para anexar parâmetros ao URL final.

auto_tagging_enabled

bool

Indica se a codificação automática está ativada para o cliente.

manager

bool

Se o cliente é um gerente.

CustomerAsset

Um vínculo entre um cliente e um recurso.

Campos
resource_name

string

O nome do recurso do cliente. Os nomes dos recursos de CustomerAsset têm o seguinte formato:

customers/{customer_id}/customerAssets/{asset_id}~{field_type}

asset

string

Obrigatório. O recurso vinculado ao cliente.

status

AssetLinkStatus

Status do recurso do cliente.

CustomerAssetSet

CustomerAssetSet é o vínculo entre um cliente e um conjunto de recursos. Adicionar um CustomerAssetSet vincula um conjunto de recursos a um cliente.

Campos
resource_name

string

O nome do recurso do conjunto de recursos do cliente. Os nomes dos recursos do conjunto de recursos têm o seguinte formato:

customers/{customer_id}/customerAssetSets/{asset_set_id}

asset_set

string

O conjunto de recursos que está vinculado ao cliente.

customer

string

O cliente ao qual este conjunto de recursos está vinculado.

status

AssetSetLinkStatus

O status do recurso do conjunto de recursos do cliente. Somente leitura.

CustomerClient

Um link entre o cliente em questão e um cliente cliente. Os CustomerClients existem apenas para clientes administradores. Todos os clientes de clientes diretos e indiretos estão incluídos, bem como o próprio gerente.

Campos
resource_name

string

O nome do recurso do cliente do cliente. Os nomes dos recursos do CustomerClient têm o seguinte formato: customers/{customer_id}/customerClients/{client_customer_id}

applied_labels[]

string

Os nomes dos recursos dos rótulos de propriedade do cliente solicitante que são aplicados ao cliente do cliente. Os nomes dos recursos de rótulo têm o seguinte formato:

customers/{customer_id}/labels/{label_id}

status

CustomerStatus

O status do cliente. Somente leitura.

client_customer

string

O nome de recurso do cliente-cliente que está vinculado ao cliente em questão. Somente leitura.

hidden

bool

Especifica se esta é uma conta oculta.

Somente leitura.

level

int64

Distância entre determinado cliente e cliente. Para o self link, o valor do nível será 0. Somente leitura.

time_zone

string

Representação de string do Common Locale Data Repository (CLDR) do fuso horário do cliente, por exemplo, America/Los_Angeles. Somente leitura.

test_account

bool

Identifica se o cliente é uma conta de teste. Somente leitura.

manager

bool

Identifica se o cliente é um gerente. Somente leitura.

descriptive_name

string

Nome descritivo do cliente. Somente leitura.

currency_code

string

Código de moeda (por exemplo, "USD", "EUR") do cliente. Somente leitura.

id

int64

O ID do cliente. Somente leitura.

DoubleClickCampaignManagerSetting

configuração do DoubleClick Campaign Manager para um cliente administrador.

Campos
advertiser_id

int64

ID do anunciante do Campaign Manager associado a esse cliente.

network_id

int64

ID da rede do Campaign Manager associada a esse cliente.

time_zone

string

Fuso horário da rede do Campaign Manager associada ao cliente no formato do banco de dados de fuso horário IANA, como America/New_York.

DynamicSearchAdsSearchTermView

Uma visualização dos termos de pesquisa dos anúncios dinâmicos de pesquisa.

Campos
resource_name

string

O nome do recurso da visualização dos termos de pesquisa dos anúncios dinâmicos de pesquisa. Os nomes dos recursos de visualização dos termos de pesquisa dos anúncios dinâmicos de pesquisa têm o seguinte formato:

customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}

landing_page

string

O URL da página de destino selecionado dinamicamente da impressão.

Este campo é somente leitura.

GenderView

Uma visualização de gênero. O recurso "gender_view" reflete o estado de veiculação efetiva, em vez dos critérios adicionados. Um grupo de anúncios sem critérios de gênero por padrão é exibido para todos os sexos, portanto, todos os sexos aparecem em gender_view com estatísticas.

Campos
resource_name

string

O nome do recurso da visualização de gênero. Os nomes dos recursos da visualização de gênero têm o seguinte formato:

customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}

GeoTargetConstant

Uma constante de segmentação geográfica.

Campos
resource_name

string

O nome do recurso da constante de segmentação geográfica. Os nomes das constantes de recursos de segmentação geográfica têm o seguinte formato:

geoTargetConstants/{geo_target_constant_id}

status

GeoTargetConstantStatus

Status da constante da segmentação geográfica.

id

int64

O ID da constante de segmentação geográfica.

name

string

Nome em inglês constante da segmentação geográfica.

country_code

string

O código do país ISO-3166-1 alfa-2 associado à segmentação.

target_type

string

Tipo de segmentação constante da segmentação geográfica.

canonical_name

string

O nome em inglês totalmente qualificado, que consiste no nome da segmentação, da segmentação pai e do país.

parent_geo_target

string

O nome do recurso da constante mãe de segmentação geográfica. Os nomes das constantes de recursos de segmentação geográfica têm o seguinte formato:

geoTargetConstants/{parent_geo_target_constant_id}

KeywordView

Uma visualização de palavras-chave.

Campos
resource_name

string

O nome do recurso da visualização de palavra-chave. Os nomes dos recursos de visualização de palavras-chave têm o seguinte formato:

customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}

Rótulo

Um marcador.

Campos
resource_name

string

Nome do recurso. Os nomes dos recursos de rótulo têm o formato: customers/{customer_id}/labels/{label_id}

status

LabelStatus

Status do rótulo. Somente leitura.

text_label

TextLabel

Um tipo de rótulo que exibe texto em um fundo colorido.

id

int64

ID do rótulo. Somente leitura.

name

string

Nome do rótulo.

Este campo é obrigatório e não deve ficar vazio ao criar um novo rótulo.

Esta string conter entre 1 e 80 caracteres (valores inclusivos).

LanguageConstant

Um idioma.

Campos
resource_name

string

O nome do recurso da constante de linguagem. Os nomes dos recursos de constantes de linguagem têm o seguinte formato:

languageConstants/{criterion_id}

id

int64

O ID da constante de idioma.

code

string

O código do idioma, por exemplo, "en_US", "en_AU", "es", "fr" etc.

name

string

O nome completo do idioma em inglês, por exemplo, "English (US)", "Spanish" etc.

targetable

bool

Indica se o idioma pode ser segmentado.

ListingGroupFilterDimension

Listando dimensões para o filtro do grupo de produtos anunciados do grupo de recursos.

Campos
Campo de união dimension. A dimensão de um dos tipos abaixo está sempre presente. dimension pode ser apenas de um dos tipos a seguir:
product_bidding_category

ProductBiddingCategory

Categoria de lance de uma oferta de produto.

product_brand

ProductBrand

Marca de uma oferta de produto.

product_channel

ProductChannel

Localidade de uma oferta de produto.

product_condition

ProductCondition

Condição de uma oferta de produto.

product_custom_attribute

ProductCustomAttribute

Atributo personalizado de uma oferta de produto.

product_item_id

ProductItemId

ID do item de uma oferta de produto.

product_type

ProductType

Tipo de oferta de um produto.

ProductBiddingCategory

Um elemento de uma categoria de lances em um determinado nível. As categorias de nível superior estão no nível 1, suas filhas no nível 2 e assim por diante. No momento, oferecemos suporte a até cinco níveis. O usuário precisa especificar um tipo de dimensão que indique o nível da categoria. Todos os casos da mesma subdivisão precisam ter o mesmo tipo de dimensão (nível de categoria).

Campos
level

ListingGroupFilterBiddingCategoryLevel

Indica o nível da categoria na taxonomia.

id

int64

ID da categoria de lance do produto.

Ele é equivalente ao ID "google_product_category", conforme descrito neste artigo: https://support.google.com/merchants/answer/6324436

ProductBrand

Marca do produto.

Campos
value

string

Valor de string da marca do produto.

ProductChannel

Localidade de uma oferta de produto.

Campos
channel

ListingGroupFilterProductChannel

Valor da localidade.

ProductCondition

Condição de uma oferta de produto.

Campos
condition

ListingGroupFilterProductCondition

Valor da condição.

ProductCustomAttribute

Atributo personalizado de uma oferta de produto.

Campos
index

ListingGroupFilterCustomAttributeIndex

Indica o índice do atributo personalizado.

value

string

Valor de string do atributo personalizado do produto.

ProductItemId

ID do item de uma oferta de produto.

Campos
value

string

Valor do ID.

ProductType

Tipo de oferta de um produto.

Campos
level

ListingGroupFilterProductTypeLevel

Nível do tipo.

value

string

Valor do tipo.

ListingGroupFilterDimensionPath

O caminho que define as dimensões que definem um filtro do grupo de fichas.

Campos
dimensions[]

ListingGroupFilterDimension

O caminho completo das dimensões na hierarquia do filtro do grupo de fichas (excluindo o nó raiz) até o filtro desse grupo.

LocationView

Uma visualização de local resume o desempenho das campanhas por critério de local.

Campos
resource_name

string

O nome do recurso da visualização do local. Os nomes dos recursos de visualização do local têm o seguinte formato:

customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}

ProductBiddingCategoryConstant

Uma categoria de lances do produto.

Campos
resource_name

string

O nome do recurso da categoria de lances do produto. Os nomes dos recursos das categorias de lances de produtos têm o seguinte formato:

productBiddingCategoryConstants/{country_code}~{level}~{id}

level

ProductBiddingCategoryLevel

Nível da categoria de lances do produto.

status

ProductBiddingCategoryStatus

Status da categoria de lance do produto.

id

int64

ID da categoria de lance do produto.

Ele é equivalente ao ID "google_product_category", conforme descrito neste artigo: https://support.google.com/merchants/answer/6324436.

country_code

string

Código do país com duas letras maiúsculas da categoria de lance do produto.

product_bidding_category_constant_parent

string

Nome do recurso da categoria de lances do produto principal.

language_code

string

Código do idioma da categoria de lances do produto.

localized_name

string

Valor de exibição da categoria de lances do produto localizada de acordo com o language_code.

ProductGroupView

Uma visualização do grupo de produtos.

Campos
resource_name

string

O nome do recurso da visualização do grupo de produtos. Os nomes dos recursos de visualização do grupo de produtos têm o seguinte formato:

customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}

SearchAds360Field

Um campo ou recurso (artefato) usado pelo SearchAds360Service.

Campos
resource_name

string

O nome de recurso do artefato. Os nomes dos recursos do artefato têm o seguinte formato:

SearchAds360Fields/{name}

category

SearchAds360FieldCategory

A categoria do artefato.

selectable_with[]

string

Os nomes de todos os recursos, segmentos e métricas que podem ser selecionados com o artefato descrito.

attribute_resources[]

string

Os nomes de todos os recursos que podem ser selecionados com o artefato descrito. Os campos desses recursos não segmentam métricas quando incluídas em consultas de pesquisa.

Esse campo é definido apenas para artefatos com categoria RESOURCE.

metrics[]

string

Esse campo lista os nomes de todas as métricas que podem ser selecionadas com o artefato descrito quando ele é usado na cláusula FROM. É definido apenas para artefatos com categoria RESOURCE.

segments[]

string

Esse campo lista os nomes de todos os artefatos, seja um segmento ou outro recurso, que segmentam métricas quando incluídas em consultas de pesquisa e quando o artefato descrito é usado na cláusula FROM. É definido apenas para artefatos com categoria RESOURCE.

enum_values[]

string

Valores que o artefato pode assumir se for um campo do tipo ENUM.

Este campo só é definido para artefatos da categoria SEGMENT ou ATTRIBUTE.

data_type

SearchAds360FieldDataType

Esse campo determina os operadores que podem ser usados com o artefato em cláusulas WHERE.

name

string

O nome do artefato.

selectable

bool

Se o artefato pode ser usado em uma cláusula SELECT em consultas de pesquisa.

filterable

bool

Se o artefato pode ser usado em uma cláusula WHERE em consultas de pesquisa.

sortable

bool

Se o artefato pode ser usado em uma cláusula ORDER BY em consultas de pesquisa.

type_url

string

O URL do proto que descreve o tipo de dados do artefato.

is_repeated

bool

Define se o artefato do campo é repetido.

ShoppingPerformanceView

Visualização do desempenho do Shopping. Fornece estatísticas da campanha do Shopping agregadas em vários níveis de dimensão do produto. Os valores de dimensão de produto do Merchant Center, como marca, categoria, atributos personalizados, condição e tipo de produto, refletem o estado de cada dimensão na data e hora em que o evento correspondente foi registrado.

Campos
resource_name

string

O nome do recurso da visualização de desempenho do Shopping. Os nomes dos recursos da visualização de desempenho do Shopping têm o seguinte formato: customers/{customer_id}/shoppingPerformanceView

UserList

Uma lista de usuários. Esta é uma lista de usuários que um cliente pode segmentar.

Campos
resource_name

string

O nome do recurso da lista de usuários. Os nomes dos recursos da lista de usuários têm o seguinte formato:

customers/{customer_id}/userLists/{user_list_id}

type

UserListType

Tipo dessa lista.

Este campo é somente leitura.

id

int64

ID da lista de usuários.

name

string

Nome dessa lista de usuários. Dependendo de access_reason, o nome da lista de usuários pode não ser exclusivo (por exemplo, se access_reason=SHARED)

Acessar

Uma visita.

Campos
resource_name

string

O nome do recurso da visita. Os nomes dos recursos de visita têm o seguinte formato:

customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}

id

int64

O ID da visita.

criterion_id

int64

ID de palavra-chave do Search Ads 360. Um valor de 0 indica que a palavra-chave não está atribuída.

merchant_id

int64

O ID da conta de inventário do Search Ads 360 que contém o produto que recebeu o clique. O Search Ads 360 gera esse ID quando você vincula uma conta de inventário nele.

ad_id

int64

ID do anúncio. Um valor de 0 indica que o anúncio não foi atribuído.

click_id

string

Uma string exclusiva para cada visita transmitida à página de destino como o parâmetro de URL de ID de clique.

visit_date_time

string

O carimbo de data/hora do evento da visita. O carimbo de data/hora está no fuso horário do cliente e no formato "aaaa-MM-dd HH:mm:ss".

product_id

string

O ID do produto clicado.

product_channel

ProductChannel

O canal de vendas do produto que foi clicado: on-line ou local.

product_language_code

string

O idioma (ISO-639-1) definido para o feed do Merchant Center que contém dados sobre o produto.

product_store_id

string

A loja no anúncio de inventário local que foi clicada. Precisa corresponder aos IDs de loja usados no feed de produtos locais.

product_country_code

string

O país (formato ISO-3166) registrado no feed de inventário que contém o produto clicado.

asset_id

int64

ID do recurso com o qual houve interação durante o evento de visita.

asset_field_type

AssetFieldType

Tipo de campo do recurso do evento da visita.

WebpageView

Uma visualização de página da Web.

Campos
resource_name

string

O nome do recurso da visualização da página da Web. Os nomes dos recursos de visualização de página da Web têm o seguinte formato:

customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}