Package google.ads.searchads360.v0.services

Índice

CustomColumnService

Serviço para gerenciar colunas personalizadas.

GetCustomColumn

rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)

Retorna a coluna personalizada solicitada com todos os detalhes.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch
ListCustomColumns

rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)

Retorna todas as colunas personalizadas associadas ao cliente com todos os detalhes.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

CustomerService

Serviço para gerenciar clientes.

ListAccessibleCustomers

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

Retorna os nomes dos recursos dos clientes diretamente acessíveis pelo usuário que autentica a chamada.

Lista de erros gerados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

SearchAds360FieldService

Serviço para buscar campos da API Search Ads 360.

GetSearchAds360Field

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

Retorna somente o campo solicitado.

Lista de erros gerados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch
SearchSearchAds360Fields

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

Retorna todos os campos que correspondem à consulta de pesquisa.

Lista de erros gerados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

SearchAds360Service

Serviço para buscar dados e métricas em vários recursos.

Pesquisar

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

Retorna todas as linhas que correspondem à consulta de pesquisa.

Lista de erros gerados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch
SearchStream

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

Retorna todas as linhas que correspondem à consulta do fluxo de pesquisa.

Lista de erros gerados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

ConversionCustomDimensionHeader

Mensagem para o cabeçalho da dimensão personalizada de conversão.

Campos
id

int64

O ID da dimensão personalizada de conversão.
name

string

O nome definido pelo usuário da dimensão personalizada de conversão.

ConversionCustomMetricHeader

Mensagem para o cabeçalho da métrica personalizada de conversão.

Campos
id

int64

O ID da métrica personalizada de conversão.
name

string

O nome definido pelo usuário da métrica personalizada de conversão.

CustomColumnHeader

Mensagem para o cabeçalho da coluna personalizada.

Campos
id

int64

O ID da coluna personalizada.
name

string

O nome definido pelo usuário da coluna personalizada.
references_metrics

bool

Verdadeiro quando a coluna personalizada faz referência a métricas.

GetCustomColumnRequest

Mensagem de solicitação para CustomColumnService.GetCustomColumn.

Campos
resource_name

string

Obrigatório. O nome do recurso da coluna personalizada a ser buscado.

GetSearchAds360FieldRequest

Mensagem de solicitação para SearchAds360FieldService.GetSearchAds360Field.

Campos
resource_name

string

Obrigatório. O nome do recurso do campo a ser recebido.

ListAccessibleCustomersRequest

Esse tipo não tem campos.

Mensagem de solicitação para CustomerService.ListAccessibleCustomers.

ListAccessibleCustomersResponse

Mensagem de resposta para CustomerService.ListAccessibleCustomers.

Campos
resource_names[]

string

Nome do recurso dos clientes diretamente acessíveis pelo usuário que autentica a chamada.

ListCustomColumnsRequest

Mensagem de solicitação para CustomColumnService.ListCustomColumns

Campos
customer_id

string

Obrigatório. O ID do cliente a que a operação da lista CustomColumn será aplicada.

ListCustomColumnsResponse

Mensagem de resposta para buscar todas as colunas personalizadas associadas a um cliente.

Campos
custom_columns[]

CustomColumn

As CustomColumns pertencentes ao cliente fornecido.

RawEventConversionDimensionHeader

Mensagem do cabeçalho da dimensão de conversão de eventos brutos.

Campos
id

int64

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

string

O nome definido pelo usuário da dimensão de evento bruto.

RawEventConversionMetricHeader

Mensagem para o cabeçalho da métrica de conversão de eventos brutos.

Campos
id

int64

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

string

O nome definido pelo usuário da métrica de evento bruta.

SearchAds360Row

Uma linha retornada pela consulta.

Campos
ad_group

AdGroup

O grupo de anúncios referenciado na consulta.
ad_group_ad

AdGroupAd

O anúncio referenciado na consulta.
ad_group_ad_effective_label

AdGroupAdEffectiveLabel

O rótulo do anúncio do grupo de anúncios referenciado na consulta.
ad_group_ad_label

AdGroupAdLabel

O rótulo do anúncio do grupo de anúncios referenciado na consulta.
ad_group_asset

AdGroupAsset

O recurso do grupo de anúncios referenciado na consulta.
ad_group_asset_set

AdGroupAssetSet

O conjunto de recursos do grupo de anúncios referenciado na consulta.
ad_group_audience_view

AdGroupAudienceView

A visualização do público-alvo do grupo de anúncios referenciada na consulta.
ad_group_bid_modifier

AdGroupBidModifier

O modificador de lance referenciado na consulta.
ad_group_criterion

AdGroupCriterion

O critério referenciado na consulta.
ad_group_criterion_effective_label

AdGroupCriterionEffectiveLabel

O rótulo efetivo do critério do grupo de anúncios referenciado na consulta.
ad_group_criterion_label

AdGroupCriterionLabel

O rótulo do critério do grupo de anúncios mencionado na consulta.
ad_group_effective_label

AdGroupEffectiveLabel

O rótulo efetivo do grupo de anúncios referenciado na consulta.
ad_group_label

AdGroupLabel

O rótulo do grupo de anúncios referenciado na consulta.
age_range_view

AgeRangeView

A visualização de faixa etária referenciada na consulta.
asset

Asset

O recurso referenciado na consulta.
asset_group_asset

AssetGroupAsset

O recurso do grupo de recursos referenciado na consulta.
asset_group_signal

AssetGroupSignal

O indicador do grupo de recursos referenciado na consulta.
asset_group_listing_group_filter

AssetGroupListingGroupFilter

O filtro do grupo de produtos anunciados de recursos referenciado na consulta.
asset_group_top_combination_view

AssetGroupTopCombinationView

A visualização da combinação principal do grupo de recursos referenciada na consulta.
asset_group

AssetGroup

O grupo de recursos referenciado na consulta.
asset_set_asset

AssetSetAsset

O recurso do conjunto de recursos referenciado na consulta.
asset_set

AssetSet

O conjunto de recursos referenciado na consulta.
bidding_strategy

BiddingStrategy

A estratégia de lances referenciada na consulta.
campaign_budget

CampaignBudget

O orçamento da campanha referenciado na consulta.
campaign

Campaign

A campanha referenciada na consulta.
campaign_asset

CampaignAsset

O recurso da campanha referenciado na consulta.
campaign_asset_set

CampaignAssetSet

O grupo de recursos da campanha referenciado na consulta.
campaign_audience_view

CampaignAudienceView

A visualização do público-alvo da campanha referenciada na consulta.
campaign_criterion

CampaignCriterion

O critério da campanha referenciado na consulta.
campaign_effective_label

CampaignEffectiveLabel

O rótulo da campanha que é referenciado na consulta.
campaign_label

CampaignLabel

O rótulo da campanha referenciado na consulta.
cart_data_sales_view

CartDataSalesView

A visualização de vendas de dados do carrinho referenciada na consulta.
audience

Audience

O público-alvo referenciado na consulta.
conversion_action

ConversionAction

A ação de conversão referenciada na consulta.
conversion_custom_variable

ConversionCustomVariable

A variável personalizada de conversão referenciada na consulta.
customer

Customer

O cliente referenciado na consulta.
customer_asset

CustomerAsset

O recurso do cliente referenciado na consulta.
customer_asset_set

CustomerAssetSet

O conjunto de recursos do cliente referenciado na consulta.
accessible_bidding_strategy

AccessibleBiddingStrategy

A estratégia de lances acessível referenciada na consulta.
customer_client

CustomerClient

O CustomerClient mencionado na consulta.
dynamic_search_ads_search_term_view

DynamicSearchAdsSearchTermView

A visualização do termo de pesquisa dos anúncios dinâmicos de pesquisa referenciada na consulta.
gender_view

GenderView

A visualização de gênero referenciada na consulta.
geo_target_constant

GeoTargetConstant

A constante de segmentação geográfica referenciada na consulta.
keyword_view

KeywordView

A visualização de palavra-chave referenciada na consulta.
label

Label

O rótulo referenciado na consulta.
language_constant

LanguageConstant

A constante de idioma referenciada na consulta.
location_view

LocationView

A visualização de local referenciada na consulta.
product_bidding_category_constant

ProductBiddingCategoryConstant

A categoria de lances do produto referenciada na consulta.
product_group_view

ProductGroupView

A visualização do grupo de produtos referenciada na consulta.
shopping_performance_view

ShoppingPerformanceView

A visualização de performance do Shopping referenciada na consulta.
user_list

UserList

A lista de usuários referenciada na consulta.
user_location_view

UserLocationView

A visualização de local do usuário referenciada na consulta.
webpage_view

WebpageView

A visualização da página da Web referenciada na consulta.
visit

Visit

A visita no nível do evento referenciada na consulta.
conversion

Conversion

A conversão no nível do evento referenciada na consulta.
metrics

Metrics

As métricas.
segments

Segments

Os segmentos.
custom_columns[]

Value

As colunas personalizadas.

SearchSearchAds360FieldsRequest

Mensagem de solicitação para SearchAds360FieldService.SearchSearchAds360Fields.

Campos
query

string

Obrigatório. A string de consulta.
page_token

string

Token da página a ser recuperada. Se não for especificado, a primeira página de resultados será retornada. Use o valor recebido de next_page_token na resposta anterior para solicitar a próxima página de resultados.
page_size

int32

Número de elementos a serem recuperados em uma única página. Quando uma página muito grande é solicitada, o servidor pode decidir limitar ainda mais o número de recursos retornados.

SearchSearchAds360FieldsResponse

Mensagem de resposta para SearchAds360FieldService.SearchSearchAds360Fields.

Campos
results[]

SearchAds360Field

A lista de campos que correspondem à consulta.
next_page_token

string

Token de paginação usado para recuperar a próxima página de resultados. Transmita o conteúdo dessa string como o atributo page_token da próxima solicitação. next_page_token não é retornado para a última página.
total_results_count

int64

Número total de resultados que correspondem à consulta, ignorando a cláusula LIMIT.

SearchSearchAds360Request

Mensagem de solicitação para SearchAds360Service.Search.

Campos
customer_id

string

Obrigatório. O ID do cliente consultado.
query

string

Obrigatório. A string de consulta.
page_token

string

Token da página a ser recuperada. Se não for especificado, a primeira página de resultados será retornada. Use o valor recebido de next_page_token na resposta anterior para solicitar a próxima página de resultados.
page_size

int32

Número de elementos a serem recuperados em uma única página. Quando uma página muito grande é solicitada, o servidor pode decidir limitar ainda mais o número de recursos retornados.
validate_only

bool

Se for verdadeiro, a solicitação será validada, mas não executada.
return_total_results_count

bool

Se verdadeiro, o número total de resultados que correspondem à consulta ignorando a cláusula LIMIT será incluído na resposta. O padrão é false
summary_row_setting

SummaryRowSetting

Determina se uma linha de resumo será retornada. Por padrão, a linha de resumo não é retornada. Se solicitado, a linha de resumo será enviada em uma resposta por conta própria depois que todos os outros resultados da consulta forem retornados.

SearchSearchAds360Response

Mensagem de resposta para SearchAds360Service.Search.

Campos
results[]

SearchAds360Row

A lista de linhas que correspondem à consulta.
next_page_token

string

Token de paginação usado para recuperar a próxima página de resultados. Transmita o conteúdo dessa string como o atributo page_token da próxima solicitação. next_page_token não é retornado para a última página.
total_results_count

int64

Número total de resultados que correspondem à consulta ignorando a cláusula LIMIT.
field_mask

FieldMask

FieldMask que representa quais campos foram solicitados pelo usuário.
summary_row

SearchAds360Row

Linha de resumo que contém o resumo das métricas nos resultados. O resumo das métricas significa a agregação de métricas em todos os resultados. Aqui, a agregação pode ser soma, média, taxa etc.
custom_column_headers[]

CustomColumnHeader

Os cabeçalhos das colunas personalizadas nos resultados.
conversion_custom_metric_headers[]

ConversionCustomMetricHeader

Os cabeçalhos das métricas personalizadas de conversão nos resultados.
conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

Os cabeçalhos das dimensões personalizadas de conversão nos resultados.
raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

Os cabeçalhos das métricas de conversão de eventos brutos nos resultados.
raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Os cabeçalhos das dimensões de conversão de eventos brutos nos resultados.

SearchSearchAds360StreamRequest

Mensagem de solicitação para SearchAds360Service.SearchStream.

Campos
customer_id

string

Obrigatório. O ID do cliente consultado.
query

string

Obrigatório. A string de consulta.
batch_size

int32

O número de linhas retornadas em cada lote de resposta de stream. Quando um lote muito grande é solicitado, o servidor pode decidir limitar ainda mais o número de linhas retornadas.
summary_row_setting

SummaryRowSetting

Determina se uma linha de resumo será retornada. Por padrão, a linha de resumo não é retornada. Se solicitado, a linha de resumo será enviada em uma resposta por conta própria depois que todos os outros resultados da consulta forem retornados.

SearchSearchAds360StreamResponse

Mensagem de resposta para SearchAds360Service.SearchStream.

Campos
results[]

SearchAds360Row

A lista de linhas que correspondem à consulta.
field_mask

FieldMask

FieldMask que representa quais campos foram solicitados pelo usuário.
summary_row

SearchAds360Row

Linha de resumo que contém o resumo das métricas nos resultados. O resumo das métricas significa a agregação de métricas em todos os resultados. Aqui, a agregação pode ser soma, média, taxa etc.
custom_column_headers[]

CustomColumnHeader

Os cabeçalhos das colunas personalizadas nos resultados.
conversion_custom_metric_headers[]

ConversionCustomMetricHeader

Os cabeçalhos das métricas personalizadas de conversão nos resultados.
conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

Os cabeçalhos da dimensão personalizada de conversão nos resultados.
raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

Os cabeçalhos das métricas de conversão de eventos brutos nos resultados.
raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Os cabeçalhos das dimensões de conversão de eventos brutos nos resultados.
request_id

string

O ID exclusivo da solicitação usado para fins de depuração.