Method: customers.googleAds.search

Muestra todas las filas que coinciden con la búsqueda.

Lista de errores arrojados: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

Solicitud HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}/googleAds:search

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
customerId

string

Obligatorio. El ID del cliente a quien se consulta.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Campos
query

string

Obligatorio. Cadena de consulta
pageToken

string

El token de la página que se recuperará. Si no se especifica, se mostrará la primera página de resultados. Usa el valor obtenido de nextPageToken en la respuesta anterior para solicitar la siguiente página de resultados.
pageSize

integer

Cantidad de elementos que se recuperan en una sola página. Cuando se solicita una página demasiado grande, el servidor puede decidir limitar aún más la cantidad de recursos que se muestran.
validateOnly

boolean

Si es verdadera, la solicitud se valida, pero no se ejecuta.
returnTotalResultsCount

boolean

Si es verdadero, el número total de resultados que coinciden con la consulta ignorando la cláusula LIMIT se incluirá en la respuesta. El valor predeterminado es falso.
summaryRowSetting

enum (SummaryRowSetting)

Determina si se mostrará una fila de resumen. De forma predeterminada, no se muestra la fila de resumen. Si se solicita, la fila de resumen se enviará por sí misma en una respuesta después de que se muestren todos los demás resultados de la consulta.

Cuerpo de la respuesta

Mensaje de respuesta para GoogleAdsService.Search.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  }
}
Campos
results[]

object (GoogleAdsRow)

La lista de filas que coincidieron con la consulta.
nextPageToken

string

Es el token de paginación que se usa para recuperar la siguiente página de resultados. Pasa el contenido de esta string como el atributo pageToken de la siguiente solicitud. No se muestra nextPageToken para la última página.
totalResultsCount

string (int64 format)

Número total de resultados que coinciden con la consulta ignorando la cláusula LIMIT.
fieldMask

string (FieldMask format)

FieldMask que representa los campos que solicitó el usuario.

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

Fila de resumen que contiene un resumen de las métricas en los resultados. El resumen de métricas significa la agregación de métricas en todos los resultados, aquí la agregación podría ser suma, promedio, tasa, etc.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.