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

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

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

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

יוצרים פרויקט של Google

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

  1. Go to the Google API Console.
  2. לחץ על צור פרויקט .
  3. הזן שם או קבל את ההצעה שנוצרה.
  4. אשר או ערוך את כל השדות שנותרו.
  5. לחץ על צור .

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

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

כדי ליצור אישור OAuth 2.0 בכניסה Google API Console , בצע את הפעולות הבאות:

  1. Go to the Credentials page.
  2. לחץ על צור אישורים> מזהה לקוח OAuth
  3. בחר את סוג היישום שלך.
  4. מלא את הטופס ולחץ על צור .

הפעלת Search Ads 360 Reporting API

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

כדי לאפשר ממשק API לפרויקט שלך:

  1. Open the API Library ב Google API Console .
  2. If prompted, select a project, or create a new one. API Library מפרט את כל ה- APIs הזמינים, מקובצים לפי משפחת מוצרים ופופולריות.
  3. אם ממשק ה- API שברצונך להפעיל אינו גלוי ברשימה, השתמש בחיפוש כדי למצוא אותו או לחץ על הצג הכל במשפחת המוצרים שאליה הוא שייך.
  4. בחר בממשק ה- API שברצונך להפעיל ולחץ על כפתור הפעל .
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

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

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

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

  1. בקר ב- Billing page .
  2. אם אין לך חשבון חיוב פעיל, צור חשבון על ידי לחיצה על הוסף חשבון חיוב ופעל לפי ההוראות.

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

  1. פתח את Consent Screen page ב- Google API Console .
  2. If prompted, select a project, or create a new one.
  3. מלא את הטופס ולחץ על שמור .

יצירה, עריכה או הצגה של מזהי URI להפניה אוטומטית

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

  1. Go to the Credentials page.
  2. בקטע מזהי לקוח OAuth 2.0 בדף, לחץ על אישור.
  3. הצגה או עריכה של קבצי ה- URI המפנים מחדש.

אם אין קטע מזהי לקוח של OAuth 2.0 בדף האישורים, לפרויקט שלך אין אישורי OAuth. כדי ליצור אחת, לחץ על צור אישורים .

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

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

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

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

התחלת השיחה

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

אחזור של קמפיינים

בסביבת הפיתוח המשולבת (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());
    }
  }
}

להורדת 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