Hello Analytics API: PHP-Kurzanleitung für Webanwendungen

In dieser Anleitung werden die Schritte beschrieben, die für den Zugriff auf ein Google Analytics-Konto, die Abfrage der Analytics APIs, die Verarbeitung der API-Antworten und die Ausgabe der Ergebnisse erforderlich sind. In dieser Anleitung werden die Core Reporting API Version 3.0, die Management API Version 3.0 und OAuth 2.0 verwendet.

Hinweis:Diese Kurzanleitungen sollen Ihnen helfen, die ersten Hürden der API-Autorisierung mit den Google API-Clientbibliotheken zu bewältigen. Da diese Bibliotheken noch aktiv sind, können diese Leitfäden gelegentlich nicht mit den neuesten Clientbibliotheken synchron sein. Wenn dieses Problem auftritt, sollten Sie die Dokumentation der Clientbibliothek lesen und gegebenenfalls die Hilfe lesen.

Schritt 1: Analytics API aktivieren

Damit du die Google Analytics API verwenden kannst, musst du zuerst mithilfe des Einrichtungstools ein Projekt in der Google API Console erstellen. Dadurch wird die API aktiviert und Anmeldedaten erzeugt.

Wenn Sie eine Web-Client-ID oder einen Client für installierte Anwendungen erstellen möchten, müssen Sie auf dem Zustimmungsbildschirm einen Produktnamen festlegen. Falls noch nicht geschehen, wirst du aufgefordert, den Zustimmungsbildschirm zu konfigurieren.

Client-ID erstellen

Auf der Seite „Anmeldedaten“:

1. Klicken Sie auf Anmeldedaten erstellen und wählen Sie OAuth-Client-ID aus.
2. Wählen Sie Webanwendung für Anwendungstyp aus.
3. Benennen Sie die Anmeldedaten.
4. Lassen Sie das Feld AUTHORIZED JAVASCRIPT OriginS leer. Sie wird für diese Anleitung nicht benötigt.
5. Legen Sie die AUTORISIERTEN REDIRECT-URIs auf http://localhost:8080/oauth2callback.php fest.
6. Klicken Sie auf Erstellen.

Wählen Sie die soeben erstellten Anmeldedaten aus und klicken Sie auf JSON herunterladen. Speichern Sie die heruntergeladene Datei als client_secrets.json. Sie benötigen sie später in der Anleitung.

Schritt 2: Google-Clientbibliothek installieren

Sie können die Google APIs-Clientbibliothek für PHP herunterladen oder Composer verwenden:

composer require google/apiclient:^2.0

Schritt 3: Beispiel einrichten

Sie müssen zwei Dateien erstellen:

1. index.php ist die Hauptseite, die der Nutzer besucht.
2. oauth2callback.php verarbeitet die OAuth 2.0-Antwort.

index.php

Diese Datei enthält die Hauptlogik zum Abfragen der Google Analytics APIs und zum Anzeigen der Ergebnisse. Kopieren Sie den ersten Beispielcode oder laden Sie ihn herunterindex.php.

<?php
// Load the Google API PHP Client Library.
require_once __DIR__ . '/vendor/autoload.php';

// Start a session to persist credentials.
session_start();

// Create the client object and set the authorization configuration
// from the client_secretes.json you downloaded from the developer console.
$client = new Google_Client();
$client->setAuthConfig(__DIR__ . '/client_secrets.json');
$client->addScope(Google_Service_Analytics::ANALYTICS_READONLY);

// If the user has already authorized this app then get an access token
// else redirect to ask the user to authorize access to Google Analytics.
if (isset($_SESSION['access_token']) && $_SESSION['access_token']) {
  // Set the access token on the client.
  $client->setAccessToken($_SESSION['access_token']);

  // Create an authorized analytics service object.
  $analytics = new Google_Service_Analytics($client);

  // Get the first view (profile) id for the authorized user.
  $profile = getFirstProfileId($analytics);

  // Get the results from the Core Reporting API and print the results.
  $results = getResults($analytics, $profile);
  printResults($results);
} else {
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}


function getFirstProfileId($analytics) {
  // Get the user's first view (profile) ID.

  // Get the list of accounts for the authorized user.
  $accounts = $analytics->management_accounts->listManagementAccounts();

  if (count($accounts->getItems()) > 0) {
    $items = $accounts->getItems();
    $firstAccountId = $items[0]->getId();

    // Get the list of properties for the authorized user.
    $properties = $analytics->management_webproperties
        ->listManagementWebproperties($firstAccountId);

    if (count($properties->getItems()) > 0) {
      $items = $properties->getItems();
      $firstPropertyId = $items[0]->getId();

      // Get the list of views (profiles) for the authorized user.
      $profiles = $analytics->management_profiles
          ->listManagementProfiles($firstAccountId, $firstPropertyId);

      if (count($profiles->getItems()) > 0) {
        $items = $profiles->getItems();

        // Return the first view (profile) ID.
        return $items[0]->getId();

      } else {
        throw new Exception('No views (profiles) found for this user.');
      }
    } else {
      throw new Exception('No properties found for this user.');
    }
  } else {
    throw new Exception('No accounts found for this user.');
  }
}

function getResults($analytics, $profileId) {
  // Calls the Core Reporting API and queries for the number of sessions
  // for the last seven days.
  return $analytics->data_ga->get(
      'ga:' . $profileId,
      '7daysAgo',
      'today',
      'ga:sessions');
}

function printResults($results) {
  // Parses the response from the Core Reporting API and prints
  // the profile name and total sessions.
  if (count($results->getRows()) > 0) {

    // Get the profile name.
    $profileName = $results->getProfileInfo()->getProfileName();

    // Get the entry for the first entry in the first row.
    $rows = $results->getRows();
    $sessions = $rows[0][0];

    // Print the results.
    print "<p>First view (profile) found: $profileName</p>";
    print "<p>Total sessions: $sessions</p>";
  } else {
    print "<p>No results found.</p>";
  }
}

?>

oauth2callback.php

Diese Datei verarbeitet die OAuth 2.0-Antwort. Kopieren Sie den zweiten Beispielcode oder laden Sie ihn nach oauth2callback.php herunter.

<?php

// Load the Google API PHP Client Library.
require_once __DIR__ . '/vendor/autoload.php';

// Start a session to persist credentials.
session_start();

// Create the client object and set the authorization configuration
// from the client_secrets.json you downloaded from the Developers Console.
$client = new Google_Client();
$client->setAuthConfig(__DIR__ . '/client_secrets.json');
$client->setRedirectUri('http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php');
$client->addScope(Google_Service_Analytics::ANALYTICS_READONLY);

// Handle authorization flow from the server.
if (! isset($_GET['code'])) {
  $auth_url = $client->createAuthUrl();
  header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));
} else {
  $client->authenticate($_GET['code']);
  $_SESSION['access_token'] = $client->getAccessToken();
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}

Schritt 4: Beispiel ausführen

Nachdem Sie die Analytics API aktiviert haben, haben Sie die Google API-Clientbibliothek für PHP installiert und den Beispielquellcode eingerichtet.

Führen Sie das Beispiel mit einem Webserver aus, der für die Bereitstellung von PHP konfiguriert ist. Wenn Sie PHP 5.4 oder höher verwenden, können Sie den integrierten PHP-Testserver ausführen, indem Sie den folgenden Befehl ausführen:

php -S localhost:8080 /path/to/sample

Rufen Sie dann in Ihrem Browser http://localhost:8080 auf.

Wenn Sie diese Schritte ausführen, gibt das Beispiel den Namen der ersten Google Analytics-Datenansicht (Profil) und die Anzahl der Sitzungen in den letzten sieben Tagen aus.

Hinweis: Damit dieses Beispiel erfolgreich ausgeführt werden kann, benötigen Sie mindestens eine Google Analytics-Property und -Datenansicht (Profil).

Mit dem autorisierten Analytics-Dienstobjekt können Sie jetzt alle Codebeispiele in der Referenzdokumentation zur Management API ausführen. Sie können beispielsweise versuchen, den Code so zu ändern, dass die Methode accountSummaries.list verwendet wird.