Récupération des objets

Objectif :comprendre comment récupérer des objets et des statistiques de performances à l'aide de GoogleAdsService. Pour en savoir plus sur les concepts de reporting, consultez les guides de reporting.

GoogleAdsService est le service unifié de récupération et de création de rapports sur les objets de l'API Google Ads. Le service dispose de méthodes qui:

• Récupérez des attributs spécifiques d'objets.
• Récupérez les métriques de performances des objets en fonction d'une plage de dates.
• Classer les objets en fonction de leurs attributs
• Utilisez des conditions pour indiquer les objets que vous souhaitez renvoyer dans la réponse.
• Limitez le nombre d'objets renvoyés.

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

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

En savoir plus sur la pagination par rapport au streaming

Envoyer une requête

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

• customer_id
• Un query de 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 page_size pour indiquer le nombre d'objets à renvoyer dans une seule réponse lors de l'utilisation de la pagination.
• (GoogleAdsService.Search uniquement) page_token facultatif 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 du langage de requête Google Ads.

Traiter une réponse

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 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 la réponse d'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 UNKNOWN

Les ressources renvoyées avec un 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, comme l'UI Google Ads. Vous pouvez sélectionner des métriques lorsqu'une ressource a un type UNKNOWN, mais vous ne pouvez pas modifier la ressource via l'API. Par exemple, une nouvelle campagne ou une nouvelle annonce est introduite dans l'UI, mais n'est pas compatible avec la version de l'API que vous interrogez.

Voici quelques points à prendre en compte:

• Une ressource de type UNKNOWN peut être prise en charge 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 de l'énumération est déjà disponible. Les ressources sont introduites avec ce changement, car elles sont disponibles pour vous permettre d'avoir 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 prise en charge.
• Les ressources UNKNOWN peuvent être associées à des métriques détaillées qui 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 mutées.

Segmentation

La réponse contient une 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 d'une requête qui sélectionne FROM campaign et contient segments.ad_network_type et segments.date dans la clause SELECT contiendra une ligne pour chaque combinaison des éléments suivants:

• campaign
• segments.ad_network_type
• segments.date

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

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

génère une ligne par campagne, et non une ligne par valeur distincte du champ campaign.status.