Provisioning degli 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 dove offri una visualizzazione personalizzata di questi dati al cliente.

Questa API è riservata ai partner che controllano i siti web o le proprietà web dei loro utenti. Se gli utenti controllano i propri siti web o le loro proprietà web, devi invece creare account Analytics controllati dall'utente.

Prima di iniziare

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

  • Consulta la pagina librerie client per un elenco completo delle librerie client specifiche per i vari linguaggi di programmazione che funzionano con l'API.
  • Leggi la Guida di riferimento per ulteriori informazioni sull'interfaccia dell'API e su come accedere ai dati senza una libreria client.

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

  1. Registra l'applicazione in Google API Console.
  2. Autorizza a creare un nuovo account Google Analytics.
  3. Creare un oggetto di servizio di Analytics.

Se non hai completato questi passaggi, interrompi e leggi il tutorial sull'API Google Analytics. Questo tutorial ti guiderà attraverso i passaggi iniziali per la creazione di un'applicazione API di Google Analytics. Al termine, saprai come accedere alle API di Google Analytics per eseguire attività reali.

L'account del modello

Poiché disponi dell'autorizzazione a utilizzare questa API, devi fornire un nuovo account Google Analytics che funga da account modello per questa API. Quando vengono creati, i nuovi account ereditano le varie impostazioni dall'account del modello, tra cui i accettatori dei Termini di servizio, l'Organizzazione e varie impostazioni di condivisione dei dati. Consulta la documentazione di riferimento createAccountTree per ulteriori informazioni 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 dell'API createAccountTree. Avrai bisogno dei seguenti dettagli di provisioning:

  • Campi 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.
  • Visualizza i campi
    • Un profileName per la vista.
    • Un timezone per la vista.

Dopo aver ottenuto 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 appartiene all'account utente che ha autorizzato la risposta tramite OAuth. Per questo motivo, consigliamo di utilizzare un account di servizio per gestire l'account Analytics anziché un account utente individuale.

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

Chiarimento sulle relazioni con gli account

Come con tutte le API di Google, un progetto Google Cloud è necessario come punto di partenza per l'autorizzazione delle richieste. Come descritto nella documentazione relativa a OAuth 2.0, in questo account puoi gestire le credenziali per le richieste API. Tuttavia, l'account Google Analytics creato non è direttamente affiliato al progetto Cloud né ai suoi account di gestione, ma è affiliato 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.