คุณต้องมีทั้งข้อมูลเข้าสู่ระบบแอปพลิเคชัน OAuth 2.0 และโทเค็นของนักพัฒนาซอฟต์แวร์เมื่อเรียกใช้ Google Ads API หากเรียก API ด้วยบัญชีดูแลจัดการ Google Ads คุณต้องระบุส่วนหัว login-customer-id พร้อมกับคำขอแต่ละรายการด้วย หน้านี้จะอธิบายวิธีตั้งค่าเหล่านี้และเอกสารส่วนหัว HTTP เฉพาะ API เพิ่มเติมหลายรายการที่ส่งและรับเมื่อใช้อินเทอร์เฟซ REST
ข้อมูลเข้าสู่ระบบ OAuth 2.0
Google Ads API ใช้ข้อมูลเข้าสู่ระบบของแอปพลิเคชันเพื่อระบุและให้สิทธิ์คําขอ API คุณสามารถกำหนดค่าทั้งไคลเอ็นต์ OAuth 2.0 และบัญชีบริการได้ ดูรายละเอียดเพิ่มเติมเกี่ยวกับการกำหนดค่าการให้สิทธิ์ฝั่งไคลเอ็นต์ได้ที่ OAuth2 ใน Google Ads API
หากคุณเพิ่งเคยใช้ Google APIs คุณสามารถใช้ oauth2l หรือ OAuth 2.0 Playground เพื่อทดสอบข้อมูลเข้าสู่ระบบของแอปพลิเคชันและ Google Ads API ก่อนที่จะเขียนโค้ดสำหรับแอปของคุณ
การใช้ขั้นตอนบนเดสก์ท็อปหรือเว็บแอป
ทำตามขั้นตอนเพื่อกำหนดค่าโปรเจ็กต์คอนโซล Google API สำหรับ Google Ads API บันทึกรหัสไคลเอ็นต์และรหัสลับไคลเอ็นต์ จากนั้นกลับมาที่หน้านี้
เมื่อสร้างไคลเอ็นต์ OAuth แล้ว ให้ทำตามวิธีการใช้แอปบนเดสก์ท็อปหรือวิธีการของเว็บแอปเพื่อสร้างโทเค็นการรีเฟรชและโทเค็นเพื่อการเข้าถึง
การใช้บัญชีบริการ
ทำตามวิธีการทั่วไปในคู่มือบัญชีบริการเพื่อตั้งค่าสิทธิ์เข้าถึงบัญชีบริการสำหรับ Google Ads API
เมื่อตั้งค่าบัญชีบริการเพื่อเข้าถึงบัญชี Google Ads แล้ว ให้ทำตามคำแนะนำการใช้ OAuth 2.0 สำหรับแอปพลิเคชันระหว่างเซิร์ฟเวอร์กับเซิร์ฟเวอร์ โดยอย่าลืมเลือกแท็บ HTTP/REST scope ที่ใช้สำหรับการเข้าถึง Google Ads API คือ https://www.googleapis.com/auth/adwords
การสร้างโทเค็นเพื่อการเข้าถึงใหม่
เมื่อมีรหัสไคลเอ็นต์ รหัสลับไคลเอ็นต์ และโทเค็นการรีเฟรชแล้ว คุณจะสร้างโทเค็นเพื่อการเข้าถึงใหม่เพื่อใช้ในการเรียก 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 ไปยัง Google Ads API ทุกครั้ง
GET /v16/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
ส่วนหัวของคำขอ
โทเค็นของนักพัฒนา
Google Ads API ยังต้องใช้โทเค็นของนักพัฒนาซอฟต์แวร์เพื่อเรียก API ด้วย คุณสามารถขอรับโทเค็นสำหรับบัญชีดูแลจัดการได้โดยตรงจาก UI ของ Google Ads สำหรับรายละเอียดเพิ่มเติมเกี่ยวกับการตั้งค่าด้วยโทเค็นของนักพัฒนา โปรดดูรับโทเค็นของนักพัฒนาของคุณ
คุณต้องใส่ค่าโทเค็นของนักพัฒนาในส่วนหัว HTTP developer-token ของการเรียก API ไปยัง Google Ads API ทุกครั้ง
GET /v16/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
เข้าสู่ระบบรหัสลูกค้า
สำหรับการเรียก Google Ads API ที่ผู้จัดการทำขึ้นไปยังบัญชีลูกค้า (กล่าวคือ เมื่อเข้าสู่ระบบในฐานะผู้จัดการเพื่อเรียก API ไปยังบัญชีลูกค้า) คุณจะต้องระบุส่วนหัว HTTP ของ login-customer-id ด้วย ค่านี้แสดงรหัสลูกค้า Google Ads ของผู้จัดการที่เรียก API
การใส่ส่วนหัวนี้เทียบเท่ากับการเลือกบัญชีใน UI ของ Google Ads หลังจากที่ลงชื่อเข้าใช้หรือคลิกรูปโปรไฟล์ที่มุมขวาบนของหน้า เมื่อระบุรหัสลูกค้า โปรดอย่าลืมนำขีดกลางสั้น (—) ออก เช่น 1234567890 ไม่ใช่ 123-456-7890
GET /v16/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
รหัสลูกค้าที่ลิงก์
ส่วนหัวนี้จะใช้โดยผู้ให้บริการวิเคราะห์แอปบุคคลที่สามเมื่ออัปโหลด Conversion ไปยังบัญชี Google Ads ที่ลิงก์ไว้เท่านั้น ดูรายละเอียดเพิ่มเติมได้ในคู่มือโครงสร้างการเรียก API
...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID
ส่วนหัวการตอบกลับ
ส่วนหัวต่อไปนี้จะแสดงผลในการตอบสนอง HTTP จาก API
รหัสคำขอ
request-id เป็นสตริงที่ระบุคำขอ API แบบไม่ซ้ำ เมื่อแก้ไขข้อบกพร่องหรือปัญหาเกี่ยวกับการเรียก API ที่เจาะจง request-id เป็นตัวระบุสำคัญที่ต้องมีเมื่อติดต่อทีมสนับสนุนนักพัฒนาแอปของ Google
request-id: 2a5Cj89VV7CNhya1DZjjrC