Search y SearchStream

Video: Informes

La API de Google Ads tiene un mecanismo unificado de informes de métricas y recuperación de atributos que te permite crear consultas con el Lenguaje de consulta de Google Ads. Esto permite realizar consultas complejas que pueden mostrar grandes cantidades de datos sobre cuentas individuales de Google Ads.

Puedes crear consultas con cualquiera de los métodos Search o SearchStream. Ambos métodos admiten las mismas consultas y muestran resultados equivalentes. El método Search muestra datos en páginas de tamaño fijo de 10,000 filas, lo que te permite iterar por un conjunto de resultados con la paginación. Esto podría ser ventajoso en condiciones de ancho de banda bajo o de red poco confiable, por ejemplo, para segmentar un conjunto de resultados grande en respuestas más pequeñas que se puedan volver a recuperar si se pierde una conexión. Por otro lado, el método SearchStream transmite todo el conjunto de resultados en una sola respuesta, lo que puede ser más eficiente para la recuperación masiva de datos.

Tanto Search como SearchStream usan la misma URL base:

    https://googleads.googleapis.com/v18/customers/CUSTOMER_ID/googleAds
POST /v18/customers/CUSTOMER_ID/googleAds:search HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

{
"query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'"
}

Si hay más de 10,000 filas en los resultados, se muestra un nextPageToken en la respuesta:

{
  "results": [
    // ...
    // ...
    // ...
  ],
  "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B",
  "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status"
}

Si repites la misma consulta con un pageToken agregado con los valores de la solicitud anterior, se recupera la siguiente página de resultados:

POST /v18/customers/CUSTOMER_ID/googleAds:search HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

{
"query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'",
"pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B"
}

Para usar el método SearchStream, que muestra todos los resultados en una sola respuesta transmitida, cambia el método de servicio en la URL a searchStream (SearchStream no requiere pageToken):

POST /v18/customers/CUSTOMER_ID/googleAds:searchStream HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

{
    "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'"
}