مرحبًا بواجهة برمجة تطبيقات "إحصاءات Google": البدء السريع لتطبيقات لغة PHP

يوضّح هذا البرنامج التعليمي الخطوات المطلوبة للوصول إلى حساب على "إحصاءات Google"، والاستعلام عن واجهات برمجة تطبيقات "إحصاءات Google"، والتعامل مع ردود واجهة برمجة التطبيقات، ثم عرض النتائج. يتم استخدام الإصدار 3.0 من واجهة برمجة التطبيقات لإعداد التقارير الأساسية والإصدار 3.0 من واجهة برمجة التطبيقات للإدارة وOAuth2.0 في هذا البرنامج التعليمي.

ملاحظة: إنّ الغرض من أدلة البدء السريع هذه هو مساعدتك في اجتياز العقبات الأولية التي تواجه تفويض واجهة برمجة التطبيقات باستخدام مكتبات عميل Google API. وبما أنّ هذه المكتبات قيد التطوير النشط، قد لا تكون هذه الأدلة متزامنة من حين لآخر مع أحدث مكتبات العملاء. إذا واجهت هذه المشكلة، يجب مراجعة مستندات مكتبة العميل وإذا لزم الأمر، يمكنك الاطّلاع على مستندات المساعدة.

الخطوة 1: تفعيل واجهة برمجة التطبيقات في "إحصاءات Google"

لبدء استخدام Google Analytics API، عليك أولاً استخدام أداة الإعداد التي ترشدك خلال إنشاء مشروع في وحدة تحكّم Google API وتفعيل واجهة برمجة التطبيقات وإنشاء بيانات الاعتماد.

لإنشاء معرّف عميل على الويب أو عميل تطبيق مثبّت، يجب ضبط اسم منتج في شاشة الموافقة. سيُطلب منك ضبط شاشة الموافقة في حال عدم تنفيذ ذلك.

إنشاء معرِّف عميل

من صفحة "بيانات الاعتماد":

1. انقر على إنشاء بيانات اعتماد واختر رقم تعريف عميل OAuth.
2. اختَر تطبيق ويب من أجل نوع التطبيق.
3. أدخِل اسمًا لبيانات الاعتماد.
4. اترك حقل مصادر JavaScript المعتمَدة فارغًا، ولن تحتاج إلى إضافة هذا البرنامج التعليمي.
5. اضبط معرّفات الموارد المنتظمة (URI) المُعتمَدة الإذن على http://localhost:8080/oauth2callback.php
6. انقر على إنشاء.

اختَر بيانات الاعتماد التي أنشأتها للتو وانقر على تنزيل JSON. احفظ الملف الذي تم تنزيله بتنسيق client_secrets.json، حيث ستحتاج إليه لاحقًا في البرنامج التعليمي.

الخطوة 2: تثبيت "مكتبة عملاء Google"

يمكنك الحصول على مكتبة عميل Google APIs لبرنامج PHP تنزيل الإصدار أو باستخدام أداة الإنشاء:

composer require google/apiclient:^2.0

الخطوة 3: إعداد النموذج

يجب إنشاء ملفَين:

1. index.php هي الصفحة الرئيسية التي زارها المستخدم.
2. سيعالج oauth2callback.php استجابة OAuth 2.0.

index.php

يحتوي هذا الملف على المنطق الرئيسي لطلب البحث في واجهات برمجة تطبيقات "إحصاءات Google" وعرض النتائج. انسخ أو انسخ نموذج الرمز الأول إلى index.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

يعالج هذا الملف استجابة OAuth 2.0. انسخ أو نزِّل نموذج الرمز الثاني إلى oauth2callback.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_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));
}

الخطوة 4: تنفيذ عيّنة من الكتاب

بعد تفعيل واجهة برمجة التطبيقات في "إحصاءات Google"، ثبّت مكتبة برامج Google APIs للغة PHP وإعداد نموذج رمز المصدر الذي يصبح النموذج جاهزًا للتشغيل.

شغّل النموذج باستخدام خادم ويب تم إعداده لعرض لغة PHP. إذا كنت تستخدم الإصدار 5.4 أو إصدارًا أحدث من لغة PHP، يمكنك استخدام خادم الويب التجريبي PHP's المضمّن من خلال تنفيذ الأمر التالي:

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

بعد ذلك، انتقِل إلى http://localhost:8080 في متصفّحك.

عند الانتهاء من هذه الخطوات، ينتج عن العيّنة اسم الملف الشخصي الأول في "إحصاءات Google" للمستخدم وعدد الجلسات في آخر سبعة أيام.

ملاحظة: لتشغيل هذا النموذج بنجاح، يجب أن يكون لديك موقع "إحصاءات Google" وملف شخصي واحد على الأقل.

باستخدام عنصر خدمة "إحصاءات Google" المفوَّض، يمكنك الآن تشغيل أيٍّ من نماذج الرموز التي تم العثور عليها في مستندات مرجعية واجهة برمجة تطبيقات الإدارة. على سبيل المثال، يمكنك محاولة تغيير الرمز لاستخدام طريقة accountSummary.list.