Structure d'une requête

**Conseil** : Utilisez le générateur de requêtes interactif pour créer et valider vos requêtes GAQL.

Les requêtes sur des champs de ressource, de segment et de métrique peuvent être envoyées aux GoogleAdsService Search ou SearchStream méthodes. Pour créer une requête dans le langage de requête Google Ads, vous devez utiliser la grammaire du langage. Pour obtenir une présentation générale du langage de requête Google Ads, consultez la page Présentation du langage de requête Google Ads. Une requête est composée de plusieurs clauses :

• SELECT
• FROM
• WHERE
• ORDER BY
• LIMIT
• PARAMETERS

Les clauses utilisent des noms de champ, des noms de ressource, des opérateurs, des conditions et des tris pour vous aider à sélectionner les données appropriées. Une fois ces éléments combinés en une seule requête, celle-ci peut être exécutée à l'aide de l'API Google Ads.

Point clé : Le GoogleAdsFieldService fournit un catalogue aux clients du langage de requête Google Ads avec des métadonnées sur tous les champs de ressource, les champs de segment et les métriques, ainsi que leurs relations et leur disponibilité dans chaque clause. Pour en savoir plus, consultez la documentation de GoogleAdsField.

Clauses

Vidéo : Compatibilité des champs GAQL

SELECT

La clause SELECT spécifie un ensemble de champs à extraire dans la requête. SELECT utilise une liste de métriques et de champs de segment séparés par une virgule, renvoyant les valeurs dans la réponse. La clause SELECT est obligatoire dans une requête.

L'exemple de requête ci-dessous montre comment sélectionner des attributs pour une ressource donnée :

SELECT
  campaign.id,
  campaign.name
FROM campaign

Vous pouvez demander différents types de champs dans une même requête, par exemple :

SELECT
  campaign.id,
  campaign.name,
  bidding_strategy.id,
  bidding_strategy.name,
  segments.device,
  segments.date,
  metrics.impressions,
  metrics.clicks
FROM campaign
WHERE segments.date DURING LAST_30_DAYS

• Champs de ressource

  • campaign.id
  • campaign.name

• Champs de ressource

  • bidding_strategy.id
  • bidding_strategy.name

• Champs de segment

  • segments.device
  • segments.date

• Métriques

  • metrics.impressions
  • metrics.clicks

Remarque : Certains champs peuvent ne pas être autorisés dans la clause SELECT en raison des restrictions suivantes :

• Interrogation de champs qui ne peuvent pas être sélectionnés. L'attribut de métadonnées Selectable de ces champs est défini sur false.
• Sélection d'attributs de champs répétés. L'attribut de métadonnées isRepeated de ces champs est défini sur true.
• Sélection de champs qui ne sont pas disponibles pour la ressource donnée dans la clause FROM. Les attributs de certaines ressources ne peuvent pas être sélectionnés ensemble. De plus, seul un sous-ensemble de toutes les métriques et de tous les segments sera disponible pour la ressource dans la clause FROM.
• Sélection de segments ou de métriques qui ne sont pas compatibles entre eux. Pour en savoir plus, consultez la section sur la segmentation.

Vous trouverez des informations sur les conditions ci-dessus dans notre documentation de référence ou dans GoogleAdsFieldService.

FROM

La clause FROM spécifie la ressource principale qui sera renvoyée. La ressource de la clause FROM définit les champs qui peuvent être utilisés par toutes les autres clauses d'une requête donnée. Une seule ressource peut être spécifiée dans la clause FROM. La clause FROM est obligatoire dans une requête adressée aux GoogleAdsService Search ou SearchStream méthodes. Toutefois, la clause FROM ne doit pas être spécifiée lorsque vous utilisez GoogleAdsFieldService.

Bien qu'une seule ressource puisse exister dans la clause FROM pour une requête donnée, les champs des ressources attribuées peuvent également être disponibles. Ces ressources sont jointes implicitement à la ressource de la clause FROM. Vous n'avez donc qu'à ajouter leurs attributs à la clause SELECT pour renvoyer leurs valeurs. Toutes les ressources ne disposent pas de ressources attribuées. Dans l'exemple suivant, vous pouvez demander à la fois l'ID du groupe d'annonces et l'ID de campagne à partir des groupes d'annonces :

SELECT
  campaign.id,
  ad_group.id
FROM ad_group

Le champ resource_name de la ressource principale est toujours renvoyé. Dans l'exemple suivant, ad_group.resource_name sera inclus dans la réponse, même s'il n'est pas explicitement sélectionné dans la requête :

SELECT ad_group.id
FROM ad_group

Il en va de même pour les autres ressources lorsqu'au moins un champ est sélectionné. Par exemple, campaign.resource_name sera inclus dans la réponse pour la requête suivante :

SELECT
  campaign.id,
  ad_group.id
FROM ad_group

Important : Si la ressource de la clause FROM répertorie une autre ressource en tant que segment, la sélection d'attributs de cette ressource agira comme un segment.

WHERE

La clause WHERE spécifie les conditions à appliquer lors du filtrage des données pour la requête. Lorsque vous utilisez la clause WHERE, une ou plusieurs conditions peuvent être spécifiées en utilisant AND comme séparateur. Chaque condition doit suivre le modèle field_name Operator value. La clause WHERE est facultative dans une requête.

Voici un exemple d'utilisation de WHERE pour afficher des métriques d'une période donnée :

SELECT
  campaign.id,
  campaign.name,
  metrics.impressions
FROM campaign
WHERE segments.date DURING LAST_30_DAYS

Vous pouvez combiner plusieurs conditions pour filtrer les données. Cet exemple demande le nombre de clics pour toutes les campagnes ayant généré des impressions sur mobile au cours des 30 derniers jours.

SELECT
  campaign.id,
  campaign.name,
  segments.device,
  metrics.clicks
FROM campaign
WHERE metrics.impressions > 0
  AND segments.device = MOBILE
  AND segments.date DURING LAST_30_DAYS

Les segments de la clause WHERE doivent figurer dans la clause SELECT, à l'exception des segments de date suivants, appelés segments de date principaux, :

• segments.date
• segments.week
• segments.month
• segments.quarter
• segments.year

Dans la requête suivante, notez que segments.date est sélectionné. Étant donné que ce segment est un segment de date principal, il nécessite qu'une plage de dates finie composée de segments de date principaux soit fournie dans la clause WHERE.

SELECT
  campaign.id,
  campaign.name,
  segments.date,
  metrics.clicks
FROM campaign
WHERE segments.date DURING LAST_30_DAYS

Tous les segments qui répondent à la condition ci-dessus sont les suivants : segments.date, segments.week, segments.month, segments.quarter et segments.year. Si l'un de ces segments est sélectionné, au moins l'un d'eux doit être utilisé dans la clause WHERE.

Pour en savoir plus sur le filtrage par date, consultez la section Plages de dates.

Important : Le séparateur AND ne peut être utilisé qu'entre des conditions d'opérateur (WHERE segments.device != "DESKTOP" AND segments.device != "MOBILE"), et non au sein d'une même condition d'opérateur (WHERE segments.device != "DESKTOP" AND "MOBILE"),

Lorsque vous filtrez, il est important de tenir compte de la sensibilité à la casse de votre opérateur. Pour en savoir plus, consultez la section Sensibilité à la casse.

Pour obtenir la liste complète des opérateurs, consultez la grammaire du langage.

ORDER BY

La clause ORDER BY spécifie l'ordre dans lequel les résultats doivent être renvoyés. Cela vous permet d'organiser les données par ordre croissant ou décroissant en fonction d'un nom de champ. Chaque tri est spécifié sous la forme field_name suivi de ASC ou DESC. Si ni ASC ni DESC ne sont spécifiés, l'ordre par défaut est ASC. La clause ORDER BY est facultative dans une requête.

La requête suivante trie les campagnes affichées par nombre de clics, du plus élevé au plus faible :

SELECT
  campaign.name,
  metrics.clicks
FROM campaign
ORDER BY metrics.clicks DESC

Vous pouvez spécifier plusieurs champs dans la clause ORDER BY à l'aide d'une liste d'éléments séparés par une virgule. Le tri s'effectue dans la même séquence que celle spécifiée dans la requête. Par exemple, dans cette requête qui sélectionne les données de groupe d'annonces, les résultats sont triés par ordre croissant du nom de la campagne, puis par nombre décroissant d'impressions, puis par nombre décroissant de clics :

SELECT
  campaign.name,
  ad_group.name,
  metrics.impressions,
  metrics.clicks
FROM ad_group
ORDER BY
  campaign.name,
  metrics.impressions DESC,
  metrics.clicks DESC

LIMIT

La clause LIMIT vous permet de spécifier le nombre de résultats à afficher. Elle est utile si vous ne souhaitez obtenir qu'un récapitulatif.

Par exemple, LIMIT peut être utilisé pour limiter le nombre total de résultats pour la requête suivante :

SELECT
  campaign.name,
  ad_group.name,
  segments.device,
  metrics.impressions
FROM ad_group
ORDER BY metrics.impressions DESC
LIMIT 50

Important : LIMIT vous permet de tronquer les résultats. Utilisez GoogleAdsService.Search pour gérer de longues listes de résultats.

PARAMETERS

La clause PARAMETERS vous permet de spécifier des méta-paramètres pour la requête. Ces paramètres peuvent avoir un impact sur les types de lignes renvoyées.

Les méta-paramètres suivants sont acceptés :

include_drafts

Définissez include_drafts sur true pour autoriser le renvoi d'entités brouillons. La valeur par défaut est false.

Par exemple, la requête suivante extrait les campagnes brouillons ainsi que les campagnes standards :

SELECT campaign.name
FROM campaign
PARAMETERS include_drafts=true

omit_unselected_resource_names

Définissez omit_unselected_resource_names sur true pour empêcher le renvoi du nom de ressource de chaque type de ressource dans la réponse, sauf s'il est explicitement demandé dans la clause SELECT. La valeur par défaut est false.

Remarque : Si vous prévoyez d'utiliser l'un des objets renvoyés pour des opérations de mise à jour ou de suppression, nous vous recommandons de définir cette option sur false car les ressources sans nom de ressource ne peuvent pas être utilisées dans les opérations de mutation. Si vous définissez cette option sur true, assurez-vous de demander explicitement les noms de ressource de la ressource principale et de toutes les ressources d'attributs que vous extrayez à l'aide de la requête.

Exemples d'omit_unselected_resource_names
SELECT campaign.name, customer.id FROM campaign	Returned resources: campaign.resource_name customer.resource_name omit_unselected_resource_names est défini par défaut sur false. Tous les champs resource_name sont donc renvoyés.
SELECT campaign.name, customer.id FROM campaign PARAMETERS omit_unselected_resource_names = true	Returned resources: Aucune. est spécifié comme true et campaign.resource_name et customer.resource_name ne font pas partie de la clause SELECT.omit_unselected_resource_names
SELECT campaign.name, campaign.resource_name FROM campaign PARAMETERS omit_unselected_resource_names = true	Returned resource: campaign.resource_name omit_unselected_resource_names est spécifié comme true et campaign.resource_name est demandé dans la clause SELECT.

Règles de langage supplémentaires

En plus des exemples pour chaque clause, le langage de requête Google Ads présente les comportements suivants qui peuvent être utilisés :

• Il n'est pas nécessaire que le champ de ressource principal figure dans la clause SELECT d'une requête. Par exemple, vous pouvez n'utiliser qu'un ou plusieurs champs de ressource principaux pour filtrer les données :

  SELECT campaign.id
  FROM ad_group
  WHERE ad_group.status = PAUSED
  

• Les métriques peuvent être sélectionnées exclusivement pour une ressource donnée. Aucun autre champ de la ressource n'est requis dans la requête :

  SELECT
    metrics.impressions,
    metrics.clicks,
    metrics.cost_micros
  FROM campaign
  

• Les champs de segmentation peuvent être sélectionnés sans aucun champ de ressource ni aucune métrique :

  SELECT segments.device FROM campaign
  

• Le champ resource_name (campaign.resource_name, par exemple) peut être utilisé pour filtrer ou trier les données :

  SELECT
    campaign.id,
    campaign.name
  FROM campaign
  WHERE campaign.resource_name = 'customers/1234567/campaigns/987654'