เริ่มต้นใช้งาน Ads Data Hub API

คู่มือนี้จะอธิบายวิธีเริ่มต้นเขียนแอปพลิเคชันที่ใช้ REST API ของ Ads Data Hub เพื่อโต้ตอบกับ Ads Data Hub Ads Data Hub REST API ช่วยให้คุณดูลูกค้า Ads Data Hub ที่เชื่อมโยงกับบัญชี Google, สร้างการค้นหา และเรียกใช้การค้นหาได้

ตั้งค่า

คุณต้องทำ 2-3 ขั้นตอนก่อนใช้ Ads Data Hub API

  1. ตรวจสอบว่าได้ให้สิทธิ์ผู้ใช้ที่เปิดใช้ API แล้ว serviceusage.services.enable ในโปรเจ็กต์ Google Cloud ผู้ใช้ ที่มีสิทธิ์ serviceusage.services.enable ต้องอยู่ในรายการที่อนุญาตสำหรับ เข้าถึง API
  2. เปิดใช้ Ads Data Hub API ในโปรเจ็กต์ Google Cloud ที่สร้างข้อมูลเข้าสู่ระบบของไคลเอ็นต์หรือบัญชีบริการ วิธีเปิดใช้ Ads Data Hub API สําหรับโปรเจ็กต์โดยใช้คอนโซล
    1. ไปที่ไลบรารี Cloud Console API
    2. เลือกโปรเจ็กต์ที่ต้องการใช้จากรายการโปรเจ็กต์
    3. ค้นหา "Ads Data Hub API"
    4. ในหน้า API ให้คลิกเปิดใช้
  3. จัดการสิทธิ์
    1. อีเมลหรือบัญชีบริการที่ใช้สร้างข้อมูลเข้าสู่ระบบจะต้อง ลงใน Ads Data Hub ได้ด้วย สิทธิ์ที่เหมาะสม สำหรับบัญชีบริการ นี่คืออีเมลบัญชีบริการ สำหรับ OAuth ซึ่งก็คืออีเมลของผู้ใช้ วิธีนี้จะช่วยให้มั่นใจได้ว่าบริการ บัญชีหรือบัญชีของผู้ใช้ปลายทางมีสิทธิ์ในการเรียกใช้การค้นหาใน Ads Data Hub
  4. (แนะนำ) ติดตั้งไลบรารีไคลเอ็นต์ Google API โดยทำดังนี้
    1. ไลบรารีของไคลเอ็นต์ Google API มีใน ภาษาต่างๆ และช่วยให้คุณทำงานกับ Google API ได้มากมาย หากไม่ใช่ ไลบรารีของไคลเอ็นต์จะลดจำนวนโค้ดที่คุณมี เพื่อเขียนและทำให้การตั้งค่าการตรวจสอบสิทธิ์ง่ายขึ้น
ห้องสมุดลูกค้า ตัวอย่าง Ads Data Hub
ไลบรารีของไคลเอ็นต์ Google API สำหรับ Java Java
ไลบรารีของไคลเอ็นต์ Google API สำหรับ Python

ตรวจสอบสิทธิ์และให้สิทธิ์

Ads Data Hub API สามารถเข้าถึงและเปลี่ยนแปลงข้อมูลในลูกค้า Ads Data Hub ของคุณได้ บัญชี ดังนั้นจึงต้องยืนยันว่าคุณเป็นผู้ใช้ที่ได้รับอนุญาต ด้วยเหตุนี้ ก่อนจะเริ่มโต้ตอบกับ Ads Data Hub API คุณจะต้องเดิน ผ่านขั้นตอนการให้สิทธิ์ กระบวนการให้สิทธิ์จะแสดง สิทธิ์ที่จำเป็นในการโต้ตอบกับ API คุณสามารถตรวจสอบสิทธิ์ได้โดยใช้ OAuth 2.0 หรือบัญชีบริการ

การตั้งค่าบัญชีบริการ

  1. ไปที่คอนโซล Google API และไปที่โปรเจ็กต์ผู้ดูแลระบบ
  2. ตรวจสอบว่าได้เปิดใช้ Ads Data Hub API สําหรับโปรเจ็กต์ใน API &แล้ว บริการ
    1. หากไม่ได้เปิดใช้อยู่ ให้คลิก + เปิดใช้ API และบริการ แล้วเปิดใช้โฆษณา Data Hub API
  3. ในเมนูการนำทางด้านซ้าย ให้คลิก IAM และ ผู้ดูแลระบบ > บัญชีบริการ
    1. หากคุณยังไม่ได้สร้างบัญชีบริการ สร้างบัญชี
  4. คลิกเมนู 3 จุด () ใต้ "การดำเนินการ" จากนั้นคลิกจัดการคีย์
    1. คลิกเพิ่มคีย์ > สร้างคีย์ใหม่
    2. หลังจากที่ตรวจสอบว่า "JSON" ที่เลือกไว้ ให้คลิกสร้าง
  5. เพิ่มอีเมลบัญชีบริการเป็นผู้ใช้ใน Ads Data Hub ของคุณได้

ส่งคำขอตัวอย่าง

#!/usr/bin/env python3

"""This sample shows how to retrieve all accounts associated with the user.
"""
import json
from google.oauth2.service_account import Credentials
from googleapiclient.discovery import build

SCOPES = ['https://www.googleapis.com/auth/adsdatahub']
DISCOVERY_URL = 'https://adsdatahub.googleapis.com/$discovery/rest?version=v1'
creds = Credentials.from_service_account_file(
    'service-account.json').with_scopes(SCOPES)
developer_key = 'YOUR_DEVELOPER_KEY'  # Replace with your developer key.
service = build('AdsDataHub', 'v1', credentials=creds,
                developerKey=developer_key, discoveryServiceUrl=DISCOVERY_URL)

# Replace with your ADH account ID.
adh_account_id = input('ADH account ID (e.g. "customers/123456789"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=adh_account_id).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

ขั้นตอนถัดไป

  • โปรดดูตัวอย่างการค้นหาใน Ads Data Hub เพื่อดูตัวอย่างการค้นหาที่คุณสร้างและเรียกใช้ได้ด้วย REST API ของ Ads Data Hub
  • ต่อยอดจากตัวอย่างเพื่อทำความคุ้นเคยกับ API และปรับแต่งให้เหมาะกับกรณีการใช้งานของคุณ จากนั้นลองทำสิ่งต่อไปนี้
  • โปรดติดต่อทีมสนับสนุนของ ADH หากมีข้อสงสัยหรือความคิดเห็นเกี่ยวกับ API