Panduan memulai developer Google Analytics Data API v1

Dalam panduan memulai ini, Anda akan membuat dan mengirim permintaan list ke Google Analytics Data API v1, 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 Data API v1.
  • 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 Data API v1 berikut untuk memilih atau membuat project Google Cloud baru dan mengaktifkan Google Analytics Data API v1 secara otomatis.

Mengaktifkan Google Analytics Data API v1

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 Data API v1 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 lebih lanjut autentikasi dan menyiapkan kredensial akun untuk aplikasi Anda, lihat Metode autentikasi di Google.

Akun Pengguna

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 Data API v1 dalam perintah. Untuk informasi selengkapnya, lihat Menyiapkan Kredensial Default Aplikasi

Akun Layanan

Berikut adalah langkah-langkah untuk melakukan autentikasi dengan akun layanan menggunakan instance VM Cloud:

  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 Data API v1 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.

Java

Panduan penginstalan library klien Java

PHP

Panduan penginstalan library klien PHP

Python

Panduan penginstalan library klien Python

Node.js

Panduan penginstalan library klien Node.js

.NET

Panduan penginstalan library klien .NET

Ruby

Panduan penginstalan library klien Ruby

Go

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

REST

Konfigurasikan variabel lingkungan Anda dengan memasukkan hal berikut. Ganti PROJECT_ID dengan ID project Google Cloud Anda dan PROPERTY_ID dengan ID properti Google Analytics Anda.

  export PROJECT_ID=PROJECT_ID
  export PROPERTY_ID=PROPERTY_ID

Melakukan panggilan API

Jalankan kode berikut untuk melakukan panggilan pertama:

Java

import com.google.analytics.data.v1beta.BetaAnalyticsDataClient;
import com.google.analytics.data.v1beta.DateRange;
import com.google.analytics.data.v1beta.Dimension;
import com.google.analytics.data.v1beta.Metric;
import com.google.analytics.data.v1beta.Row;
import com.google.analytics.data.v1beta.RunReportRequest;
import com.google.analytics.data.v1beta.RunReportResponse;

/**
 * Google Analytics Data API sample quickstart application.
 *
 * <p>This application demonstrates the usage of the Analytics Data API using service account
 * credentials.
 *
 * <p>Before you start the application, please review the comments starting with "TODO(developer)"
 * and update the code to use correct values.
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.QuickstartSample"
 * }</pre>
 */
public class QuickstartSample {

  public static void main(String... args) throws Exception {
    /**
     * TODO(developer): Replace this variable with your Google Analytics 4 property ID before
     * running the sample.
     */
    String propertyId = "YOUR-GA4-PROPERTY-ID";
    sampleRunReport(propertyId);
  }

  // This is an example snippet that calls the Google Analytics Data API and runs a simple report
  // on the provided GA4 property id.
  static void sampleRunReport(String propertyId) throws Exception {
    // Using a default constructor instructs the client to use the credentials
    // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
    try (BetaAnalyticsDataClient analyticsData = BetaAnalyticsDataClient.create()) {

      RunReportRequest request =
          RunReportRequest.newBuilder()
              .setProperty("properties/" + propertyId)
              .addDimensions(Dimension.newBuilder().setName("city"))
              .addMetrics(Metric.newBuilder().setName("activeUsers"))
              .addDateRanges(DateRange.newBuilder().setStartDate("2020-03-31").setEndDate("today"))
              .build();

      // Make the request.
      RunReportResponse response = analyticsData.runReport(request);

      System.out.println("Report result:");
      // Iterate through every row of the API response.
      for (Row row : response.getRowsList()) {
        System.out.printf(
            "%s, %s%n", row.getDimensionValues(0).getValue(), row.getMetricValues(0).getValue());
      }
    }
  }
}

PHP

require 'vendor/autoload.php';

use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\RunReportRequest;

/**
 * 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.
$client = new BetaAnalyticsDataClient();

// Make an API call.
$request = (new RunReportRequest())
    ->setProperty('properties/' . $property_id)
    ->setDateRanges([
        new DateRange([
            'start_date' => '2020-03-31',
            'end_date' => 'today',
        ]),
    ])
    ->setDimensions([new Dimension([
            'name' => 'city',
        ]),
    ])
    ->setMetrics([new Metric([
            'name' => 'activeUsers',
        ])
    ]);
$response = $client->runReport($request);

// Print results of an API call.
print 'Report result: ' . PHP_EOL;

foreach ($response->getRows() as $row) {
    print $row->getDimensionValues()[0]->getValue()
        . ' ' . $row->getMetricValues()[0]->getValue() . PHP_EOL;
}

Python

from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
    DateRange,
    Dimension,
    Metric,
    RunReportRequest,
)


def sample_run_report(property_id="YOUR-GA4-PROPERTY-ID"):
    """Runs a simple report on a Google Analytics 4 property."""
    # TODO(developer): Uncomment this variable and replace 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.
    client = BetaAnalyticsDataClient()

    request = RunReportRequest(
        property=f"properties/{property_id}",
        dimensions=[Dimension(name="city")],
        metrics=[Metric(name="activeUsers")],
        date_ranges=[DateRange(start_date="2020-03-31", end_date="today")],
    )
    response = client.run_report(request)

    print("Report result:")
    for row in response.rows:
        print(row.dimension_values[0].value, row.metric_values[0].value)

Node.js

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

  // Imports the Google Analytics Data API client library.
  const {BetaAnalyticsDataClient} = require('@google-analytics/data');

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

  // Runs a simple report.
  async function runReport() {
    const [response] = await analyticsDataClient.runReport({
      property: `properties/${propertyId}`,
      dateRanges: [
        {
          startDate: '2020-03-31',
          endDate: 'today',
        },
      ],
      dimensions: [
        {
          name: 'city',
        },
      ],
      metrics: [
        {
          name: 'activeUsers',
        },
      ],
    });

    console.log('Report result:');
    response.rows.forEach((row) => {
      console.log(row.dimensionValues[0], row.metricValues[0]);
    });
  }

  runReport();

.NET

using Google.Analytics.Data.V1Beta;
using System;

namespace AnalyticsSamples
{
    class QuickStart
    {
        static void SampleRunReport(string propertyId="YOUR-GA4-PROPERTY-ID")
        {
            /**
             * TODO(developer): Uncomment this variable and replace with your
             *  Google Analytics 4 property ID before running the sample.
             */
            // propertyId = "YOUR-GA4-PROPERTY-ID";

            // Using a default constructor instructs the client to use the credentials
            // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
            BetaAnalyticsDataClient client = BetaAnalyticsDataClient.Create();

            // Initialize request argument(s)
            RunReportRequest request = new RunReportRequest
            {
                Property = "properties/" + propertyId,
                Dimensions = { new Dimension{ Name="city"}, },
                Metrics = { new Metric{ Name="activeUsers"}, },
                DateRanges = { new DateRange{ StartDate="2020-03-31", EndDate="today"}, },
            };

            // Make the request
            RunReportResponse response = client.RunReport(request);

            Console.WriteLine("Report result:");
            foreach(Row row in response.Rows)
            {
                Console.WriteLine("{0}, {1}", row.DimensionValues[0].Value, row.MetricValues[0].Value);
            }
        }
        static int Main(string[] args)
        {
            if (args.Length > 0) {
                SampleRunReport(args[0]);
            } else {
                SampleRunReport();
            }
            return 0;
        }
    }
}

REST

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

curl -X POST \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: ${PROJECT_ID}" \
  -H "Content-Type: application/json" \
  -d '
  {
    "dateRanges": [
      {
        "startDate": "2025-01-01",
        "endDate": "2025-02-01"
      }
    ],
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ]
  }'  https://analyticsdata.googleapis.com/v1beta/properties/${PROPERTY_ID}:runReport

Respons akan berisi laporan dengan pengguna aktif yang dikelompokkan berdasarkan negara, misalnya:

{
  "dimensionHeaders": [
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "3242"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "(not set)"
        }
      ],
      "metricValues": [
        {
          "value": "3015"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "India"
        }
      ],
      "metricValues": [
        {
          "value": "805"
        }
      ]
    }
  ],
  "rowCount": 3,
  "metadata": {
    "currencyCode": "USD",
    "timeZone": "America/Los_Angeles"
  },
  "kind": "analyticsData#runReport"
}