Method: customers.googleAds.search

Retorna todas as linhas que correspondem à consulta de pesquisa.

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

Solicitação HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}/googleAds:search

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. ID do cliente que está sendo consultado.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Campos
query

string

Obrigatório. A string de consulta.
pageToken

string

Token da página a ser recuperada. Se não for especificado, a primeira página de resultados será retornada. Use o valor extraído de nextPageToken na resposta anterior para solicitar a próxima página de resultados.
pageSize

integer

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

boolean

Se verdadeiro, a solicitação é validada, mas não executada.
returnTotalResultsCount

boolean

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
summaryRowSetting

enum (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 sozinha depois que todos os outros resultados da consulta forem retornados.

Corpo da resposta

Mensagem de resposta para GoogleAdsService.Search.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  }
}
Campos
results[]

object (GoogleAdsRow)

A lista de linhas que correspondem à consulta.
nextPageToken

string

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

string (int64 format)

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

string (FieldMask format)

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

Esta é uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

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.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.