Method: customers.googleAds.searchStream

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

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

Solicitação HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

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,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Campos
query

string

Obrigatório. A string de consulta.
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 GoogleAdsService.SearchStream.

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

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

object (GoogleAdsRow)

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 (GoogleAdsRow)

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

string

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

string (int64 format)

A quantidade de recursos consumidos para atender a consulta. O consumo de recursos de consulta para a linha "Resumo" e as respostas que não são de resumo são retornados separadamente nas respectivas linhas. O consumo de recursos de consulta para respostas que não são de resumo é retornado no lote final de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

SummaryRowSetting

Enumeração que descreve as configurações da linha de resumo de retorno.

Enums
UNSPECIFIED Não especificado.
UNKNOWN Representa valores desconhecidos da linha de resumo de retorno.
NO_SUMMARY_ROW Não retorna a linha de resumo.
SUMMARY_ROW_WITH_RESULTS Retorna a linha de resumo com os resultados. A linha de resumo será retornada apenas no último lote, que não terá resultados.
SUMMARY_ROW_ONLY Retorna apenas a linha de resumo e não retorna resultados.