Recherche et SearchStream

Vidéo: rapports

L'API Google Ads dispose d'un mécanisme unifié de récupération des attributs et de rapports sur les métriques qui vous permet de créer des requêtes à l'aide du langage de requête Google Ads. Cela permet d'effectuer des requêtes complexes pouvant afficher de grandes quantités de données sur des comptes Google Ads individuels.

Vous pouvez créer des requêtes à l'aide des méthodes Search ou SearchStream. Les deux méthodes acceptent les mêmes requêtes et renvoient des résultats équivalents. La méthode Search renvoie les données dans des tailles de page personnalisables, ce qui vous permet d'itérer un ensemble de résultats à l'aide de la pagination. Cela peut être avantageux en cas de bande passante faible ou de conditions de réseau peu fiables, par exemple pour segmenter un grand ensemble de résultats en réponses plus petites qui peuvent être récupérées en cas de perte de connexion. En revanche, la méthode SearchStream renvoie l'ensemble du résultat défini dans une seule réponse, ce qui peut être plus efficace pour la récupération groupée de données.

Search et SearchStream utilisent la même URL de base:

    https://googleads.googleapis.com/v16/customers/CUSTOMER_ID/googleAds

La méthode de recherche basée sur la page accepte un paramètre pageSize facultatif qui limite le nombre de résultats renvoyés dans une seule réponse d'API.

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

{
"pageSize": 10000,
"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'"
}

S'il y a plus de lignes dans les résultats que pageSize, une nextPageToken est renvoyée dans la réponse:

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

Répéter la même requête avec un pageToken ajouté avec la valeur ci-dessus récupère la page de résultats suivante:

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

{
"pageSize": 10000,
"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"
}

Pour utiliser la méthode SearchStream, qui renvoie tous les résultats dans une seule réponse diffusée, il vous suffit de remplacer la méthode de service dans l'URL par searchStream (pageSize et pageToken ne sont pas requis par SearchStream):

POST /v16/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'"
}