क्लाइंट लाइब्रेरी

Google Ads API क्लाइंट लाइब्रेरी, Google Ads API की सुविधाओं के बारे में ज़्यादा जानकारी और बुनियादी जानकारी देती हैं. इससे ऐप्लिकेशन को तेज़ी से डेवलप करने में मदद मिलती है. अगर आपको एपीआई के बारे में ज़्यादा जानकारी नहीं है, तो क्लाइंट लाइब्रेरी से शुरुआत करें.

यहां दी गई टेबल में, आधिकारिक क्लाइंट लाइब्रेरी की सूची दी गई है. साथ ही, उनके सेटअप की गाइड, सोर्स रिपॉज़िटरी, पैकेज, और कोड के उदाहरणों के लिंक दिए गए हैं:

क्लाइंट लाइब्रेरी सेटअप और इस्तेमाल करने से जुड़ी गाइड स्रोत डिस्ट्रिब्यूशन कोड के उदाहरण
Java बुनियादी इस्तेमाल, कॉन्फ़िगरेशन, पुष्टि करना, लॉग करना, फ़ील्ड मास्क, संसाधन के नाम google-ads-java Maven, tar.gz, zip GitHub पर देखें
.NET बुनियादी इस्तेमाल, कॉन्फ़िगरेशन, पुष्टि करना, लॉग करना, फ़ील्ड मास्क, संसाधन के नाम google-ads-dotnet NuGet, tar.gz, zip GitHub पर देखें
PHP बुनियादी इस्तेमाल, कॉन्फ़िगरेशन, पुष्टि करना, लॉग करना, फ़ील्ड मास्क, संसाधन के नाम google-ads-php Composer, tar.gz, zip GitHub पर देखें
Python इंस्टॉल करना, कॉन्फ़िगरेशन, पुष्टि करना, लॉग करना, फ़ील्ड मास्क, संसाधन के नाम google-ads-python PyPI, tar.gz, zip GitHub पर देखें
रूबी बुनियादी इस्तेमाल, कॉन्फ़िगरेशन, पुष्टि करना, लॉग करना, फ़ील्ड मास्क, संसाधन के नाम google-ads-ruby RubyGems, tar.gz, zip GitHub पर देखें
Perl बुनियादी इस्तेमाल, कॉन्फ़िगरेशन, पुष्टि करना, लॉग करना, फ़ील्ड मास्क, संसाधन के नाम google-ads-perl CPAN, tar.gz, zip GitHub पर देखें

कम्यूनिटी लाइब्रेरी

हमें ऐसी कई लाइब्रेरी के बारे में पता है जिनका रखरखाव ओपन सोर्स कम्यूनिटी करती है. हम इस सूची को अपडेट करते रहते हैं, ताकि दिलचस्पी रखने वाले डेवलपर को ये टूल आसानी से मिल सकें. हम इन लाइब्रेरी की जांच नहीं करते, इनमें योगदान नहीं देते, और न ही इनका रखरखाव करते हैं. इन्हें अपने जोखिम पर इस्तेमाल करें. अगर आपका कोई सवाल है, तो ओपन सोर्स प्रोजेक्ट के मालिकों से संपर्क करें.

अगर आपको किसी ऐसी लाइब्रेरी के बारे में पता है जिसे हमने शामिल नहीं किया है, तो पेज पर सबसे ऊपर मौजूद सुझाव/राय दें या शिकायत करें पर क्लिक करके हमें बताएं.

एपीआई के साथ काम करने वाले वर्शन

इस टेबल में बताया गया है कि कौनसी क्लाइंट लाइब्रेरी, एपीआई के किस वर्शन के साथ काम करती है.

क्लाइंट लाइब्रेरी का यहां दिया गया कम से कम वर्शन, Google Ads API के मुख्य वर्शन (जैसे, v26) के लिए ज़रूरी है. माइनर रिलीज़ के लिए ज़रूरी क्लाइंट लाइब्रेरी वर्शन देखने के लिए, लिंक किया गया बदलावों का लॉग देखें.

Java

बदलावों का लॉग

Java के लिए क्लाइंट लाइब्रेरी
v26 Min: 48.0.0
Max: -
v25 Min: 44.0.0
Max: -
v24 Min: 43.0.0
Max: -
v23 Min: 42.0.0
Max: -

C#

बदलावों का लॉग

.NET के लिए क्लाइंट लाइब्रेरी
v26 Min: 27.5.0
Max: -
v25 Min: 26.1.0
Max: -
v24 Min: 25.3.0
Max: -
v23 Min: 25.1.0
Max: -

PHP

बदलावों का लॉग

PHP के लिए क्लाइंट लाइब्रेरी
v26 Min: 35.2.0
Max: -
v25 Min: 33.6.0
Max: -
v24 Min: 33.3.0
Max: -
v23 Min: 32.2.0
Max: -

Python

बदलावों का लॉग

Python के लिए क्लाइंट लाइब्रेरी
v26 Min: 34.0.0
Max: -
v25 Min: 31.2.0
Max: -
v24 Min: 30.1.0
Max: -
v23 Min: 29.2.0
Max: -

Ruby

बदलावों का लॉग

Ruby के लिए क्लाइंट लाइब्रेरी
v26 Min: 46.0.0
Max: -
v25 Min: 43.0.0
Max: -
v24 Min: 40.0.0
Max: -
v23 Min: 38.0.0
Max: -

Perl

बदलावों का लॉग

Perl के लिए क्लाइंट लाइब्रेरी
v26 Min: 36.0.0
Max: -
v25 Min: 33.0.0
Max: -
v24 Min: 32.0.0
Max: -
v23 Min: 31.0.0
Max: -

कॉन्फ़िगरेशन

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

यहां स्टैंडर्ड एनवायरमेंट वैरिएबल दिए गए हैं. इनका इस्तेमाल करके, क्लाइंट लाइब्रेरी को कॉन्फ़िगर किया जा सकता है:

  • क्लाइंट लाइब्रेरी
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: कॉन्फ़िगरेशन फ़ाइल का पाथ (Java (fromPropertiesFile()), Perl (Client->new()), PHP (fromFile()), Python (load_from_storage(), और load_from_env() से भी जांच की गई), और Ruby (GoogleAdsClient.new) में, साफ़ तौर पर पाथ आर्ग्युमेंट के बिना कॉन्फ़िगरेशन फ़ाइल से लोड करते समय अपने-आप पढ़ा जाता है; .NET में, config.TryLoadFromEnvironmentFilePath का इस्तेमाल करके इस वैरिएबल को साफ़ तौर पर लोड करें या LoadFromSettingsJson, LoadFromConfigurationSection या LoadFromConfigurationRoot का इस्तेमाल करके कॉन्फ़िगरेशन फ़ाइलें लोड करें).
  • OAuth2
    • ऐप्लिकेशन मोड
      • GOOGLE_ADS_CLIENT_ID: इस वैल्यू को अपने OAuth2 क्लाइंट आईडी पर सेट करें.
      • GOOGLE_ADS_CLIENT_SECRET: इस वैल्यू को अपने OAuth2 क्लाइंट सीक्रेट पर सेट करें.
      • GOOGLE_ADS_REFRESH_TOKEN: अगर आपको OAuth2 टोकन का फिर से इस्तेमाल करना है, तो इस वैल्यू को पहले से जनरेट किए गए OAuth2 रीफ़्रेश टोकन पर सेट करें. इस सेटिंग का इस्तेमाल करना ज़रूरी नहीं है.
    • सेवा खाता मोड
      • GOOGLE_ADS_JSON_KEY_FILE_PATH: इस वैल्यू को अपनी OAuth2 JSON कुंजी फ़ाइल के पाथ पर सेट करें (.NET में, GOOGLE_ADS_OAUTH2_MODE को SERVICE_ACCOUNT पर भी सेट करें, क्योंकि OAuth2Mode डिफ़ॉल्ट रूप से APPLICATION पर सेट होता है; v32.1.0 से पहले के PHP वर्शन में या कस्टम स्कोप का इस्तेमाल करते समय, google_ads_php.ini में [OAUTH2] scopes भी सेट करें या withScopes() को कॉल करें, क्योंकि fromEnvironmentVariables() किसी एनवायरमेंट वैरिएबल से OAuth2 स्कोप को नहीं पढ़ता है).
      • GOOGLE_ADS_IMPERSONATED_EMAIL: इस वैल्यू को उस खाते के ईमेल पते पर सेट करें जिसकी पहचान का इस्तेमाल, Google Workspace के डोमेन-वाइड डेलिगेशन का इस्तेमाल करते समय किया जा रहा है. इस सेटिंग का इस्तेमाल करना ज़रूरी नहीं है.
    • ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल मोड
      • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी) का इस्तेमाल करके पुष्टि करने के लिए, इस वैल्यू को true पर सेट करें. यह Java v41.1.0 और इसके बाद के वर्शन, Python v28.3.0 और इसके बाद के वर्शन, और Ruby v36.1.0 और इसके बाद के वर्शन में काम करता है (.NET v24.1.0 और इसके बाद के वर्शन में, LoadFromEnvironmentVariables() बिना प्रीफ़िक्स वाले USE_APPLICATION_DEFAULT_CREDENTIALS वैरिएबल को पढ़ता है या UseApplicationDefaultCredentials = true को GoogleAdsConfig पर सेट करता है; PHP में, जब कोई OAuth2 क्रेडेंशियल सेट नहीं होता है, तो OAuth2TokenBuilder अपने-आप एडीसी पर वापस चला जाता है; Perl, एडीसी के साथ काम नहीं करता है).
  • Google Ads API
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID: यह उस ग्राहक का आईडी है जिसे अनुरोध में इस्तेमाल करने की अनुमति मिली है. इसमें हाइफ़न (-) नहीं होने चाहिए.
    • GOOGLE_ADS_LINKED_CUSTOMER_ID: यह हेडर सिर्फ़ उन तरीकों के लिए ज़रूरी है जो किसी इकाई के संसाधनों को अपडेट करते हैं. ऐसा तब होता है, जब Google Ads यूज़र इंटरफ़ेस (यूआई) में लिंक किए गए खातों (Google Ads API में AccountLink संसाधन) के ज़रिए अनुमति दी जाती है. इस वैल्यू को डेटा उपलब्ध कराने वाली उस कंपनी के ग्राहक आईडी पर सेट करें जो दिए गए ग्राहक आईडी के संसाधनों को अपडेट करती है. इसे हाइफ़न (-) के बिना सेट किया जाना चाहिए. लिंक किए गए खातों के बारे में ज़्यादा जानने के लिए, सहायता केंद्र पर जाएं.

आम तौर पर, एनवायरमेंट वैरिएबल को bash कॉन्फ़िगरेशन फ़ाइल में तय किया जाता है. जैसे, $HOME डायरेक्ट्री में मौजूद .bashrc या .bash_profile फ़ाइल. इन्हें कमांड लाइन का इस्तेमाल करके भी तय किया जा सकता है.

टर्मिनल का इस्तेमाल करके, .bashrc फ़ाइल की मदद से एनवायरमेंट वैरिएबल तय करने के कुछ बुनियादी तरीके यहां दिए गए हैं:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
source ~/.bashrc

एनवायरमेंट वैरिएबल को सीधे कमांड लाइन से, टर्मिनल इंस्टेंस में भी सेट किया जा सकता है:

export GOOGLE_ADS_CLIENT_ID=1234567890

दूसरा विकल्प यह है कि एनवायरमेंट वैरिएबल का इस्तेमाल करने वाले कमांड को कॉल करते समय, एनवायरमेंट वैरिएबल सेट करें:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

इकाइयां फ़ेच करें

GoogleAdsService.SearchStream का इस्तेमाल आम तौर पर इकाइयों को फ़ेच करने के लिए किया जाता है. साथ ही, नतीजे पंक्तियों की स्ट्रीम के तौर पर दिखाए जाते हैं. इसके अलावा, खराब इंटरनेट कनेक्शन होने पर, इकाइयों को फ़ेच करने के लिए GoogleAdsService.Search का इस्तेमाल किया जा सकता है. GoogleAdsService.Search नतीजों को हर पेज पर 10,000 पंक्तियों के तय पेज साइज़ के तौर पर दिखाता है.

जब नतीजों को बार-बार दोहराया जाता है, तब क्लाइंट लाइब्रेरी पेजिंग को अपने-आप लागू कर देती हैं. इससे, उन्हें एक साथ डाउनलोड और प्रोसेस किया जा सकता है.

Java

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

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V26.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;
    }
}

PHP

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

Python

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.'
            )

Ruby

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

Perl

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::V26::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;
}

curl

कोड के उदाहरण

Google Ads API में कुछ सामान्य फ़ंक्शन के कोड के उदाहरण देखें.