Cette API est obsolète et n'est pas compatible avec les propriétés Google Analytics 4 (GA4). Utilisez l'API Admin pour provisionner et gérer les propriétés GA4.

Cette page a été traduite par l'API Cloud Translation.

Gestion des comptes contrôlés par des partenaires – Guide du développeur de l'API

Présentation

createAccountTree fait partie de l'API de provisionnement et permet de créer des comptes Google Analytics à grande échelle. Contrairement à createAccountTicket, createAccountTree ne nécessite aucune interaction de l'utilisateur final pour finaliser la création du compte. Le processus est entièrement automatisé. Cela s'avère utile lorsque vous devez configurer un compte Analytics que vous contrôlez au nom d'un client et lorsque vous fournissez une vue personnalisée de ces données à votre client.

Cette API est réservée aux partenaires qui contrôlent les sites Web ou les propriétés Web de leurs utilisateurs. Si vos utilisateurs contrôlent leurs propres sites Web ou propriétés Web, nous vous recommandons de créer des comptes Analytics contrôlés par les utilisateurs.

Avant de commencer

Toutes les API Google Analytics sont accessibles de la même manière. Avant de commencer à utiliser l'API de provisionnement, vous devez:

Consultez la page Bibliothèques clientes pour obtenir la liste complète des bibliothèques clientes spécifiques aux langages de programmation qui fonctionnent avec l'API.
Consultez le Guide de référence pour en savoir plus sur l'interface API et découvrir comment accéder aux données sans bibliothèque cliente.

Chaque bibliothèque cliente fournit un seul objet de service d'analyse permettant d'accéder à l'API de provisionnement. Pour créer l'objet de service, vous devez généralement procéder comme suit:

Enregistrez votre application dans la console Google APIs.
Autorisez la création d'un compte Google Analytics.
Créez un objet de service Analytics.

Si vous n'avez pas effectué ces étapes, veuillez lire le tutoriel API Hello Google Analytics. Ce didacticiel va vous guider à travers les premières étapes de la création d'une application API Google Analytics. Vous saurez ensuite comment accéder aux API Google Analytics pour effectuer des tâches concrètes.

Compte du modèle

Dans le cadre de l'autorisation d'utiliser cette API, vous devez fournir un nouveau compte Google Analytics, qui servira de compte modèle pour cette API. Lorsque des comptes sont créés, ils héritent de divers paramètres du compte du modèle, y compris l'accepteur des conditions d'utilisation, l'organisation et divers paramètres de partage de données. Pour en savoir plus sur le modèle de compte et obtenir la liste de toutes les données héritées, consultez la documentation de référence sur createAccountTree.

Provisionnement d'un compte

Pour provisionner un nouveau compte Google Analytics, envoyez une requête au point de terminaison de l'API createAccountTree. Vous aurez besoin des informations de provisionnement suivantes:

Champs Compte
- Un accountName pour le compte.
Champs Site Web
- Un webpropertyName pour la propriété.
- Un websiteUrl. Il doit s'agir de l'URL associée à la propriété utilisateur de ce compte Analytics.
Champs Afficher
- Un élément profileName pour la vue
- Un élément timezone pour la vue

Une fois que vous disposez de ces informations, effectuez un appel authentifié sur le point de terminaison de l'API:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

Si l'opération réussit, l'API envoie une réponse contenant les détails du compte, de la propriété Web et de la vue nouvellement créés:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

Propriété et gestion du compte

Le compte Google Analytics créé appartiendra au compte utilisateur qui a autorisé la réponse via OAuth. C'est pourquoi nous recommandons à votre organisation d'utiliser un compte de service pour gérer le compte Analytics, plutôt qu'un compte utilisateur individuel.

Une fois le compte créé, vous pouvez le configurer avec l'API Management. Voici quelques tâches courantes pour les nouveaux comptes:

Précisions concernant les relations avec les comptes

Comme pour toutes les API Google, un projet Google Cloud est requis comme point de départ pour autoriser les requêtes. Comme décrit dans la documentation OAuth 2.0, ce compte vous permet de gérer vos identifiants pour les requêtes API. Toutefois, le compte Google Analytics créé n'est pas directement affilié d'une manière ou d'une autre au projet Cloud ou à ses comptes de gestion. Il est uniquement affilié à l'utilisateur ou au compte de service qui a autorisé la demande. Si vous devez configurer l'accès au compte Analytics, vous pouvez utiliser l'API Management.