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

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

क्लाइंट लाइब्रेरी स्रोत डिस्ट्रिब्यूशन कोड के उदाहरण
Java google-ads-java Maven, tar.gz GitHub पर देखें
.NET google-ads-dotnet nuget, tar.gz, zip GitHub पर देखें
PHP google-ads-php tar.gz GitHub पर देखें
Python google-ads-python tar.gz, zip GitHub पर देखें
Ruby google-ads-ruby gem, tar.gz, zip GitHub पर देखें
Perl google-ads-perl tar.gz, zip GitHub पर देखें

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

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

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

एपीआई के इस्तेमाल किए जा सकने वाले वर्शन

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

Java

Java के लिए क्लाइंट लाइब्रेरी
v21 Min: 39.0.0
Max: -
v20 Min: 38.0.0
Max: -
v19 Min: 36.0.0
Max: -

C#

.NET के लिए क्लाइंट लाइब्रेरी
v21 Min: 24.0.0
Max: -
v20 Min: 23.0.0
Max: -
v19 Min: 22.1.0
Max: -
v18 Min: 21.1.0
Max: 23.0.0

PHP

PHP के लिए क्लाइंट लाइब्रेरी
v21 Min: 31.0.0
Max: -
v20 Min: 28.0.0
Max: -
v19 Min: 26.1.0
Max: -
v18 Min: 25.0.0
Max: 30.0.0

Python

Python के लिए क्लाइंट लाइब्रेरी
v21 Min: 28.0.0
Max: -
v20 Min: 27.0.0
Max: -
v19 Min: 25.2.0
Max: -

Ruby

Ruby के लिए क्लाइंट लाइब्रेरी
v21 Min: 35.0.0
Max: -
v20 Min: 34.0.0
Max: -
v19 Min: 32.0.0
Max: -
v18 Min: 31.0.0
Max: -

Perl

Perl के लिए क्लाइंट लाइब्रेरी
v21 Min: 28.0.0
Max: -
v20 Min: 27.0.0
Max: -
v19 Min: 26.0.0
Max: -
v18 Min: 25.0.1
Max: 28.0.0

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

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

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

  • क्लाइंट लाइब्रेरी
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: कॉन्फ़िगरेशन फ़ाइल का पाथ.
  • 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 कॉन्फ़िगरेशन फ़ाइल के पाथ पर सेट करें.
      • GOOGLE_ADS_IMPERSONATED_EMAIL : इस वैल्यू को उस खाते के ईमेल पते पर सेट करें जिसका इस्तेमाल करके धोखाधड़ी की जा रही है.
  • Google Ads API
    • GOOGLE_ADS_DEVELOPER_TOKEN : इसे अपने डेवलपर टोकन पर सेट करें.
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID : यह उस ग्राहक का आईडी है जिसे अनुरोध में इस्तेमाल करने की अनुमति मिली है. इसमें हाइफ़न (-) नहीं होने चाहिए.
    • GOOGLE_ADS_LINKED_CUSTOMER_ID : यह हेडर सिर्फ़ उन तरीकों के लिए ज़रूरी है जो Google Ads यूज़र इंटरफ़ेस (यूआई) में लिंक किए गए खातों (Google Ads API में AccountLink संसाधन) के ज़रिए अनुमति मिलने पर, किसी इकाई के संसाधनों को अपडेट करते हैं. इस वैल्यू को डेटा प्रोवाइडर के उस ग्राहक आईडी पर सेट करें जो बताए गए ग्राहक आईडी के संसाधनों को अपडेट करता है. इसे हाइफ़न (-) के बिना सेट किया जाना चाहिए. लिंक किए गए खातों के बारे में ज़्यादा जानने के लिए, सहायता केंद्र पर जाएं.

आम तौर पर, एनवायरमेंट वैरिएबल को बैश कॉन्फ़िगरेशन फ़ाइल में तय किया जाता है. जैसे, $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.
src ~/.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.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;
    }
}
      

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

कोड के उदाहरण

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