Hello Analytics Reporting API Version 4; Python-Kurzanleitung für Dienstkonten

In dieser Anleitung werden die Schritte für den Zugriff auf Version 4 der Analytics Reporting API beschrieben.

Hinweis: Diese Kurzanleitungen sollen Ihnen die ersten Hürden bei der API-Autorisierung mit den Google API-Clientbibliotheken erleichtern. Da sich diese Bibliotheken in der aktiven Entwicklung befinden, können diese Leitfäden gelegentlich nicht mit den neuesten Clientbibliotheken synchron sein. Falls dieses Problem auftritt, lesen Sie die Dokumentation der Clientbibliothek und gegebenenfalls die Hilfedokumentation.

1. API aktivieren

Wenn Sie die Analytics Reporting API Version 4 verwenden möchten, müssen Sie zuerst das Einrichtungstool verwenden. Es führt Sie durch die Erstellung eines Projekts in der Google API Console sowie durch die Aktivierung der API und die Erstellung von Anmeldedaten.

Anmeldedaten erstellen

Hinweis: Wenn Sie dazu aufgefordert werden, klicken Sie auf Neuen privaten Schlüssel bereitstellen. Wählen Sie als Schlüsseltyp JSON aus und speichern Sie den generierten Schlüssel als client_secrets.json. Sie benötigen ihn später in dieser Anleitung.

1. Öffne die Seite Dienstkonten. Wähle ein Projekt aus, wenn du dazu aufgefordert wirst.
2. Klicke auf Dienstkonto erstellen und gib einen Namen und eine Beschreibung für das Dienstkonto ein. Du kannst die standardmäßige Dienstkonto-ID verwenden oder eine andere eindeutige ID auswählen. Wenn du fertig bist, klicke auf Erstellen.
3. Für den folgenden Abschnitt Dienstkontoberechtigungen (optional) sind keine Maßnahmen erforderlich. Klicke auf Weiter.
4. Scrolle auf dem Bildschirm Nutzern Zugriff auf dieses Dienstkonto erteilen nach unten zum Abschnitt Schlüssel erstellen. Klicke auf Schlüssel erstellen.
5. Wähle in der angezeigten Seitenleiste das Format für deinen Schlüssel aus. Empfohlen wird JSON.
6. Klicken Sie auf Erstellen. Dein neues öffentliches/privates Schlüsselpaar wird generiert und auf deinen Computer heruntergeladen. Dies ist die einzige Kopie dieses Schlüssels. Informationen dazu, wie du den Schlüssel sicher speicherst, findest du unter Dienstkontoschlüssel verwalten.
7. Klicke im Dialogfeld Privater Schlüssel auf deinem Computer gespeichert auf Schließen und dann auf Fertig, um zur Tabelle deiner Dienstkonten zurückzukehren.

Dienstkonto zum Google Analytics-Konto hinzufügen

Das neu erstellte Dienstkonto hat eine E-Mail-Adresse, die in etwa so aussieht:

[e-mail]

Verwenden Sie diese E-Mail-Adresse, um der Google Analytics-Datenansicht, auf die Sie über die API zugreifen möchten, einen Nutzer hinzuzufügen. Für diese Anleitung sind nur die Berechtigungen zum Lesen und Analysieren erforderlich.

2. Clientbibliothek installieren

Die Verwendung von pip zusammen mit venv wird für die Installation von Python-Paketen empfohlen: sudo -s apt-get install python3-venv python3 -m venv analytics-Schnellstart source analytics-tooltip/bin/activate pip install --upgrade google-api-python-client pip install --upgrade oauth2client

3. Beispiel einrichten

Sie müssen eine einzelne Datei mit dem Namen HelloAnalytics.py erstellen, die den angegebenen Beispielcode enthält.

1. Kopieren oder laden Sie den folgenden Quellcode in HelloAnalytics.py herunter.
2. Verschieben Sie die zuvor heruntergeladene client_secrets.json in das Verzeichnis, in dem sich auch der Beispielcode befindet.
3. Ersetzen Sie den Wert von KEY_FILE_LOCATION durch den entsprechenden Pfad zum heruntergeladenen client_secrets.json.
4. Ersetzen Sie den Wert von VIEW_ID. Mit dem Konto-Explorer können Sie die ID der Datenansicht ermitteln.

"""Hello Analytics Reporting API V4."""

from apiclient.discovery import build
from oauth2client.service_account import ServiceAccountCredentials


SCOPES = ['https://www.googleapis.com/auth/analytics.readonly']
KEY_FILE_LOCATION = '<REPLACE_WITH_JSON_FILE>'
VIEW_ID = '<REPLACE_WITH_VIEW_ID>'


def initialize_analyticsreporting():
  """Initializes an Analytics Reporting API V4 service object.

  Returns:
    An authorized Analytics Reporting API V4 service object.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      KEY_FILE_LOCATION, SCOPES)

  # Build the service object.
  analytics = build('analyticsreporting', 'v4', credentials=credentials)

  return analytics


def get_report(analytics):
  """Queries the Analytics Reporting API V4.

  Args:
    analytics: An authorized Analytics Reporting API V4 service object.
  Returns:
    The Analytics Reporting API V4 response.
  """
  return analytics.reports().batchGet(
      body={
        'reportRequests': [
        {
          'viewId': VIEW_ID,
          'dateRanges': [{'startDate': '7daysAgo', 'endDate': 'today'}],
          'metrics': [{'expression': 'ga:sessions'}],
          'dimensions': [{'name': 'ga:country'}]
        }]
      }
  ).execute()


def print_response(response):
  """Parses and prints the Analytics Reporting API V4 response.

  Args:
    response: An Analytics Reporting API V4 response.
  """
  for report in response.get('reports', []):
    columnHeader = report.get('columnHeader', {})
    dimensionHeaders = columnHeader.get('dimensions', [])
    metricHeaders = columnHeader.get('metricHeader', {}).get('metricHeaderEntries', [])

    for row in report.get('data', {}).get('rows', []):
      dimensions = row.get('dimensions', [])
      dateRangeValues = row.get('metrics', [])

      for header, dimension in zip(dimensionHeaders, dimensions):
        print(header + ': ', dimension)

      for i, values in enumerate(dateRangeValues):
        print('Date range:', str(i))
        for metricHeader, value in zip(metricHeaders, values.get('values')):
          print(metricHeader.get('name') + ':', value)


def main():
  analytics = initialize_analyticsreporting()
  response = get_report(analytics)
  print_response(response)

if __name__ == '__main__':
  main()

4. Beispiel ausführen

Führen Sie das Beispiel mit dem folgenden Befehl aus:

python HelloAnalytics.py

Wenn Sie diese Schritte abgeschlossen haben, gibt das Beispiel die Anzahl der Sitzungen in den letzten sieben Tagen für die jeweilige Ansicht aus.

Hinweis :Sie benötigen mindestens eine Google Analytics-Property und -Datenansicht, um dieses Beispiel ausführen zu können.

Fehlerbehebung

AttributeError: Objekt "Module_six_moves_urllib_parse" hat kein Attribut "urlparse"

Dieser Fehler kann unter Mac OSX auftreten, wo die Standardinstallation des Moduls "six" (eine Abhängigkeit dieser Bibliothek) vor dem Modul geladen wird, das pip installiert hat. Um das Problem zu beheben, fügen Sie den Installationsspeicherort von pip der Systemumgebungsvariablen PYTHONPATH hinzu:

• Bestimmen Sie den Installationspfad von pip mit dem folgenden Befehl:

  pip show Six | grep "Location:" | cut -d " " -f2

• Fügen Sie der Datei ~/.bashrc die folgende Zeile hinzu und ersetzen Sie dabei <pip_install_path> durch den oben ermittelten Wert:

  export PYTHONPATH=$PYTHONPATH:<pip_install_path>

• Laden Sie die Datei ~/.bashrc mit dem folgenden Befehl in allen geöffneten Terminalfenstern neu:

  Quelle: ~/.bashrc