ফলাফল মাধ্যমে পেজিং

Search Ads 360 Reporting API আপনার অনুরোধে page_size উল্লেখ করে Search পদ্ধতির মাধ্যমে ক্যোয়ারী ফলাফলের পেজিনেশন সমর্থন করে। এটি ক্যোয়ারীটির ফলাফল সেটটিকে একাধিক প্রতিক্রিয়ায় বিভক্ত করবে যার প্রতিটিতে page_size অবজেক্ট রয়েছে। যদি page_size নির্দিষ্ট করা না থাকে, তাহলে এটি স্বয়ংক্রিয়ভাবে 10,000 সারির সর্বোচ্চ পৃষ্ঠার আকারে সেট হয়ে যায়।

উদাহরণস্বরূপ, নিম্নলিখিত প্রশ্নের সাথে:

SELECT
  ad_group.id,
  ad_group_criterion.type,
  ad_group_criterion.criterion_id,
  ad_group_criterion.keyword.text,
  ad_group_criterion.keyword.match_type
FROM ad_group_criterion
WHERE ad_group_criterion.type = KEYWORD

যদি আপনার অ্যাকাউন্টে 50,000টি কীওয়ার্ড থাকে এবং page_size 1,000 এ সেট করা থাকে, তাহলে ফলাফল সেটে 1,000টি SearchAdsRow অবজেক্ট থাকবে প্রথম প্রতিক্রিয়ায়, একটি next_page_token সহ। পরবর্তী এক হাজার সারি পুনরুদ্ধার করতে, একই পৃষ্ঠার আকারের সাথে আবার অনুরোধ পাঠান, কিন্তু অনুরোধের page_token প্রতিক্রিয়ার next_page_token এ আপডেট করুন। পরবর্তী অনুরোধে page_size এর মান প্রতিবার আলাদা হতে পারে।

দ্রষ্টব্য: next_page_token সারিগুলির শেষ ব্যাচ ধারণ করে এমন প্রতিক্রিয়াতে পপুলেট করা হবে না।

আমাদের ক্লায়েন্ট লাইব্রেরি স্বয়ংক্রিয়ভাবে পেজিং পরিচালনা করে। আপনাকে শুধুমাত্র প্রতিক্রিয়ার সারিগুলির মাধ্যমে পুনরাবৃত্তি করতে হবে। যখন বর্তমান পৃষ্ঠার সমস্ত সারি ফেরত দেওয়া হয়, ক্লায়েন্ট লাইব্রেরি সম্পূর্ণ ডেটা সেট পুনরুদ্ধার না হওয়া পর্যন্ত আপনার পক্ষ থেকে স্বয়ংক্রিয়ভাবে সারিগুলির একটি নতুন পৃষ্ঠা আনবে৷ GRPC এর পরিবর্তে REST ব্যবহার করলে, আপনাকে অবশ্যই প্রতিটি নতুন পৃষ্ঠার জন্য স্পষ্টভাবে একটি অনুরোধ করতে হবে।

Search Ads 360 Reporting API অভ্যন্তরীণভাবে সম্পূর্ণ ডেটা সেট ক্যাশে করে, তাই পরবর্তী অনুরোধগুলি প্রথম অনুরোধের চেয়ে দ্রুত হয়। আপনার ব্যবহারের ক্ষেত্রের উপর নির্ভর করে, আপনি 1 থেকে 10,000 এর মধ্যে যেকোনো মানতে page_size সেট করতে পারেন। সাধারণভাবে, দ্রুত সামগ্রিক পারফরম্যান্সের জন্য, আপনার প্রতিক্রিয়াগুলিতে কম রাউন্ড ট্রিপের কারণে আপনার একটি বড় page_size ব্যবহার করা উচিত।

পৃষ্ঠা সংখ্যার উদাহরণ

জাভা

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package sample;

import com.beust.jcommander.Parameter;
import com.google.ads.searchads360.v0.lib.SearchAds360Client;
import com.google.ads.searchads360.v0.services.SearchAds360Row;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;
import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;

/** Get campaign details. */
public class GetCampaigns {
  private static final int PAGE_SIZE = 200;

  private static class GetCampaignsParams extends CodeSampleParams {

    @Parameter(names = "--customerId", required = true)
    private String customerId;

    @Parameter(names = "--loginCustomerId")
    private String loginCustomerId;
  }

  public static void main(String[] args) {
    GetCampaignsParams params = new GetCampaignsParams();
    if (!params.parseArguments(args)) {
      // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
      // here (10 digits, no dashes). If neither are set, customerId will be used as
      // loginCustomerId.
      // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
    }
    final String loginCustomerId = params.loginCustomerId;
    final String customerId = params.customerId;

    try {
      // Creates a SearchAds360Client with the specified loginCustomerId. If there's
      // no loginCustomerId, customerId will be used instead.
      final SearchAds360Client searchAds360Client =
          SearchAds360Client.newBuilder()
              .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
              .fromPropertiesFile()
              .build();
      // Creates the Search Ads 360 Service client.
      SearchAds360ServiceClient client = searchAds360Client.create();
      new GetCampaigns().runExample(client, customerId);
    } catch (Exception exception) {
      System.err.printf("Failed with exception: %s%n", exception);
      exception.printStackTrace();
      System.exit(1);
    }
  }

  private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
    // Creates a query that retrieves all campaigns under the customerId.
    String query = "SELECT campaign.name, campaign.id, campaign.status FROM campaign";
    SearchSearchAds360Request request =
        SearchSearchAds360Request.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .setPageSize(PAGE_SIZE)
            .build();

    // Issues a search request.
    final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
    for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
      System.out.printf(
          "Campaign found with name '%s', ID %d, and status: %s.%n",
          element.getCampaign().getName(),
          element.getCampaign().getId(),
          element.getCampaign().getStatus());
    }
  }
}

GetCampaigns.java ডাউনলোড করুন

পাইথন

#!/usr/bin/env python
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Retrieves campaigns for a customer using a pagination search request."""

import argparse
import traceback
from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360Request
from util_searchads360 import SearchAds360Client

_DEFAULT_PAGE_SIZE = 10000


def main(client, customer_id, page_size) -> None:
  search_ads_360_service = client.get_service()

  query = """
      SELECT
        campaign.name,
        campaign.id,
        campaign.status
      FROM campaign"""

  request = SearchSearchAds360Request()
  request.customer_id = customer_id
  request.query = query
  request.page_size = page_size

  # Issues a search request.
  results = search_ads_360_service.search(request=request)

  for row in results:
    campaign = row.campaign
    print(
        f'campaign "{campaign.name}" has id {campaign.id} and status {campaign.status.name}'
    )


if __name__ == "__main__":
  # SearchAds360Client will read the search-ads-360.yaml configuration file in
  # the home directory if none is specified.
  search_ads_360_client = SearchAds360Client.load_from_file()

  parser = argparse.ArgumentParser(
      description=("Retrieves campaigns for a customer."))
  # Arguments to provide to run the example.
  parser.add_argument(
      "-c",
      "--customer_id",
      type=str,
      required=True,
      help="The Search Ads 360 customer ID (10 digits, no dashes).",
  )

  parser.add_argument(
      "-l",
      "--login_customer_id",
      type=str,
      required=False,
      help="The Search Ads 360 login customer ID (10 digits, no dashes).",
  )

  args = parser.parse_args()

  search_ads_360_client.set_ids(args.customer_id, args.login_customer_id)

  try:
    main(search_ads_360_client, args.customer_id, _DEFAULT_PAGE_SIZE)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

get_campaigns.py ডাউনলোড করুন