Récupérer des objets

Le GoogleAdsService est le service unifié de récupération d'objets et de création de rapports de l'API Google Ads. Ce service comporte des méthodes qui permettent d'effectuer les opérations suivantes :

• Récupérer des attributs spécifiques d'objets
• Récupérer des métriques sur les performances d'objets en fonction d'une plage de dates
• Trier des objets en fonction de leurs attributs
• Utiliser des conditions pour indiquer les objets que vous souhaitez renvoyer dans la réponse
• Limiter le nombre d'objets renvoyés

Le GoogleAdsService peut renvoyer des résultats de deux manières :

• GoogleAdsService.SearchStream renvoie toutes les lignes dans une seule réponse de streaming,ce qui est plus efficace pour les ensembles de résultats volumineux (plus de 10 000 lignes). Cette méthode peut être plus appropriée si votre application par lot souhaite télécharger le plus de données possible le plus rapidement possible.
• GoogleAdsService.Search divise les réponses volumineuses en pages de résultats gérables. Cette méthode peut être plus appropriée si votre application interactive affiche une page de résultats à la fois.

En savoir plus sur la pagination et le streaming.

Envoyer une requête

La méthode de recherche nécessite un SearchGoogleAdsRequest, qui se compose des attributs suivants :

• Un customer_id
• Une query du langage de requête Google Ads qui indique la ressource à interroger, les attributs, les segments et les métriques à récupérer, ainsi que les conditions à utiliser pour limiter les objets renvoyés
• (GoogleAdsService.Search uniquement) Un facultatif page_token pour récupérer le lot de résultats suivant lors de l'utilisation de la pagination.

Pour en savoir plus sur le langage de requête Google Ads, consultez le guide sur le langage de requête Google Ads.

Traiter une réponse

Le GoogleAdsService renvoie une liste d'objets GoogleAdsRow.

Chaque GoogleAdsRow représente un objet renvoyé par une requête et se compose d'un ensemble d'attributs qui sont renseignés en fonction des champs demandés dans la clause SELECT. Les attributs non inclus dans la clause SELECT ne sont pas renseignés dans les objets GoogleAdsRow de la réponse.

Par exemple, bien qu'un ad_group_criterion possède un attribut status, le champ status de l'attribut ad_group_criterion de la ligne n'est pas renseigné dans une réponse à une requête où la clause SELECT n'inclut pas ad_group_criterion.status. De même, l'attribut campaign de la ligne n'est pas renseigné si la clause SELECT n'inclut aucun champ de la ressource campaign.

Chaque GoogleAdsRow peut avoir des attributs et des métriques différents d'une autre ligne du même ensemble de résultats. Les lignes doivent donc être considérées comme des objets plutôt que comme des lignes fixes d'un tableau.

Types d'énumération INCONNUS

Les ressources renvoyées avec le type UNKNOWN ne sont pas entièrement compatibles avec cette version de l'API. Ces ressources peuvent avoir été créées via d'autres interfaces, telles que l'interface utilisateur Google Ads. Vous pouvez sélectionner des métriques lorsqu'une ressource est de type UNKNOWN, mais vous ne pouvez pas la modifier via l'API. Par exemple, une nouvelle campagne ou annonce peut être introduite dans l'interface utilisateur, mais n'est pas compatible avec la version de l'API que vous interrogez.

Voici quelques points à retenir :

• Une ressource de type UNKNOWN peut être compatible ultérieurement ou rester UNKNOWN indéfiniment.
• De nouveaux objets de type UNKNOWN peuvent apparaître à tout moment. Ces objets sont rétrocompatibles, car la valeur d'énumération est déjà disponible. Les ressources sont introduites avec cette modification dès qu'elles sont disponibles afin que vous disposiez d'une vue précise de votre compte. La ressource UNKNOWN peut apparaître en raison de nouvelles activités dans votre compte via d'autres interfaces ou lorsqu'une ressource n'est plus compatible.
• Des métriques détaillées peuvent être associées aux ressources UNKNOWN et peuvent être interrogées.
• Les ressources UNKNOWN sont généralement entièrement visibles dans l'interface utilisateur Google Ads.
• Les ressources UNKNOWN ne peuvent généralement pas être modifiées.

Segmentation

La réponse contient un GoogleAdsRow pour chaque combinaison des éléments suivants :

• Instance de la ressource principale spécifiée dans la clause FROM
• Valeur de chaque champ segment sélectionné

Par exemple, la réponse à une requête qui sélectionne FROM campaign et comporte segments.ad_network_type et segments.date dans la clause SELECT contient une ligne pour chaque combinaison des éléments suivants :

• campaign
• segments.ad_network_type
• segments.date

Les résultats sont segmentés de manière implicite par chaque instance de la ressource principale, et non par les valeurs des champs individuels sélectionnés. Par exemple,

SELECT campaign.status, metrics.impressions
FROM campaign
WHERE segments.date DURING LAST_14_DAYS

entraîne une ligne par campagne, et non une ligne par valeur distincte du campaign.status champ.