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

คู่มือนี้อธิบายวิธีเริ่มต้นเขียนแอปพลิเคชันที่ใช้ Ads Data Hub REST API เพื่อโต้ตอบกับ 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 และบริการ แล้วเปิดใช้ Ads 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 customer ID.
customer_name = input('Customer name (e.g. "customers/123"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=customer_name).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

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

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