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

วิดีโอ: การตรวจสอบสิทธิ์

คุณต้องมีทั้งข้อมูลเข้าสู่ระบบแอปพลิเคชัน 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 /v17/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 /v17/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 /v17/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