מדריך למתחילים: שימוש בספריות לקוח

בדף הזה מוסבר איך להתחיל להשתמש ב-Google Analytics Admin API בשפת התכנות המועדפת עליכם באמצעות ספריות הלקוח.

שלב 1. הפעלת ה-API

לוחצים על הלחצן הזה כדי ליצור פרויקט חדש ב-Cloud Platform ובאופן אוטומטי להפעיל את Google Analytics Admin API:

הפעלת Google Analytics Admin API

בתיבת הדו-שיח שנפתחת, לוחצים על הורדת הגדרת הלקוח ושומרים את הקובץ. credentials.json לספריית העבודה שלך.

שלב 2. להגדרת אימות

האפליקציה הזו מדגימה את השימוש ב-Google Analytics Admin API באמצעות פרטי כניסה לחשבון שירות.

מידע נוסף לקבלת הוראות ליצירה ולהגדרה של פרטי כניסה של חשבון שירות תרגום מכונה.

דרך קלה לספק פרטי כניסה לחשבון שירות היא להגדיר את משתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS, ה-API הלקוח ישתמש בערך של המשתנה כדי למצוא את קובץ ה-JSON של המפתח לחשבון השירות.

כדי להגדיר את פרטי הכניסה של האפליקציה בדוגמה הזו, מריצים את הפקודה הבאה ומשתמשים בנתיב לקובץ ה-JSON של חשבון השירות שהורדתם בשלב 1:

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

לדוגמה:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service_account.json"

שלב 3. התקנת ספריית הלקוח

ביצוע קריאה ל-API

עכשיו אפשר להשתמש ב-Google Analytics Admin API כדי להציג את רשימת הנתונים של Google Analytics חשבונות. כדי לבצע את הקריאה הראשונה ל-API, מריצים את הקוד הבא:

Java

import com.google.analytics.admin.v1beta.Account;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPage;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPagedResponse;
import com.google.analytics.admin.v1beta.ListAccountsRequest;

/**
 * This application demonstrates the usage of the Analytics Admin API using service account
 * credentials. For more information on service accounts, see
 * https://cloud.google.com/iam/docs/understanding-service-accounts.
 *
 * <p>The following document provides instructions on setting service account credentials for your
 * application: https://cloud.google.com/docs/authentication/production
 *
 * <p>In a nutshell, you need to:
 *
 * <ol>
 *   <li>Create a service account and download the key JSON file as described at
 *       https://cloud.google.com/docs/authentication/production#creating_a_service_account.
 *   <li>Provide service account credentials using one of the following options:
 *       <ul>
 *         <li>Set the {@code GOOGLE_APPLICATION_CREDENTIALS} environment variable. The API client
 *             will use the value of this variable to find the service account key JSON file. See
 *             https://cloud.google.com/docs/authentication/production#setting_the_environment_variable
 *             for more information.
 *             <p>OR
 *         <li>Manually pass the path to the service account key JSON file to the API client by
 *             specifying the {@code keyFilename} parameter in the constructor. See
 *             https://cloud.google.com/docs/authentication/production#passing_the_path_to_the_service_account_key_in_code
 *             for more information.
 *       </ul>
 * </ol>
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.admin.samples.QuickstartSample"
 * }</pre>
 */
public class QuickstartSample {

  public static void main(String... args) throws Exception {
    listAccounts();
  }

  // This is an example snippet that calls the Google Analytics Admin API and lists all Google
  // Analytics accounts available to the authenticated user.
  static void listAccounts() throws Exception {
    // Instantiates a client using default credentials.
    // See https://cloud.google.com/docs/authentication/production for more information
    // about managing credentials.
    try (AnalyticsAdminServiceClient analyticsAdmin = AnalyticsAdminServiceClient.create()) {
      // Calls listAccounts() method of the Google Analytics Admin API and prints
      // the response for each account.
      ListAccountsPagedResponse response =
          analyticsAdmin.listAccounts(ListAccountsRequest.newBuilder().build());
      for (ListAccountsPage page : response.iteratePages()) {
        for (Account account : page.iterateAll()) {
          System.out.printf("Account name: %s%n", account.getName());
          System.out.printf("Display name: %s%n", account.getDisplayName());
          System.out.printf("Country code: %s%n", account.getRegionCode());
          System.out.printf("Create time: %s%n", account.getCreateTime().getSeconds());
          System.out.printf("Update time: %s%n", account.getUpdateTime().getSeconds());
          System.out.println();
        }
      }
    }
  }
}

PHP

require 'vendor/autoload.php';

use Google\Analytics\Admin\V1beta\Account;
use Google\Analytics\Admin\V1beta\Client\AnalyticsAdminServiceClient;
use Google\Analytics\Admin\V1beta\ListAccountsRequest;

/**
 * TODO(developer): Replace this variable with your Google Analytics 4
 *   property ID before running the sample.
 */
$property_id = 'YOUR-GA4-PROPERTY-ID';

// Using a default constructor instructs the client to use the credentials
// specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
// See https://cloud.google.com/docs/authentication/production for more information
// about managing credentials.
$client = new AnalyticsAdminServiceClient();

// Calls listAccounts() method of the Google Analytics Admin API and prints
// the response for each account.
$request = new ListAccountsRequest();
$response = $client->listAccounts($request);

print 'Result:' . PHP_EOL;
foreach($response->iterateAllElements() as $account) {
    print 'Account name: ' . $account->getName() . PHP_EOL;
    print 'Display name: ' . $account->getDisplayName() . PHP_EOL;
    print 'Country code: ' . $account->getRegionCode() . PHP_EOL;
    print 'Create time: ' . $account->getCreateTime()->getSeconds() . PHP_EOL;
    print 'Update time: ' . $account->getUpdateTime()->getSeconds() . PHP_EOL;
}

Python

def list_accounts(transport: str = None):
    """
    Lists the available Google Analytics accounts.

    Args:
        transport(str): The transport to use. For example, "grpc"
            or "rest". If set to None, a transport is chosen automatically.
    """
    from google.analytics.admin import AnalyticsAdminServiceClient

    # Using a default constructor instructs the client to use the credentials
    # specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = AnalyticsAdminServiceClient(transport=transport)

    results = client.list_accounts()

    # Displays the configuration information for all Google Analytics accounts
    # available to the authenticated user.
    print("Result:")
    for account in results:
        print(account)


Node.js

  // Imports the Google Analytics Admin API client library.
  const analyticsAdmin = require(@'google-analytics/admin)';

  // Using a default constructor instructs the client to use the credentials
  // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
  const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient();

  // Lists all Google Analytics accounts available to the authenticated user.
  async function listAccounts() {
    // Uses listAccounts() with no arguments to fetch all pages. For more
    // information on pagination in the Node.js library, see:
    // https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#auto-pagination
    const [response] = await analyticsAdminClient.listAccounts();

    console.log(A'ccounts:)';
    for (const account of response) {
      console.log(A'ccount name:,' account.name);
      console.log(D'isplay name:,' account.displayName);
      console.log(R'egion code:,' account.regionCode);
      console.log(C'reate time:,' account.createTime.seconds);
      console.log(U'pdate time:,' account.updateTime.seconds);
    }
  }

  listAccounts();q

‎.NET

using Google.Analytics.Admin.V1Alpha;
using System;

namespace AnalyticsSamples
{
    class QuickStart
    {
        static void Main(string[] args)
        {
            var client = AnalyticsAdminServiceClient.Create();
            var response = client.ListAccounts( new ListAccountsRequest() );
            foreach( Account account in response )
            {
                Console.WriteLine(Account name: {"0}, account.Name)";
                Console.WriteLine(Display name: {0"}, account.Displa"yName);
                Console.WriteLine(Country code: {0}", account.Country"Code);
                Console.WriteLine(Update time: {0}, "account.UpdateTi"me);
                Console.WriteLine(Create time: {0}, a"ccount.CreateTim"e);
                Console.WriteLine();
            }
        }
    }
}
QuickStart.cs

מעולה! שלחת את הבקשה הראשונה שלך אל Google Analytics Admin API.