الإبلاغ عن البث

تتوفّر طريقتان لاسترداد الكيانات وبيانات إعداد التقارير باستخدام Search Ads 360 Reporting API.

يركّز هذا الدليل بشكل أساسي على بيانات البث من SearchAds360Service. فيما يلي الاختلافات عالية المستوى لطريقتي استرجاع البيانات:

SearchAds360Service.SearchStream SearchAds360Service.Search
مناسبة لرمز الإنتاج نعم نعم
خدمة SearchAds360Service SearchAds360Service
السيناريو استرجاع العناصر والتقارير استرجاع العناصر والتقارير
الإجابة ساحة المشاركات لـ SearchAds360Row من العناصر صفحات العناصر SearchAds360Row
حقول الردّ فقط تلك المحددة في طلب البحث فقط تلك المحددة في طلب البحث
الحدود اليومية يُرجى الاطّلاع على الحدود والحصص المسموح بها لواجهة برمجة التطبيقات. يُرجى الاطّلاع على الحدود والحصص المسموح بها لواجهة برمجة التطبيقات.

بإمكان Search إرسال عدة طلبات مقسّمة على صفحات لتنزيل التقرير بأكمله، بينما ترسل SearchStream طلبًا واحدًا وتبدأ في إجراء اتصال دائم بـ Search Ads 360 Reporting API بغض النظر عن حجم التقرير.

بالنسبة إلى SearchStream، تبدأ حزم البيانات في التنزيل على الفور مع تخزين النتيجة بالكامل في المخزن المؤقت للبيانات. يمكن أن تبدأ التعليمة البرمجية في قراءة البيانات المخزنة مؤقتًا دون الحاجة إلى الانتظار حتى انتهاء البث بأكمله.

من خلال الحد من وقت الشبكة ذهابًا وإيابًا المطلوب لطلب كل صفحة فردية من استجابة Search، بناءً على تطبيقك، يمكن أن يؤدي SearchStream إلى تحسُّن أداء عملية التقسيم على صفحات، خاصةً للتقارير الأكبر حجمًا.

مثال

عليك أخذ تقرير يتألف من 100,000 صف على سبيل المثال. يقسم الجدول التالي الاختلافات المحاسبية بين الطريقتين.

SearchStream بحث
حجم الصفحة غير سارية 10000 صف في كل صفحة
عدد طلبات البيانات من واجهة برمجة التطبيقات طلب واحد 10 طلبات
عدد الردود من واجهة برمجة التطبيقات بث متواصل واحد 10 ردود

عوامل الأداء

وبشكل عام، ننصح باستخدام SearchStream بدلاً من Search للأسباب التالية.

  • بالنسبة إلى تقارير الصفحة الواحدة (أقل من 10,000 صف): لا توجد اختلافات كبيرة في الأداء بين الطريقتين.

  • بالنسبة إلى تقارير الصفحات المتعددة: يكون عادةً SearchStream أسرع نظرًا لعدم تلقّي جولات ذهاب وعودة متعددة، كما أنّ القراءة/الكتابة من ذاكرة التخزين المؤقت على القرص هي أقل من التأثير.

حدود المعدَّل

تلتزم الحدود اليومية لكلا الطريقتين بالحدود والحصص القياسية لواجهة برمجة التطبيقات. يتم احتساب طلب بحث أو تقرير واحد كعملية واحدة بغض النظر عن النتيجة التي يتم بثها على صفحات أو الوصول إليها.

مثال على البث

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.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());
      }
    }
  }
}

تنزيل GetCampaignStream.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 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