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

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

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

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

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

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

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

.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.Search का इस्तेमाल इंटरैक्टिव ऐप्लिकेशन में किया जाता है. इसमें नतीजों के पेज दिखते हैं.

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

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
      

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

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
      

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
      

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
      

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::V17::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.