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

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

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

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

คำว่า REST เป็นคำสั้นๆ ของ "Sentational State Transfer" ในบริบทของ Google APIs หมายถึงการใช้คำกริยา 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 2.0 จะแตกต่างกันไปโดยขึ้นอยู่กับประเภทของแอปพลิเคชันที่คุณเขียน แอปพลิเคชันทุกประเภทจะใช้กระบวนการทั่วไปต่อไปนี้

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

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

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

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

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

การส่งคำขอ

ขั้นตอนสุดท้ายคือการสร้างคำขอ API โปรดดู เอกสารอ้างอิงสำหรับ