हमारी क्लाइंट लाइब्रेरी, Google Ads API के काम करने के तरीके के बारे में हाई-लेवल व्यू और बुनियादी बिल्डिंग ब्लॉक उपलब्ध कराती है. इससे ऐप्लिकेशन डेवलप करने में आसानी होती है. हमारा सुझाव है कि अगर आपने हाल ही में एपीआई का इस्तेमाल करना शुरू किया है, तो एक एपीआई से शुरुआत करें.
क्लाइंट लाइब्रेरी | सोर्स | कॉन्टेंट डिस्ट्रिब्यूट करने का अधिकार | कोड के उदाहरण |
---|---|---|---|
Java | google-ads-java | मावेन, 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 पर देखें |
रूबी | google-ads-ruby | जेम, टार.जी॰, ज़िप | GitHub पर देखें |
पर्ल | google-ads-perl | tar.gz, zip | GitHub पर देखें |
एपीआई के ऐसे वर्शन जिन पर Looker Studio काम करता है
इस टेबल से पता चलता है कि कौनसी क्लाइंट लाइब्रेरी, एपीआई के किन वर्शन के साथ काम करती हैं.
Java
Google Ads API |
Java के लिए क्लाइंट लाइब्रेरी |
v16 |
Min: 30.0.0 Max: - |
v15 |
Min: 28.0.0 Max: - |
v14 |
Min: 26.0.0 Max: - |
C#
Google Ads API |
.NET के लिए क्लाइंट लाइब्रेरी |
v16 |
Min: 18.1.0 Max: - |
v15 |
Min: 17.1.0 Max: - |
v14 |
Min: 16.1.0 Max: - |
PHP
Google Ads API |
PHP के लिए क्लाइंट लाइब्रेरी |
v16 |
Min: 22.1.0 Max: - |
v15 |
Min: 21.1.0 Max: - |
v14 |
Min: 19.2.0 Max: - |
Python
Google Ads API |
Python के लिए क्लाइंट लाइब्रेरी |
v15 |
Min: 22.1.0 Max: - |
v14 |
Min: 21.2.0 Max: - |
Ruby
Google Ads API |
Ruby के लिए क्लाइंट लाइब्रेरी |
v16 |
Min: 27.0.0 Max: - |
v15 |
Min: 25.0.0 Max: - |
v14 |
Min: 23.0.0 Max: - |
Perl
Google Ads API |
Perl के लिए क्लाइंट लाइब्रेरी |
v16 |
Min: 21.0.0 Max: - |
v15 |
Min: 19.0.0 Max: - |
v14 |
Min: 17.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
संसाधन) से अनुमति मिलने पर इकाई के संसाधन अपडेट हो जाते हैं. इस वैल्यू को डेटा उपलब्ध कराने वाली कंपनी के उस ग्राहक आईडी पर सेट करें जो बताए गए ग्राहक आईडी के संसाधनों को अपडेट करता है. यह हाइफ़न (-
) के बिना सेट होना चाहिए. लिंक किए गए खातों के बारे में ज़्यादा जानने के लिए, सहायता केंद्र पर जाएं.
आम तौर पर, एनवायरमेंट वैरिएबल किसी बैश कॉन्फ़िगरेशन फ़ाइल में बताए जाते हैं. जैसे, $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.Search
का इस्तेमाल ऐसे इंटरैक्टिव ऐप्लिकेशन में किया जाता है जो नतीजों के पेज दिखाते हैं.
जब आप नतीजों को फिर से दोहराते हैं, तो हमारी क्लाइंट लाइब्रेरी अपने-आप पेजिंग लागू कर देती है, ताकि आप उन सभी को एक साथ डाउनलोड और प्रोसेस कर सकें. उदाहरण के लिए:
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.V16.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, 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.' )
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::V16::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; }
इस्तेमाल के उदाहरण के हिसाब से, आपको ये काम करने पड़ सकते हैं:
- ऑप्टिमाइज़ करें कि कितने पेज फ़ेच किए जाएं.
- ऑप्टिमाइज़ करें कि एक बार में कितने नतीजे सेव किए जाएं.
- नतीजों के पेजों को एक खास क्रम में डाउनलोड और प्रोसेस करें.
ऐसा करने के लिए, नतीजों के बजाय पेज टोकन को स्टोर किया जा सकता है. इससे आपका कोड और जटिल हो जाता है.
Java
/** * Fetches and prints the results of a page of a search using a cache of page tokens. * * @param googleAdsClient the Google Ads API client. * @param customerId the client customer ID. * @param query the search query. * @param pageNumber the number of the page to fetch and print results for. * @param pageTokens the cache of page tokens to use and update. */ private static void fetchAndPrintPageResults( GoogleAdsClient googleAdsClient, long customerId, String query, int pageNumber, SortedMap<Integer, String> pageTokens) { int currentPageNumber; // There is no need to fetch the pages we already know the page tokens for. if (pageTokens.containsKey(pageNumber)) { System.out.println( "The token of the requested page was cached, we will use it to get the results."); currentPageNumber = pageNumber; } else { System.out.printf( "The token of the requested page was never cached, we will use the closest page we know" + " the token for (page %d) and sequentially get pages from there.%n", pageTokens.size()); currentPageNumber = pageTokens.lastKey(); } // Fetches next pages in sequence and caches their tokens until the requested page results // are returned. while (currentPageNumber <= pageNumber) { // Fetches the next page. System.out.printf("Fetching page %d...%n", currentPageNumber); SearchGoogleAdsRequest request = SearchGoogleAdsRequest.newBuilder() .setCustomerId(Long.toString(customerId)) .setPageSize(PAGE_SIZE) .setQuery(query) .setReturnTotalResultsCount(true) // Uses the page token cached for the current page number. .setPageToken(pageTokens.get(currentPageNumber)) .build(); try (GoogleAdsServiceClient googleAdsServiceClient = googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) { SearchPagedResponse response = googleAdsServiceClient.search(request); cacheNextPageToken(pageTokens, response.getPage(), currentPageNumber + 1); // Prints only the results for the requested page. if (currentPageNumber == pageNumber) { // Prints the results of the requested page. System.out.printf("Printing results found for page %d:%n", pageNumber); for (GoogleAdsRow googleAdsRow : response.getPage().getResponse().getResultsList()) { System.out.printf( "- Campaign with ID %d and name '%s'.%n", googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName()); } } currentPageNumber++; } } }
C#
/// <summary> /// Fetches and prints the results of a page of a search using a cache of page tokens. /// </summary> /// <param name="googleAdsService">The Google Ads API Service client.</param> /// <param name="request">The request.</param> /// <param name="pageNumber">The number of the page to fetch and print results for.</param> /// <param name="pageTokens">The cache of page tokens to use and update.</param> /// <returns></returns> private static void FetchAndPrintPageResults(GoogleAdsServiceClient googleAdsService, SearchGoogleAdsRequest request, int pageNumber, Dictionary<int, string> pageTokens) { int currentPageNumber = pageNumber; // There is no need to fetch the pages we already know the page tokens for. if (pageTokens.ContainsKey(pageNumber - 1)) { Console.WriteLine("The token of the requested page was cached, we will use it " + "to get the results."); currentPageNumber = pageNumber; } else { Console.WriteLine("The token of the requested page was never cached, we will " + $"use the closest page we know the token for (page #{pageNumber}) and " + $"sequentially get pages from there."); currentPageNumber = pageNumber; while (!pageTokens.ContainsKey(currentPageNumber)) { currentPageNumber--; } } SearchGoogleAdsResponse response = null; // Fetches next pages in sequence and caches their tokens until the requested page // results are returned. while (currentPageNumber <= pageNumber) { // Fetches the next page. Console.WriteLine($"Fetching page #{currentPageNumber}..."); request.PageToken = pageTokens[currentPageNumber - 1]; response = googleAdsService.Search(request) .AsRawResponses().First(); CacheNextPageToken(pageTokens, response, currentPageNumber); currentPageNumber++; } // Prints the results of the requested page. Console.WriteLine($"Printing results found for the page #{pageNumber}"); foreach (GoogleAdsRow row in response.Results) { Campaign c = row.Campaign; Console.WriteLine($" - Campaign with ID {c.Id} and name '{c.Name}'"); } }
PHP
/** * Fetches and prints the results of a page of a search using a cache of page tokens. * * @param GoogleAdsServiceClient $googleAdsServiceClient the Google Ads API Service client * @param int $customerId the customer ID * @param string $searchQuery the search query * @param array $searchOptions the search options * @param int $pageNumber the number of the page to fetch and print results for * @param array &$pageTokens the cache of page tokens to use and update */ private static function fetchAndPrintPageResults( GoogleAdsServiceClient $googleAdsServiceClient, int $customerId, string $searchQuery, array $searchOptions, int $pageNumber, array &$pageTokens ) { // There is no need to fetch the pages we already know the page tokens for. if (isset($pageTokens[$pageNumber])) { printf( 'The token of the requested page was cached, we will use it to get the results.%s', PHP_EOL ); $currentPageNumber = $pageNumber; } else { printf( 'The token of the requested page was never cached, we will use the closest page ' . 'we know the token for (page #%d) and sequentially get pages from there.%s', count($pageTokens), PHP_EOL ); $currentPageNumber = count($pageTokens); } // Fetches next pages in sequence and caches their tokens until the requested page results // are returned. while ($currentPageNumber <= $pageNumber) { // Fetches the next page. printf('Fetching page #%d...%s', $currentPageNumber, PHP_EOL); $response = $googleAdsServiceClient->search( (new SearchGoogleAdsRequest( $searchOptions + [ // Uses the page token cached for the current page number. 'page_token' => $pageTokens[$currentPageNumber] ] ))->setCustomerId($customerId)->setQuery($searchQuery) ); self::cacheNextPageToken($pageTokens, $response->getPage(), $currentPageNumber); $currentPageNumber++; } // Prints the results of the requested page. printf('Printing results found for the page #%d:%s', $pageNumber, PHP_EOL); foreach ($response->getPage()->getIterator() as $googleAdsRow) { /** @var GoogleAdsRow $googleAdsRow */ printf( " - Campaign with ID %d and name '%s'.%s", $googleAdsRow->getCampaign()->getId(), $googleAdsRow->getCampaign()->getName(), PHP_EOL ); } }
Python
def fetch_and_print_results( client, customer_id, query, page_number, page_tokens ): """Fetches and prints the results of a page using a cache of page tokens. Args: client: an initialized GoogleAdsClient instance. customer_id: a client customer ID. query: the search query. page_number: the number of the page to fetch and print results for. page_tokens: the cache of page tokens to use and update. """ current_page_number = None # There is no need to fetch the pages we already know the page tokens for. if page_tokens.get(page_number, None): print( "The token of the request page was cached, we will use it to get " "the results." ) current_page_number = page_number else: count = len(page_tokens.keys()) print( "The token of the requested page was never cached, we will use " f"the closest page we know the token for (page {count}) and " "sequentially get pages from there." ) current_page_number = count googleads_service = client.get_service("GoogleAdsService") # Fetches next pages in sequence and caches their tokens until the requested # page results are returned. while current_page_number <= page_number: # Fetches the next page. print(f"Fetching page {current_page_number}...") request = client.get_type("SearchGoogleAdsRequest") request.customer_id = customer_id request.query = query request.page_size = _PAGE_SIZE request.return_total_results_count = True # Uses the page token cached for the current page number. request.page_token = page_tokens[current_page_number] response = googleads_service.search(request=request) cache_next_page_token(page_tokens, response, current_page_number) current_page_number += 1 # Prints the results of the requested page. print(f"Printing results found for the page {page_number}.") for row in response.results: print( f" - Campaign with ID {row.campaign.id} and name " f"{row.campaign.name}." )
Ruby
def fetch_and_print_page_results(client, customer_id, query, page_size, return_total_results_count, page_number, page_tokens) if page_tokens.has_key?(page_number) puts 'The page token for the request page was cached. Reusing it.' current_page = page_number else puts "The token for the requested page has not been cached yet. We will start " \ "at page #{page_tokens.size} and request and cache pages until we find it." current_page = page_tokens.size end while current_page <= page_number puts page_tokens response = client.service.google_ads.search( customer_id: customer_id, query: query, page_size: page_size, return_total_results_count: return_total_results_count, page_token: page_tokens[current_page], ) cache_next_page_token(page_tokens, response.page, current_page + 1) current_page += 1 end puts "Printing results found for page #{page_number}." response.page.response.results.each do |result| puts "- Campaign with ID #{result.campaign.id} and name #{result.campaign.name}." end end
Perl
# Fetches and prints the results of a page of a search using a cache of page tokens. sub fetch_and_print_page_results { my ( $api_client, $customer_id, $query, $search_options, $page_number, $page_tokens ) = @_; my $current_page_number = undef; # There is no need to fetch the pages we already know the page tokens for. if (exists $page_tokens->{$page_number}) { print "The token of the requested page was cached, " . "we will use it to get the results.\n"; $current_page_number = $page_number; } else { printf "The token of the requested page was never cached, " . "we will use the closest page we know the token for (page #%d) " . "and sequentially get pages from there.\n", scalar keys %$page_tokens; $current_page_number = scalar keys %$page_tokens; } # Fetch next pages in sequence and cache their tokens until the requested page # results are returned. my $response = undef; while ($current_page_number <= $page_number) { # Fetch the next page. printf "Fetching page #%d...\n", $current_page_number; $response = $api_client->GoogleAdsService()->search({ customerId => $customer_id, query => $query, %$search_options, # Use the page token cached for the current page number. pageToken => $page_tokens->{$current_page_number}}); cache_next_page_token($page_tokens, $response, $current_page_number); $current_page_number++; } # Print the results of the requested page. printf "Printing results found for the page #%d:\n", $page_number; foreach my $google_ads_row (@{$response->{results}}) { printf " - Campaign with ID %d and name '%s'.\n", $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name}; } }
कोड के उदाहरण
Google Ads API के कुछ सामान्य फ़ंक्शन के लिए, हमारे कोड के उदाहरण देखें.