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

परफ़ॉर्मेंस के कारक

ज़्यादातर मामलों में, हमारा सुझाव है कि आप Search के बजाय SearchStream का इस्तेमाल करें. इसकी वजहें यहां दी गई हैं:

  • एक पेज वाली रिपोर्ट (10,000 से कम लाइनें): इन दोनों तरीकों के बीच परफ़ॉर्मेंस में कोई खास अंतर नहीं होता.
  • एक से ज़्यादा पेज वाली रिपोर्ट: आम तौर पर, SearchStream ज़्यादा तेज़ी से काम करता है, क्योंकि इसमें नेटवर्क के कई राउंड ट्रिप से बचा जा सकता है. साथ ही, डिस्क कैश से पढ़ने या लिखने में कम समय लगता है.
  • मेमोरी की बचत: SearchStream की मदद से बड़ी रिपोर्ट प्रोसेस करते समय, स्ट्रीम के हिस्सों को बार-बार प्रोसेस करें और लाइनों को प्रोसेस करते समय, उन्हें मेमोरी में बफ़र करने के बजाय, एक-एक करके प्रोसेस करें. इससे, आउट-ऑफ़-मेमोरी (OOM) से जुड़ी गड़बड़ियां नहीं होंगी.
  • कनेक्शन की मज़बूती: SearchStream लगातार कनेक्शन पर काम करता है. इसलिए, लंबे समय तक चलने वाली स्ट्रीम में नेटवर्क की गड़बड़ियों या समयसीमा खत्म होने की वजह से रुकावट आ सकती है. स्ट्रीम में होने वाली गड़बड़ियों के लिए, आरपीसी की समयसीमा को सही तरीके से कॉन्फ़िगर करें और फिर से कोशिश करने की लॉजिक लागू करें.

दर की सीमाएं

दोनों तरीकों के लिए, रोज़ाना के ऑपरेशन की सीमाएं, आपके Google Cloud प्रोजेक्ट की स्टैंडर्ड सीमाओं और ऐक्सेस लेवल के हिसाब से तय की जाती हैं. रिपोर्ट की एक लॉजिकल क्वेरी को, रोज़ाना के ऑपरेशन के कोटे में एक ऑपरेशन के तौर पर गिना जाता है. भले ही, नतीजे को SearchStream की मदद से स्ट्रीम किया गया हो या Search page_token का इस्तेमाल करके, कैश मेमोरी में सेव किए गए कई पेजों से वापस पाया गया हो. हालांकि, पेज के हिसाब से हर 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;
}

curl

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