A nova API Search Ads 360 Reporting já está disponível. Participe do grupo do Google searchads-api-announcements para ficar por dentro das próximas melhorias e versões.

Esta página foi traduzida pela API Cloud Translation.

Package google.ads.searchads360.v0.services

Índice

CustomColumnService (interface)
CustomerService (interface)
SearchAds360FieldService (interface)
SearchAds360Service (interface)
ConversionCustomDimensionHeader (mensagem)
ConversionCustomMetricHeader (mensagem)
CustomColumnHeader (mensagem)
GetCustomColumnRequest (mensagem)
GetSearchAds360FieldRequest (mensagem)
ListAccessibleCustomersRequest (mensagem)
ListAccessibleCustomersResponse (mensagem)
ListCustomColumnsRequest (mensagem)
ListCustomColumnsResponse (mensagem)
RawEventConversionDimensionHeader (mensagem)
RawEventConversionMetricHeader (mensagem)
SearchAds360Row (mensagem)
SearchSearchAds360FieldsRequest (mensagem)
SearchSearchAds360FieldsResponse (mensagem)
SearchSearchAds360Request (mensagem)
SearchSearchAds360Response (mensagem)
SearchSearchAds360StreamRequest (mensagem)
SearchSearchAds360StreamResponse (mensagem)

CustomColumnService

Serviço para gerenciar colunas personalizadas.

GetCustomColumn

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`

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

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`

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

ListAccessibleCustomers
`rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)` Retorna nomes de recursos de 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`

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

Retorna nomes de recursos de 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

GetSearchAds360Field
`rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)` Retorna apenas 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`

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

Retorna apenas 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

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`

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

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`

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

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`

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

Campos
`id`	`int64` O ID da dimensão personalizada da conversão.
`name`	`string` O nome definido pelo usuário para a dimensão personalizada de conversão.

id

int64

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

name

string

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

ConversionCustomMetricHeader

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

Campos

Campos
`id`	`int64` O ID da métrica personalizada de conversão.
`name`	`string` O nome definido pelo usuário para a métrica personalizada de conversão.

id

int64

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

name

string

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

CustomColumnHeader

Mensagem sobre o cabeçalho da coluna personalizada.

Campos

Campos
`id`	`int64` O ID da coluna personalizada.
`name`	`string` O nome definido pelo usuário para a coluna personalizada.
`references_metrics`	`bool` Verdadeiro quando a coluna personalizada faz referência a métricas.

id

int64

O ID da coluna personalizada.

name

string

O nome definido pelo usuário para a 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

Campos
`resource_name`	`string` Obrigatório. O nome do recurso da coluna personalizada a ser buscada.

resource_name

string

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

GetSearchAds360FieldRequest

Mensagem de solicitação para SearchAds360FieldService.GetSearchAds360Field.

Campos

Campos
`resource_name`	`string` Obrigatório. O nome do recurso do campo a ser recebido.

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

Campos
`resource_names[]`	`string` Nome de recurso dos clientes diretamente acessível pelo usuário que autentica a chamada.

resource_names[]

string

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

ListCustomColumnsRequest

Solicitar mensagem para CustomColumnService.ListCustomColumns

Campos

Campos
`customer_id`	`string` Obrigatório. O ID do cliente ao qual aplicar a operação de lista CustomColumn.

customer_id

string

Obrigatório. O ID do cliente ao qual aplicar a operação de lista CustomColumn.

ListCustomColumnsResponse

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

Campos

Campos
`custom_columns[]`	`CustomColumn` O CustomColumns do cliente fornecido.

custom_columns[]

CustomColumn

O CustomColumns do cliente fornecido.

RawEventConversionDimensionHeader

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

Campos

Campos
`id`	`int64` O ID da variável personalizada de conversão.
`name`	`string` O nome definido pelo usuário da dimensão do evento bruto.

id

int64

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

name

string

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

RawEventConversionMetricHeader

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

Campos

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

id

int64

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

name

string

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

Linha do SearchAds360

Uma linha retornada da consulta.

Campos
`ad_group`	`AdGroup` Grupo de anúncios mencionado na consulta.
`ad_group_ad`	`AdGroupAd` O anúncio mencionado na consulta.
`ad_group_ad_label`	`AdGroupAdLabel` O rótulo do anúncio do grupo de anúncios mencionado na consulta.
`ad_group_asset`	`AdGroupAsset` O recurso do grupo de anúncios mencionado na consulta.
`ad_group_asset_set`	`AdGroupAssetSet` O conjunto de recursos do grupo de anúncios mencionado na consulta.
`ad_group_audience_view`	`AdGroupAudienceView` A visualização do público-alvo do grupo de anúncios mencionada na consulta.
`ad_group_bid_modifier`	`AdGroupBidModifier` O modificador de lance mencionado na consulta.
`ad_group_criterion`	`AdGroupCriterion` O critério indicado na consulta.
`ad_group_criterion_label`	`AdGroupCriterionLabel` O rótulo do critério do grupo de anúncios mencionado na consulta.
`ad_group_label`	`AdGroupLabel` O rótulo do grupo de anúncios mencionado 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 do grupo de recursos mencionado na consulta.
`asset_group_top_combination_view`	`AssetGroupTopCombinationView` A visualização de combinação superior do grupo de recursos mencionada 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` Estratégia de lances mencionada na consulta.
`campaign_budget`	`CampaignBudget` Orçamento da campanha mencionado na consulta.
`campaign`	`Campaign` A campanha mencionada na consulta.
`campaign_asset`	`CampaignAsset` O recurso da campanha mencionado na consulta.
`campaign_asset_set`	`CampaignAssetSet` O conjunto de recursos da campanha referenciado na consulta.
`campaign_audience_view`	`CampaignAudienceView` A visualização do público-alvo da campanha mencionada na consulta.
`campaign_criterion`	`CampaignCriterion` O critério de campanha indicado na consulta.
`campaign_label`	`CampaignLabel` O rótulo da campanha mencionado na consulta.
`cart_data_sales_view`	`CartDataSalesView` Visualização de vendas de dados do carrinho mencionada na consulta.
`audience`	`Audience` O público-alvo mencionado na consulta.
`conversion_action`	`ConversionAction` Ação de conversão mencionada na consulta.
`conversion_custom_variable`	`ConversionCustomVariable` A variável personalizada de conversão referenciada na consulta.
`customer`	`Customer` O cliente mencionado na consulta.
`customer_asset`	`CustomerAsset` O recurso do cliente mencionado na consulta.
`customer_asset_set`	`CustomerAssetSet` O conjunto de recursos do cliente mencionado na consulta.
`accessible_bidding_strategy`	`AccessibleBiddingStrategy` A estratégia de lances acessível mencionada na consulta.
`customer_manager_link`	`CustomerManagerLink` O CustomerManagerLink mencionado na consulta.
`customer_client`	`CustomerClient` O CustomerClient mencionado na consulta.
`dynamic_search_ads_search_term_view`	`DynamicSearchAdsSearchTermView` Visualização do termo de pesquisa dos anúncios dinâmicos de pesquisa mencionada 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` Visualização de palavra-chave referenciada na consulta.
`label`	`Label` O rótulo referenciado na consulta.
`language_constant`	`LanguageConstant` A constante de linguagem referenciada na consulta.
`location_view`	`LocationView` A visualização do local referenciada na consulta.
`product_bidding_category_constant`	`ProductBiddingCategoryConstant` A categoria de lances do produto mencionada na consulta.
`product_group_view`	`ProductGroupView` A visualização do grupo de produtos referenciada na consulta.
`shopping_performance_view`	`ShoppingPerformanceView` A visualização de desempenho de compras referenciada na consulta.
`user_list`	`UserList` A lista de usuários referenciada na consulta.
`webpage_view`	`WebpageView` A visualização da página da Web mencionada 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` Colunas personalizadas

SearchSearchAds360FieldsRequest

Mensagem de solicitação para SearchAds360FieldService.SearchSearchAds360Fields.

Campos

Campos
`query`	`string` Obrigatório. A string de consulta.
`page_token`	`string` Token da página a ser recuperada. Caso não seja 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.

query

string

Obrigatório. A string de consulta.

page_token

string

Token da página a ser recuperada. Caso não seja 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

Campos
`results[]`	`SearchAds360Field` 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.

results[]

SearchAds360Field

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. ID do cliente que está sendo consultado.
`query`	`string` Obrigatório. A string de consulta.
`page_token`	`string` Token da página a ser recuperada. Caso não seja 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 verdadeiro, a solicitação é 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 só 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 um resumo das métricas nos resultados. Resumo de métricas significa 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 brutas de conversão de eventos 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. ID do cliente que está sendo 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 só 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 um resumo das métricas nos resultados. Resumo de métricas significa 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 brutas de conversão de eventos 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.