Reports: generate

Autorisation requise

Permet de générer un rapport AdSense en fonction de la demande de rapport envoyée dans les paramètres de requête. Renvoie le résultat au format JSON ; pour extraire le résultat au format CSV, spécifiez "alt=csv" comme paramètre de requête. Essayer dès maintenant

Demande

Requête HTTP

GET https://www.googleapis.com/adsensehost/v4.1/reports

Paramètres

Nom du paramètre Valeur Description
Paramètres obligatoires
endDate string Date de fin de la période sur laquelle doit porter le rapport au format "JJ-MM-AAAA", date de fin incluse.
startDate string Date de début de la période sur laquelle doit porter le rapport au format "JJ-MM-AAAA", date de début incluse.
Paramètres facultatifs
dimension string

Attributs sur lesquels baser le rapport. Les attributs disponibles sont :

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
filter string Filtres à utiliser dans le rapport.
locale string Paramètre régional facultatif à utiliser pour traduire le rapport généré dans une langue locale. S'il n'est pas spécifié, la valeur par défaut est "en_US".
maxResults unsigned integer

Nombre maximal de lignes de données de rapport à afficher.

Si startIndex n'est pas défini ou si sa valeur est zéro, l'API affiche le nombre de lignes spécifié par la valeur de maxResults. Si maxResults n'est pas défini, l'API affiche autant de lignes que possible, jusqu'à un maximum de 50 000.

Si la valeur de startIndex est différente de zéro, la somme de startIndex et de maxResults ne peut pas être supérieure à 5 000. Dans le cas contraire, une erreur est déclenchée : la pagination au-delà de la 5 000e ligne n'est pas acceptée.

Les valeurs autorisées vont de 0 à 50000, inclus.
metric string Colonnes numériques à inclure dans le rapport. Les valeurs disponibles sont :
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
sort string

Nom d'un attribut ou d'une valeur de tri du rapport obtenu, éventuellement avec le préfixe "+" pour un tri croissant ou "-" pour un tri décroissant. En l'absence de préfixe, la colonne est triée dans l'ordre croissant.

Il s'agit de l'union des attributs et des valeurs :

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
startIndex unsigned integer

Index de la première ligne de données du rapport à afficher.

Si startIndex n'est pas défini ou si sa valeur est zéro, l'API affiche le nombre de lignes spécifié par la valeur de maxResults. Si maxResults n'est pas défini, l'API affiche autant de lignes que possible, jusqu'à un maximum de 50 000.

Si la valeur de startIndex est différente de zéro, la somme de startIndex et de maxResults ne peut pas être supérieure à 5 000. Dans le cas contraire, une erreur est déclenchée : la pagination au-delà de la 5 000e ligne n'est pas acceptée.

Les valeurs autorisées vont de 0 à 5000, inclus.

Autorisation

Une autorisation est requise pour cette demande. Celle-ci doit inclure au moins l'un des paramètres d'accès suivants. En savoir plus sur le processus d'authentification et d'autorisation

Paramètre d'accès
https://www.googleapis.com/auth/adsensehost

Corps de la demande

Ne fournissez pas de corps de demande pour cette méthode.

Réponse

Lorsque cette méthode fonctionne, elle renvoie un corps de réponse structuré comme suit :

JSON

{
  "kind": "adsensehost#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ]
}
Nom de la propriété Valeur Description Remarques
kind string Type de ressource concerné. Dans ce cas, "adsensehost#report".
totalMatchedRows long Nombre total de lignes correspondant à la demande de rapport. Il est possible que la réponse contienne moins de lignes à cause de la limite du nombre de lignes demandées ou du nombre de lignes autorisées dans le rapport.
headers[] list Informations d'en-tête des colonnes requises dans le rapport. Il s'agit d'une liste d'en-têtes, un pour chaque attribut de la demande, suivi d'un en-tête pour chaque valeur de la demande.
headers[].name string Nom de l'en-tête.
headers[].type string Le type de l'en-tête ; il peut s'agir de "DIMENSION", "METRIC_TALLY", "METRIC_RATIO", ou "METRIC_CURRENCY".
headers[].currency string Devise de cette colonne. Uniquement présente si le type d'en-tête est "METRIC_CURRENCY".
rows[] list Lignes de résultats du rapport. Chaque ligne est composée d'une liste de cellules, une pour chaque attribut de la demande, suivie d'une cellule pour chaque valeur de la demande. Les cellules d'attributs contiennent des chaînes, et les cellules de valeurs, des nombres.
totals[] list Totaux du rapport. La longueur de cette ligne est identique à celle des autres lignes du rapport ; les cellules correspondant à des colonnes d'attribut sont vides.
averages[] list Moyennes du rapport. La longueur de cette ligne est identique à celle des autres lignes du rapport ; les cellules correspondant à des colonnes d'attribut sont vides.
warnings[] list Tout avertissement relatif à la création du rapport.

CSV

"(dynamic)"
(foreach)
  (value)
(/foreach)
Nom de la propriété Valeur Description Remarques
(dynamic)"> (dynamic) (any)

Essayez dès maintenant !

Utilisez l'explorateur des API ci-dessous pour appeler cette méthode sur des données réelles et obtenir la réponse.