Referenz für integrierte Komponenten

In diesem Dokument werden die Optionen, Methoden, Eigenschaften und Ereignisse für alle integrierten Embed API-Komponenten beschrieben.

Auth

gapi.analytics.auth

Die Authentifizierungskomponente ist ein Singleton, mit dem ein Nutzer autorisiert werden kann.

Methoden

authorize(options:Object)

Retouren:gapi.analytics.auth

Hiermit wird eine Google Analytics-Anmeldeschaltfläche im angegebenen Container gerendert, sodass sich der Nutzer mit seinem Google-Konto anmelden kann.

isAuthorized()

Retouren:boolean

Gibt true zurück, wenn der Nutzer erfolgreich autorisiert wurde. Andernfalls wird false zurückgegeben.

signOut()

Retouren:gapi.analytics.auth

Der aktuelle Nutzer wird abgemeldet. Löst außerdem das Ereignis signOut aus.

getAuthResponse()

Retouren: Object

Ruft die von der ursprünglichen Autorisierungsanfrage zurückgegebenen Authentifizierungsdaten ab. Das zurückgegebene Objekt enthält das Zugriffstoken, mit dem normalerweise authentifizierte Anfragen manuell gesendet werden können.

getUserProfile()

Retouren: Object

Ruft grundlegende Profilinformationen über den aktuell angemeldeten Nutzer ab. Dazu gehören der Name des Nutzers, seine E-Mail-Adresse und das öffentliche Profilbild (falls festgelegt).

Übernommene Methoden

on
once
off

Optionen

clientId

Typ:string

Die Client-ID Ihres Projekts in der Developers Console.

container

Typ: string|HTMLElement

Die ID eines HTML-Elements im DOM, in dem die Anmeldeschaltfläche gehostet wird. Sie können auch einen Verweis auf das Element selbst übergeben.

userInfoLabel

Typ:string

Der Text, der vor der E-Mail-Adresse eines angemeldeten Nutzers angezeigt werden soll Die Standardeinstellung ist 'You are logged in as: '.

scopes

Typ:Array

Eine Liste von Google API-Authentifizierungsbereichen, die von Ihrer Anwendung angefordert werden. Eine Übersicht über alle verfügbaren Bereiche finden Sie im OAuth 2.0 Playground. Informationen zu Authentifizierungsbereichen für die Google Analytics API finden Sie in den Entwicklerleitfäden für die Konfiguration und die Berichterstellung.

overwriteDefaultScopes

Typ: boolean

Gibt an, ob die Option scopes die standardmäßigen Embed API-Bereiche ersetzt oder ergänzt. Wenn Sie false (Standardeinstellung) angeben, werden die Standardbereiche hinzugefügt. Wenn Sie true angeben, werden sie durch die in der Option scopes angegebenen Werte ersetzt.

Der Standardwert für Bereiche ist:['https://www.googleapis.com/auth/analytics.readonly'].

Hinweis: Für die Authentifizierung über die Embed API ist der Zugriff auf das Basisprofil des Nutzers erforderlich. Diese Bereiche können nicht überschrieben werden.

serverAuth.access_token

Typ:string

Wenn Sie bereits ein gültiges Zugriffstoken haben, können Sie es direkt an die Autorisierungsmethode übergeben. Der Nutzer wird dann nicht zur Autorisierung aufgefordert. Weitere Informationen zum Abrufen eines Zugriffstokens finden Sie in der OAuth 2.0-Dokumentation.

Events

signIn

Argumente:Keine

Wird ausgelöst, wenn sich der Nutzer erfolgreich angemeldet hat

signOut

Argumente: Keine

Wird ausgelöst, wenn sich der Nutzer erfolgreich abgemeldet hat

needsAuthorization

Argumente: Keine

Beim Aufrufen der Methode gapi.analytics.auth.authorize wird zuerst geprüft, ob der Nutzer gerade angemeldet ist. Wenn der Nutzer nicht angemeldet ist, wird dieses Ereignis ausgelöst, um anzugeben, dass eine weitere Autorisierung erforderlich ist.

error

Argumente: response

Wird ausgelöst, wenn während des Authentifizierungsprozesses ein Fehler auftritt Wenn Sie die Fehlermeldung aus dem Antwortobjekt erhalten möchten, finden Sie sie unter response.error.message.

Eingestellte Ereignisse
success

Argumente: response

Dieses Ereignis ist aus Gründen der Abwärtskompatibilität vorhanden und wird möglicherweise in einer zukünftigen Version entfernt. Verwenden Sie stattdessen das Ereignis signIn.

Beispiel

// 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'
  }
});

Daten

gapi.analytics.report.Data
Konstruktor
Data(options:Object) Mit der Komponente „Daten“ können Sie die Core Reporting API von Google Analytics abfragen und die Ergebnisse abrufen.

Optionen

query

Typ:Object

Ein Objekt, das Abfrageparameter der Core Reporting API enthält. Die folgenden Standardwerte werden zusätzlich zu den normalen Standardeinstellungen der API verwendet:

{
  'start-date': '7daysAgo',
  'end-date': 'yesterday
}

Übernommene Methoden

get
set
execute
on
once
off
emit

Events

success

Argumente: response

Wird ausgelöst, wenn die Abfrage erfolgreich abgeschlossen wurde

error

Argumente: response

Wird ausgelöst, wenn während des Abfragevorgangs ein Fehler auftritt Wenn Sie die Fehlermeldung aus dem Antwortobjekt erhalten möchten, finden Sie sie unter response.error.message.

Beispiel

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
Konstruktor
DataChart(options:Object) DataChart fasst ein Standard-Google-Diagramm und eine Daten-Komponente zusammen, sodass Sie ganz einfach eine Visualisierung aus einer Abfrage erstellen können, ohne sie selbst verbinden zu müssen.

Optionen

query

Typ:Object

Siehe Abfrageoption für Datenkomponenten

chart

Typ:Object

Details zu den einzelnen Diagrammoptionen finden Sie unten.

chart.container

Typ: string|HTMLElement

Die ID eines HTML-Elements im DOM, in dem das DataChart gehostet wird. Sie können auch einen Verweis auf das Element selbst übergeben.

chart.type

Typ: string

Der Diagrammtyp. Mögliche Optionen sind: LINE, COLUMN, BAR, TABLE und GEO.

chart.options

Typ:Object

Alle Optionen, die an das entsprechende Google Chart-Objekt übergeben werden können.

Übernommene Methoden

get
set
execute
on
once
off
emit

Events

success

Argumente: result

Wird ausgelöst, wenn die Abfrage abgeschlossen und das Diagramm vollständig gerendert wurde

  • result.chart: Die Google Chart-Instanz.
  • result.data: Die Berichtsantwort im Format Datenparameter.
  • result.dataTable: Die DataTable-Instanz, die aus dem result.data-Objekt erstellt wurde.
  • result.response: Das unbearbeitete API-Antwortobjekt.
error

Argumente: response

Wird ausgelöst, wenn während der Abfrage oder des Renderings ein Fehler auftritt Wenn Sie die Fehlermeldung aus dem Antwortobjekt erhalten möchten, finden Sie sie unter response.error.message.

Beispiel

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();

Ansichtsauswahl

gapi.analytics.ViewSelector
Konstruktor
ViewSelector(options:Object) Mit der Komponente „ViewSelector“ können Sie über Drop-down-Menüs Ihr Konto, Ihre Property und Ihre Datenansicht auswählen.

Optionen

container

Typ: string|HTMLElement

Die ID eines HTML-Elements im DOM, auf dem der ViewSelector gehostet wird. Sie können auch einen Verweis auf das Element selbst übergeben.

Übernommene Methoden

get
set
execute
on
once
off
emit

Instanz-Attribute

ids

Typ:string

Die eindeutige Tabellen-ID im Format „ga:XXXX“, wobei XXXX die ID der Analytics-Datenansicht (Profil) ist.

Events

change

Argumente: ids

Wird jedes Mal ausgelöst, wenn der Nutzer eine neue Ansicht aus den Drop-down-Menüs auswählt. Er wird auch ausgelöst, wenn die ViewSelector-Instanz zum ersten Mal gerendert und die Standardansicht angezeigt wird.

Beispiel

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

Gemeinsam genutzte Komponentenmethoden

Methoden
set(options)

returns: this

Legt die Konfigurationsoptionen der Komponente fest oder aktualisiert sie (kann auch bei der Erstellung im Konstruktor erfolgen).

get()

returns: Object

Gibt die aktuellen Konfigurationsoptionen einer Komponente zurück.

execute()

returns: this

Ruft die primäre Aktion der Komponente auf Dadurch wird normalerweise etwas auf der Seite gerendert oder ein Bericht erstellt (oder beides).

on(event, handler)

returns: this

Registriert eine Funktion, die aufgerufen werden soll, wenn die Komponente das angegebene Ereignis ausgibt.

once(event, handler)

returns: this

Registriert eine Funktion, die nur beim nächsten Auftreten des angegebenen Ereignisses aufgerufen werden soll. Nachdem der Handler ausgeführt wurde, wird die automatische Registrierung aufgehoben.

off(opt_event, opt_handler)

returns: undefined

Entfernt einen Ereignis-Handler aus einer Komponente. Wenn kein Handler übergeben wird, werden alle Handler für das übergebene Ereignis entfernt. Wenn kein Ereignis übergeben wird, werden alle Handler für alle Ereignisse entfernt.

emit(event, ...opt_args)

returns: undefined

Gibt ein Ereignis aus Sie können optional die Argumente angeben, die an alle registrierten Handler übergeben werden sollen.

set

Legt die Konfigurationsoptionen der Komponente fest oder aktualisiert sie (kann auch bei der Erstellung im Konstruktor erfolgen).

Nutzung

component.set(options);

Parameter

Name Typ Beschreibung
options Object Die Konfigurationsoptionen für diese Komponente. Die übergebenen Optionen werden mit den vorhandenen Optionen zusammengeführt.

Gibt Folgendes zurück:

this: Die Komponenteninstanz.


get

Gibt die aktuellen Konfigurationsoptionen einer Komponente zurück.

Gibt Folgendes zurück:

Object: Die aktuellen Konfigurationsoptionen der Komponente.


execute()

Ruft die primäre Aktion der Komponente auf Dadurch wird normalerweise etwas auf der Seite gerendert oder ein Bericht erstellt (oder beides).

Gibt Folgendes zurück:

this: Die Komponenteninstanz.


on(event, handler)

Registriert eine Funktion, die aufgerufen werden soll, wenn die Komponente das angegebene Ereignis ausgibt.

Parameter

Name Typ Beschreibung
event string Der Name des Ereignisses.
handler Function Die Funktion, die beim Eintreten des Ereignisses aufgerufen werden soll. Parameterdetails finden Sie in den jeweiligen Ereignisreferenzen.

Gibt Folgendes zurück:

this: Die Komponenteninstanz.


once(event, handler)

Registriert eine Funktion, die nur beim nächsten Auftreten des angegebenen Ereignisses aufgerufen werden soll. Nachdem der Handler ausgeführt wurde, wird die automatische Registrierung aufgehoben.

Parameter

Name Typ Beschreibung
event string Der Name des Ereignisses.
handler Function Die Funktion, die beim Eintreten des Ereignisses aufgerufen werden soll. Parameterdetails finden Sie in den jeweiligen Ereignisreferenzen.

Gibt Folgendes zurück:

this: Die Komponenteninstanz.


off(opt_event, opt_handler)

Entfernt einen Ereignis-Handler aus einer Komponente. Wenn kein Handler übergeben wird, werden alle Handler für das übergebene Ereignis entfernt. Wenn kein Ereignis übergeben wird, werden alle Handler für alle Ereignisse entfernt.

Parameter

Name Typ Beschreibung
opt_event string Der Name des Ereignisses. Wenn kein Ereignis angegeben ist, werden alle Handler für alle Ereignisse entfernt. Optional.
opt_handler Function Ein Verweis auf den zu entfernenden Funktions-Handler. Wenn keine Funktion übergeben wird, werden alle Handler entfernt. Optional.

Gibt Folgendes zurück:

undefined


emit(event, ...opt_args)

Gibt ein Ereignis aus Sie können optional die Argumente angeben, die an alle registrierten Handler übergeben werden sollen.

Parameter

Name Typ Beschreibung
event string Der Name des Ereignisses.
...opt_args * Optionale Argumente, die an alle registrierten Ereignis-Handler übergeben werden.

Gibt Folgendes zurück:

undefined