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

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

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

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

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

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

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

Google Analytics Admin API को चालू करना

Google Cloud सेट अप करना

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

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

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

    gcloud components update

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

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

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

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

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

सेवा खाते से पुष्टि करने का तरीका यहां बताया गया है:

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

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

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

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

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

JavaPHPPythonNode.js.NETRubyशुरू करेंREST

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

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

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

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

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

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

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

नीचे दिए गए निर्देशों का पालन करके, अपने एनवायरमेंट वैरिएबल कॉन्फ़िगर करें. PROJECT_ID की जगह अपने Google Cloud प्रोजेक्ट का आईडी डालें. 

  EXPORT PROJECT_ID=PROJECT_ID

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

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

JavaPHPPythonNode.js.NETREST

google-analytics-admin/src/main/java/com/google/analytics/admin/samples/QuickstartSample.java
Cloud Shell में खोलें GitHub पर देखें 
import com.google.analytics.admin.v1beta.Account;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPage;
import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPagedResponse;
import com.google.analytics.admin.v1beta.ListAccountsRequest;

/**
 * This application demonstrates the usage of the Analytics Admin API using service account
 * credentials. For more information on service accounts, see
 * https://cloud.google.com/iam/docs/understanding-service-accounts.
 *
 * <p>The following document provides instructions on setting service account credentials for your
 * application: https://cloud.google.com/docs/authentication/production
 *
 * <p>In a nutshell, you need to:
 *
 * <ol>
 *   <li>Create a service account and download the key JSON file as described at
 *       https://cloud.google.com/docs/authentication/production#creating_a_service_account.
 *   <li>Provide service account credentials using one of the following options:
 *       <ul>
 *         <li>Set the {@code GOOGLE_APPLICATION_CREDENTIALS} environment variable. The API client
 *             will use the value of this variable to find the service account key JSON file. See
 *             https://cloud.google.com/docs/authentication/production#setting_the_environment_variable
 *             for more information.
 *             <p>OR
 *         <li>Manually pass the path to the service account key JSON file to the API client by
 *             specifying the {@code keyFilename} parameter in the constructor. See
 *             https://cloud.google.com/docs/authentication/production#passing_the_path_to_the_service_account_key_in_code
 *             for more information.
 *       </ul>
 * </ol>
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.admin.samples.QuickstartSample"
 * }</pre>
 */
public class QuickstartSample {

  public static void main(String... args) throws Exception {
    listAccounts();
  }

  // This is an example snippet that calls the Google Analytics Admin API and lists all Google
  // Analytics accounts available to the authenticated user.
  static void listAccounts() throws Exception {
    // Instantiates a client using default credentials.
    // See https://cloud.google.com/docs/authentication/production for more information
    // about managing credentials.
    try (AnalyticsAdminServiceClient analyticsAdmin = AnalyticsAdminServiceClient.create()) {
      // Calls listAccounts() method of the Google Analytics Admin API and prints
      // the response for each account.
      ListAccountsPagedResponse response =
          analyticsAdmin.listAccounts(ListAccountsRequest.newBuilder().build());
      for (ListAccountsPage page : response.iteratePages()) {
        for (Account account : page.iterateAll()) {
          System.out.printf("Account name: %s%n", account.getName());
          System.out.printf("Display name: %s%n", account.getDisplayName());
          System.out.printf("Country code: %s%n", account.getRegionCode());
          System.out.printf("Create time: %s%n", account.getCreateTime().getSeconds());
          System.out.printf("Update time: %s%n", account.getUpdateTime().getSeconds());
          System.out.println();
        }
      }
    }
  }
}

QuickstartSample.java

google-analytics-admin/quickstart.php
Cloud Shell में खोलें GitHub पर देखें 
require 'vendor/autoload.php';

use Google\Analytics\Admin\V1beta\Account;
use Google\Analytics\Admin\V1beta\Client\AnalyticsAdminServiceClient;
use Google\Analytics\Admin\V1beta\ListAccountsRequest;

/**
 * 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.
// See https://cloud.google.com/docs/authentication/production for more information
// about managing credentials.
$client = new AnalyticsAdminServiceClient();

// Calls listAccounts() method of the Google Analytics Admin API and prints
// the response for each account.
$request = new ListAccountsRequest();
$response = $client->listAccounts($request);

print 'Result:' . PHP_EOL;
foreach ($response->iterateAllElements() as $account) {
    print 'Account name: ' . $account->getName() . PHP_EOL;
    print 'Display name: ' . $account->getDisplayName() . PHP_EOL;
    print 'Country code: ' . $account->getRegionCode() . PHP_EOL;
    print 'Create time: ' . $account->getCreateTime()->getSeconds() . PHP_EOL;
    print 'Update time: ' . $account->getUpdateTime()->getSeconds() . PHP_EOL;
}
quickstart.php

google-analytics-admin/quickstart.py
Cloud Shell में खोलें GitHub पर देखें 
def list_accounts(transport: str = None):
    """
    Lists the available Google Analytics accounts.

    Args:
        transport(str): The transport to use. For example, "grpc"
            or "rest". If set to None, a transport is chosen automatically.
    """
    from google.analytics.admin import AnalyticsAdminServiceClient

    # Using a default constructor instructs the client to use the credentials
    # specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = AnalyticsAdminServiceClient(transport=transport)

    results = client.list_accounts()

    # Displays the configuration information for all Google Analytics accounts
    # available to the authenticated user.
    print("Result:")
    for account in results:
        print(account)


quickstart.py

google-analytics-admin/quickstart.js
Cloud Shell में खोलें GitHub पर देखें 
  // Imports the Google Analytics Admin API client library.
  const analyticsAdmin = require('@google-analytics/admin');

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

  // Lists all Google Analytics accounts available to the authenticated user.
  async function listAccounts() {
    // Uses listAccounts() with no arguments to fetch all pages. For more
    // information on pagination in the Node.js library, see:
    // https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#auto-pagination
    const [response] = await analyticsAdminClient.listAccounts();

    console.log('Accounts:');
    for (const account of response) {
      console.log('Account name:', account.name);
      console.log('Display name:', account.displayName);
      console.log('Region code:', account.regionCode);
      console.log('Create time:', account.createTime.seconds);
      console.log('Update time:', account.updateTime.seconds);
    }
  }

  listAccounts();
quickstart.js

analytics-admin/QuickStart/QuickStart.cs
Cloud Shell में खोलें GitHub पर देखें 
using Google.Analytics.Admin.V1Beta;
using Google.Api.Gax;
using System;

namespace AnalyticsSamples
{
    class QuickStart
    {
        static void Main(string[] args)
        {
            AnalyticsAdminServiceClient client = AnalyticsAdminServiceClient.Create();
            PagedEnumerable<ListAccountsResponse, Account> response =
                client.ListAccounts( new ListAccountsRequest() );
            foreach( Account account in response )
            {
                Console.WriteLine("Account name: {0}", account.Name);
                Console.WriteLine("Display name: {0}", account.DisplayName);
                Console.WriteLine("Region code: {0}", account.RegionCode);
                Console.WriteLine("Update time: {0}", account.UpdateTime);
                Console.WriteLine("Create time: {0}", account.CreateTime);
                Console.WriteLine();
            }
        }
    }
}
QuickStart.cs

यह अनुरोध भेजने के लिए, कमांड लाइन से curl कमांड चलाएं या अपने ऐप्लिकेशन में REST कॉल शामिल करें. 

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: ${PROJECT_ID}" \
  -H "Content-Type: application/json" \
  https://analyticsadmin.googleapis.com/v1beta/accounts

सैंपल कोड के जवाब में, उन Google Analytics खातों की सूची दी गई है जिन्हें आपके उपयोगकर्ता या सेवा खाते के पास देखने का ऐक्सेस है:

{
  "accounts": [
    {
      "name": "accounts/123456789",
      "createTime": "2025-01-01T00:12:23.456Z",
      "createTime": "2025-01-01T00:12:23.456Z",
      "displayName": "Demo Account",
      "regionCode": "US",
      "gmpOrganization": "marketingplatformadmin.googleapis.com/organizations/abcdef12345678"
    }
}