Von Partnern verwaltete Konten bereitstellen – API-Entwicklerleitfaden

Einleitung

createAccountTree ist Teil der Provisioning API, mit der in großem Umfang neue Google Analytics-Konten erstellt werden können. Im Gegensatz zu createAccountTicket erfordert createAccountTree keine Endnutzerinteraktion, um die Kontoerstellung abzuschließen. Der Vorgang erfolgt vollständig automatisiert. Das ist nützlich, wenn Sie ein Analytics-Konto bereitstellen müssen, das Sie im Auftrag eines Kunden verwalten und in dem Sie dem Kunden eine benutzerdefinierte Ansicht dieser Daten zur Verfügung stellen.

Diese API ist Partnern vorbehalten, die die Websites oder Web-Properties ihrer Nutzer verwalten. Wenn Ihre Nutzer ihre Websites oder Web-Properties selbst verwalten, sollten Sie stattdessen Analytics-Konten mit Nutzersteuerung erstellen.

Vorbereitung

Der Zugriff auf alle Google Analytics APIs erfolgt auf ähnliche Weise. Bevor Sie mit der Provisioning API beginnen, sollten Sie Folgendes tun:

  • Auf der Seite Clientbibliotheken finden Sie eine vollständige Liste der programmiersprachenspezifischen Clientbibliotheken, die mit der API funktionieren.
  • Im Referenzhandbuch erhalten Sie Informationen zur API-Oberfläche und zum Zugriff auf Daten ohne Clientbibliothek.

Jede Clientbibliothek stellt ein einzelnes Analysedienstobjekt für den Zugriff auf die Provisioning API bereit. In der Regel müssen Sie die folgenden Schritte ausführen, um das Dienstobjekt zu erstellen:

  1. Registrieren Sie Ihre Anwendung in der Google API Console.
  2. Autorisieren Sie die Berechtigung, ein neues Google Analytics-Konto zu erstellen.
  3. Erstellen Sie ein Analytics-Dienstobjekt.

Falls Sie diese Schritte noch nicht ausgeführt haben, beenden Sie bitte die Anleitung zur Google Analytics API. In dieser Anleitung werden Sie durch die ersten Schritte zum Erstellen einer Google Analytics API-Anwendung geführt. Anschließend wissen Sie, wie Sie mit den Google Analytics APIs praktische Aufgaben ausführen.

Das Vorlagenkonto

Im Rahmen der Autorisierung zur Verwendung dieser API müssen Sie ein neues Google Analytics-Konto angeben, das als Vorlagenkonto für diese API dient. Neue Konten übernehmen verschiedene Einstellungen aus dem Vorlagenkonto, z. B. die Annahme der Nutzungsbedingungen, die Organisation und verschiedene Einstellungen für die Datenfreigabe. Weitere Details zum Vorlagenkonto, einschließlich einer Liste aller übernommenen Daten, finden Sie in der Referenz zu createAccountTree.

Ein Konto bereitstellen

Wenn Sie ein neues Google Analytics-Konto bereitstellen möchten, stellen Sie eine Anfrage an den createAccountTree API-Endpunkt. Sie benötigen die folgenden Details zur Bereitstellung:

  • Account-Felder
    • Ein accountName für das Konto.
  • Web-Property-Felder
    • Ein webpropertyName für die Property.
    • Ein websiteUrl. Das sollte die URL sein, die mit der Nutzereigenschaft für dieses Analytics-Konto verknüpft ist.
  • View-Felder
    • Ein profileName für die Ansicht.
    • Ein timezone für die Ansicht.

Sobald Sie die Details haben, führen Sie einen authentifizierten Aufruf an den API-Endpunkt aus:

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

Wenn der Vorgang erfolgreich war, gibt die API die Details des neu erstellten Kontos, der Web-Property und der Datenansicht zurück:

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

Kontoinhaber und -verwaltung

Das erstellte Google Analytics-Konto gehört dem Nutzerkonto, das die Antwort über OAuth autorisiert hat. Daher empfehlen wir Ihnen, für die Verwaltung des Analytics-Kontos ein Dienstkonto zu verwenden, anstatt ein einzelnes Nutzerkonto zu verwenden.

Nachdem das Konto erstellt wurde, können Sie es mit der Management API konfigurieren. Im Folgenden sind einige häufige Aufgaben für neu erstellte Konten aufgeführt:

Klärung der Kontobeziehungen

Wie bei allen Google APIs ist ein Google Cloud-Projekt als Ausgangspunkt für die Autorisierung der Anfrage erforderlich. Wie in der OAuth 2.0-Dokumentation beschrieben, verwalten Sie in diesem Konto Ihre Anmeldedaten für API-Anfragen. Das erstellte Google Analytics-Konto ist jedoch in keiner Weise direkt mit dem Cloud-Projekt oder dessen Verwaltungskonten verknüpft. Es ist nur mit dem Nutzer oder Dienstkonto verknüpft, der die Anfrage autorisiert hat. Sie können die Management API verwenden, wenn Sie den Kontozugriff auf das Analytics-Konto konfigurieren müssen.