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

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

ตั้งค่า

คุณต้องทําตามขั้นตอนต่อไปนี้ก่อนจึงจะใช้ 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. ไปที่คลัง API ของ Cloud Console
    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 และบริการ แล้วเปิดใช้ Ads Data Hub API
  3. ในเมนูการนำทางด้านซ้าย ให้คลิก IAM และผู้ดูแลระบบ > บัญชีบริการ
    1. หากคุณยังไม่ได้สร้างบัญชีบริการ ให้สร้างบัญชี
  4. คลิกเมนู 3 จุด () ในส่วน "การดำเนินการ" แล้วคลิกจัดการคีย์
    1. คลิกเพิ่มคีย์ > สร้างคีย์ใหม่
    2. หลังจากตรวจสอบว่าได้เลือก "JSON" แล้ว ให้คลิกสร้าง
  5. เพิ่มอีเมลบัญชีบริการในฐานะผู้ใช้ในบัญชีฮับข้อมูล Ads

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

#!/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 เพื่อดูตัวอย่างการค้นหาที่คุณสร้างและเรียกใช้ด้วย Ads Data Hub REST API ได้
  • ขยายตัวอย่างเพื่อทำความคุ้นเคยกับ API และปรับแต่งให้เหมาะกับกรณีการใช้งานของคุณ จากนั้นลองทำดังนี้
    • สถานะการดําเนินการของคําค้นหาแบบโพล
    • ใช้ไลบรารีไคลเอ็นต์ BigQuery เพื่อดึงข้อมูลผลการค้นหาที่เสร็จสมบูรณ์
  • โปรดติดต่อทีมสนับสนุนของ ADH หากมีคำถามหรือข้อเสนอแนะเกี่ยวกับ API