การแบ่งหน้าผ่านผลลัพธ์

Search Ads 360 Reporting API รองรับการแบ่งหน้าผลการค้นหาผ่านเมธอด Search โดยระบุ page_size ในคําขอ ซึ่งจะแบ่งชุดผลลัพธ์ของคำค้นหาออกเป็นคำตอบหลายรายการ โดยแต่ละรายการจะมีออบเจ็กต์ 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 ชุดผลลัพธ์จะมีออบเจ็กต์ SearchAdsRow 1,000 รายการในการตอบกลับครั้งแรก พร้อมกับ next_page_token หากต้องการดึงข้อมูลแถวถัดไป 1,000 แถว ให้ส่งคําขออีกครั้งโดยใช้ขนาดหน้าเว็บเดียวกัน แต่อัปเดต page_token ของคําขอเป็น next_page_token ของคําตอบ ค่าของ page_size ในคำขอที่ตามมาอาจแตกต่างกันไปในแต่ละครั้ง

หมายเหตุ: ระบบจะไม่ป้อนข้อมูล next_page_token ในการตอบกลับที่มีแถวชุดสุดท้าย

ไลบรารีของไคลเอ็นต์จะจัดการการแบ่งหน้าโดยอัตโนมัติ คุณเพียงแค่ต้องวนซ้ำผ่านแถวของการตอบกลับ เมื่อมีการส่งคืนแถวทั้งหมดในหน้าปัจจุบันแล้ว ไลบรารีของไคลเอ็นต์จะดึงข้อมูลแถวหน้าใหม่ในนามของคุณโดยอัตโนมัติจนกว่าจะได้รับชุดข้อมูลทั้งชุด หากใช้ REST แทน gRPC คุณต้องส่งคำขอสำหรับหน้าใหม่แต่ละหน้าอย่างชัดเจน

Search Ads 360 Reporting API จะแคชชุดข้อมูลทั้งหมดไว้ในที่เก็บข้อมูลภายใน เพื่อให้คำขอที่ตามมาเร็วกว่าคำขอแรก คุณตั้งค่า page_size เป็นค่าใดก็ได้ระหว่าง 1 ถึง 10,000 ทั้งนี้ขึ้นอยู่กับกรณีการใช้งาน โดยทั่วไปแล้ว คุณควรใช้ page_size ที่ใหญ่ขึ้นเพื่อให้ประสิทธิภาพโดยรวมเร็วขึ้น เนื่องจากมีการส่งข้อมูลไปมาน้อยลงในการตอบกลับ

ตัวอย่างการแบ่งหน้า

Java

// 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

Python

#!/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