Panduan memulai developer Google Analytics Admin API

Dalam panduan memulai ini, Anda akan membuat dan mengirim permintaan list ke Google Analytics Admin API, lalu melihat respons untuk menyiapkan dan memverifikasi akses API Anda.

Anda dapat menyelesaikan panduan memulai ini menggunakan SDK, atau REST API di lingkungan lokal atau instance VM Google Cloud.

Berikut ringkasan langkah-langkahnya:

  • Siapkan project Google Cloud dan aktifkan Google Analytics Admin API.
  • Di mesin lokal atau instance VM Cloud Anda:
    • Menginstal, melakukan inisialisasi, dan mengautentikasi dengan Google Cloud.
    • Instal SDK untuk bahasa Anda (opsional).
  • Konfigurasikan autentikasi.
  • Konfigurasi akses Google Analytics.
  • Siapkan SDK.
  • Lakukan panggilan API.

Menyiapkan project Google Cloud

Klik tombol Aktifkan Google Analytics Admin API berikut untuk memilih atau membuat project Google Cloud baru dan mengaktifkan Google Analytics Admin API secara otomatis.

Mengaktifkan Google Analytics Admin API

Menyiapkan Google Cloud

Di komputer lokal atau instance VM Cloud, siapkan dan lakukan autentikasi dengan Google Cloud.

  1. Instal dan lakukan inisialisasi Google Cloud.

  2. Untuk memastikan komponen gcloud Anda sudah yang terbaru, jalankan perintah berikut.

    gcloud components update

Untuk menghindari pemberian project ID ke Google Cloud, Anda dapat menggunakan perintah gcloud config set untuk menetapkan project dan region default.

Mengonfigurasi autentikasi

Panduan memulai ini menggunakan Kredensial Default Aplikasi untuk menemukan kredensial secara otomatis berdasarkan lingkungan aplikasi, sehingga Anda tidak perlu mengubah kode klien untuk mengautentikasi.

Google Analytics Admin API mendukung akun pengguna dan akun layanan:

  • Akun pengguna mewakili developer, administrator, atau orang lain yang berinteraksi dengan Google API dan layanan Google.
  • Akun layanan tidak mewakili pengguna manusia tertentu. Akun ini menyediakan cara untuk mengelola autentikasi dan otorisasi saat manusia tidak terlibat secara langsung, seperti saat aplikasi perlu mengakses resource Google Cloud.

Untuk mempelajari autentikasi dan menyiapkan kredensial akun untuk aplikasi Anda lebih lanjut, lihat Metode autentikasi di Google.

Akun PenggunaAkun Layanan

Buat file Kredensial Default Aplikasi (ADC) lokal dengan menjalankan perintah berikut. Perintah ini meluncurkan alur web tempat Anda memberikan kredensial pengguna.

  gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"

Jangan lupa untuk menentukan cakupan yang diperlukan oleh Google Analytics Admin API dalam perintah. Untuk informasi selengkapnya, lihat Menyiapkan Kredensial Default Aplikasi

Berikut adalah langkah-langkah untuk mengautentikasi dengan akun layanan:

  1. Membuat akun layanan
  2. Lampirkan akun layanan ke instance Cloud VM Anda dengan menjalankan perintah gcloud CLI berikut:
  gcloud compute instances stop YOUR-VM-INSTANCE-ID

  gcloud compute instances set-service-account YOUR-VM-INSTANCE-ID \
    --service-account YOUR-SERVICE-ACCOUNT-EMAIL-ALIAS  \
    --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"

Jangan lupa untuk menentukan cakupan yang diperlukan oleh Google Analytics Admin API dalam perintah. Untuk informasi selengkapnya, lihat Menyiapkan Kredensial Default Aplikasi

Mengonfigurasi akses ke Google Analytics

Berikan akses Google Analytics ke email yang terkait dengan akun pengguna atau layanan Anda.

Menyiapkan SDK untuk bahasa pemrograman Anda

Di komputer lokal, instal SDK untuk bahasa pemrograman Anda.

JavaPHPPythonNode.js.NETRubyGoREST

Panduan penginstalan library klien Java

Panduan penginstalan library klien PHP

Panduan penginstalan library klien Python

Panduan penginstalan library klien Node.js

Panduan penginstalan library klien .NET

Panduan penginstalan library klien Ruby 

go get google.golang.org/genproto/googleapis/analytics/admin/v1beta

Konfigurasikan variabel lingkungan Anda dengan memasukkan hal berikut. Ganti PROJECT_ID dengan ID project Google Cloud Anda. 

  EXPORT PROJECT_ID=PROJECT_ID

Melakukan panggilan API

Jalankan kode berikut untuk melakukan panggilan pertama:

JavaPHPPythonNode.js.NETREST

google-analytics-admin/src/main/java/com/google/analytics/admin/samples/QuickstartSample.java
Buka di Cloud Shell Lihat di GitHub 
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();
        }
      }
    }
  }
}

QuickstartSample.java

google-analytics-admin/quickstart.php
Buka di Cloud Shell Lihat di GitHub 
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;
}
quickstart.php

google-analytics-admin/quickstart.py
Buka di Cloud Shell Lihat di GitHub 
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)


quickstart.py

google-analytics-admin/quickstart.js
Buka di Cloud Shell Lihat di GitHub 
  // 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('Accounts:');
    for (const account of response) {
      console.log('Account name:', account.name);
      console.log('Display name:', account.displayName);
      console.log('Region code:', account.regionCode);
      console.log('Create time:', account.createTime.seconds);
      console.log('Update time:', account.updateTime.seconds);
    }
  }

  listAccounts();
quickstart.js

analytics-admin/QuickStart/QuickStart.cs
Buka di Cloud Shell Lihat di GitHub 
using Google.Analytics.Admin.V1Beta;
using Google.Api.Gax;
using System;

namespace AnalyticsSamples
{
    class QuickStart
    {
        static void Main(string[] args)
        {
            AnalyticsAdminServiceClient client = AnalyticsAdminServiceClient.Create();
            PagedEnumerable<ListAccountsResponse, Account> response =
                client.ListAccounts( new ListAccountsRequest() );
            foreach( Account account in response )
            {
                Console.WriteLine("Account name: {0}", account.Name);
                Console.WriteLine("Display name: {0}", account.DisplayName);
                Console.WriteLine("Region code: {0}", account.RegionCode);
                Console.WriteLine("Update time: {0}", account.UpdateTime);
                Console.WriteLine("Create time: {0}", account.CreateTime);
                Console.WriteLine();
            }
        }
    }
}
QuickStart.cs

Untuk mengirim permintaan ini, jalankan perintah curl dari command line atau sertakan panggilan REST di aplikasi Anda. 

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: ${PROJECT_ID}" \
  -H "Content-Type: application/json" \
  https://analyticsadmin.googleapis.com/v1beta/accounts

Contoh respons kode mencantumkan akun Google Analytics yang dapat dilihat oleh pengguna atau akun layanan Anda:

{
  "accounts": [
    {
      "name": "accounts/123456789",
      "createTime": "2025-01-01T00:12:23.456Z",
      "createTime": "2025-01-01T00:12:23.456Z",
      "displayName": "Demo Account",
      "regionCode": "US",
      "gmpOrganization": "marketingplatformadmin.googleapis.com/organizations/abcdef12345678"
    }
}