GoogleAdsService का इस्तेमाल करके रिपोर्ट स्ट्रीम करना

Google Ads API की इकाइयों और रिपोर्टिंग डेटा को वापस पाने के लिए, इनमें से कोई एक तरीका अपनाएं:

दोनों तरीकों के बीच के मुख्य अंतर यहां दिए गए हैं:

GoogleAdsService.SearchStream GoogleAdsService.Search
प्रोडक्शन कोड के लिए सही है हां हां
सेवा GoogleAdsService GoogleAdsService
स्थिति ऑब्जेक्ट और रिपोर्ट फ़ेच करना ऑब्जेक्ट और रिपोर्ट फ़ेच करना
जवाब GoogleAdsRow ऑब्जेक्ट की स्ट्रीम GoogleAdsRow ऑब्जेक्ट के पेज
जवाब के फ़ील्ड सिर्फ़ वे फ़ील्ड जो क्वेरी में बताए गए हैं सिर्फ़ वे फ़ील्ड जो क्वेरी में बताए गए हैं
रोज़ाना इस्तेमाल की सीमाएं ऐक्सेस लेवल के आधार पर, रोज़ाना इस्तेमाल की सीमाएं ऐक्सेस लेवल के आधार पर, रोज़ाना इस्तेमाल की सीमाएं

Search, पूरी रिपोर्ट डाउनलोड करने के लिए, पेज के हिसाब से कई अनुरोध भेजता है. वहीं, SearchStream, रिपोर्ट के साइज़ पर ध्यान दिए बिना, एक अनुरोध भेजता है और Google Ads API के साथ एक स्थायी gRPC कनेक्शन शुरू करता है.

SearchStream के लिए, डेटा पैकेट तुरंत डाउनलोड होने लगते हैं. ये पैकेट, SearchGoogleAdsStreamResponse ऑब्जेक्ट के बैच में डाउनलोड होते हैं. आपका कोड, आने वाले बैच पर तब तक बार-बार काम कर सकता है, जब तक कि वे पूरी स्ट्रीम के खत्म होने का इंतज़ार किए बिना नहीं आ जाते.

Search रिस्पॉन्स के हर पेज का अनुरोध करने के लिए, नेटवर्क के दोतरफ़ा यात्रा के समय को खत्म करके, SearchStream पेजिंग की तुलना में बेहतर परफ़ॉर्मेंस देता है. खास तौर पर, बड़ी रिपोर्ट के लिए.

उदाहरण

इस उदाहरण में, 100,000 पंक्तियों वाली रिपोर्ट को देखा गया है. यहां दी गई टेबल में, दोनों तरीकों के बीच अनुरोध और जवाब के अंतर को बताया गया है:

SearchStream खोजें
पेज आकार इस पर रेटिंग लागू नहीं होती हर पेज पर 10,000 लाइनें
एपीआई अनुरोधों की संख्या 1 अनुरोध 10 अनुरोध
एपीआई से मिले जवाबों की संख्या 1 कॉन्टिन्यूअस स्ट्रीम 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.V26.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::V26::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;
}

curl

पीछे जाएं
लेबल
आगे बढ़ें
पृष्ठांकन