Method: customers.searchAds360.searchStream

Retorna todas as linhas que correspondem à consulta do fluxo 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:searchStream

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

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. O 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,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Campos
query

string

Obrigatório. A string de consulta.
batchSize

integer

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

enum (SummaryRowSetting)

Determina se uma linha de resumo será retornada. Por padrão, a linha de resumo não é retornada. Se solicitada, 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 SearchAds360Service.SearchStream.

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

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

object (SearchAds360Row)

A lista de linhas que correspondem à consulta.
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. Resumo das métricas significa que a agregação de métricas em todos os resultados 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 da dimensão personalizada 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 brutas de conversão de eventos nos resultados.
requestId

string

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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