قائمة التحقُّق من نقل البيانات

  1. مراجعة عمليات الربط من Search Ads 360 API القديمة بالواجهة الجديدة Search Ads 360 Reporting API:

  2. فعِّل Search Ads Reporting 360 API في مشروعك على Google Cloud.

    • افتح مكتبة واجهة برمجة التطبيقات في وحدة تحكم واجهة برمجة تطبيقات Google. اختَر مشروعك أو أنشئ مشروعًا جديدًا إذا طُلب منك ذلك. تسرد مكتبة واجهة برمجة التطبيقات جميع واجهات برمجة التطبيقات المتاحة، مجمَّعة حسب مجموعة المنتج ومستوى الشعبية.
    • استخدِم البحث للعثور على Search Ads 360 Reporting API إذا لم تكن ظاهرة في القائمة.
    • اختَر Search Ads 360 Reporting API وانقر على تفعيل.

  3. اختَر مكتبة البرامج.

  4. أجرِ مكالمتك الأولى.

استخدام مكتبات البرامج

إنّ استخدام مكتبة برامج Search Ads 360 Reporting API هو الطريقة المقترَحة للربط بواجهة Search Ads 360 Reporting API.

يمكنك تنزيل مكتبة برامج واجهة برمجة التطبيقات لإعداد التقارير في "إعلانات شبكة البحث 360" لبيئة التطوير. اتبع التعليمات الخاصة باللغة حول كيفية إعداد ملف إعداد مكتبة البرامج. في معظم الحالات، يمكنك إعادة استخدام الإعدادات الحالية عند نقل البيانات إلى مكتبة برامج Search Ads 360 Reporting API الجديدة.

وأحد التغييرات المهمة هو عنوان login-customer-id الجديد. يُرجى الاطّلاع على عنوان "رقم تعريف عميل تسجيل الدخول" للحصول على تفاصيل حول الوقت الذي تحتاج فيه إلى إضافة هذا الرقم إلى الإعدادات.

مثال على إعداد Java

يوضّح لك هذا المثال كيفية تعديل ملف searchads360.properties لمكتبة برنامج Java عن طريق استبدال doubleclicksearch بـ searchads360 لسمات المصادقة.

api.doubleclicksearch.clientId       -> api.searchads360.clientId
api.doubleclicksearch.clientSecret   -> api.searchads360.clientSecret
api.doubleclicksearch.refreshToken   -> api.searchads360.refreshToken

إجراء مكالمتك الأولى

بعد تحديث ملف الإعداد، يمكنك إجراء المكالمة الأولى.

الحصول على حملات

في IDE، نفِّذ التعليمة البرمجية التالية:

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

تنزيل Getحملات.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

من المفترض أن تطبع وحدة التحكم قائمة بالحملات في حسابك.

استخدام REST

إذا قررت عدم استخدام مكتبة برامج، فستحتاج إلى فهم كيفية استخدام REST.

إذا كنت قد استخدمت REST مع واجهة Search Ads 360 API القديمة، ستظلّ بيانات الاعتماد متوافقة مع واجهة Search Ads 360 Reporting API الجديدة. يمكنك العثور على نقطة النهاية الجديدة والتفاصيل الأخرى في قسم مراجع REST.

مزيد من المعلومات

مزيد من المعلومات عن Search Ads 360 Reporting API