- 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 pesquisa.
Lista de erros gerados: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
Solicitação HTTP
POST https://googleads.googleapis.com/v17/customers/{customerId}/googleAds:search
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
customerId |
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,
"pageToken": string,
"pageSize": integer,
"validateOnly": boolean,
"returnTotalResultsCount": boolean,
"summaryRowSetting": enum ( |
Campos | |
---|---|
query |
Obrigatório. A string de consulta. |
pageToken |
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 |
pageSize |
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 |
Se for verdadeiro, a solicitação será validada, mas não executada. |
returnTotalResultsCount |
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 |
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 GoogleAdsService.Search
.
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. |
nextPageToken |
Token de paginação usado para recuperar a próxima página de resultados. Transmita o conteúdo dessa string como o atributo |
totalResultsCount |
Número total de resultados que correspondem à consulta ignorando a cláusula LIMIT. |
fieldMask |
FieldMask que representa quais campos foram solicitados pelo usuário. É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
summaryRow |
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. |
queryResourceConsumption |
A quantidade de recursos consumidas para atender à consulta. |
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.