การให้สิทธิ์และส่วนหัว 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 จะอนุญาตให้แอปไคลเอ็นต์ Search Ads 360 Reporting API เข้าถึงบัญชี Search Ads 360 ของผู้ใช้ได้โดยไม่ต้องจัดการหรือจัดเก็บข้อมูลการเข้าสู่ระบบของผู้ใช้

หากคุณยังไม่เคยใช้ Google API มาก่อน คุณสามารถใช้ oauth2l หรือ OAuth 2.0 Playground เพื่อทดสอบข้อมูลเข้าสู่ระบบแอปพลิเคชันและ 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 ในส่วนหัว HTTP Authorization ของการเรียก API ไปยัง Search Ads 360 Reporting API ทุกครั้ง

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

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

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

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