Questo documento descrive le opzioni, i metodi, le proprietà e gli eventi per tutti i componenti integrati dell'API Embed.
auth
gapi.analytics.auth
Il componente di autenticazione è un singleton che può essere utilizzato per autorizzare un utente.
Metodi |
|
---|---|
authorize(options:Object) |
Resi: Visualizza un pulsante di accesso a Google Analytics all'interno del contenitore specificato per consentire all'utente di accedere con il proprio Account Google. |
isAuthorized() |
Resi: Restituisce |
signOut() |
Resi: Disconnette l'utente corrente. Attiva anche l'evento |
getAuthResponse() |
Resi: Recupera i dati di autenticazione restituiti dalla richiesta di autorizzazione originale. L'oggetto restituito include il token di accesso, che di solito consente di effettuare manualmente richieste autenticate. |
getUserProfile() |
Resi: Recupera le informazioni di base del profilo dell'utente che ha eseguito l'accesso. Sono inclusi il nome, l'indirizzo email e l'immagine del profilo pubblico (se impostata). |
Opzioni |
|
---|---|
clientId |
Tipo: L'ID client del tuo progetto nella console per gli sviluppatori. |
container |
Tipo: L'ID di un elemento HTML nel DOM che ospiterà il pulsante di accesso. Puoi anche passare un riferimento all'elemento stesso. |
userInfoLabel |
Tipo: Il testo da visualizzare prima dell'indirizzo email di un utente che ha eseguito l'accesso. Il valore predefinito è |
scopes |
Tipo: Un elenco degli ambiti di autenticazione delle API di Google richiesti dall'applicazione. Per vedere tutti gli ambiti disponibili, visita OAuth 2.0 Playground. Per gli ambiti di autenticazione delle API di Google Analytics, consulta le guide per gli sviluppatori per le risorse di configurazione e report. |
overwriteDefaultScopes |
Tipo: Indica se l'opzione Il valore predefinito dell'ambito è: Nota: l'autenticazione tramite l'API Embed richiede l'accesso al profilo di base dell'utente. Questi ambiti non possono essere sovrascritti. |
serverAuth.access_token |
Tipo: Se hai già un token di accesso valido, puoi passarlo direttamente al metodo di autorizzazione e all'utente non verrà richiesta l'autorizzazione. Per maggiori dettagli su come recuperare un token di accesso, consulta la documentazione relativa a OAuth 2.0. |
Eventi |
|
---|---|
signIn |
Argomenti: nessuno Attivato quando l'utente ha eseguito l'accesso. |
signOut |
Argomenti: nessuno Attivato quando l'utente si è disconnesso. |
needsAuthorization |
Argomenti: nessuno Quando richiami il metodo |
error |
Argomenti: Attivato quando si verifica un errore durante il processo di autenticazione. Se vuoi ricevere il messaggio di errore dall'oggetto risposta, si trova all'indirizzo |
Eventi deprecati | |
---|---|
success |
Argomenti: Questo evento esiste per la compatibilità con le versioni precedenti e potrebbe essere rimosso in una versione futura. Utilizza invece l'evento |
Esempio
// Standard client-side authorization. gapi.analytics.auth.authorize({ clientId: 'XXXXXX', container: 'auth-button' }); gapi.analytics.auth.on('signIn', function() { console.log(gapi.analytics.auth.getUserProfile()); });
// Authorization using an access token obtained server-side. // You do not need to register an event handler because // authorization happens immediately. gapi.analytics.auth.authorize({ serverAuth: { access_token: 'XXXXXX' } });
Dati
gapi.analytics.report.Data
Costruttore | |
---|---|
Data(options:Object)
|
Il componente Dati ti consente di eseguire query sull'API di reporting principale di Google Analytics e di recuperare i risultati. |
Opzioni |
|
---|---|
query
|
Tipo: Un oggetto contenente i parametri di query dell' API di reporting principale. Vengono utilizzati i seguenti valori predefiniti in aggiunta ai normali valori predefiniti forniti dall'API: { 'start-date': '7daysAgo', 'end-date': 'yesterday } |
Eventi |
|
---|---|
success |
Argomenti: Attivato quando la query è stata completata correttamente. |
error |
Argomenti: Attivato quando si verifica un errore durante il processo di query. Se vuoi ricevere il messaggio di errore dall'oggetto risposta, si trova all'indirizzo |
Esempio
var report = new gapi.analytics.report.Data({ query: { ids: 'ga:XXXX', metrics: 'ga:sessions', dimensions: 'ga:city' } }); report.on('success', function(response) { console.log(response); }); report.execute();
DataChart
gapi.analytics.googleCharts.DataChart
Costruttore | |
---|---|
DataChart(options:Object)
|
DataChart aggrega un grafico di Google standard e un componente Dati per consentirti di creare facilmente una visualizzazione a partire da una query senza doverli collegare personalmente. |
Opzioni |
|
---|---|
query |
Tipo: Consulta l'opzione di query del componente di dati. |
chart |
Tipo: Di seguito sono riportati i dettagli sulle singole opzioni dei grafici. |
chart.container |
Tipo: L'ID di un elemento HTML nel DOM che ospiterà il DataChart. Puoi anche passare un riferimento all'elemento stesso. |
chart.type |
Tipo: Il tipo di grafico. Le opzioni possibili sono: |
chart.options |
Tipo: Tutte le opzioni che possono essere trasmesse all'oggetto Google Chart corrispondente. |
Eventi |
|
---|---|
success |
Argomenti: Attivato quando la query è stata completata correttamente e il grafico è stato visualizzato completamente.
|
error |
Argomenti: Attivato quando si verifica un errore durante il processo di query o di rendering. Se vuoi ricevere il messaggio di errore dall'oggetto risposta, si trova all'indirizzo |
Esempio
var chart = new gapi.analytics.googleCharts.DataChart({ query: { ids: 'ga:XXXX', metrics: 'ga:sessions', dimensions: 'ga:date' }, chart: { type: 'LINE', container: 'line-chart', options: { title: 'Sessions over the past week.', fontSize: 12 } } }); chart.on('success', function(response) { // response.chart : the Google Chart instance. // response.data : the Google Chart data object. }); chart.execute();
ViewSelector
gapi.analytics.ViewSelector
Costruttore | |
---|---|
ViewSelector(options:Object)
|
Il componente ViewSelector ti consente di scegliere l'account, la proprietà e la vista tramite menu a discesa. |
Opzioni |
|
---|---|
container |
Tipo: L'ID di un elemento HTML nel DOM che ospiterà il selettore View. Puoi anche passare un riferimento all'elemento stesso. |
Proprietà istanza |
|
---|---|
ids |
Tipo: L'ID tabella univoco nel formato ga:XXXX, dove XXXX è l'ID della vista (profilo) di Analytics. |
Eventi |
|
---|---|
change |
Argomenti: Si attiva ogni volta che l'utente seleziona una nuova visualizzazione dai menu a discesa. Viene attivato anche quando viene eseguito il rendering dell'istanza ViewSelector e viene mostrata la visualizzazione predefinita. |
Esempio
var viewSelector = new gapi.analytics.ViewSelector({ container: 'view-selector' }); viewSelector.on('change', function(ids) { console.log(ids); }); viewSelector.execute();
Metodi con componenti condivisi
Metodi | |
---|---|
set(options) |
restituzioni: Imposta o aggiorna le opzioni di configurazione del componente (questa operazione può essere eseguita anche al momento della creazione nel costruttore). |
get() |
restituzioni: Restituisce le opzioni di configurazione correnti di un componente. |
execute() |
restituzioni: Richiama l'azione principale del componente. In genere si tratta di eseguire il rendering di un elemento sulla pagina e/o l'esecuzione di un report. |
on(event, handler) |
restituzioni: Registra una funzione da richiamare quando il componente emette l'evento specificato. |
once(event, handler) |
restituzioni: Registra una funzione da richiamare solo alla successiva occorrenza dell'evento specificato. Dopo l'esecuzione del gestore, una volta eseguita automaticamente l'annullamento della registrazione. |
off(opt_event, opt_handler) |
restituzioni: Rimuove un gestore di eventi da un componente. Se non viene passato alcun gestore, vengono rimossi tutti i gestori per l'evento passato. Se non viene passato alcun evento, vengono rimossi tutti i gestori per tutti gli eventi. |
emit(event, ...opt_args) |
restituzioni: Emette un evento. Facoltativamente, puoi specificare gli argomenti da passare a qualsiasi gestore registrato. |
set
Imposta o aggiorna le opzioni di configurazione del componente (questa operazione può essere eseguita anche al momento della creazione nel costruttore).
Utilizzo
component.set(options);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
options |
Object |
Le opzioni di configurazione per questo componente. Le opzioni superate verranno unite a quelle esistenti. |
Ritorni
this
: l'istanza del componente.
get
Restituisce le opzioni di configurazione correnti di un componente.
Ritorni
Object
: opzioni di configurazione attuali del componente.
execute()
Richiama l'azione principale del componente. In genere si tratta di eseguire il rendering di un elemento sulla pagina e/o l'esecuzione di un report.
Ritorni
this
: l'istanza del componente.
on(event, handler)
Registra una funzione da richiamare quando il componente emette l'evento specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
event |
string |
Il nome dell'evento. |
handler |
Function |
La funzione da richiamare quando si verifica l'evento. (per i dettagli dei parametri, vedi i riferimenti ai singoli eventi). |
Ritorni
this
: l'istanza del componente.
once(event, handler)
Registra una funzione da richiamare solo alla successiva occorrenza dell'evento specificato. Dopo l'esecuzione del gestore, una volta eseguita automaticamente l'annullamento della registrazione.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
event |
string |
Il nome dell'evento. |
handler |
Function |
La funzione da richiamare quando si verifica l'evento. (per i dettagli dei parametri, vedi i riferimenti ai singoli eventi). |
Ritorni
this
: l'istanza del componente.
off(opt_event, opt_handler)
Rimuove un gestore di eventi da un componente. Se non viene passato alcun gestore, vengono rimossi tutti i gestori per l'evento passato. Se non viene passato alcun evento, vengono rimossi tutti i gestori per tutti gli eventi.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
opt_event |
string |
Il nome dell'evento. Se non viene specificato nessun evento, tutti i gestori di tutti gli eventi vengono rimossi. Facoltativo. |
opt_handler |
Function |
Un riferimento al gestore della funzione da rimuovere. Se non viene passata alcuna funzione, tutti i gestori vengono rimossi. Facoltativo. |
Ritorni
undefined
emit(event, ...opt_args)
Emette un evento. Facoltativamente, puoi specificare gli argomenti da passare a qualsiasi gestore registrato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
event |
string |
Il nome dell'evento. |
...opt_args |
* |
Argomenti facoltativi da passare a qualsiasi gestore di eventi registrato. |
Ritorni
undefined