Google Analytics Data API v1 geliştirici hızlı başlangıç kılavuzu

Bu hızlı başlangıç kılavuzunda, Google Analytics Data API v1'e list isteği oluşturup gönderir ve ardından API erişiminizi ayarlamak ve doğrulamak için yanıtları görüntülersiniz.

Bu hızlı başlangıç kılavuzunu bir SDK'yı veya yerel ortamınızdaki REST API'yi ya da bir Google Cloud sanal makine örneğini kullanarak tamamlayabilirsiniz.

Adımların özetini aşağıda bulabilirsiniz:

  • Google Cloud projesi oluşturun ve Google Analytics Data API v1'i etkinleştirin.
  • Yerel makinenizde veya Cloud VM örneğinizde:
    • Google Cloud'u yükleyin, başlatın ve kimlik doğrulama yapın.
    • Dilinize yönelik SDK'yı yükleyin (isteğe bağlı).
  • Kimlik doğrulamayı yapılandırın.
  • Google Analytics erişimini yapılandırın.
  • Bir SDK oluşturun.
  • API çağrısı yapma.

Google Cloud projesi oluşturun

Yeni bir Google Cloud projesi seçmek veya oluşturmak ve Google Analytics Data API v1'i otomatik olarak etkinleştirmek için aşağıdaki Google Analytics Data API v1'i etkinleştir düğmesini tıklayın.

Google Analytics Data API v1'i etkinleştirme

Google Cloud'u kurma

Yerel makinenizde veya bir Cloud VM örneğinde Google Cloud'u kurun ve kimlik doğrulama yapın.

  1. Google Cloud'u yükleyin ve başlatın.

  2. gcloud bileşenlerinizin güncel olduğundan emin olmak için aşağıdaki komutu çalıştırın.

    gcloud components update

Proje kimliğinizi Google Cloud'a vermek istemiyorsanız varsayılan bir proje ve bölge ayarlamak için gcloud config set komutunu kullanabilirsiniz.

Doğrulamayı yapılandırma

Bu hızlı başlangıç kılavuzu, kimlik bilgilerini uygulama ortamına göre otomatik olarak bulmak için uygulama varsayılan kimlik bilgilerini kullanır. Bu sayede, kimlik doğrulamak için istemci kodunu değiştirmeniz gerekmez.

Google Analytics Data API v1, kullanıcı hesaplarını ve hizmet hesaplarını destekler:

  • Kullanıcı hesapları, bir geliştiriciyi, yöneticiyi veya Google API'leri ve hizmetleriyle etkileşime geçen başka bir kişiyi temsil eder.
  • Hizmet hesapları belirli bir kullanıcıyı temsil etmez. Doğrulama ve yetkilendirmeyi, doğrudan bir kişinin dahil olmadığı durumlarda (ör. bir uygulamanın Google Cloud kaynaklarına erişmesi gerektiğinde) yönetmenin bir yolunu sağlarlar.

Kimlik doğrulama ve uygulamanız için hesap kimlik bilgilerini ayarlama hakkında daha fazla bilgi edinmek için Google'daki kimlik doğrulama yöntemleri başlıklı makaleyi inceleyin.

Kullanıcı Hesabı

Aşağıdaki komutu çalıştırarak yerel bir Uygulama Varsayılan Kimlik Bilgileri (ADC) dosyası oluşturun. Bu komut, kullanıcı kimlik bilgilerinizi sağladığınız bir web akışı başlatır.

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

Komutta Google Analytics Data API v1 tarafından gereken kapsamları belirtmeyi unutmayın. Daha fazla bilgi için Uygulama Varsayılan Kimlik Bilgileri'ni ayarlama başlıklı makaleyi inceleyin.

Hizmet Hesabı

Cloud sanal makine örneğini kullanarak bir hizmet hesabıyla kimlik doğrulama adımları aşağıda verilmiştir:

  1. Hizmet hesabı oluşturun.
  2. Aşağıdaki gcloud CLI komutunu çalıştırarak hizmet hesabını Cloud VM örneğinize ekleyin:
  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"

Komutta Google Analytics Data API v1 tarafından gereken kapsamları belirtmeyi unutmayın. Daha fazla bilgi için Uygulama Varsayılan Kimlik Bilgileri'ni ayarlama başlıklı makaleyi inceleyin.

Google Analytics'e erişimi yapılandırma

Kullanıcı veya hizmet hesabınızla ilişkili e-postaya Google Analytics'e erişim izni verin.

SDK'yı programlama diliniz için ayarlama

Yerel makinenize programlama diliniz için SDK'yı yükleyin.

Java

Java istemci kitaplığı kurulum kılavuzu

PHP

PHP istemci kitaplığı kurulum kılavuzu

Python

Python istemci kitaplığı kurulum kılavuzu

Node.js

Node.js istemci kitaplığı yükleme kılavuzu

.NET

.NET istemci kitaplığı kurulum kılavuzu

Ruby

Ruby istemci kitaplığı kurulum kılavuzu

Go

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

REST

Aşağıdakileri girerek ortam değişkenlerinizi yapılandırın. PROJECT_ID değerini Google Cloud projenizin kimliğiyle, PROPERTY_ID değerini ise Google Analytics mülkünüzünün kimliğiyle değiştirin.

  export PROJECT_ID=PROJECT_ID
  export PROPERTY_ID=PROPERTY_ID

API çağrısı yapma

İlk aramanızı yapmak için aşağıdaki kodu çalıştırın:

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

Bu isteği göndermek için komut satırından curl komutunu çalıştırın veya REST çağrısını uygulamanıza ekleyin.

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

Yanıt, etkin kullanıcıların ülkeye göre ayrıldığı bir rapor içerir. Örneğin:

{
  "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"
}