Journal des modifications de l'API de gestion Google Analytics

Nous mettons régulièrement à jour l'API Management Google Analytics afin de proposer de nouvelles fonctionnalités et de réparer les défauts détectés dans les versions précédentes. Dans la plupart des cas, ces modifications seront transparentes pour les développeurs d'API. Cependant, nous devons parfois apporter des modifications qui obligent les développeurs à modifier leurs applications existantes.

Cette page décrit toutes les modifications apportées à l'API de gestion de Google Analytics susceptibles d'affecter votre application. Nous recommandons aux développeurs d'API de consulter régulièrement cette liste pour prendre connaissance des nouvelles annonces. Vous pouvez également vous abonner aux modifications via les flux listés dans la section S'abonner ci-dessous.

S'abonner aux journaux de modifications associés

Inclut toutes les API de collecte, de configuration et de reporting.

Inclut l'API de gestion et l'API de gestion des comptes.

Paramètres de conservation des données utilisateur dans l'API Management

Il est désormais possible de configurer par programmation les paramètres de conservation des données utilisateur à l'aide des nouveaux champs "dataConservationTtl" et "dataDeletionOnNewActivity" ajoutés à la ressource WebProperty.

Opérations d'écriture dans l'API Management

Vous n'avez plus besoin d'ajouter à la liste blanche les opérations d'écriture dans l'API de gestion (création, mise à jour, suppression, correction, etc.) pour les ressources de propriété Web, de vue (profil) et d'objectif. La limite quotidienne par défaut pour toutes les opérations d'écriture dans l'API Management est de 50 écritures/jour. Pour en savoir plus, consultez la page Limites et quotas.

Custom Metrics (Métriques personnalisées)

Cette version corrige un bug. Elle résout le problème qui empêchait la création d'une métrique personnalisée de type TIME lorsque min_value n'était pas défini. Les requêtes sans min_value créent désormais une métrique personnalisée avec une valeur min_value par défaut de 0.

Cette version ajoute les audiences de remarketing à l'API Management.

Audiences de remarketing

L'API Management vous permet d'create, de get, de list, de update et d'patch d'audiences de remarketing pour une propriété Google Analytics. Pour en savoir plus sur le fonctionnement des audiences de remarketing, consultez l'article À propos des audiences de remarketing dans Analytics du centre d'aide.

Rapports non échantillonnés

L'API de rapports non échantillonnés n'est plus limitée à 100 rapports par jour. L'API utilise le même système de jetons par propriété, par jour que lors de la création d'un rapport non échantillonné via l'interface Web.

Rapports non échantillonnés

Les rapports non échantillonnés auxquels l'utilisateur actuel n'a pas accès ne présenteront plus de lien de téléchargement dans le message de réponse de l'API de gestion. Ce comportement est désormais cohérent avec la fonctionnalité du tableau de bord de l'interface utilisateur, où seuls les propriétaires du rapport peuvent voir le lien de téléchargement du document généré.

Segments

Cette version corrige un bug. Cette version corrige un problème qui entraînait un affichage incorrect des segments dont la définition comportait des valeurs de devise lors de l'appel de la méthode de liste de segments.

Segments

Cette version corrige un bug. Dans cette version, les utilisateurs dont les segments privés sont épinglés à plusieurs vues (profils) reçoivent une réponse d'erreur 500 lorsqu'ils appellent la méthode de liste de segments.

Vues (profils)

Dans cette version, la propriété currency de la vue (profil) est désormais définie sur USD par défaut si elle n'est pas définie lors d'une opération insert. De plus, les opérations get et list renvoient USD pour les vues (profils) créées précédemment sans propriété currency.

Filtres

Cette version marque la suppression finale des champs de filtre obsolètes IS_MOBILE et IS_TABLET, qui doivent être remplacés par DEVICE_CATEGORY=mobile et DEVICE_CATEGORY=tablet. Les requêtes d'insertion, de mise à jour et de correctif qui définissent les champs de filtre pour utiliser IS_MOBILE et IS_TABLET renvoient une erreur.

Filtres

Cette version permet d'utiliser une dimension personnalisée pour un champ de filtre en ajoutant une propriété fieldIndex à toutes les sections des détails du filtre. Par exemple, il est maintenant possible de définir l'expression de filtre avec "field": "CUSTOM_DIMENSION" et "fieldIndex": "1" pour que le filtre fonctionne sur la première dimension personnalisée.

Objectifs

Cette version résout également un problème en cas d'échec de la création d'un objectif avec "comparisonValue": "0".

Cette version marque l'abandon final et la suppression de la ressource dailyUpload. La ressource dailyUpload a été officiellement obsolète le 20 juin 2014. Toutes les données de coût doivent désormais être importées à l'aide de la ressource d'importations.

Cette version ajoute deux nouvelles collections à l'API de gestion : les dimensions personnalisées et les métriques personnalisées.

Statistiques et dimensions personnalisées

Il est désormais possible de créer, de répertorier, d'obtenir, de corriger et de mettre à jour des dimensions et des métriques personnalisées avec l'API de gestion.

La réponse de la méthode list pour toutes les collections inclut désormais une liste vide pour la propriété items lorsque la collection ne contient aucune ressource. Auparavant, la propriété items était omise de la réponse. Consultez la documentation de référence de l'API pour en savoir plus sur les requêtes et les réponses concernant les données de configuration Google Analytics.

Cette version introduit un nouveau champ d'application pour l'API de gestion de Google Analytics. - analytics.manage.users.readonly - Afficher les autorisations des utilisateurs de Google Analytics.

Un nouveau champ de filtres DEVICE_CATEGORY a été ajouté, et IS_MOBILE et IS_TABLET sont désormais obsolètes. Utilisez DEVICE_CATEGORY=mobile et DEVICE_CATEGORY=tablet.

La ressource Vue (profil) inclut désormais une propriété enhancedECommerceTracking qui indique si l'e-commerce amélioré est activé (true) ou désactivé (false).

Cette version inclut de nouveaux types d'importation de données et l'abandon de la ressource dailyUpload.

Importation de données

Pour savoir comment utiliser l'API de gestion afin d'importer des données dans votre compte Google Analytics, consultez le Guide du développeur pour l'importation de données.

Mises en ligne

  • La ressource upload est désormais compatible avec les types d'importation suivants :
    • Données de la campagne
    • Données relatives au contenu
    • Données de coût
    • Données relatives aux produits
    • Données relatives aux rejets de débit
    • Données utilisateur
  • La ressource upload dispose d'une nouvelle méthode migrateDataImport pour migrer les données de coût customDataSources existantes.

Abandon des importations quotidiennes

  • La ressource dailyUpload est désormais obsolète. Consultez le guide de migration pour en savoir plus sur la migration afin d'utiliser la fonctionnalité d'importation de données.
  • La ressource dailyUpload continuera de fonctionner pendant six mois supplémentaires, après quoi tout customDataSources restant avec la propriété uploadType définie sur analytics#dailyUploads sera automatiquement migré et ne fonctionnera qu'avec la ressource upload.
  • Les utilisateurs actuels de la ressource dailyUpload doivent mettre à jour leur code et migrer vers la ressource d'importation dès que possible.

Cette version ajoute deux nouvelles API de configuration.

Filtres

Rapports non échantillonnés: API Management

Nous ajoutons à l'API Management une ressource appelée Rapports non échantillonnés. Les rapports non échantillonnés sont des rapports Google Analytics (GA) qui ont été générés à l'aide de données non échantillonnées.Les rapports non échantillonnés ne sont actuellement disponibles que pour les utilisateurs de GA Premium. 

Segments: API Management versions 2.4 et 3.0

Les modifications suivantes ont été apportées à la collection de segments:

  • Les segments d'utilisateurs et de séquence sont désormais compatibles avec l'API.
  • La collection de segments renvoie désormais tous les segments intégrés et personnalisés au niveau de la session et au niveau de l'utilisateur.
  • La propriété definition des segments utilise désormais la nouvelle syntaxe de segment. Cela inclut les définitions des segments existants au niveau de la session, qui passeront de definition: "" à definition: "sessions::condition::".
  • Une nouvelle propriété type a été ajoutée à la ressource Segment pour indiquer si un segment est CUSTOM (créé par un utilisateur dans l'interface Web) ou BUILT_IN (fourni par Google Analytics).

Tests

Les métriques AdSense suivantes peuvent désormais être utilisées comme objectifs d'optimisation:

  • ga:adsenseAdsClicks : nombre de fois où les utilisateurs ont cliqué sur les annonces AdSense de votre site.
  • ga:adsenseAdsViewed : nombre d'annonces AdSense vues. Plusieurs annonces peuvent être diffusées dans un bloc d'annonces.
  • ga:adsenseRevenue : revenu total généré par les annonces AdSense

Nouvelle collection de résumés de compte

Les modifications suivantes ont été apportées aux segments par défaut en raison de l'abandon des dimensions ga:isMobile et ga:isTablet:

  • Le segment gaid::-11 a été renommé Trafic sur mobile en Trafic sur mobile et tablette. La définition de ce segment est passée de ga:isMobile==Yes à ga:deviceCategory==mobile,ga:deviceCategory==tablet. Notez que ga:isMobile inclut le trafic provenant des tablettes, ce qui se reflète dans la nouvelle définition. Si vous ne souhaitez afficher que le trafic sur mobile, à l'exclusion des tablettes, passez au nouveau segment Trafic sur mobile (gaid::-14).
  • La définition du segment gaid::-13 est passée de ga:isTablet==Yes à ga:deviceCategory==tablet. Cela représente toujours le trafic des tablettes.
  • Le segment gaid::-14 a été ajouté. Le nom du segment est Trafic sur mobile et sa définition est ga:deviceCategory==mobile.

Corrections de bugs:

  • Les informations de fuseau horaire pour les vues (profils) ont été corrigées. Détails: avant ce correctif, dans certains cas, lors de la création d'une liste de vues (profils) dans l'API Management, des informations de fuseau horaire incorrectes pour une vue (profil) s'affichaient. Le fuseau horaire des vues (profils) est désormais le même que celui défini dans l'interface d'administration de Google Analytics.

Cette version présente les opérations d'écriture pour les ressources de propriété Web, de vue (profil) et d'objectif, ainsi qu'un ensemble de trois nouvelles ressources permettant de gérer les autorisations de l'utilisateur.

API de configuration et de configuration du compte

Autorisations de l'utilisateur dans l'API de gestion

  • La nouvelle ressource accountUserLinks permet de gérer les autorisations de compte pour les utilisateurs.
  • La nouvelle ressource webpropertyUserLinks permet de gérer les autorisations de propriété pour les utilisateurs.
  • La nouvelle ressource profileUserLinks permet de gérer les autorisations de vue (profil) pour les utilisateurs.
  • Les autorisations accordées à un utilisateur autorisé sont désormais disponibles dans les ressources Compte, Site Web et Vue (profil).
  • Un nouveau champ d'application a été introduit et est requis pour gérer les autorisations des utilisateurs. https://www.googleapis.com/auth/analytics.manage.users.
  • Pour en savoir plus, consultez le Guide du développeur sur les autorisations utilisateur.

Dans le cadre du lancement des nouveaux segments, nous allons apporter les modifications suivantes à la collection de segments:

  • Tous les ID de segment passeront des entiers positifs à des chaînes alphanumériques. Si vous avez enregistré des ID de segment utilisateur, nous vous recommandons de les mettre à jour avec les nouveaux ID.
  • La collection "Segments" n'affiche que les segments existants au niveau de la visite. Les nouveaux segments de visiteur, de cohorte et de séquence ne sont actuellement pas compatibles avec l'API.
  • La collection "Segments" continuera à renvoyer les segments par défaut existants associés aux mêmes ID numériques négatifs. Toutefois, les nouveaux segments par défaut ne sont pas acceptés pour le moment.

Cette version ajoute deux nouvelles propriétés à la ressource de propriété Web:

  • profileCount : renvoie le nombre de profils pour une propriété. Cela vous permet de filtrer les propriétés qui n'ont pas de profil (par exemple, profileCount = 0).
  • industryVertical : affiche le secteur/la catégorie d'activité sélectionné pour une propriété.

Corrections de bugs:

  • La propriété eCommerceTracking de la ressource de profil correspond désormais aux paramètres d'e-commerce de la section "Administration" de l'interface Web. Renvoie true si le suivi de l'e-commerce est activé, et false dans le cas contraire.
  • La ressource Webproperty inclut désormais une propriété level pour indiquer si la propriété Web est PREMIUM ou STANDARD.
  • Un nouveau point de terminaison a été ajouté à l'API Management v3 pour accéder aux ressources Tests et les modifier.
  • La ressource de profil inclut désormais une propriété type pour déterminer si un profil est configuré pour un site Web ou une application. Les deux valeurs possibles sont WEB ou APP.

Cette version ajoute des réponses d'erreur utiles à l'API Management.

  • De nouveaux codes d'erreur, motifs et descriptions ont été ajoutés au corps des réponses d'erreur de l'API. Tous les codes ont été documentés pour les versions 2.4 et 3.0 de l'API Management.

Cette version ajoute des données, modifie des fonctionnalités existantes et corrige un bug.

Nouvelles données

  • La collection "Segment avancé" contient désormais un champ segmentId utilisable dans le paramètre segment de l'API d'exportation des données.

Changements

  • Le type de données de max-results a été remplacé par integer.

  • La valeur par défaut et maximale de max-results est passée à 1 000.

Correction de bugs

  • Les comptes, sites Web et profils utilisés pour les tests de l'Optimiseur de Site Google ne sont plus inclus dans les collections correspondantes.

Cette version ajoute deux nouvelles versions de l'API avec de nombreuses nouvelles fonctionnalités et abandonne l'ancienne version. Les modifications ont une incidence sur la façon dont vous demandez et gérez les données de l'API.

Version 3.0

  • Il s'agit de la dernière version majeure de notre API. Elle n'est pas rétrocompatible. Tout développement futur de l'API se fera sur cette version.

  • Nouvelles données

    • Représentation complète des objectifs de l'événement
    • ID de propriété Web interne permettant de créer un lien profond dans l'interface utilisateur GA.
    • Configurations de profil pour les paramètres de requête de recherche sur site et de page par défaut
  • Changements

Version 2.4

  • Il s'agit d'une mise à niveau de version mineure principalement rétrocompatible avec la version 2.3 existante.

  • Changements

    • Une nouvelle règle relative aux quotas
    • L'intégration à la console des API Google permet de gérer l'accès aux API et de demander une augmentation de quota.
    • Maintien de la compatibilité avec les mécanismes d'autorisation existants et OAuth 2.0
    • Nouvelle URL pour l'envoi des requêtes: https://www.googleapis.com/analytics/v2.4/management/…
    • Réponses au format XML uniquement
    • Incompatibilité avec la bibliothèque cliente JavaScript de Google Data
    • La sortie XML est cohérente avec la version 2.3. Les autres bibliothèques clientes Google Data existantes continueront donc de fonctionner.

Obsolescence

  • Nous annonçons l'abandon de l'ancienne version 2.3 de l'API Management. Elle continuera de fonctionner pendant deux mois, après quoi toutes les requêtes v2.3 renverront une réponse v2.4.

Il s'agit de la version bêta de l'API de gestion de Google Analytics.

Nouveaux flux

Bibliothèques clientes mises à jour

  • L'API de gestion appartient à la même bibliothèque que l'API d'exportation de données Google Analytics. Les bibliothèques Java et JavaScript de Google Data ont été mises à jour. Vous pouvez accéder à chaque flux en spécifiant l'URI de flux approprié dans la méthode getManagementFeed() des bibliothèques.

Nouvelle documentation

  • Une nouvelle section de la documentation destinée aux développeurs Google Analytics a été créée afin de décrire le fonctionnement de la nouvelle API de gestion.