รายงานสตรีมมิง

การดึงข้อมูลเอนทิตีและข้อมูลการรายงานด้วย Search Ads 360 Reporting API ทําได้ 2 วิธี

คู่มือนี้มุ่งเน้นที่การสตรีมข้อมูลจาก SearchAds360Service เป็นหลัก ความแตกต่างระดับสูงของวิธีการดึงข้อมูล 2 วิธีมีดังนี้

SearchAds360Service.SearchStream SearchAds360Service.Search
เหมาะสำหรับโค้ดเวอร์ชันที่ใช้งานจริง มี มี
บริการ SearchAds360Service SearchAds360Service
สถานการณ์ การดึงข้อมูลออบเจ็กต์และรายงาน การดึงข้อมูลออบเจ็กต์และรายงาน
คำตอบ สตรีมของออบเจ็กต์ SearchAds360Row หน้าของวัตถุ SearchAds360Row
ฟิลด์ของคำตอบ เฉพาะรายการที่ระบุไว้ในข้อความค้นหา เฉพาะรายการที่ระบุไว้ในข้อความค้นหา
ขีดจำกัดการใช้งานต่อวัน โปรดดูขีดจํากัดและโควต้าของ API โปรดดูขีดจํากัดและโควต้าของ API

แม้ว่า Search จะส่งคําขอแบบแบ่งหน้าได้หลายรายการเพื่อดาวน์โหลดรายงานทั้งฉบับ แต่ SearchStream จะส่งคําขอรายการเดียวและเริ่มการเชื่อมต่อแบบถาวรกับ Search Ads 360 Reporting API โดยไม่คำนึงถึงขนาดของรายงาน

สำหรับ SearchStream ระบบจะเริ่มดาวน์โหลดแพ็กเก็ตข้อมูลทันทีโดยแคชผลลัพธ์ทั้งหมดไว้ในบัฟเฟอร์ข้อมูล โค้ดของคุณจะเริ่มอ่านข้อมูลที่บัฟเฟอร์ไว้ได้โดยไม่ต้องรอให้สตรีมทั้งหมดเล่นจบ

SearchStream มีประสิทธิภาพที่ดีขึ้นกว่าการแบ่งหน้า โดยเฉพาะสําหรับรายงานขนาดใหญ่ เนื่องจากจะช่วยลดเวลาในการรับส่งข้อมูลในเครือข่ายที่จําเป็นในการขอหน้าแต่ละหน้าของคําตอบ Search ทั้งนี้ขึ้นอยู่กับแอปของคุณ

ตัวอย่าง

สมมติว่ารายงานมีแถว 100,000 แถว ตารางต่อไปนี้จะแสดงรายละเอียดความแตกต่างของการบัญชีระหว่าง 2 วิธี

SearchStream ค้นหา
ขนาดหน้า ไม่เกี่ยวข้อง 10,000 แถวต่อหน้า
จำนวนคำขอ API คำขอ 1 รายการ คำขอ 10 รายการ
จํานวนการตอบกลับของ API สตรีมต่อเนื่อง 1 รายการ 10 การตอบกลับ

ปัจจัยด้านประสิทธิภาพ

โดยทั่วไป เราขอแนะนำให้ใช้ SearchStream แทน Search ด้วยเหตุผลต่อไปนี้

  • สําหรับรายงานหน้าเดียว (น้อยกว่า 10,000 แถว): ประสิทธิภาพของทั้ง 2 วิธีไม่มีความแตกต่างกันมากนัก

  • สําหรับรายงานหลายหน้า: SearchStream มักจะเร็วกว่าเนื่องจากจะหลีกเลี่ยงการส่งข้อมูลหลายรอบและการอ่าน/เขียนจากแคชดิสก์มีปัจจัยน้อยกว่า

ขีดจำกัดอัตรา

ขีดจํากัดรายวันของทั้ง 2 วิธีเป็นไปตามขีดจํากัดและโควต้า API มาตรฐาน การค้นหาหรือรายงานรายการเดียวจะนับเป็นการดำเนินการ 1 ครั้ง ไม่ว่าผลลัพธ์จะแสดงเป็นหน้าเว็บหรือสตรีมก็ตาม

ตัวอย่างสตรีมมิง

JavaPython

// 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.SearchSearchAds360StreamRequest;
import com.google.ads.searchads360.v0.services.SearchSearchAds360StreamResponse;
import com.google.api.gax.rpc.ServerStream;

/** Get campaign details using SearchStream. */
public class GetCampaignsStream {
  private static class GetCampaignsStreamParams extends CodeSampleParams {

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

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

  public static void main(String[] args) {
    GetCampaignsStreamParams params = new GetCampaignsStreamParams();
    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 GetCampaignsStream().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";
    SearchSearchAds360StreamRequest request =
        SearchSearchAds360StreamRequest.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .build();

    // Issues a search stream request.
    ServerStream<SearchSearchAds360StreamResponse> stream =
        searchAds360ServiceClient.searchStreamCallable().call(request);

    for (SearchSearchAds360StreamResponse response : stream) {
      for (SearchAds360Row element : response.getResultsList()) {
        System.out.printf(
            "Campaign found with name '%s', ID %d, and status: %s.%n",
            element.getCampaign().getName(),
            element.getCampaign().getId(),
            element.getCampaign().getStatus());
      }
    }
  }
}

ดาวน์โหลด GetCampaignsStream.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 stream request."""

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


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

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

  request = SearchSearchAds360StreamRequest()
  request.customer_id = customer_id
  request.query = query

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

  for response in results:
    for result in response.results:
      campaign = result.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)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

ดาวน์โหลด get_campaigns_stream.py