Provisioning di account controllati dai partner – Guida per gli sviluppatori di API

Introduzione

createAccountTree fa parte dell'API di provisioning che può essere utilizzata per creare nuovi account Google Analytics su larga scala. A differenza di createAccountTicket, createAccountTree non richiede alcuna interazione dell'utente finale per completare la creazione dell'account; il processo è completamente automatizzato. Questo è utile quando devi eseguire il provisioning di un account Analytics che controlli per conto di un cliente e quando fornisci una visualizzazione personalizzata di questi dati al cliente.

Questa API è riservata ai partner che controllano i siti web o le proprietà web dei propri utenti. Se gli utenti controllano i propri siti web o le proprie proprietà web, devi creare account Analytics controllati dagli utenti.

Prima di iniziare

L'accesso a tutte le API di Google Analytics è simile a quello delle API. Prima di iniziare a utilizzare l'API di provisioning, devi:

  • Leggi la pagina Librerie client per un elenco completo delle librerie client specifiche dei linguaggi di programmazione che funzionano con l'API.
  • Leggi la Guida di riferimento per saperne di più sull'interfaccia dell'API e su come accedere ai dati senza una libreria client.

Ogni libreria client fornisce un singolo oggetto del servizio di analisi per accedere all'API di provisioning. Per creare l'oggetto di servizio, in genere devi seguire questi passaggi:

  1. Registra la tua applicazione nella console API di Google.
  2. Autorizza la creazione di un nuovo account Google Analytics.
  3. Creare un oggetto di servizio Analytics.

Se non hai completato questi passaggi, ti invitiamo a leggere il tutorial sull'API Hello Google Analytics. Questo tutorial illustra i passaggi iniziali per la creazione di un'applicazione API di Google Analytics. Al termine, capirai come accedere alle API di Google Analytics per eseguire attività reali.

L'account modello

Per ottenere l'autorizzazione a utilizzare questa API, dovrai fornire un nuovo account Google Analytics, che fungerà da account modello per questa API. Quando vengono creati nuovi account, questi ereditano varie impostazioni dall'account modello, tra cui l'accettatore dei Termini di servizio, l'Organizzazione e varie impostazioni di condivisione dei dati. Consulta il riferimento createAccountTree per ulteriori dettagli sull'account modello, incluso un elenco di tutti i dati ereditati.

Provisioning di un account

Per eseguire il provisioning di un nuovo account Google Analytics, invia una richiesta all'endpoint API di createAccountTree. Avrai bisogno dei seguenti dettagli di provisioning:

  • Campi dell'account
    • Un accountName per l'account.
  • Campi della proprietà web
    • Un webpropertyName per la proprietà.
    • Un websiteUrl. Deve essere l'URL associato alla proprietà utente per questo account Analytics.
  • Campi Visualizza
    • Un profileName per la vista.
    • Un timezone per la vista.

Una volta ottenuti i dettagli, effettua una chiamata autenticata all'endpoint 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",
}

In caso di esito positivo, l'API risponderà con i dettagli dell'account, della proprietà web e della vista appena creati:

{
    "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",
        ...
    },
    ...
}

Proprietà e gestione dell'account

L'account Google Analytics creato sarà di proprietà dell'account utente che ha autorizzato la risposta tramite OAuth. Per questo motivo, consigliamo alla tua organizzazione di utilizzare un account di servizio per gestire l'account Analytics anziché un account utente individuale.

Una volta creato l'account, puoi configurarlo con l'API di gestione. Di seguito sono riportate alcune attività comuni per un account appena creato:

Chiarimento sui rapporti degli account

Come con tutte le API di Google, è necessario un progetto Google Cloud come punto di partenza per l'autorizzazione della richiesta. Come descritto nella documentazione relativa ad OAuth 2.0, è in questo account che devi gestire le credenziali per le richieste API. Tuttavia, l'account Google Analytics creato non è in alcun modo affiliato direttamente al progetto Cloud o ai suoi account di gestione, ma solo all'account utente o di servizio che ha autorizzato la richiesta. Puoi utilizzare l'API di gestione se devi configurare l'accesso all'account Analytics.