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 วิธีนี้ เป็นวิธีการตรวจสอบสิทธิ์ที่แนะนำสำหรับโค้ดที่ทำงานในทรัพยากรการประมวลผลของ Google Cloud

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

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

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

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

  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 หรือค่าส่วนหัว HTTP Authorization Bearer หากเป็นไปได้ ควรใช้ส่วนหัว 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