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 সার্চ করুন
পৃষ্ঠার আকার প্রযোজ্য নয় প্রতি পৃষ্ঠায় ১০,০০০ সারি
API অনুরোধের সংখ্যা ১টি অনুরোধ ১০টি অনুরোধ
API রেসপন্সের সংখ্যা ১টি একটানা স্ট্রিম ১০টি উত্তর

পারফর্ম্যান্স ফ্যাক্টর

বেশিরভাগ ক্ষেত্রে, আমরা নিম্নলিখিত কারণে Search-এর পরিবর্তে SearchStream ব্যবহার করার সাজেস্ট করি:

  • সিঙ্গেল-পেজ রিপোর্ট (১০,০০০-এর কম সারি): দুটি পদ্ধতির মধ্যে পারফর্ম্যান্সের কোনও উল্লেখযোগ্য পার্থক্য নেই।
  • মাল্টি-পেজ রিপোর্ট: SearchStream সাধারণত দ্রুত কাজ করে কারণ একাধিক নেটওয়ার্ক রাউন্ড ট্রিপ এড়ানো যায় এবং ডিস্ক ক্যাশে থেকে রিড বা রাইট করার প্রয়োজন হয় না।
  • মেমরি সংক্রান্ত দক্ষতা: SearchStream-এর মাধ্যমে বড় রিপোর্ট প্রসেস করার সময়, স্ট্রিম চাঙ্ক এবং প্রসেস রোয়ের মাধ্যমে ইটারেট করুন, কারণ সেগুলি আউট-অফ-মেমরি (OOM) সংক্রান্ত সমস্যা এড়াতে একবারে মেমরিতে সব রো বাফার করার পরিবর্তে আসে।
  • কানেকশন রেসিলিয়েন্সি: SearchStream যেহেতু একটি অবিরাম কানেকশনের উপর নির্ভর করে, তাই দীর্ঘক্ষণ ধরে চলা স্ট্রিম নেটওয়ার্ক ড্রপ বা ডেডলাইন টাইম-আউটের কারণে বাধা পেতে পারে। উপযুক্ত RPC টাইম-আউট কনফিগার করুন এবং ট্রানজিয়েন্ট স্ট্রিম সংক্রান্ত সমস্যার জন্য আবার চেষ্টা করার লজিক প্রয়োগ করুন।

রেটের সীমা

দুটি পদ্ধতির জন্যই দৈনিক অপারেশন সীমা আপনার Google Cloud প্রোজেক্টের স্ট্যান্ডার্ড সীমা এবং অ্যাক্সেস লেভেল মেনে চলে। আপনার দৈনিক অপারেশন কোটার ক্ষেত্রে একটি লজিক্যাল রিপোর্ট কোয়েরিকে একটি অপারেশন হিসেবে গণনা করা হয়, ফলাফল SearchStream-এর মাধ্যমে স্ট্রিম করা হোক বা page_token-এর সাথে Search ব্যবহার করে একাধিক ক্যাশে করা পৃষ্ঠা থেকে পুনরুদ্ধার করা হোক না কেন। তবে, প্রতিটি পেজ করা Search অনুরোধ এখনও স্বল্প-মেয়াদী রেট সীমার বিপরীতে একটি স্বতন্ত্র RPC কল হিসাবে গণনা করা হয়।

কোডের উদাহরণ

ক্লায়েন্ট লাইব্রেরি ব্যবহার করে কীভাবে স্ট্রিমিং রিপোর্ট কোয়েরি এক্সিকিউট করতে হয় তা নিম্নলিখিত কোডের উদাহরণ থেকে দেখানো হয়েছে:

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;
}

কার্ল

পূর্ববর্তী
লেবেলগুলি
পরবর্তী
পেজিং