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

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

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

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

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

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

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

مثال

لنفترض مثلاً تقريرًا يتألّف من 100,000 صفًا. يوضّح الجدول التالي الاختلافات المحاسبية بين الطريقتَين.

SearchStream بحث
حجم الصفحة غير سارية 10,000 صف في كل صفحة
عدد طلبات البيانات من واجهة برمجة التطبيقات طلب واحد 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());
      }
    }
  }
}

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