Google Analytics Data API v1 के लिए डेवलपर क्विकस्टार्ट

इस शुरुआती लेख में, Google Analytics Data API v1 के लिए list अनुरोध बनाए और भेजे जाते हैं. इसके बाद, एपीआई ऐक्सेस को सेट अप और उसकी पुष्टि करने के लिए, जवाब देखे जाते हैं.

इस शुरुआती लेख को पढ़कर, एसडीके या अपने स्थानीय एनवायरमेंट में REST API या Google Cloud VM इंस्टेंस का इस्तेमाल करके, यह तरीका अपनाया जा सकता है.

यहां इस प्रोसेस के चरणों के बारे में खास जानकारी दी गई है:

  • Google Cloud प्रोजेक्ट सेट अप करें और Google Analytics Data API v1 को चालू करें.
  • अपनी लोकल मशीन या Cloud VM इंस्टेंस पर:
    • Google Cloud के साथ इंस्टॉल, शुरू, और पुष्टि करें.
    • अपनी भाषा के लिए SDK टूल इंस्टॉल करें (ज़रूरी नहीं).
  • पुष्टि करने की सुविधा कॉन्फ़िगर करें.
  • Google Analytics का ऐक्सेस कॉन्फ़िगर करें.
  • SDK टूल सेट अप करें.
  • एपीआई कॉल करें.

Google Cloud प्रोजेक्ट सेट अप करना

नया Google Cloud प्रोजेक्ट चुनने या बनाने के लिए, यहां दिए गए Google Analytics Data API v1 को चालू करें बटन पर क्लिक करें. इससे, Google Analytics Data API v1 अपने-आप चालू हो जाएगा.

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

Google Cloud सेट अप करना

अपनी लोकल मशीन या Cloud VM इंस्टेंस पर, Google Cloud सेट अप करें और पुष्टि करें.

  1. Google Cloud को इंस्टॉल और शुरू करें.

  2. यह पक्का करने के लिए कि आपके gcloud कॉम्पोनेंट अप-टू-डेट हैं, यह कमांड चलाएं.

    gcloud components update

Google Cloud को अपना प्रोजेक्ट आईडी देने से बचने के लिए, डिफ़ॉल्ट प्रोजेक्ट और क्षेत्र सेट करने के लिए, gcloud config set कमांड का इस्तेमाल किया जा सकता है.

पुष्टि करने की सुविधा कॉन्फ़िगर करना

यह क्विकस्टार्ट, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल का इस्तेमाल करके, ऐप्लिकेशन के एनवायरमेंट के आधार पर क्रेडेंशियल अपने-आप ढूंढता है. इसलिए, पुष्टि करने के लिए आपको क्लाइंट कोड में बदलाव करने की ज़रूरत नहीं होती.

Google Analytics Data API v1, उपयोगकर्ता खातों और सेवा खातों के साथ काम करता है:

  • उपयोगकर्ता खाते, किसी डेवलपर, एडमिन या ऐसे किसी अन्य व्यक्ति को दिखाते हैं जो Google के एपीआई और सेवाओं के साथ इंटरैक्ट करता है.
  • सेवा खाते, किसी व्यक्ति के खाते के तौर पर काम नहीं करते. ये, पुष्टि करने और अनुमति देने का एक तरीका उपलब्ध कराते हैं. ऐसा तब होता है, जब कोई व्यक्ति सीधे तौर पर शामिल न हो. जैसे, जब किसी ऐप्लिकेशन को Google Cloud के संसाधनों को ऐक्सेस करना हो.

अपने ऐप्लिकेशन के लिए पुष्टि करने और खाते के क्रेडेंशियल सेट अप करने के बारे में ज़्यादा जानने के लिए, Google पर पुष्टि करने के तरीके देखें.

उपयोगकर्ता खाता

नीचे दिया गया कमांड चलाकर, लोकल ऐप्लिकेशन डिफ़ॉल्ट क्रेडेंशियल (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 के लिए ज़रूरी स्कोप बताना न भूलें. ज़्यादा जानकारी के लिए, ऐप्लिकेशन के लिए डिफ़ॉल्ट क्रेडेंशियल सेट अप करना लेख पढ़ें

सेवा खाता

Cloud VM इंस्टेंस का इस्तेमाल करके, सेवा खाते की पुष्टि करने का तरीका यहां बताया गया है:

  1. सेवा खाता बनाएं.
  2. अपने Cloud VM इंस्टेंस में सेवा खाता अटैच करें. इसके लिए, gcloud CLI का यह कमांड चलाएं:
  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 के लिए ज़रूरी स्कोप बताना न भूलें. ज़्यादा जानकारी के लिए, ऐप्लिकेशन के लिए डिफ़ॉल्ट क्रेडेंशियल सेट अप करना लेख पढ़ें

Google Analytics का ऐक्सेस कॉन्फ़िगर करना

अपने उपयोगकर्ता या सेवा खाते से जुड़े ईमेल पते को Google Analytics का ऐक्सेस दें.

अपनी प्रोग्रामिंग भाषा के लिए SDK टूल सेट अप करना

अपनी प्रोग्रामिंग भाषा के लिए, अपनी लोकल मशीन पर SDK टूल इंस्टॉल करें.

Java

Java क्लाइंट लाइब्रेरी इंस्टॉल करने की गाइड

PHP

PHP क्लाइंट लाइब्रेरी इंस्टॉल करने की गाइड

Python

Python क्लाइंट लाइब्रेरी इंस्टॉल करने की गाइड

Node.js

Node.js क्लाइंट लाइब्रेरी इंस्टॉल करने की गाइड

.NET

.NET क्लाइंट लाइब्रेरी इंस्टॉल करने की गाइड

Ruby

Ruby क्लाइंट लाइब्रेरी इंस्टॉल करने से जुड़ी गाइड

शुरू करें

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

एपीआई कॉल करना

अपना पहला कॉल करने के लिए, यह कोड चलाएं:

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