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. Affiche 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 maintenant

Demande

Demande HTTP

GET https://www.googleapis.com/adsense/v1.4/reports

Paramètres

Nom du paramètre Valeur Description
Paramètres de la requête (obligatoires)
endDate string Date de fin de la période sur laquelle doit porter le rapport au format "AAAA-MM-JJ", date de fin incluse.
startDate string Date de début de la période sur laquelle doit porter le rapport au format "AAAA-MM-JJ", date de début incluse.
Paramètres de la requête (facultatifs)
accountId string Comptes pour lesquels vous souhaitez créer un rapport.
currency string (Facultatif) Devise à utiliser dans les rapports sur les statistiques monétaires. En l'absence de spécification, la valeur par défaut est la devise du compte.
dimension string Attributs sur lesquels baser le rapport. Une description des attributs disponibles est fournie dans la section Valeurs et attributs. Pour obtenir plus d'informations sur chacun des attributs, consultez le Glossaire AdSense.
filter string Filtres à appliquer au 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 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 renverra 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 Valeurs sur lesquelles baser le rapport. Une description des valeurs disponibles est fournie dans la section Valeurs et attributs. Pour obtenir plus d'informations sur chacune des valeurs, consultez le Glossaire AdSense.
sort string Attribut ou valeur à utiliser pour trier le rapport obtenu. Le nom peut éventuellement être précédé du 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.
startIndex 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 renverra 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.
useTimezoneReporting boolean Indique si le rapport doit être généré dans le fuseau horaire local du compte AdSense. Si la valeur spécifiée est "false", le fuseau horaire par défaut (HNP/HAP) est utilisé.

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ètres d'accès
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly

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": "adsense#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ],
  "startDate": string,
  "endDate": string
}
Nom de la propriété Valeur Description Remarques
kind string Type de ressource dont il s'agit (dans ce cas, "adsense#report").
totalMatchedRows long Nombre total de lignes correspondant à la demande de rapport. Il se peut 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 Type d'en-tête dont il s'agit (DIMENSION, METRIC_TALLY, METRIC_RATIO ou METRIC_CURRENCY).

Les valeurs acceptées sont les suivantes :
  • "DIMENSION":
  • "METRIC_CURRENCY":
  • "METRIC_RATIO":
  • "METRIC_TALLY":
headers[].currency string Devise de cette colonne. Uniquement présente si l'en-tête est de type "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.
startDate string Date de début demandée, au format "aaaa-mm-jj".
endDate string Date de fin demandée, au format "aaaa-mm-jj".

CSV

"(dynamic)"
(foreach)
  string
(/foreach)
Nom de la propriété Valeur Description Remarques
(dynamic) string

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.