L'ancienne API Search Ads 360 Reporting va disparaître et sera mise hors service le 30 juin 2024. Notez que l'API Search Ads 360 Conversion n'est pas affectée et continuera d'être disponible. Tout nouveau développement de rapports doit utiliser la nouvelle API Search Ads 360 Reporting.

À partir d'avril 2024, une erreur "supportedApiVersion" s'affichera lorsque vous demanderez un rapport. En savoir plus

Par ailleurs, nous vous recommandons vivement de migrer toutes les implémentations Search Ads 360 existantes vers la nouvelle API. Pour en savoir plus, consultez le guide de démarrage et le guide de migration de la nouvelle API Search Ads 360 Reporting.

Cette page a été traduite par l'API Cloud Translation.

Reports: generate

Génère et renvoie immédiatement un rapport. Essayer maintenant

Requête

Requête HTTP :

POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate

Autorisation

Cette requête nécessite une autorisation dont la portée est la suivante:

Champ d'application
`https://www.googleapis.com/auth/doubleclicksearch`

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Dans le corps de la requête, fournissez les données avec la structure suivante:

{
  "reportScope": {
    "agencyId": long,
    "advertiserId": long,
    "engineAccountId": long,
    "campaignId": long,
    "adGroupId": long,
    "keywordId": long,
    "adId": long
  },
  "reportType": string,
  "columns": [
    {
      "columnName": string,
      "savedColumnName": string,
      "customDimensionName": string,
      "customMetricName": string,
      "headerText": string,
      "startDate": string,
      "endDate": string,
      "groupByColumn": boolean,
      "platformSource": string,
      "productReportPerspective": string
    }
  ],
  "timeRange": {
    "startDate": string,
    "endDate": string,
    "changedMetricsSinceTimestamp": datetime,
    "changedAttributesSinceTimestamp": datetime
  },
  "filters": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "operator": string,
      "values": [
        (value)
      ]
    }
  ],
  "orderBy": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "sortOrder": string
    }
  ],
  "includeDeletedEntities": boolean,
  "includeRemovedEntities": boolean,
  "verifySingleTimeZone": boolean,
  "downloadFormat": string,
  "statisticsCurrency": string,
  "startRow": integer,
  "rowCount": integer,
  "maxRowsPerFile": integer
}

Nom de propriété	Valeur	Description
`reportScope`	`object`	L'élément reportScope est un ensemble d'ID permettant de déterminer le sous-ensemble d'entités à inclure dans le rapport. Veuillez indiquer la traçabilité complète des ID du niveau de portée le plus bas souhaité via l'agence.
`reportScope.agencyId`	`long`	ID de l'agence DS.
`reportScope.advertiserId`	`long`	Référence annonceur DS.
`reportScope.engineAccountId`	`long`	ID du compte de moteur DS.
`reportScope.campaignId`	`long`	ID de campagne DS.
`reportScope.adGroupId`	`long`	ID du groupe d'annonces DS.
`reportScope.keywordId`	`long`	ID du mot clé DS.
`reportScope.adId`	`long`	ID de l'annonce DS.
`reportType`	`string`	Détermine le type de lignes à afficher dans le rapport. Par exemple, si vous spécifiez `reportType: keyword`, chaque ligne du rapport contient des données sur un mot clé. Pour en savoir plus sur les colonnes disponibles pour chaque type, consultez la page Types de rapports.
`columns[]`	`list`	Colonnes à inclure dans le rapport. Cela inclut à la fois les colonnes DoubleClick Search et les colonnes enregistrées. Pour les colonnes DoubleClick Search, seul le paramètre `columnName` est requis. Pour les colonnes enregistrées, seul le paramètre `savedColumnName` est requis. Vous ne pouvez pas définir à la fois `columnName` et `savedColumnName` dans le même bloc. Le nombre maximal de colonnes par requête est de 300.
`columns[].columnName`	`string`	Nom d'une colonne DoubleClick Search à inclure dans le rapport.
`columns[].savedColumnName`	`string`	Nom d'une colonne enregistrée à inclure dans le rapport. La portée du rapport doit être définie au niveau de l'annonceur ou à un niveau inférieur. En outre, la colonne enregistrée doit avoir été créée dans l'interface utilisateur de DoubleClick Search.
`columns[].headerText`	`string`	Texte utilisé pour identifier cette colonne dans le résultat du rapport. S'il n'est pas spécifié, la valeur par défaut est `columnName` ou `savedColumnName`. Cela permet d'éviter les conflits entre les colonnes DoubleClick Search et les colonnes enregistrées portant le même nom.
`columns[].startDate`	`string`	Date inclusive au format AAAA-MM-JJ. Lorsqu'elle est fournie, cette valeur remplace la période globale du rapport pour cette colonne uniquement. Doit être fourni avec `endDate`.
`columns[].endDate`	`string`	Jour inclusif au format AAAA-MM-JJ. Lorsqu'elle est fournie, cette valeur remplace la période globale du rapport pour cette colonne uniquement. Doit être fourni avec `startDate`.
`columns[].groupByColumn`	`boolean`	Rapport synchrone uniquement. Définissez la valeur sur `true` pour effectuer le regroupement d'après cette colonne. La valeur par défaut est `false`.
`timeRange`	`object`	Si des métriques sont demandées dans un rapport, cet argument sera utilisé pour les restreindre à une période spécifique.
`timeRange.startDate`	`string`	Date inclusive au format AAAA-MM-JJ.
`timeRange.endDate`	`string`	Date inclusive au format AAAA-MM-JJ.
`timeRange.changedMetricsSinceTimestamp`	`datetime`	Horodatage UTC inclusif au format RFC (par exemple, `2013-07-16T10:16:23.555Z`. Consultez des références supplémentaires sur le fonctionnement des rapports sur les métriques modifiées.
`timeRange.changedAttributesSinceTimestamp`	`datetime`	Horodatage UTC inclusif au format RFC (par exemple, `2013-07-16T10:16:23.555Z`. Consultez d'autres références concernant le fonctionnement des rapports sur les attributs modifiés.
`filters[]`	`list`	Liste des filtres à appliquer au rapport. Le nombre maximal de filtres par requête est de 300.
`filters[].column`	`nested object`	Colonne sur laquelle effectuer le filtre. Il peut s'agir d'une colonne DoubleClick Search ou d'une colonne enregistrée.
`filters[].column.columnName`	`string`	Nom d'une colonne DoubleClick Search à inclure dans le rapport.
`filters[].column.savedColumnName`	`string`	Nom d'une colonne enregistrée à inclure dans le rapport. La portée du rapport doit être définie au niveau de l'annonceur ou à un niveau inférieur. En outre, la colonne enregistrée doit avoir été créée dans l'interface utilisateur de DoubleClick Search.
`filters[].operator`	`string`	Opérateur à utiliser dans le filtre. Consultez la documentation de référence sur le filtre pour obtenir la liste des opérateurs disponibles.
`filters[].values[]`	`list`	Liste de valeurs avec lesquelles filtrer la valeur de colonne. Le nombre maximal de valeurs de filtre par requête est de 300.
`orderBy[]`	`list`	Rapport synchrone uniquement. Liste de colonnes et d'itinéraires définissant le tri à effectuer sur les lignes du rapport. Le nombre de commandes par demande est limité à 300.
`orderBy[].column`	`nested object`	Colonne sur laquelle effectuer le tri. Il peut s'agir d'une colonne DoubleClick Search définie ou d'une colonne enregistrée.
`orderBy[].column.columnName`	`string`	Nom d'une colonne DoubleClick Search à inclure dans le rapport.
`orderBy[].column.savedColumnName`	`string`	Nom d'une colonne enregistrée à inclure dans le rapport. La portée du rapport doit être définie au niveau de l'annonceur ou à un niveau inférieur. En outre, la colonne enregistrée doit avoir été créée dans l'interface utilisateur de DoubleClick Search.
`orderBy[].sortOrder`	`string`	Le sens de tri, qui est `ascending` ou `descending`.
`includeDeletedEntities`	`boolean`	Détermine si les entités supprimées doivent être incluses dans le rapport. La valeur par défaut est `false`. Obsolète. Veuillez utiliser `includeRemovedEntities` à la place.
`verifySingleTimeZone`	`boolean`	Si la valeur est `true`, le rapport n'est créé que si toutes les données statistiques demandées proviennent d'un seul fuseau horaire. La valeur par défaut est `false`.
`downloadFormat`	`string`	Format dans lequel le rapport doit être renvoyé. Actuellement, `csv` ou `tsv` sont compatibles.
`statisticsCurrency`	`string`	Spécifie la devise dans laquelle les montants seront renvoyés. Les valeurs possibles sont `usd`, `agency` (valide si le rapport est limité à une agence ou à un niveau inférieur), `advertiser` (valide si le rapport est limité à * annonceur ou à un niveau inférieur) ou `account` (valide si le rapport est limité à un compte de moteur).
`startRow`	`integer`	Rapport synchrone uniquement. Index basé sur zéro de la première ligne à renvoyer. Les valeurs autorisées vont de `0` à `50000`, inclus. La valeur par défaut est `0`.
`rowCount`	`integer`	Rapport synchrone uniquement. Nombre maximal de lignes à renvoyer. Les lignes supplémentaires sont supprimées. Les valeurs autorisées vont de `0` à `10000`, inclus. La valeur par défaut est `10000`.
`maxRowsPerFile`	`integer`	Rapport asynchrone uniquement. Nombre maximal de lignes par fichier de rapport. Un rapport volumineux est divisé en plusieurs fichiers en fonction de ce champ. Les valeurs autorisées vont de `1000000` à `100000000`, inclus.
`includeRemovedEntities`	`boolean`	Détermine si les entités supprimées doivent être incluses dans le rapport. La valeur par défaut est `false`.
`columns[].customDimensionName`	`string`	Segmente un rapport en fonction d'une dimension personnalisée. Le rapport doit être limité à un annonceur ou à un niveau inférieur. En outre, la dimension personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la dimension personnalisée, qui apparaît dans DoubleClick Search, est sensible à la casse. Si elle est utilisée dans un rapport sur les conversions, affiche la valeur de la dimension personnalisée spécifiée pour la conversion donnée, si elle est définie. Cette colonne ne segmente pas le rapport sur les conversions.
`columns[].platformSource`	`string`	Plate-forme utilisée pour fournir des données pour la dimension personnalisée. Valeurs acceptées : "projectlight".
`filters[].column.customDimensionName`	`string`	Segmente un rapport en fonction d'une dimension personnalisée. Le rapport doit être limité à un annonceur ou à un niveau inférieur. En outre, la dimension personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la dimension personnalisée, qui apparaît dans DoubleClick Search, est sensible à la casse. Si elle est utilisée dans un rapport sur les conversions, affiche la valeur de la dimension personnalisée spécifiée pour la conversion donnée, si elle est définie. Cette colonne ne segmente pas le rapport sur les conversions.
`filters[].column.headerText`	`string`	Texte utilisé pour identifier cette colonne dans le résultat du rapport. S'il n'est pas spécifié, la valeur par défaut est `columnName` ou `savedColumnName`. Cela permet d'éviter les conflits entre les colonnes DoubleClick Search et les colonnes enregistrées portant le même nom.
`filters[].column.startDate`	`string`	Date inclusive au format AAAA-MM-JJ. Lorsqu'elle est fournie, cette valeur remplace la période globale du rapport pour cette colonne uniquement. Doit être fourni avec `endDate`.
`filters[].column.endDate`	`string`	Jour inclusif au format AAAA-MM-JJ. Lorsqu'elle est fournie, cette valeur remplace la période globale du rapport pour cette colonne uniquement. Doit être fourni avec `startDate`.
`filters[].column.groupByColumn`	`boolean`	Rapport synchrone uniquement. Définissez la valeur sur `true` pour effectuer le regroupement d'après cette colonne. La valeur par défaut est `false`.
`filters[].column.platformSource`	`string`	Plate-forme utilisée pour fournir des données pour la dimension personnalisée. Valeurs acceptées : "projectlight".
`orderBy[].column.customDimensionName`	`string`	Segmente un rapport en fonction d'une dimension personnalisée. Le rapport doit être limité à un annonceur ou à un niveau inférieur. En outre, la dimension personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la dimension personnalisée, qui apparaît dans DoubleClick Search, est sensible à la casse. Si elle est utilisée dans un rapport sur les conversions, affiche la valeur de la dimension personnalisée spécifiée pour la conversion donnée, si elle est définie. Cette colonne ne segmente pas le rapport sur les conversions.
`orderBy[].column.headerText`	`string`	Texte utilisé pour identifier cette colonne dans le résultat du rapport. S'il n'est pas spécifié, la valeur par défaut est `columnName` ou `savedColumnName`. Cela permet d'éviter les conflits entre les colonnes DoubleClick Search et les colonnes enregistrées portant le même nom.
`orderBy[].column.startDate`	`string`	Date inclusive au format AAAA-MM-JJ. Lorsqu'elle est fournie, cette valeur remplace la période globale du rapport pour cette colonne uniquement. Doit être fourni avec `endDate`.
`orderBy[].column.endDate`	`string`	Jour inclusif au format AAAA-MM-JJ. Lorsqu'elle est fournie, cette valeur remplace la période globale du rapport pour cette colonne uniquement. Doit être fourni avec `startDate`.
`orderBy[].column.groupByColumn`	`boolean`	Rapport synchrone uniquement. Définissez la valeur sur `true` pour effectuer le regroupement d'après cette colonne. La valeur par défaut est `false`.
`orderBy[].column.platformSource`	`string`	Plate-forme utilisée pour fournir des données pour la dimension personnalisée. Valeurs acceptées : "projectlight".
`columns[].customMetricName`	`string`	Nom d'une métrique personnalisée à inclure dans le rapport. Le rapport doit être limité à un annonceur ou à un niveau inférieur. En outre, la statistique personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la métrique personnalisée, qui apparaît dans DoubleClick Search, est sensible à la casse.
`filters[].column.customMetricName`	`string`	Nom d'une métrique personnalisée à inclure dans le rapport. Le rapport doit être limité à un annonceur ou à un niveau inférieur. En outre, la statistique personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la métrique personnalisée, qui apparaît dans DoubleClick Search, est sensible à la casse.
`orderBy[].column.customMetricName`	`string`	Nom d'une métrique personnalisée à inclure dans le rapport. Le rapport doit être limité à un annonceur ou à un niveau inférieur. En outre, la statistique personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la métrique personnalisée, qui apparaît dans DoubleClick Search, est sensible à la casse.
`columns[].productReportPerspective`	`string`	Affiche des métriques uniquement pour un type d'activité spécifique du produit. Valeurs acceptées: "`sold`" : renvoie des métriques uniquement pour les produits vendus "`advertised`" : renvoie des métriques uniquement pour les produits qui ont fait l'objet d'une promotion dans une campagne Shopping, et qui peuvent ou non avoir été vendus
`filters[].column.productReportPerspective`	`string`	Affiche des métriques uniquement pour un type d'activité spécifique du produit. Valeurs acceptées : "`sold`" : renvoie des métriques uniquement pour les produits vendus "`advertised`" : renvoie des métriques uniquement pour les produits qui ont fait l'objet d'une promotion dans une campagne Shopping, et qui peuvent ou non avoir été vendus
`orderBy[].column.productReportPerspective`	`string`	Affiche des métriques uniquement pour un type d'activité spécifique du produit. Valeurs acceptées : "`sold`" : renvoie des métriques uniquement pour les produits vendus "`advertised`" : renvoie des métriques uniquement pour les produits qui ont fait l'objet d'une promotion dans une campagne Shopping, et qui peuvent ou non avoir été vendus

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource "Reports" dans le corps de réponse.

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse. Vous pouvez également essayer l'explorateur autonome.