Authentication

เอกสารนี้อธิบายวิธีตรวจสอบสิทธิ์กับ Ad Manager API วิธีตรวจสอบสิทธิ์จะขึ้นอยู่กับอินเทอร์เฟซที่คุณใช้และสภาพแวดล้อมที่โค้ดทำงานอยู่ แต่คำขอ API ทั้งหมดต้องมีโทเค็นเพื่อการเข้าถึงที่มีขอบเขต Ad Manager API

ไลบรารีของไคลเอ็นต์ Ad Manager ใช้ ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน เพื่อสร้างโทเค็นเพื่อการเข้าถึงที่มีขอบเขต Ad Manager API คู่มือนี้แสดงวิธีกำหนดค่าข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน

หากไม่ได้ใช้ไลบรารีของไคลเอ็นต์ คุณยังคงต้องสร้างข้อมูลรับรองและใช้ข้อมูลรับรองดังกล่าวเพื่อให้สิทธิ์คำขอ

ดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ได้ที่ คู่มือการใช้ OAuth 2.0

กำหนดประเภทการตรวจสอบสิทธิ์

ประเภทการตรวจสอบสิทธิ์ คำอธิบาย
บัญชีบริการ เลือกตัวเลือกนี้หากต้องการตรวจสอบสิทธิ์เป็นบัญชีเฉพาะแทนที่จะเป็นบุคคลใดบุคคลหนึ่ง
ดูข้อมูลเพิ่มเติม
เว็บแอปพลิเคชัน เลือกตัวเลือกนี้หากต้องการตรวจสอบสิทธิ์เป็นผู้ใช้ที่ให้สิทธิ์แอปพลิเคชันของคุณในการเข้าถึงข้อมูล Ad Manager
ดูข้อมูลเพิ่มเติม
การพัฒนาภายในเครื่อง เลือกตัวเลือกนี้หากต้องการตรวจสอบสิทธิ์เป็นบัญชี Google ของคุณเองหรือบัญชีบริการจากสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ภายในเครื่อง

เปิดใช้ Ad Manager API

  1. เปิดใช้ Ad Manager API ในโปรเจ็กต์ Cloud ของคอนโซล Google API

  2. เมื่อได้รับข้อความเตือน ให้เลือกโปรเจ็กต์หรือสร้างโปรเจ็กต์ใหม่

สร้างข้อมูลรับรอง

คลิกแท็บสำหรับประเภทการตรวจสอบสิทธิ์ แล้วทำตามวิธีการเพื่อสร้างข้อมูลรับรอง

บัญชีบริการ

ใน Google Cloud

หากต้องการตรวจสอบสิทธิ์เวิร์กโหลดที่ทำงานบน Google Cloud คุณต้องใช้ข้อมูลรับรองของบัญชีบริการที่แนบกับทรัพยากรการประมวลผลที่โค้ดทำงานอยู่

ตัวอย่างเช่น คุณสามารถแนบบัญชีบริการกับอินสแตนซ์เครื่องเสมือน (VM) ของ Compute Engine, บริการ Cloud Run หรือ Dataflow Job วิธีนี้เป็นวิธีการตรวจสอบสิทธิ์ที่แนะนำสำหรับโค้ดที่ทำงานบนทรัพยากรการประมวลผลของ Google Cloud

ดูข้อมูลเกี่ยวกับทรัพยากรที่คุณแนบบัญชีบริการได้ รวมถึงความช่วยเหลือในการแนบบัญชีบริการกับทรัพยากรได้ที่ เอกสารประกอบเกี่ยวกับการแนบบัญชีบริการ

ภายในองค์กรหรือในผู้ให้บริการคลาวด์รายอื่น

วิธีที่แนะนำในการตั้งค่าการตรวจสอบสิทธิ์จากภายนอก Google Cloud คือ การใช้ Workload Identity Federation โดยคุณจะสร้าง ไฟล์การกำหนดค่าข้อมูลรับรองและตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS ให้ชี้ไปยังไฟล์ดังกล่าว วิธีนี้ปลอดภัยกว่าการสร้างคีย์บัญชีบริการ

หากกำหนดค่า Workload Identity Federation ไม่ได้ คุณต้องสร้างบัญชีบริการและสร้างคีย์สำหรับบัญชีบริการโดยทำดังนี้

  1. เปิดหน้าข้อมูลเข้าสู่ระบบของคอนโซล Google API

  2. ในหน้าข้อมูลเข้าสู่ระบบ ให้เลือกสร้างข้อมูลเข้าสู่ระบบ แล้ว เลือก บัญชีบริการ

  3. คลิกอีเมลของบัญชีบริการที่ต้องการสร้างคีย์

  4. คลิกแท็บคีย์

  5. คลิกเมนูแบบเลื่อนลงเพิ่มคีย์ แล้วเลือกสร้างคีย์ใหม่

  6. เลือก JSON เป็นประเภทคีย์ แล้วคลิกสร้าง

  7. ตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS เป็นเส้นทางของไฟล์ JSON

Linux หรือ macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

เว็บแอปพลิเคชัน

  1. เปิดหน้าข้อมูลเข้าสู่ระบบของคอนโซล Google API

  2. เมื่อได้รับข้อความเตือน ให้เลือกโปรเจ็กต์ที่คุณเปิดใช้ Ad Manager API

  3. ในหน้าข้อมูลเข้าสู่ระบบ ให้เลือกสร้างข้อมูลเข้าสู่ระบบ แล้ว เลือก รหัสไคลเอ็นต์ OAuth

  4. เลือกประเภทแอปพลิเคชันเว็บแอปพลิเคชัน

  5. กรอกข้อมูลในแบบฟอร์ม แล้วคลิกสร้าง แอปพลิเคชันที่ใช้ภาษาและเฟรมเวิร์ก เช่น PHP, Java, Python, Ruby และ .NET ต้องระบุ URI การเปลี่ยนเส้นทาง ที่ได้รับอนุญาต URI การเปลี่ยนเส้นทางคือปลายทางที่เซิร์ฟเวอร์ OAuth 2.0 ส่งการตอบกลับได้ ปลายทางเหล่านี้ต้องเป็นไปตามกฎการตรวจสอบ ของ Google

  6. หลังจากสร้างข้อมูลรับรองแล้ว ให้ดาวน์โหลดไฟล์ client_secret.json จัดเก็บไฟล์อย่างปลอดภัยในตำแหน่งที่แอปพลิเคชันของคุณเท่านั้นเข้าถึงได้

จากนั้นทำตามขั้นตอนเพื่อรับโทเค็นเพื่อการเข้าถึง OAuth 2.0

การพัฒนาภายในเครื่อง

ตั้งค่าข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน (ADC) ในสภาพแวดล้อมภายในเครื่อง

ติดตั้ง Google Cloud CLI แล้วเริ่มต้นใช้งานโดยเรียกใช้คำสั่งต่อไปนี้

gcloud init

สร้างข้อมูลรับรองการตรวจสอบสิทธิ์ภายในเครื่องสำหรับบัญชี Google และตั้งค่ารหัสโปรเจ็กต์เป็นโปรเจ็กต์ที่เปิดใช้ Ad Manager API

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

หรือตรวจสอบสิทธิ์เป็นบัญชีบริการโดยตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS เป็นเส้นทางของไฟล์คีย์

Linux หรือ macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

กำหนดค่าเครือข่าย Ad Manager

บัญชีบริการ

  1. ไปที่เครือข่าย Ad Manager
  2. คลิกแท็บผู้ดูแลระบบ
  3. ตรวจสอบว่าได้เปิดใช้การเข้าถึง API แล้ว
  4. คลิกปุ่มเพิ่มผู้ใช้บัญชีบริการ
  5. กรอกข้อมูลในแบบฟอร์มโดยใช้อีเมลของบัญชีบริการ ต้องเพิ่มผู้ใช้บัญชีบริการลงในบทบาทและทีมที่เหมาะสมสำหรับการผสานรวม API
  6. คลิกปุ่มบันทึก ข้อความควรปรากฏขึ้นเพื่อยืนยันการเพิ่มบัญชีบริการ
  7. ดูผู้ใช้บัญชีบริการที่มีอยู่โดยไปที่แท็บผู้ใช้ แล้วคลิกตัวกรองบัญชีบริการ

เว็บแอปพลิเคชัน

  1. ไปที่เครือข่าย Ad Manager
  2. คลิกแท็บผู้ดูแลระบบ
  3. ตรวจสอบว่าได้เปิดใช้การเข้าถึง API แล้ว

การพัฒนาภายในเครื่อง

  1. ไปที่เครือข่าย Ad Manager
  2. คลิกแท็บผู้ดูแลระบบ
  3. ตรวจสอบว่าได้เปิดใช้การเข้าถึง API แล้ว

หากไม่ได้ใช้ไลบรารีของไคลเอ็นต์

หากไม่ได้ใช้ไลบรารีของไคลเอ็นต์ เรายังคงขอแนะนำให้ใช้ไลบรารี OAuth2 สำหรับการตรวจสอบสิทธิ์

ดูวิธีการโดยละเอียดในการรับโทเค็นเพื่อการเข้าถึงได้ที่หัวข้อ การใช้ OAuth2 กับ Google APIs

โทเค็นเพื่อการเข้าถึง

ใส่โทเค็นเพื่อการเข้าถึงในคำขอไปยัง API โดยใส่พารามิเตอร์การค้นหา access_token หรือค่า Bearer ของส่วนหัว HTTP Authorization หากเป็นไปได้ เราขอแนะนำให้ใช้ส่วนหัว HTTP เนื่องจากสตริงการค้นหามักจะปรากฏในบันทึกของเซิร์ฟเวอร์

ตัวอย่างเช่น

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX

GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

ขอบเขต

โทเค็นเพื่อการเข้าถึงแต่ละรายการจะเชื่อมโยงกับขอบเขตอย่างน้อย 1 รายการ ขอบเขตจะควบคุมชุดทรัพยากรและการดำเนินการที่โทเค็นเพื่อการเข้าถึงอนุญาต Ad Manager API มีขอบเขต 2 รายการ เราขอแนะนำให้ใช้ขอบเขต admanager.readonly ที่แคบกว่า หากแอปพลิเคชันไม่จำเป็นต้องเขียนข้อมูล

ขอบเขต สิทธิ์
https://www.googleapis.com/auth/admanager ดูและจัดการแคมเปญใน Google Ad Manager
https://www.googleapis.com/auth/admanager.readonly ดูแคมเปญและข้อมูลใน Google Ad Manager