Authentication

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

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

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

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

ระบุประเภทการตรวจสอบสิทธิ์

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

เปิดใช้ Ad Manager API

  1. เปิดใช้ Ad Manager API ใน โปรเจ็กต์ที่อยู่ในระบบคลาวด์ของคอนโซล Google API

  2. หากมีข้อความแจ้ง ให้เลือกโปรเจ็กต์หรือสร้างโปรเจ็กต์ใหม่

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

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

บัญชีบริการ

บน Google Cloud

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

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

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

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

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

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

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

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

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

  4. คลิกแท็บ Keys

  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 เซิร์ฟเวอร์สามารถส่งการตอบกลับได้ อุปกรณ์ปลายทางเหล่านี้ต้องเป็นไปตาม กฎการตรวจสอบความถูกต้อง

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

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

การพัฒนาในพื้นที่

ตั้งค่า Application Default Credentials (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 API

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

รวมโทเค็นเพื่อการเข้าถึงไว้ในคำขอที่ส่งไปยัง 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 REST API มีเพียง 1 ขอบเขต ควรดำเนินการให้สิทธิ์กับผู้ใช้ ภายในผลิตภัณฑ์

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