Search Ads 360 Reporting API เวอร์ชันใหม่พร้อมให้ใช้งานแล้ว เข้าร่วมกลุ่ม Google searchads-api-announcements เพื่อติดตามการปรับปรุงและรุ่นที่กำลังจะเปิดตัว

หน้านี้ได้รับการแปลโดย Cloud Translation API

การให้สิทธิ์และส่วนหัว HTTP

คุณต้องมีข้อมูลเข้าสู่ระบบแอปพลิเคชัน OAuth 2.0 เมื่อเรียกใช้ Search Ads 360 Reporting API หากคุณเรียก API ในฐานะบัญชีดูแลจัดการ Search Ads 360 คุณจะต้องระบุส่วนหัว login-customer-id กับคําขอแต่ละรายการด้วย หน้านี้จะอธิบายวิธีตั้งค่าค่าเหล่านี้และเอกสารส่วนหัว HTTP สำหรับ API โดยเฉพาะเพิ่มเติมอีกหลายรายการที่ส่งและรับเมื่อใช้อินเทอร์เฟซ REST

ข้อมูลเข้าสู่ระบบ OAuth 2.0

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

หากเพิ่งเริ่มใช้ Google APIs คุณสามารถใช้ oauth2l หรือ OAuth 2.0 เพลย์กราวด์ เพื่อทดสอบข้อมูลเข้าสู่ระบบของแอปพลิเคชันและ Search Ads 360 Reporting API ก่อนเขียนโค้ดสําหรับแอป นอกจากนี้ คุณยังสร้างโทเค็นการรีเฟรช OAuth ได้โดยเรียกใช้สคริปต์การสร้างข้อมูลเข้าสู่ระบบของผู้ใช้ที่ระบุ

การสร้างโทเค็นการเข้าถึงใหม่

เมื่อคุณมีรหัสไคลเอ็นต์ คีย์ไคลเอ็นต์ และโทเค็นการรีเฟรชแล้ว คุณสามารถสร้างโทเค็นการเข้าถึงใหม่เพื่อใช้ในคําเรียก API ด้วยเครื่องมือบรรทัดคําสั่ง curl ดังนี้

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

จากนั้นใช้โทเค็นการเข้าถึงที่ส่งคืนโดยคําขอ curl ในส่วนหัว Authorization HTTP ของคําเรียก API ทั้งหมดไปยัง Search Ads 360 Reporting API ดังนี้

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

ส่วนหัวของคำขอ

รหัสลูกค้าสำหรับการเข้าสู่ระบบ

สําหรับการเรียกใช้ Reporting API ของ Search Ads 360 ที่ผู้จัดการทํากับบัญชีลูกค้า (นั่นคือ เมื่อเข้าสู่ระบบในฐานะผู้จัดการเพื่อเรียกใช้ API กับบัญชีลูกค้าบัญชีใดบัญชีหนึ่ง) คุณยังต้องระบุส่วนหัว login-customer-id HTTP ด้วย ค่านี้แสดงรหัสลูกค้า Search Ads 360 ของผู้จัดการที่เรียก API

การใส่ส่วนหัวนี้เทียบเท่ากับการเลือกบัญชีใน UI ของ Search Ads 360 หลังจากที่ลงชื่อเข้าใช้หรือคลิกรูปโปรไฟล์ที่มุมขวาบนของหน้า เมื่อระบุรหัสลูกค้า โปรดนำขีดกลาง (—) ออก เช่น 1234567890 ไม่ใช่ 123-456-7890

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

ส่วนหัวการตอบกลับ

ระบบจะแสดงส่วนหัวต่อไปนี้ในการตอบกลับ HTTP จาก API

รหัสคำขอ

request-id คือสตริงที่ระบุคำขอ API โดยไม่ซ้ำกัน เมื่อแก้ไขข้อบกพร่องหรือแก้ปัญหาการเรียก API ที่เฉพาะเจาะจง request-id จะเป็นตัวระบุที่สำคัญที่ควรเก็บไว้เมื่อติดต่อทีมสนับสนุนนักพัฒนาซอฟต์แวร์ของ Google

request-id: 2a5Cj89VV7CNhya1DZjjrC