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 ในโปรเจ็กต์ Google Cloud ของคอนโซล Google API

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

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

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

บัญชีบริการ

บน Google Cloud

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

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

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

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

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

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

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

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