- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Retorna todas as linhas que correspondem à consulta de 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/v14/customers/{customerId}/googleAds:searchStream
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
customerId |
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,
"summaryRowSetting": enum ( |
Campos | |
---|---|
query |
Obrigatório. A string de consulta. |
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.SearchStream
.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "results": [ { object ( |
Campos | |
---|---|
results[] |
A lista de linhas que correspondem à consulta. |
fieldMask |
FieldMask que representa quais campos foram solicitados pelo usuário. Esta é uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
summaryRow |
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. |
requestId |
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/adwords
Para mais informações, consulte a Visão geral do OAuth 2.0.