Method: customers.searchAds360.search

Retorna todas as linhas que correspondem à consulta de pesquisa.

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

Solicitação HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:search

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

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. O ID do cliente 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 recebido 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 for verdadeiro, a solicitação será 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 por conta própria depois que todos os outros resultados da consulta forem retornados.

Corpo da resposta

Mensagem de resposta para SearchAds360Service.Search.

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

Representação JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
Campos
results[]

object (SearchAds360Row)

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.

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

object (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.
customColumnHeaders[]

object (CustomColumnHeader)

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

object (ConversionCustomMetricHeader)

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

object (ConversionCustomDimensionHeader)

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

object (RawEventConversionMetricHeader)

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

object (RawEventConversionDimensionHeader)

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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