Google Ads API की इकाइयों और रिपोर्टिंग डेटा को वापस पाने के लिए, इनमें से किसी एक तरीके का इस्तेमाल करें:
यहां दोनों तरीकों के बीच के मुख्य अंतर दिए गए हैं:
| GoogleAdsService.SearchStream | GoogleAdsService.Search | |
|---|---|---|
| प्रोडक्शन कोड के लिए सही है | हां | हां |
| सेवा | GoogleAdsService |
GoogleAdsService |
| स्थिति | ऑब्जेक्ट और रिपोर्ट फ़ेच करना | ऑब्जेक्ट और रिपोर्ट फ़ेच करना |
| जवाब | GoogleAdsRow ऑब्जेक्ट की स्ट्रीम |
GoogleAdsRow ऑब्जेक्ट के पेज |
| जवाब के फ़ील्ड | सिर्फ़ वे जिन्हें क्वेरी में बताया गया है | सिर्फ़ वे जिन्हें क्वेरी में बताया गया है |
| रोज़ाना इस्तेमाल की सीमाएं | ऐक्सेस लेवल के आधार पर रोज़ाना इस्तेमाल की सीमाएं | ऐक्सेस लेवल के आधार पर रोज़ाना इस्तेमाल की सीमाएं |
SearchStream बनाम Search
Search पूरी रिपोर्ट डाउनलोड करने के लिए, पेज के हिसाब से कई अनुरोध भेजता है. वहीं, SearchStream एक ही अनुरोध भेजता है और रिपोर्ट के साइज़ से कोई फ़र्क़ नहीं पड़ता. यह Google Ads API के साथ लगातार gRPC कनेक्शन शुरू करता है.
SearchStream के लिए, डेटा पैकेट तुरंत डाउनलोड होने लगते हैं. ये पैकेट, SearchGoogleAdsStreamResponse ऑब्जेक्ट के बैच में डाउनलोड होते हैं. आपका कोड, पूरी स्ट्रीम के खत्म होने का इंतज़ार किए बिना, आने वाले बैच पर तब तक काम कर सकता है, जब तक वे पहुंचते हैं.
Search जवाब के हर पेज का अनुरोध करने के लिए, नेटवर्क के राउंड-ट्रिप टाइम को कम करके, SearchStream, पेजिंग की तुलना में बेहतर परफ़ॉर्मेंस देता है. खास तौर पर, बड़ी रिपोर्ट के लिए.
उदाहरण
इस उदाहरण में, 100,000 लाइनों वाली रिपोर्ट दिखाई गई है. यहां दी गई टेबल में, अनुरोध और जवाब के बीच के अंतर को दिखाया गया है:
| SearchStream | खोजें | |
|---|---|---|
| पेज आकार | इस पर रेटिंग लागू नहीं होती | हर पेज पर 10,000 लाइनें |
| एपीआई अनुरोधों की संख्या | 1 अनुरोध | 10 अनुरोध |
| एपीआई से मिले जवाबों की संख्या | लगातार एक स्ट्रीम | 10 जवाब |
परफ़ॉर्मेंस के फ़ैक्टर
हम ज़्यादातर मामलों में, Search के बजाय SearchStream का इस्तेमाल करने का सुझाव देते हैं. इसकी वजहें यहां दी गई हैं:
- एक पेज वाली रिपोर्ट (10,000 से कम लाइनें): दोनों तरीकों की परफ़ॉर्मेंस में कोई खास अंतर नहीं है.
- एक से ज़्यादा पेज वाली रिपोर्ट: आम तौर पर,
SearchStreamज़्यादा तेज़ होता है. ऐसा इसलिए, क्योंकि इसमें नेटवर्क राउंड ट्रिप से बचा जाता है. साथ ही, डिस्क की कैश मेमोरी से डेटा को पढ़ने या लिखने में कम समय लगता है. - मेमोरी का सही इस्तेमाल:
SearchStreamकी मदद से बड़ी रिपोर्ट प्रोसेस करते समय, स्ट्रीम के चंक को दोहराएं और पंक्तियों को प्रोसेस करें. इसके लिए, सभी पंक्तियों को एक साथ मेमोरी में बफ़र न करें, ताकि मेमोरी से जुड़ी गड़बड़ियों (ओओएम) से बचा जा सके. - कनेक्शन की स्थिरता:
SearchStreamको लगातार कनेक्शन की ज़रूरत होती है. इसलिए, लंबे समय तक चलने वाली स्ट्रीम में नेटवर्क की समस्या या समयसीमा खत्म होने की वजह से रुकावट आ सकती है. सही आरपीसी टाइमआउट कॉन्फ़िगर करें और स्ट्रीम से जुड़ी कुछ समय के लिए होने वाली गड़बड़ियों के लिए, फिर से कोशिश करने का लॉजिक लागू करें.
अनुरोधों की संख्या की सीमाएं
दोनों तरीकों के लिए, रोज़ाना के ऑपरेशन की सीमाएं, आपके Google Cloud प्रोजेक्ट की स्टैंडर्ड सीमाओं और ऐक्सेस लेवल के मुताबिक होती हैं. एक लॉजिकल रिपोर्ट क्वेरी को, हर दिन के ऑपरेशन कोटे के लिए एक ऑपरेशन के तौर पर गिना जाता है. भले ही, नतीजे को SearchStream के साथ स्ट्रीम किया गया हो या page_token के साथ Search का इस्तेमाल करके, कैश मेमोरी में सेव किए गए कई पेजों से वापस पाया गया हो. हालांकि, हर पेज वाले 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.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; }