Search Ads 360 Reporting API החדש זמין עכשיו. כדי להתעדכן לגבי השיפורים והגרסאות שצפויים בקרוב, הצטרפו לקבוצת Google searchads-api-announcements.

תחילת העבודה עם Search Ads 360 Reporting API

בקטעים הבאים מוסבר איך להתחיל לעבוד עם Search Ads 360 Reporting API.

הגדרת הפרויקט ב-Google Cloud

כדי להשתמש ב-Search Ads 360 Reporting API, צריך ליצור פרויקט לאפליקציה ב-Google Cloud.

יצירת פרויקט ב-Google

פרויקט ב-Google משמש כמאגר משאבים למשאבים שלכם ב-Google Cloud.

עוברים אל Google API Console.
לוחצים על יצירת פרויקט.
מזינים שם או מאשרים את ההצעה שנוצרה.
מאשרים או עורכים את השדות שנותרו.
לוחצים על יצירה.

יצירת פרטי כניסה של OAuth2

ב-Search Ads 360 Reporting API נעשה שימוש ב-OAuth 2.0 לצורך אימות והרשאה. פרטי הכניסה ל-OAuth מזהים את האפליקציה שלכם ב-Google, ומאפשרים לכם ליצור אסימוני OAuth לניהול משתמשים ב-Search Ads 360.

כדי ליצור פרטי כניסה מסוג OAuth 2.0 ב-Google API Console:

עוברים אל דף הלקוחות.
לוחצים על Create credentials > OAuth client ID (יצירת פרטי כניסה > מזהה לקוח OAuth).
בוחרים את סוג הבקשה.
ממלאים את הטופס ולוחצים על יצירה.

הפעלת Search Ads 360 Reporting API

כדי להשתמש ב-API, צריך להפעיל את Search Ads 360 Reporting API בפרויקט ב-Google API Console.

כדי להפעיל API בפרויקט:

פותחים את API Library ב-Google API Console.
אם מתבקשים, בוחרים פרויקט או יוצרים פרויקט חדש. בספריית ה-API מפורטים כל ממשקי ה-API הזמינים, מקובצים לפי משפחת מוצרים ופופולריות.
אם ה-API שרוצים להפעיל לא מופיע ברשימה, אפשר להשתמש בחיפוש כדי למצוא אותו, או ללחוץ על הצגת כל במשפחת המוצרים שאליה הוא שייך.
בוחרים את ה-API שרוצים להפעיל ולוחצים על הכפתור הפעלה.
אם תופיע בקשה, תצטרכו להפעיל את החיוב.
אם מתבקשים לעשות זאת, קוראים את התנאים וההגבלות של ה-API ומאשרים אותם.

אפשר להפעיל חיוב בפרויקט

אין תשלום על שימוש ב-Search Ads 360 Reporting API ב-Google Cloud. עם זאת, יש מכסה למספר הכולל של פרויקטים ב-Cloud ללא תשלום לכל חשבון. אם הגעתם למגבלה, אתם יכולים להירשם לחשבון Google חדש שיכלול מכסת פרויקטים בחינם.

כדי להפעיל את החיוב בפרויקט:

עוברים אל דף החיוב.
אם אין לכם חשבון פעיל לחיוב, תוכלו ליצור אחד על ידי לחיצה על הוספת חשבון לחיוב וביצוע ההוראות.

הפעלת מסך ההסכמה של הפרויקט

כדי להפעיל את מסך ההסכמה של הפרויקט:

פותחים את הדף Branding במסוף Google Cloud.
אם מתבקשים, בוחרים פרויקט או יוצרים פרויקט חדש.
ממלאים את הטופס ולוחצים על שמירה.

יצירה, עריכה או צפייה ב-URI להפניה אוטומטית

כדי ליצור, להציג או לערוך את כתובות ה-URI להפניה אוטומטית של פרטי כניסה מסוג OAuth 2.0:

עוברים אל דף הלקוחות.
לוחצים על הלקוח.
צפייה ב-URI של ההפניה או עריכה שלו.

אם אין לקוח ברשימה בדף Clients (לקוחות), המשמעות היא שלפרויקט שלכם אין פרטי כניסה של OAuth. כדי ליצור לקוח, לוחצים על יצירת לקוח.

הורדה של ספריית לקוח

הדרך המומלצת להתחבר אל Search Ads 360 Reporting API היא באמצעות ספריית לקוח של Search Ads 360 Reporting API.

מורידים את ספריית הלקוח של Search Ads 360 Reporting API לסביבת הפיתוח. פועלים לפי ההוראות הספציפיות לשפה שמופיעות במאמר איך מגדירים את קובץ התצורה של ספריית הלקוח. ברוב המקרים, אפשר לעשות שימוש חוזר בהגדרה הקיימת כשעוברים לספריית הלקוח של Search Ads 360 Reporting API החדש.

שינוי חשוב אחד הוא הכותרת החדשה login-customer-id. במאמר כותרת מזהה הלקוח בכניסה מוסבר מתי צריך להוסיף את הכותרת הזו להגדרה.

ביצוע השיחה הראשונה

אחרי שמגדירים את ספריית הלקוח, אפשר לבצע את הקריאה הראשונה.

קבלת קמפיינים

בסביבת הפיתוח המשולבת, מריצים את הקוד הבא:

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

מורידים את GetCampaigns.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