ส่งคำขอโดยตรง

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

รูปแบบการโทร

REST คือรูปแบบของสถาปัตยกรรมซอฟต์แวร์ที่ให้แนวทางที่สะดวกและสอดคล้องกันในการส่งคำขอและแก้ไขข้อมูล

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

ในระบบ RESTful ทรัพยากรจะเก็บอยู่ในพื้นที่เก็บข้อมูล โดยไคลเอ็นต์จะส่งคำขอให้เซิร์ฟเวอร์ดำเนินการบางอย่าง (เช่น สร้าง เรียก อัปเดต หรือลบทรัพยากร) และเซิร์ฟเวอร์จะดำเนินการและส่งการตอบกลับ ซึ่งมักจะอยู่ในรูปแบบการนำเสนอทรัพยากรที่ระบุ

ใน RESTful API ของ Google ไคลเอ็นต์จะระบุการดำเนินการโดยใช้กริยา HTTP เช่น POST, GET, PUT หรือ DELETE โดยระบุแหล่งข้อมูลตาม URI ที่ไม่ซ้ำกันทั่วโลกในรูปแบบต่อไปนี้

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

เนื่องจากทรัพยากร API ทั้งหมดมี URI ที่เข้าถึงได้ด้วย HTTP ไม่ซ้ำกัน REST จึงเปิดใช้การแคชข้อมูลและมีการเพิ่มประสิทธิภาพให้ทำงานกับโครงสร้างพื้นฐานแบบกระจายของเว็บ

คุณอาจพบว่าคำจำกัดความของเมธอดในเอกสารมาตรฐาน HTTP 1.1 มีประโยชน์ ซึ่งมีข้อกำหนดสำหรับ GET, POST, PUT และ DELETE อยู่ด้วย

REST ใน AdSense Management API

การดำเนินการที่รองรับจะแมปกับคำกริยา HTTP ของ REST โดยตรงตามที่อธิบายไว้ในการทำงานของ AdSense Management API

รูปแบบเฉพาะสำหรับ URI ของ AdSense Management API ได้แก่

https://adsense.googleapis.com/v2/resourceID?parameters

โดย resourceID คือตัวระบุของไคลเอ็นต์โฆษณา, หน่วยโฆษณา, แชแนล URL, แชแนลที่กำหนดเอง หรือคอลเล็กชันรายงาน และ parameters คือพารามิเตอร์ใดๆ ที่จะใช้กับการค้นหา

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

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

ชุด URI ทั้งหมดที่ใช้กับการดำเนินการที่รองรับแต่ละรายการใน API มีการสรุปไว้ในเอกสารเอกสารอ้างอิง API การจัดการ AdSense

ตัวอย่างบางส่วนของวิธีการทำงานใน AdSense Management API มีดังนี้

แสดงรายชื่อลูกค้าโฆษณา:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

แสดงรายการหน่วยโฆษณาในไคลเอ็นต์โฆษณา ca-pub-1234567890123456 ดังนี้

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

รูปแบบข้อมูล

JSON (JavaScript Object Notation) เป็นรูปแบบข้อมูลทั่วไปที่ไม่ขึ้นอยู่กับภาษาซึ่งแสดงโครงสร้างข้อมูลที่กำหนดเองในรูปแบบข้อความธรรมดา สำหรับข้อมูลเพิ่มเติม โปรดดู json.org

การอนุญาตคำขอ

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

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

เกี่ยวกับโปรโตคอลการให้สิทธิ์

แอปพลิเคชันต้องใช้ OAuth 2.0 เพื่อให้สิทธิ์คำขอ ระบบไม่รองรับโปรโตคอลการให้สิทธิ์อื่นๆ หากแอปพลิเคชันใช้ลงชื่อเข้าใช้ด้วย Google ระบบจะจัดการการให้สิทธิ์บางส่วนแก่คุณ

การให้สิทธิ์คำขอด้วย OAuth 2.0

คำขอทั้งหมดที่ส่งไปยัง AdSense Management API จะต้องได้รับอนุญาตจากผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

ทำขั้นตอนนี้ด้วยรหัสไคลเอ็นต์ OAuth

รับรหัสไคลเอ็นต์ OAuth

หรือสร้างไว้ในหน้าข้อมูลเข้าสู่ระบบ

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

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

บางกระบวนการจะมีขั้นตอนเพิ่มเติม เช่น การใช้โทเค็นการรีเฟรชเพื่อขอโทเค็นเพื่อการเข้าถึงใหม่ ดูข้อมูลอย่างละเอียดเกี่ยวกับกระบวนการของแอปพลิเคชันประเภทต่างๆ ได้ที่เอกสารประกอบเกี่ยวกับ OAuth 2.0 ของ Google

ข้อมูลขอบเขตของ OAuth 2.0 สำหรับ AdSense Management API มีดังนี้

ขอบเขต ความหมาย
https://www.googleapis.com/auth/adsense สิทธิ์การอ่าน/การเขียนข้อมูล AdSense
https://www.googleapis.com/auth/adsense.readonly สิทธิ์การอ่านอย่างเดียวสำหรับข้อมูล AdSense

หากต้องการขอสิทธิ์โดยใช้ OAuth 2.0 แอปพลิเคชันของคุณต้องมีข้อมูลขอบเขต รวมถึงข้อมูลที่ Google ให้คุณตอนลงทะเบียนแอปพลิเคชัน (เช่น รหัสไคลเอ็นต์และรหัสลับไคลเอ็นต์)

เคล็ดลับ: ไลบรารีของไคลเอ็นต์ Google APIs จัดการขั้นตอนการให้สิทธิ์บางส่วนให้คุณได้ ไลบรารีเหล่านี้พร้อมให้บริการเป็นภาษาโปรแกรมต่างๆ โปรดดูรายละเอียดเพิ่มเติมที่หน้าที่มีไลบรารีและตัวอย่าง

การส่งคำขอ

ขั้นตอนสุดท้ายคือการส่งคำขอ API ดูเอกสารอ้างอิงสำหรับข้อมูลที่เฉพาะเจาะจง