מדריך למפתחים בנושא Google Analytics Data API v1

במדריך למתחילים הזה תלמדו ליצור ולשלוח בקשות list ל-Google Analytics Data API v1, ואז להציג את התשובות כדי להגדיר ולאמת את הגישה שלכם ל-API.

אפשר להשלים את המדריך למתחילים הזה באמצעות SDK, או באמצעות ה-API ל-REST בסביבה המקומית או במכונה וירטואלית ב-Google Cloud.

זהו סיכום השלבים:

  • מגדירים פרויקט ב-Google Cloud ומפעילים את Google Analytics Data API v1.
  • במכונה המקומית או במכונה הווירטואלית ב-Cloud:
    • התקנה, הפעלה ואימות באמצעות Google Cloud.
    • מתקינים את ה-SDK בשפה הרצויה (אופציונלי).
  • מגדירים את האימות.
  • מגדירים את הגישה ל-Google Analytics.
  • מגדירים SDK.
  • מריצים קריאה ל-API.

הגדרת פרויקט ב-Google Cloud

לוחצים על הלחצן Enable the Google Analytics Data API v1 כדי לבחור או ליצור פרויקט חדש ב-Google Cloud ולהפעיל באופן אוטומטי את Google Analytics Data API v1.

הפעלת Google Analytics Data API v1

הגדרת Google Cloud

במכונה המקומית או במכונה הווירטואלית ב-Cloud, מגדירים את Google Cloud ומבצעים אימות באמצעותו.

  1. מתקינים ומפעילים את Google Cloud.

  2. כדי לוודא שרכיבי gcloud מעודכנים, מריצים את הפקודה הבאה.

    gcloud components update

כדי שלא תצטרכו לספק את מזהה הפרויקט ל-Google Cloud, תוכלו להשתמש בפקודה gcloud config set כדי להגדיר פרויקט ואזור ברירת מחדל.

הגדרת אימות

במדריך למתחילים הזה נעשה שימוש ב-Application Default Credentials כדי למצוא באופן אוטומטי את פרטי הכניסה על סמך הסביבה שבה פועלת האפליקציה, כך שלא תצטרכו לשנות את קוד הלקוח כדי לבצע אימות.

Google Analytics Data API v1 תומך בחשבונות משתמשים ובחשבונות שירות:

  • חשבונות משתמשים מייצגים מְפַתֵּחַ, אדמין או כל אדם אחר שמנהל אינטראקציה עם ממשקי ה-API והשירותים של Google.
  • חשבונות שירות לא מייצגים משתמש אנושי ספציפי. הם מספקים דרך לנהל את האימות וההרשאות בלי מעורבות ישירה של בני אדם, למשל כדי לתת לאפליקציות גישה למשאבים של Google Cloud.

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

חשבון משתמש

מריצים את הפקודה הבאה כדי ליצור קובץ מקומי של Application Default Credentials‏ (ADC). הפקודה הזו מפעילה תהליך אינטרנט שבו מזינים את פרטי הכניסה של המשתמש.

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

חשוב לציין את ההיקפים הנדרשים על ידי Google Analytics Data API v1 בפקודה. מידע נוסף זמין במאמר הגדרה של Application Default Credentials.

חשבון שירות

כך מבצעים אימות באמצעות חשבון שירות באמצעות מכונה וירטואלית ב-Cloud:

  1. יוצרים חשבון שירות.
  2. מקשרים את חשבון השירות למכונה הווירטואלית ב-Cloud באמצעות הפקודה הבאה ב-CLI של gcloud:
  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"

חשוב לציין את ההיקפים הנדרשים על ידי Google Analytics Data API v1 בפקודה. מידע נוסף זמין במאמר הגדרה של Application Default Credentials.

הגדרת הגישה ל-Google Analytics

נותנים ל-Google Analytics גישה לכתובת האימייל שמשויכת לחשבון המשתמש או לחשבון השירות שלכם.

הגדרת ה-SDK לשפת התכנות שלכם

מתקינים את ה-SDK של שפת התכנות במחשב המקומי.

Java

מדריך להתקנת ספריית לקוח Java

PHP

מדריך להתקנה של ספריית הלקוח של PHP

Python

מדריך להתקנה של ספריית הלקוח ב-Python

Node.js

מדריך להתקנה של ספריית הלקוח של Node.js

‎.NET

מדריך להתקנת ספריית הלקוח של ‎.NET

Ruby

מדריך להתקנה של ספריית הלקוח של Ruby

Go

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

REST

מזינים את הפרטים הבאים כדי להגדיר את משתני הסביבה. מחליפים את PROJECT_ID במזהה הפרויקט ב-Google Cloud ואת PROPERTY_ID במזהה הנכס ב-Google Analytics.

  export PROJECT_ID=PROJECT_ID
  export PROPERTY_ID=PROPERTY_ID

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

מריצים את הקוד הבא כדי לבצע את הקריאה הראשונה:

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

כדי לשלוח את הבקשה הזו, מריצים את הפקודה curl משורת הפקודה או כוללים את הקריאה ל-REST באפליקציה.

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

התגובה תכיל דוח עם משתמשים פעילים שמפורטים לפי מדינה, לדוגמה:

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