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

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

Un rapport DoubleClick Search Cet objet contient la demande de rapport, certaines métadonnées de rapport telles que le code de devise et les lignes ou fichiers de rapport générés.

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "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
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}

Nom de propriété	Valeur	Description
`files[]`	`list`	Rapport asynchrone uniquement. Contient une liste de fichiers générés une fois le rapport créé.
`files[].byteCount`	`long`	Taille de ce fichier de rapport en octets.
`files[].url`	`string`	Utilisez cette URL pour télécharger le fichier du rapport.
`id`	`string`	Rapport asynchrone uniquement. ID du rapport.
`isReportReady`	`boolean`	Rapport asynchrone uniquement. Ce champ n'est vrai que si le rapport est terminé et que les fichiers du rapport sont prêts à être téléchargés.
`kind`	`string`	Identifie la ressource comme un rapport. Valeur: chaîne fixe `doubleclicksearch#report`.
`request`	`nested object`	Requête ayant créé le rapport. Les champs facultatifs non spécifiés dans la requête d'origine sont renseignés avec des valeurs par défaut.
`request.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.
`request.columns[].columnName`	`string`	Nom d'une colonne DoubleClick Search à inclure dans le rapport.
`request.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.
`request.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.
`request.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`.
`request.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`.
`request.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.
`request.columns[].platformSource`	`string`	Plate-forme utilisée pour fournir des données pour la dimension personnalisée. Valeurs acceptées : "projectlight".
`request.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
`request.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.
`request.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`.
`request.downloadFormat`	`string`	Format dans lequel le rapport doit être renvoyé. Actuellement, `csv` ou `tsv` sont compatibles.
`request.filters[]`	`list`	Liste des filtres à appliquer au rapport. Le nombre maximal de filtres par requête est de 300.
`request.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.
`request.filters[].column.columnName`	`string`	Nom d'une colonne DoubleClick Search à inclure dans le rapport.
`request.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.
`request.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.
`request.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`.
`request.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`.
`request.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.
`request.filters[].column.platformSource`	`string`	Plate-forme utilisée pour fournir des données pour la dimension personnalisée. Valeurs acceptées : "projectlight".
`request.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
`request.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.
`request.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`.
`request.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.
`request.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.
`request.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.
`request.includeRemovedEntities`	`boolean`	Détermine si les entités supprimées doivent être incluses dans le rapport. La valeur par défaut est `false`.
`request.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.
`request.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.
`request.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.
`request.orderBy[].column.columnName`	`string`	Nom d'une colonne DoubleClick Search à inclure dans le rapport.
`request.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.
`request.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.
`request.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`.
`request.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`.
`request.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.
`request.orderBy[].column.platformSource`	`string`	Plate-forme utilisée pour fournir des données pour la dimension personnalisée. Valeurs acceptées : "projectlight".
`request.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
`request.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.
`request.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`.
`request.orderBy[].sortOrder`	`string`	Le sens de tri, qui est `ascending` ou `descending`.
`request.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.
`request.reportScope.adGroupId`	`long`	ID du groupe d'annonces DS.
`request.reportScope.adId`	`long`	ID de l'annonce DS.
`request.reportScope.advertiserId`	`long`	Référence annonceur DS.
`request.reportScope.agencyId`	`long`	ID de l'agence DS.
`request.reportScope.campaignId`	`long`	ID de campagne DS.
`request.reportScope.engineAccountId`	`long`	ID du compte de moteur DS.
`request.reportScope.keywordId`	`long`	ID du mot clé DS.
`request.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.
`request.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`.
`request.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`.
`request.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).
`request.timeRange`	`object`	Si des métriques sont demandées dans un rapport, cet argument sera utilisé pour les restreindre à une période spécifique.
`request.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.
`request.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.
`request.timeRange.endDate`	`string`	Date inclusive au format AAAA-MM-JJ.
`request.timeRange.startDate`	`string`	Date inclusive au format AAAA-MM-JJ.
`request.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`.
`rowCount`	`integer`	Nombre de lignes du rapport générées par le rapport, sans les en-têtes.
`rows[]`	`list`	Rapport synchrone uniquement. Lignes de rapport générées
`rows[].(key)`	`any value`	Indique les colonnes représentées sur cette ligne. Autrement dit, chaque clé correspond à une colonne dont une ligne n'est pas vide.
`statisticsCurrencyCode`	`string`	Code de devise de toutes les valeurs monétaires générées dans le rapport, y compris les valeurs définies par les utilisateurs (les paramètres des enchères de mot clé, par exemple) et les métriques (les coûts et les revenus, par exemple). Le code de devise d'un rapport est déterminé par le champ `statisticsCurrency` de la demande de rapport.
`statisticsTimeZone`	`string`	Si toutes les statistiques du rapport proviennent du même fuseau horaire, il s'agirait de. Sinon, le champ n'est pas défini.

Méthodes

générer: Génère et renvoie immédiatement un rapport.
obtenir: Sondez l'état d'une demande de rapport.
getFile.: Télécharge un fichier de rapport encodé en UTF-8.
getIdMappingFile: Télécharge un fichier CSV (codé en UTF-8) contenant les mappages d'identifiants entre l'ancien Search Ads 360 et le nouveau. Pour l'annonceur demandé, le fichier inclut toutes les entités enfants (par exemple, comptes associés à un moteur, campagnes, groupes d'annonces, etc.) qui existent à la fois dans l'ancienne interface Search Ads 360 et dans la nouvelle.
demande: Insère une demande de rapport dans le système de reporting.