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

हमारी क्लाइंट लाइब्रेरी, 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 पर देखना

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

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

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

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

टेबल से पता चलता है कि कौनसी क्लाइंट लाइब्रेरी, API के किन वर्शन के साथ काम करती हैं.

Java

Java के लिए क्लाइंट लाइब्रेरी
v18 Min: 34.0.0
Max: -
v17 Min: 32.0.0
Max: -
v16 Min: 30.0.0
Max: -

C#

.NET के लिए क्लाइंट लाइब्रेरी
v18 Min: 21.1.0
Max: -
v17 Min: 20.1.0
Max: -
v16 Min: 18.1.0
Max: -

PHP

PHP के लिए क्लाइंट लाइब्रेरी
v18 Min: 25.0.0
Max: -
v17 Min: 23.1.0
Max: -
v16 Min: 22.1.0
Max: -

Python

Python के लिए क्लाइंट लाइब्रेरी
v18 Min: 25.1.0
Max: -
v17 Min: 24.1.0
Max: -
v16 Min: 23.1.0
Max: -

Ruby

Ruby के लिए क्लाइंट लाइब्रेरी
v18 Min: 31.0.0
Max: -
v17 Min: 29.0.0
Max: -
v16 Min: 27.0.0
Max: -

Perl

Perl के लिए क्लाइंट लाइब्रेरी
v18 Min: 25.0.1
Max: -
v17 Min: 23.0.0
Max: -
v16 Min: 21.0.0
Max: -

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

हर 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 संसाधन) में लिंक किए गए खातों के ज़रिए अनुमति दी जाती है. इस वैल्यू को डेटा उपलब्ध कराने वाली उस कंपनी के ग्राहक आईडी पर सेट करें जो बताए गए ग्राहक आईडी के संसाधनों को अपडेट करती है. इसे हाइफ़न (-) के बिना सेट किया जाना चाहिए. लिंक किए गए खातों के बारे में ज़्यादा जानने के लिए, सहायता केंद्र पर जाएं.

एनवायरमेंट वैरिएबल आम तौर पर, 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.
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());
      }
    }
  }
}
GetCampaigns.java

C#

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

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

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

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

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::V18::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

कोड के उदाहरण

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