گزارش جریان

دو روش برای بازیابی موجودیت ها و گزارش داده ها با Search Ads 360 Reporting API وجود دارد.

این راهنما در درجه اول بر جریان داده از SearchAds360Service تمرکز دارد. در اینجا تمایزات سطح بالا برای دو روش بازیابی داده وجود دارد:

SearchAds360Service.SearchStream SearchAds360Service.Search
مناسب برای کد تولید بله بله
خدمات SearchAds360Service SearchAds360Service
سناریو واکشی اشیا و گزارش ها واکشی اشیا و گزارش ها
پاسخ جریانی از اشیاء SearchAds360Row صفحات اشیاء SearchAds360Row
فیلدهای پاسخ فقط آنهایی که در پرس و جو مشخص شده اند فقط آنهایی که در پرس و جو مشخص شده اند
محدودیت های روزانه محدودیت ها و سهمیه های API را ببینید. محدودیت ها و سهمیه های API را ببینید.

در حالی که Search می‌تواند چندین درخواست صفحه‌بندی شده برای دانلود کل گزارش ارسال کند، SearchStream یک درخواست را ارسال می‌کند و بدون در نظر گرفتن اندازه گزارش، یک اتصال دائمی را با Search Ads 360 Reporting API آغاز می‌کند.

برای SearchStream ، بسته‌های داده بلافاصله شروع به دانلود می‌کنند و کل نتیجه در یک بافر داده ذخیره می‌شود. کد شما می‌تواند شروع به خواندن داده‌های بافر کند بدون اینکه منتظر بمانید تا کل جریان به پایان برسد.

با حذف زمان رفت و برگشت شبکه مورد نیاز برای درخواست هر صفحه جداگانه از یک پاسخ Search ، بسته به برنامه شما، SearchStream می‌تواند عملکرد بهتری را نسبت به صفحه‌بندی، به ویژه برای گزارش‌های بزرگ‌تر، ارائه دهد.

مثال

به عنوان مثال گزارشی از 100,000 ردیف در نظر بگیرید. جدول زیر تفاوت های حسابداری بین این دو روش را نشان می دهد.

SearchStream جستجو کنید
اندازه صفحه قابل اجرا نیست 10000 ردیف در هر صفحه
تعداد درخواست های API 1 درخواست 10 درخواست
تعداد پاسخ های API 1 جریان پیوسته 10 پاسخ

عوامل عملکردی

به طور کلی، به دلایل زیر، SearchStream از طریق Search توصیه می کنیم.

  • برای گزارش های تک صفحه ای (زیر 10000 ردیف): تفاوت عملکرد قابل توجهی بین دو روش وجود ندارد.

  • برای گزارش‌های چند صفحه: SearchStream معمولاً سریع‌تر است، زیرا از چندین بار رفت و برگشت اجتناب می‌شود و خواندن/نوشتن از حافظه پنهان دیسک عامل کمتری است.

محدودیت های نرخ

محدودیت‌های روزانه برای هر دو روش به محدودیت‌ها و سهمیه‌های استاندارد API پایبند هستند. یک پرس و جو یا گزارش به عنوان یک عملیات بدون در نظر گرفتن نتیجه صفحه یا پخش جریانی حساب می شود.

نمونه استریم

جاوا 

// 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 را دانلود کنید