Referenz zu integrierten 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-Element, mit dem ein Nutzer autorisiert werden kann.

Methoden
authorize(options:Object)	Gibt Folgendes zurück:  gapi.analytics.auth Rendering einer Google Analytics-Anmeldeschaltfläche im angegebenen Container, über die sich der Nutzer mit seinem Google-Konto anmelden kann.
isAuthorized()	Gibt Folgendes zurück:  boolean Gibt true zurück, wenn der Nutzer die Autorisierung erfolgreich ausgeführt hat. Andernfalls wird false zurückgegeben.
signOut()	Gibt Folgendes zurück:  gapi.analytics.auth Hiermit wird der aktuelle Nutzer abgemeldet. Löst auch das Ereignis signOut aus.
getAuthResponse()	Gibt Folgendes zurück:  Object Ruft Authentifizierungsdaten ab, die von der ursprünglichen Autorisierungsanfrage zurückgegeben wurden. Das zurückgegebene Objekt enthält das Zugriffstoken, das normalerweise für manuelle authentifizierte Anfragen verwendet werden kann.
getUserProfile()	Gibt Folgendes zurück:  Object Ruft grundlegende Profilinformationen zum aktuell angemeldeten Nutzer ab. Dazu gehören Name, 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 Developer Console.
container	Typ:string|HTMLElement Die ID eines HTML-Elements im DOM, das die Anmeldeschaltfläche hostet. 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 wird. Die Standardeinstellung ist 'You are logged in as: '.
scopes	Typ:Array Eine Liste der Google API-Authentifizierungsbereiche, die Ihre Anwendung anfordert. Eine Liste aller verfügbaren Bereiche finden Sie im OAuth 2.0 Playground. Informationen zu den Authentifizierungsbereichen der Google Analytics API finden Sie in den Entwicklerleitfäden für die Ressourcen zur Konfiguration und zur 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 Bereiche zu den Standardbereichen hinzugefügt. Wenn Sie true angeben, werden sie durch die Bereiche ersetzt, die mit der Option scopes angegeben werden. Der standardmäßige Bereichswert 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. Ausführliche Informationen zum Abrufen eines Zugriffstokens finden Sie in der OAuth 2.0-Dokumentation.

Veranstaltungen
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 derzeit 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 Authentifizierungsvorgangs ein Fehler auftritt. Wenn Sie die Fehlermeldung vom Antwortobjekt erhalten möchten, finden Sie diese unter response.error.message.

Eingestellte Ereignisse
success	Argumente:  response Dieses Ereignis dient nur der Abwärtskompatibilität 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'
  }
});

Hinweis:Die Autorisierung erfolgt sofort, wenn serverAuth.access_token verwendet wird. Es ist also nicht nötig, einen Event-Handler zu registrieren.

Wichtig:Wenn Sie serverAuth.access_token verwenden, müssen Sie selbst dafür sorgen, dass das Token gültig und nicht abgelaufen ist. Weitere Informationen zum Aktualisieren eines abgelaufenen Zugriffstokens finden Sie in der OAuth 2.0-Dokumentation.

Daten

gapi.analytics.report.Data

Konstruktor
Data(options:Object)	Mit der Datenkomponente können Sie die Google Analytics Core Reporting API abfragen, um die Ergebnisse zurückzugeben.

Optionen
query	Typ:Object Ein Objekt, das Abfrageparameter aus der Core Reporting API enthält. Die folgenden Standardwerte werden zusätzlich zu den regulären Standardeinstellungen der API verwendet: { 'start-date': '7daysAgo', 'end-date': 'yesterday }

Übernommene Methoden
get
set
execute
on
once
off
emit

Veranstaltungen
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 vom Antwortobjekt erhalten möchten, finden Sie diese 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 umfasst ein standardmäßiges Google-Diagramm und eine Datenkomponente, 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 Weitere Informationen zu den einzelnen Diagrammoptionen finden Sie unten.
chart.container	Typ:string|HTMLElement Die ID eines HTML-Elements im DOM, das das DataChart hostet. Sie können auch einen Verweis auf das Element selbst übergeben.
chart.type	Typ:string Diagrammtyp Mögliche Optionen sind: LINE, COLUMN, BAR, TABLE und GEO.
chart.options	Typ:Object Alle Optionen, die an das entsprechende Google-Diagramm-Objekt übergeben werden können.

Übernommene Methoden
get
set
execute
on
once
off
emit

Veranstaltungen
success	Argumente:  result Wird ausgelöst, wenn die Abfrage erfolgreich abgeschlossen und das Diagramm vollständig gerendert wurde. result.chart – Google-Diagramminstanz. result.data: Berichtsantwort im Datenparameterformat result.dataTable: Die DataTable-Instanz, die aus dem result.data-Objekt erstellt wurde. result.response – das API-Rohdatenobjekt.
error	Argumente:  response Wird ausgelöst, wenn während des Abfrage- oder Renderingprozesses ein Fehler auftritt Wenn Sie die Fehlermeldung vom Antwortobjekt erhalten möchten, finden Sie diese 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();

ViewSelector

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, das den ViewSelector hostet. 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.

Veranstaltungen
change	Argumente:  ids Wird immer dann ausgelöst, wenn der Nutzer eine neue Datenansicht aus dem Drop-down-Menü auswählt Sie 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();

Methoden für gemeinsam genutzte Komponenten

Methoden
set(options)	Gibt Folgendes zurück: this Legt die Konfigurationsoptionen der Komponente fest oder aktualisiert sie. Dies kann auch beim Erstellen im Konstruktor erfolgen.
get()	Gibt Folgendes zurück: Object Gibt die aktuellen Konfigurationsoptionen einer Komponente zurück.
execute()	Gibt Folgendes zurück: this Ruft die primäre Aktion der Komponente auf. Dabei wird normalerweise etwas auf der Seite gerendert, ein Bericht erstellt (oder beides).
on(event, handler)	Gibt Folgendes zurück: this Registriert eine Funktion, die aufgerufen werden soll, wenn die Komponente das angegebene Ereignis ausgibt.
once(event, handler)	Gibt Folgendes zurück: this Registriert eine Funktion, die nur beim nächsten Auftreten des angegebenen Ereignisses aufgerufen werden soll. Nachdem der Handler ausgeführt wurde, sobald er automatisch die Registrierung aufgehoben hat.
off(opt_event, opt_handler)	Gibt Folgendes zurück: undefined Entfernt einen Event-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)	Gibt Folgendes zurück: 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. Dies kann auch beim Erstellen im Konstruktor erfolgen.

Nutzung

component.set(options);

Parameter

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

Returns

this: Die Komponenteninstanz.

---

get

Gibt die aktuellen Konfigurationsoptionen einer Komponente zurück.

Returns

Object: Die aktuellen Konfigurationsoptionen der Komponente.

---

execute()

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

Returns

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	Name des Ereignisses
handler	Function	Die Funktion, die beim Eintreten des Ereignisses aufgerufen werden soll. Parameterdetails finden Sie in den einzelnen Ereignisverweisen.

Returns

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, sobald er automatisch die Registrierung aufgehoben hat.

Parameter

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

Returns

this: Die Komponenteninstanz.

---

off(opt_event, opt_handler)

Entfernt einen Event-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	Name des Ereignisses Wenn kein Ereignis angegeben ist, werden alle Handler für alle Ereignisse entfernt. Optional.
opt_handler	Function	Ein Verweis auf den Funktions-Handler, der entfernt werden soll. Wenn keine Funktion übergeben wird, werden alle Handler entfernt. Optional.

Returns

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	Name des Ereignisses
...opt_args	*	Optionale Argumente, die an alle registrierten Event-Handler übergeben werden.

Returns

undefined