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

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

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

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

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

  1. oauth2l टूल चलाकर, रीफ़्रेश टोकन जनरेट करें:

    oauth2l fetch --credentials credentials.json --scope adwords \
    --output_format refresh_token

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

  2. oauth2l कमांड, Google खाते की लॉगिन विंडो को नई ब्राउज़र विंडो में खोलता है. साथ ही, आपको OAuth 2.0 की पुष्टि करने के चरणों पर ले जाता है.

    पक्का करें कि आपने उस चरण में दिए गए ईमेल पते का इस्तेमाल करके साइन इन किया है जहां आपने अपने लॉगिन ग्राहक आईडी की पहचान की थी.

    अगर आपके ऐप्लिकेशन की पुष्टि नहीं की गई है, तो आपको चेतावनी वाली स्क्रीन दिख सकती है. ऐसे मामलों में, बेहतर दिखाएं लिंक पर क्लिक करके, PROJECT_NAME पर जाएं (पुष्टि नहीं की गई है) विकल्प पर क्लिक करना सुरक्षित है.

  3. दायरों की पुष्टि करने के बाद, जारी रखें बटन पर क्लिक करके अनुमति दें.

    ब्राउज़र में इस टेक्स्ट के साथ एक प्रॉम्प्ट दिखेगा:

    Authorization code granted. Please close this tab.

    oauth2l कमांड, नीचे दिया गया JSON स्निपेट देता है:

    {
  "client_id": "******.apps.googleusercontent.com",
  "client_secret": "******",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "refresh_token": "******",
  "type": "authorized_user"
}

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

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

Java

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

मेवन डिपेंडेंसी यह है:

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

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

implementation 'com.google.api-ads:google-ads:30.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 repository में पब्लिश किए गए हैं. Google.Ads.GoogleAds पैकेज में एक नगेट रेफ़रंस जोड़कर शुरुआत करें.

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.V16.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:22.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")

इसके बाद, अपने खाते में कैंपेन को फिर से पाने के लिए GoogleAdsService.SearchStream तरीके का इस्तेमाल करके कैंपेन रिपोर्ट चलाएं. इस गाइड में रिपोर्टिंग की जानकारी शामिल नहीं है.

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

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

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

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

Ruby

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

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

इसके बाद, चलाएं:

bundle install

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

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

लाइब्रेरी का डिस्ट्रिब्यूशन सीपीएएन पर होता है. अपनी पसंद की डायरेक्ट्री में, 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::V16::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

आराम

सबसे पहले, 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/v16/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"
}
पीछे जाएं
टूल और लाइब्रेरी डाउनलोड करना
आगे बढ़ें
आम तौर पर होने वाली गड़बड़ियां