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

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 पर देखें
Ruby 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 पर सेट होता है. PHP के v32.1.0 से पहले के वर्शन या कस्टम स्कोप का इस्तेमाल करते समय, 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 वैरिएबल को पढ़ता है. इसके अलावा, GoogleAdsConfig पर UseApplicationDefaultCredentials = true सेट करें. PHP में, OAuth2 के क्रेडेंशियल साफ़ तौर पर सेट न होने पर, OAuth2TokenBuilder अपने-आप एडीसी पर फ़ॉल बैक हो जाता है. Perl, एडीसी के साथ काम नहीं करता.
  • Google Ads API
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID: यह, अनुरोध में इस्तेमाल करने के लिए, अनुमति वाले ग्राहक का ग्राहक आईडी है. इसमें हाइफ़न (-) शामिल नहीं होते.
    • GOOGLE_ADS_LINKED_CUSTOMER_ID: इस हेडर की ज़रूरत सिर्फ़ उन तरीकों के लिए होती है जो Google Ads के यूज़र इंटरफ़ेस (यूआई) में लिंक किए गए खातों (AccountLink रिसॉर्स, Google Ads API में) के ज़रिए अनुमति मिलने पर, किसी इकाई के रिसॉर्स को अपडेट करते हैं. इस वैल्यू को, डेटा उपलब्ध कराने वाले उस ग्राहक के आईडी पर सेट करें जो बताए गए ग्राहक आईडी के रिसॉर्स को अपडेट करता है. इसे हाइफ़न (-) के बिना सेट किया जाना चाहिए . लिंक किए गए खातों के बारे में ज़्यादा जानने के लिए, सहायता केंद्र पर जाएं.

आम तौर पर, एनवायरमेंट वैरिएबल को बैश कॉन्फ़िगरेशन फ़ाइल में तय किया जाता है. जैसे, $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.V25.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::V25::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 में, आम तौर पर इस्तेमाल किए जाने वाले कुछ फ़ंक्शन केकोड के उदाहरण देखें.