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

इस गाइड के लिए, पहले से कई ज़रूरी सेटिंग कॉन्फ़िगर करनी होती हैं. ये सेटिंग, पिछले चरणों में कॉन्फ़िगर की गई थीं. अगर आपने अब तक ऐसा नहीं किया है, तो परिचय से शुरू करें.

इस गाइड में रीफ़्रेश टोकन का इस्तेमाल भी किया गया है. यह एक ऐसा वर्कफ़्लो है जिसमें Google Ads खाते का ऐक्सेस रखने वाला उपयोगकर्ता, आपके ऐप्लिकेशन को एक बार सेटअप करने के दौरान अनुमति दे सकता है. इससे ऐप्लिकेशन, उपयोगकर्ता के किसी भी तरह के हस्तक्षेप के बिना, खाते में ऑफ़लाइन एपीआई कॉल कर सकता है. रीफ़्रेश टोकन का इस्तेमाल, ऑफ़लाइन और इंटरैक्टिव, दोनों तरह के वर्कफ़्लो बनाने के लिए किया जा सकता है. जैसे, क्रॉन जॉब या डेटा पाइपलाइन जैसे ऑफ़लाइन वर्कफ़्लो और वेब या मोबाइल ऐप्लिकेशन जैसे इंटरैक्टिव वर्कफ़्लो.

रीफ़्रेश टोकन फ़ेच करना

Google Ads API, OAuth 2.0 का इस्तेमाल ऑथराइज़ेशन के तरीके के तौर पर करता है. डिफ़ॉल्ट रूप से, OAuth 2.0 पुष्टि करने की सुविधा, एक ऐक्सेस टोकन जारी करती है. इसकी समयसीमा सीमित होती है. ऐक्सेस टोकन को अपने-आप रिन्यू करने के लिए, रीफ़्रेश टोकन जारी करें.

gcloud सीएलआई

  1. gcloud सीएलआई टूल का इस्तेमाल करके, रीफ़्रेश टोकन जनरेट करें:

    gcloud auth application-default \
    login --scopes=https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform \
    --client-id-file=<path_to_credentials.json>

    credentials.json फ़ाइल, पिछले चरण से मिली है.

  2. gcloud कमांड, नई ब्राउज़र विंडो में Google खाते में लॉगिन करने की विंडो खोलती है. साथ ही, आपको OAuth 2.0 की पुष्टि करने के चरणों के बारे में बताती है. पक्का करें कि आपने उसी ईमेल पते से साइन इन किया हो जिसका इस्तेमाल उस चरण में किया गया था जहां आपने लॉगिन ग्राहक आईडी की पहचान की थी. अगर आपके ऐप्लिकेशन की पुष्टि नहीं हुई है, तो आपको चेतावनी वाली स्क्रीन दिख सकती है. ऐसे मामलों में, बेहतर विकल्प दिखाएं लिंक पर क्लिक करना सुरक्षित होता है. इसके बाद, PROJECT_NAME (पुष्टि नहीं हुई) पर जाएं विकल्प पर क्लिक करें.

  3. स्कोप की पुष्टि करने के बाद, अनुमति देने के लिए जारी रखें बटन पर क्लिक करें. ब्राउज़र https://cloud.google.com/sdk/auth_success पर रीडायरेक्ट हो जाता है. इससे पता चलता है कि पुष्टि करने की प्रोसेस पूरी हो गई है. पेज पर यह मैसेज दिखता है:

    Authorization code granted. Close this tab.

    gcloud कमांड, यह मैसेज प्रिंट करती है:

    Credentials saved to file: [/****/.config/gcloud/application_default_credentials.json]

    अब application_default_credentials.json फ़ाइल खोलें. इसका कॉन्टेंट, यहां दिए गए कॉन्टेंट से मिलता-जुलता होना चाहिए:

    {
  "account": "",
  "client_id": "******.apps.googleusercontent.com",
  "client_secret": "******",
  "refresh_token": "******",
  "type": "authorized_user",
  "universe_domain": "googleapis.com"
}

अन्य

अगर आपको इसके बजाय curl या अपने एचटीटीपी क्लाइंट का इस्तेमाल करना है, तो उदाहरण के लिए मोबाइल और डेस्कटॉप ऐप्लिकेशन के लिए OAuth 2.0 गाइड देखें.

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

एपीआई कॉल करने का तरीका जानने के लिए, अपनी पसंद का क्लाइंट चुनें:

Java

क्लाइंट लाइब्रेरी के आर्टफ़ैक्ट, Maven Central Repository में पब्लिश किए जाते हैं. क्लाइंट लाइब्रेरी को अपने प्रोजेक्ट में इस तरह डिपेंडेंसी के तौर पर जोड़ें:

Maven डिपेंडेंसी यह है:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>40.0.0</version>
</dependency>

Gradle डिपेंडेंसी यह है:

implementation 'com.google.api-ads:google-ads:40.0.0'

नीचे दिए गए कॉन्टेंट के साथ ~/ads.properties फ़ाइल बनाएं:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

GoogleAdsClient ऑब्जेक्ट इस तरह बनाएं:

GoogleAdsClient googleAdsClient = null;
try {
  googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
  System.err.printf(
      "Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
      fnfe);
  System.exit(1);
} catch (IOException ioe) {
  System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
  System.exit(1);
}

इसके बाद, GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन की रिपोर्ट जनरेट करें, ताकि आपके खाते में मौजूद कैंपेन का डेटा वापस मिल सके. इस गाइड में, रिपोर्टिंग के बारे में जानकारी नहीं दी गई है.

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java

C#

क्लाइंट लाइब्रेरी पैकेज, Nuget.org रिपॉज़िटरी पर पब्लिश किए जाते हैं. Google.Ads.GoogleAds पैकेज में nuget रेफ़रंस जोड़कर शुरू करें.

dotnet add package Google.Ads.GoogleAds --version 18.1.0

काम की सेटिंग के साथ GoogleAdsConfig ऑब्जेक्ट बनाएं. इसके बाद, इसका इस्तेमाल करके GoogleAdsClient ऑब्जेक्ट बनाएं.

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "APPLICATION",
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******",
    LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);

इसके बाद, GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन की रिपोर्ट जनरेट करें, ताकि आपके खाते में मौजूद कैंपेन का डेटा वापस मिल सके. इस गाइड में, रिपोर्टिंग के बारे में जानकारी नहीं दी गई है.

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V21.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs

PHP

क्लाइंट लाइब्रेरी के पैकेज, Packagist रिपॉज़िटरी पर पब्लिश किए जाते हैं. अपने प्रोजेक्ट की रूट डायरेक्ट्री में जाएं. इसके बाद, लाइब्रेरी और उससे जुड़े सभी ज़रूरी सॉफ़्टवेयर को अपने प्रोजेक्ट की रूट डायरेक्ट्री की vendor/ डायरेक्ट्री में इंस्टॉल करने के लिए, यहां दिया गया कमांड चलाएं.

composer require googleads/google-ads-php:31.0.0

GitHub रिपॉज़िटरी से google_ads_php.ini फ़ाइल की एक कॉपी बनाएं और उसमें अपने क्रेडेंशियल शामिल करने के लिए बदलाव करें.

[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"

[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"

GoogleAdsClient ऑब्जेक्ट का इंस्टेंस बनाएं.

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

इसके बाद, GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन की रिपोर्ट जनरेट करें, ताकि आपके खाते में मौजूद कैंपेन का डेटा वापस मिल सके. इस गाइड में, रिपोर्टिंग के बारे में जानकारी नहीं दी गई है.

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php

Python

क्लाइंट लाइब्रेरी को PyPI पर डिस्ट्रिब्यूट किया जाता है. इसे pip कमांड का इस्तेमाल करके इंस्टॉल किया जा सकता है. इसके लिए, यह तरीका अपनाएं:

python -m pip install google-ads==21.3.0

GitHub रिपॉज़िटरी से google-ads.yaml फ़ाइल की कॉपी बनाएं और उसमें अपने क्रेडेंशियल शामिल करने के लिए बदलाव करें.

client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE

GoogleAdsClient.load_from_storage तरीके को कॉल करके, GoogleAdsClient इंस्टेंस बनाएं. google-ads.yaml का पाथ, इसे कॉल करते समय स्ट्रिंग के तौर पर पास करें:

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

लाइब्रेरी के लॉगर में एक हैंडलर जोड़ें. इससे लॉगर को यह पता चलेगा कि लॉग कहां प्रिंट करने हैं. नीचे दिए गए कोड से, लाइब्रेरी के लॉगर को कंसोल (stdout) पर प्रिंट करने के लिए कहा जाएगा.

import logging
import sys

logger = logging.getLogger('google.ads.googleads.client')
logger.addHandler(logging.StreamHandler(sys.stdout))

इसके बाद, GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन की रिपोर्ट जनरेट करें, ताकि आपके खाते में मौजूद कैंपेन का डेटा वापस मिल सके. इस गाइड में, रिपोर्टिंग के बारे में जानकारी नहीं दी गई है.

def main(client: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

    query: str = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py

Ruby

क्लाइंट लाइब्रेरी के लिए Ruby gems, Rubygems gem होस्टिंग साइट पर पब्लिश किए जाते हैं. इसे इंस्टॉल करने का सुझाया गया तरीका, बंडलर का इस्तेमाल करना है. अपनी Gemfile में यह लाइन जोड़ें:

gem 'google-ads-googleads', '~> 35.2.0'

इसके बाद, यह कमांड चलाएं:

bundle install

GitHub रिपॉज़िटरी से google_ads_config.rb फ़ाइल की एक कॉपी बनाएं और उसमें अपने क्रेडेंशियल शामिल करने के लिए बदलाव करें. ruby Google::Ads::GoogleAds::Config.new do |c| c.client_id = 'INSERT_CLIENT_ID_HERE' c.client_secret = 'INSERT_CLIENT_SECRET_HERE' c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE' c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE' c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE' end इस फ़ाइल को जिस पाथ पर रखा गया है उसे पास करके, GoogleAdsClient इंस्टेंस बनाएं.

client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')

इसके बाद, GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन की रिपोर्ट जनरेट करें, ताकि आपके खाते में मौजूद कैंपेन का डेटा वापस मिल सके. इस गाइड में, रिपोर्टिंग के बारे में जानकारी नहीं दी गई है.

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb

Perl

लाइब्रेरी को CPAN पर डिस्ट्रिब्यूट किया जाता है. अपनी पसंद की डायरेक्ट्री में google-ads-perl रिपॉज़िटरी को क्लोन करके शुरू करें.

git clone https://github.com/googleads/google-ads-perl.git

google-ads-perl डायरेक्ट्री में जाएं और लाइब्रेरी का इस्तेमाल करने के लिए ज़रूरी सभी डिपेंडेंसी इंस्टॉल करने के लिए, कमांड प्रॉम्प्ट पर यह कमांड चलाएं.

cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps

GitHub रिपॉज़िटरी से googleads.properties फ़ाइल की एक कॉपी बनाएं और उसमें अपने क्रेडेंशियल शामिल करने के लिए बदलाव करें.

clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

इस फ़ाइल को जिस पाथ पर रखा गया है उसे पास करके, Client इंस्टेंस बनाएं.

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

इसके बाद, GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन की रिपोर्ट जनरेट करें, ताकि आपके खाते में मौजूद कैंपेन का डेटा वापस मिल सके. इस गाइड में, रिपोर्टिंग के बारे में जानकारी नहीं दी गई है.

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V21::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}
get_campaigns.pl

REST

सबसे पहले, एचटीटीपी क्लाइंट का इस्तेमाल करके, OAuth 2.0 का ऐक्सेस टोकन फ़ेच करें. इस गाइड में curl कमांड का इस्तेमाल किया गया है.

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

इसके बाद, GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन की रिपोर्ट जनरेट करें, ताकि आपके खाते में मौजूद कैंपेन का डेटा वापस मिल सके. इस गाइड में, रिपोर्टिंग के बारे में जानकारी नहीं दी गई है.

curl -i -X POST https://googleads.googleapis.com/v21/customers/CUSTOMER_ID/googleAds:searchStream \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer ACCESS_TOKEN" \
   -H "developer-token: DEVELOPER_TOKEN" \
   -H "login-customer-id: LOGIN_CUSTOMER_ID" \
   --data-binary "@query.json"

query.json में ये चीज़ें शामिल हैं:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}
पीछे जाएं
Google Ads खाता तैयार करना
आगे बढ़ें
आम तौर पर होने वाली गड़बड़ियां