हमारे प्रॉडक्ट के बारे में चर्चा करने और सुझाव देने के लिए, Google विज्ञापन और मेज़रमेंट कम्यूनिटी सर्वर में Google Ads के आधिकारिक Discord चैनल से जुड़ें.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

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

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

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

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

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'

api.googleads.serviceAccountSecretsPath=JSON_KEY_FILE_PATH
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 = OAuth2Flow.SERVICE_ACCOUNT,
    OAuth2SecretsJsonPath = "PATH_TO_CREDENTIALS_JSON",
    LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);

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]
jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE"
scopes = "https://www.googleapis.com/auth/adwords"

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();

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 फ़ाइल की कॉपी बनाएं और उसमें अपने क्रेडेंशियल शामिल करने के लिए बदलाव करें.

developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE
json_key_file_path: JSON_KEY_FILE_PATH_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))

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 फ़ाइल की एक कॉपी बनाएं और उसमें अपने क्रेडेंशियल शामिल करने के लिए बदलाव करें.

Google::Ads::GoogleAds::Config.new do |c|
  c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
  c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
  c.keyfile = 'JSON_KEY_FILE_PATH'
end

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

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

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
endget_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 फ़ाइल की एक कॉपी बनाएं और उसमें अपने क्रेडेंशियल शामिल करने के लिए बदलाव करें.

jsonKeyFilePath=JSON_KEY_FILE_PATH
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
});

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

सबसे पहले, सेवा खाते को gcloud CLI में चालू क्रेडेंशियल के तौर पर सेट करें.

gcloud auth login --cred-file=PATH_TO_CREDENTIALS_JSON

इसके बाद, Google Ads API के लिए OAuth 2.0 का ऐक्सेस टोकन फ़ेच करें.

gcloud auth \
  print-access-token \
  --scopes='https://www.googleapis.com/auth/adwords'

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 खाता तैयार करना

आगे बढ़ें

आम तौर पर होने वाली गड़बड़ियां