เริ่มต้นใช้งาน 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. The API Library แสดงรายการ API ที่มีอยู่ทั้งหมดจัดกลุ่มตามตระกูลผลิตภัณฑ์และความนิยม
  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 การเปลี่ยนเส้นทาง

ในการสร้างดูหรือแก้ไข URIs การเปลี่ยนเส้นทางสำหรับข้อมูลรับรอง OAuth 2.0 ที่ระบุให้ทำดังต่อไปนี้:

  1. Go to the Credentials page.
  2. ในส่วน รหัสลูกค้า OAuth 2.0 ของหน้าคลิกข้อมูลรับรอง
  3. ดูหรือแก้ไข URIs การเปลี่ยนเส้นทาง

หากไม่มีส่วน รหัสลูกค้า 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