एपीआई क्विकस्टार्ट

इस पेज पर बताया गया है कि क्लाइंट लाइब्रेरी का इस्तेमाल करके, अपनी पसंदीदा प्रोग्रामिंग भाषा में Google Analytics Data API v1 का इस्तेमाल कैसे शुरू किया जा सकता है.

पहला चरण. एपीआई चालू करें

नया Cloud Platform प्रोजेक्ट बनाने के लिए इस बटन पर क्लिक करें, Google Analytics Data API v1 अपने-आप चालू हो जाए, और इस ट्यूटोरियल के लिए ज़रूरी सेवा खाता बनाएं:

Google Analytics Data API v1 चालू करना

डायलॉग बॉक्स में, क्लाइंट कॉन्फ़िगरेशन डाउनलोड करें पर क्लिक करें और फ़ाइल को credentials.json अपनी वर्क डायरेक्ट्री में सेव करें.

दूसरा चरण. Google Analytics 4 प्रॉपर्टी में सेवा खाता जोड़ें

टेक्स्ट एडिटर का इस्तेमाल करके, पिछले चरण में डाउनलोड की गई credentials.json फ़ाइल खोलें और इससे मिलता-जुलता, सेवा खाते का ईमेल पता पाने के लिए client_email फ़ील्ड खोजें:

quickstart@PROJECT-ID.iam.gserviceaccount.com

इस ईमेल पते का इस्तेमाल करके, उस Google Analytics 4 प्रॉपर्टी में उपयोगकर्ता जोड़ें जिसे आपको Google Analytics Data API v1 के ज़रिए ऐक्सेस करना है. इस ट्यूटोरियल के लिए, सिर्फ़ दर्शक की अनुमतियां ज़रूरी हैं.

तीसरा चरण. प्रमाणीकरण कॉन्फ़िगर करें

यह ऐप्लिकेशन, सेवा खाते के क्रेडेंशियल का इस्तेमाल करके, Google Analytics Data API v1 के इस्तेमाल के बारे में बताता है.

अपने ऐप्लिकेशन के लिए, सेवा खाते के क्रेडेंशियल बनाने और उन्हें सेट करने से जुड़े निर्देशों के लिए और पढ़ें.

सेवा खाते के क्रेडेंशियल देने का सबसे आसान तरीका यह है कि GOOGLE_APPLICATION_CREDENTIALS के एनवायरमेंट वैरिएबल को सेट किया जाए. एपीआई क्लाइंट, सेवा खाते की कुंजी वाली JSON फ़ाइल को ढूंढने के लिए, इस वैरिएबल की वैल्यू का इस्तेमाल करेगा.

इस उदाहरण में ऐप्लिकेशन क्रेडेंशियल सेट करने के लिए, नीचे दिया गया निर्देश चलाएं और पहले चरण में डाउनलोड की गई सेवा खाते की JSON फ़ाइल के पाथ का इस्तेमाल करें:

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

उदाहरण के लिए:

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

चरण 4. क्लाइंट लाइब्रेरी इंस्टॉल करना

एपीआई कॉल करें

अब Google Analytics 4 प्रॉपर्टी के लिए क्वेरी करने के लिए, Google Analytics Data 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());
      }
    }
  }
}

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
            var 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)
        {
            SampleRunReport();
            return 0;
        }
    }
}

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;
}

बधाई हो! आपने Google Analytics Data API को अपना पहला अनुरोध भेज दिया है.