Method: customers.searchAds360.search

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

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

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
customerId

string

Obligatorio. Es el ID del cliente que 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. Es la cadena de consulta.
pageToken

string

Es 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

Es la cantidad de elementos que se recuperarán 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 verdadero, la solicitud se valida, pero no se ejecuta.
returnTotalResultsCount

boolean

Si es verdadero, la cantidad total de resultados que coinciden con la consulta, sin tener en cuenta 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á 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 SearchAds360Service.Search.

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

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

object (SearchAds360Row)

Es 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 cadena como el atributo pageToken de la siguiente solicitud. nextPageToken no se muestra en la última página.
totalResultsCount

string (int64 format)

Es la cantidad total de resultados que coinciden con la consulta, sin tener en cuenta la cláusula LIMIT.
fieldMask

string (FieldMask format)

Es 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 (SearchAds360Row)

Es la fila de resumen que contiene el resumen de las métricas en los resultados. El resumen de las métricas significa la agregación de métricas en todos los resultados. Aquí, la agregación podría ser la suma, el promedio, la tasa, etcétera.
customColumnHeaders[]

object (CustomColumnHeader)

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

object (ConversionCustomMetricHeader)

Son los encabezados de las métricas personalizadas de conversiones en los resultados.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Son los encabezados de las dimensiones personalizadas de conversiones en los resultados.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Son los encabezados de las métricas de conversiones de eventos sin procesar en los resultados.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Son los encabezados de las dimensiones de conversiones de eventos sin procesar en los resultados.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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