Method: customers.googleAds.searchStream

Muestra todas las filas que coinciden con la consulta del flujo de búsqueda.

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

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
customerId

string

Es obligatorio. El ID del cliente sobre el que se consulta.

Cuerpo de la solicitud

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

Representación JSON 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Campos
query

string

Es obligatorio. Es la cadena de consulta.
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á en una respuesta por sí sola después de que se muestren todos los demás resultados de la consulta.

Cuerpo de la respuesta

Mensaje de respuesta para GoogleAdsService.SearchStream.

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

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

object (GoogleAdsRow)

Es la lista de filas que coincidieron con la consulta.
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 totalmente calificados. Ejemplo: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

Es la fila de resumen que contiene el 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 puede ser la suma, el promedio, la tasa, etcétera.
requestId

string

El ID único de la solicitud que se usa para depurar.
queryResourceConsumption

string (int64 format)

Es la cantidad de recursos que se consumen para entregar la consulta. queryResourceConsumption para la fila Resumen y las respuestas que no son de Resumen se muestran por separado en sus respectivas filas. queryResourceConsumption para las respuestas que no son de Resumen se muestra en el lote final de resultados.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

SummaryRowSetting

Es un enum que describe la configuración de la fila de resumen de devoluciones.

Enumeraciones
UNSPECIFIED No se especifica.
UNKNOWN Representa los valores desconocidos de la fila de resumen de la devolución.
NO_SUMMARY_ROW No muestra la fila de resumen.
SUMMARY_ROW_WITH_RESULTS Muestra la fila de resumen junto con los resultados. La fila de resumen se mostrará solo en el último lote (el último lote no contendrá resultados).
SUMMARY_ROW_ONLY Muestra solo la fila de resumen y no muestra ningún resultado.