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 ayant le champ d'application suivant:

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 selon 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`	reportScope est un ensemble d'ID permettant de déterminer quel sous-ensemble d'entités sera renvoyé dans le rapport. La traçabilité complète des ID depuis le niveau le plus bas souhaité jusqu'à l'agence est requise.
`reportScope.agencyId`	`long`	ID d'agence DS.
`reportScope.advertiserId`	`long`	référence annonceur DS.
`reportScope.engineAccountId`	`long`	ID de 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`	l'identifiant de l'annonce DS.
`reportType`	`string`	Détermine le type de lignes renvoyées dans le rapport. Par exemple, si vous spécifiez `reportType: keyword`, chaque ligne du rapport contiendra des données sur un mot clé. Consultez la documentation de référence sur les types de rapports pour connaître les colonnes disponibles pour chaque type.
`columns[]`	`list`	Colonnes à inclure dans le rapport. Cela inclut les colonnes DoubleClick Search et les colonnes enregistrées. Pour les colonnes DoubleClick Search, seul le paramètre `columnName` est obligatoire. Pour les colonnes enregistrées, seul le paramètre `savedColumnName` est obligatoire. `columnName` et `savedColumnName` ne peuvent pas être définis 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, et cette colonne enregistrée doit déjà être créée dans l'interface utilisateur de DoubleClick Search.
`columns[].headerText`	`string`	Texte utilisé pour identifier cette colonne dans le résultat du rapport la valeur par défaut est `columnName` ou `savedColumnName` lorsqu'il n'est pas spécifié. 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 un regroupement en fonction de cette colonne. La valeur par défaut est `false`.
`timeRange`	`object`	Si des métriques sont demandées dans un rapport, cet argument permet de les limiter à 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 des références supplémentaires sur 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 appliquer 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, et cette colonne enregistrée doit déjà être créée dans l'interface utilisateur de DoubleClick Search.
`filters[].operator`	`string`	Opérateur à utiliser dans le filtre. Consultez la référence sur les filtres pour obtenir la liste des opérateurs disponibles.
`filters[].values[]`	`list`	Liste de valeurs par rapport auxquelles filtrer la valeur de la colonne. Le nombre maximal de valeurs de filtre par requête est de 300.
`orderBy[]`	`list`	Rapport synchrone uniquement. Liste de colonnes et d'instructions définissant le tri à effectuer sur les lignes du rapport. Le nombre maximal de commandes par requête est de 300.
`orderBy[].column`	`nested object`	Colonne sur laquelle effectuer le tri. Il peut s'agir d'une colonne définie par DoubleClick Search 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, et cette colonne enregistrée doit déjà être créée dans l'interface utilisateur de DoubleClick Search.
`orderBy[].sortOrder`	`string`	L'ordre 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 ne sera créé que si toutes les données statistiques demandées proviennent d'un même fuseau horaire. La valeur par défaut est `false`.
`downloadFormat`	`string`	Format dans lequel le rapport doit être renvoyé. Actuellement, `csv` ou `tsv` est pris en charge.
`statisticsCurrency`	`string`	Spécifie la devise dans laquelle les valeurs monétaires sont renvoyées. Les valeurs possibles sont les suivantes: `usd`, `agency` (valide si le rapport est limité à une agence ou à un niveau inférieur), `advertiser` (valide si le rapport est limité à un annonceur * ou à un niveau inférieur) ou `account` (valide si le rapport est limité à un compte de moteur ou à un niveau inférieur).
`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 à partir 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. La portée du rapport doit être limitée à un annonceur ou à un niveau inférieur, et 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, cette fonction renvoie 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 les données de la dimension personnalisée. Les valeurs possibles sont "projecteur".
`filters[].column.customDimensionName`	`string`	Segmente un rapport en fonction d'une dimension personnalisée. La portée du rapport doit être limitée à un annonceur ou à un niveau inférieur, et 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, cette fonction renvoie 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 la valeur par défaut est `columnName` ou `savedColumnName` lorsqu'il n'est pas spécifié. 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 un regroupement en fonction de cette colonne. La valeur par défaut est `false`.
`filters[].column.platformSource`	`string`	Plate-forme utilisée pour fournir les données de la dimension personnalisée. Les valeurs possibles sont "projecteur".
`orderBy[].column.customDimensionName`	`string`	Segmente un rapport en fonction d'une dimension personnalisée. La portée du rapport doit être limitée à un annonceur ou à un niveau inférieur, et 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, cette fonction renvoie 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 la valeur par défaut est `columnName` ou `savedColumnName` lorsqu'il n'est pas spécifié. 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 un regroupement en fonction de cette colonne. La valeur par défaut est `false`.
`orderBy[].column.platformSource`	`string`	Plate-forme utilisée pour fournir les données de la dimension personnalisée. Les valeurs possibles sont "projecteur".
`columns[].customMetricName`	`string`	Nom d'une métrique personnalisée à inclure dans le rapport. La portée du rapport doit être limitée à un annonceur ou à un niveau inférieur, et la statistique personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la statistique 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. La portée du rapport doit être limitée à un annonceur ou à un niveau inférieur, et la statistique personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la statistique 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. La portée du rapport doit être limitée à un annonceur ou à un niveau inférieur, et la statistique personnalisée doit déjà être configurée dans DoubleClick Search. Le nom de la statistique personnalisée, qui apparaît dans DoubleClick Search, est sensible à la casse.
`columns[].productReportPerspective`	`string`	Renvoie uniquement les métriques d'un type spécifique d'activité liée aux produits. Valeurs acceptées: `sold` : renvoie uniquement les métriques des produits vendus `advertised` : renvoie uniquement les métriques des produits ayant fait l'objet d'une promotion dans une campagne Shopping, et qui ont pu être vendus ou non.
`filters[].column.productReportPerspective`	`string`	Renvoie uniquement les métriques d'un type spécifique d'activité liée aux produits. Valeurs acceptées: `sold` : renvoie uniquement les métriques des produits vendus `advertised` : renvoie uniquement les métriques des produits ayant fait l'objet d'une promotion dans une campagne Shopping, et qui ont pu être vendus ou non.
`orderBy[].column.productReportPerspective`	`string`	Renvoie uniquement les métriques d'un type spécifique d'activité liée aux produits. Valeurs acceptées: `sold` : renvoie uniquement les métriques des produits vendus `advertised` : renvoie uniquement les métriques des produits ayant fait l'objet d'une promotion dans une campagne Shopping, et qui ont pu être vendus ou non.

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource "Reports" dans le corps de la 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 autonome un navigateur Web.