Method: customers.searchAds360.searchStream

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

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

Solicitud HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

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 al que se realiza la consulta.

Cuerpo de la solicitud

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

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

string

Obligatorio. La cadena de consulta.
batchSize

integer

La cantidad de filas que se muestran en cada lote de respuesta de transmisión. Cuando se solicita un lote muy grande, el servidor puede decidir limitar aún más la cantidad de filas devueltas.
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á sola como respuesta después de que se muestren todos los demás resultados de la consulta.

Cuerpo de la respuesta

Mensaje de respuesta para SearchAds360Service.SearchStream.

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

Representación JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
Campos
results[]

object (SearchAds360Row)

La lista de filas que coincidieron con la consulta.
fieldMask

string (FieldMask format)

FieldMask que representa qué campos solicitó el usuario.

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

object (SearchAds360Row)

Fila de resumen que contiene un resumen de las métricas en los resultados. 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étera.
customColumnHeaders[]

object (CustomColumnHeader)

Los encabezados de las columnas personalizadas en los resultados.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

Los encabezados de las métricas personalizadas de conversión en los resultados.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Son los encabezados de la dimensión personalizada de conversión en los resultados.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Los encabezados de las métricas de conversión de eventos sin procesar en los resultados.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Los encabezados de las dimensiones de conversión de eventos sin procesar en los resultados.
requestId

string

El ID único de la solicitud que se utiliza para fines de depuración.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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