พื้นหลัง

ก่อนจะเริ่ม

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

บัญชีหลักและบัญชีย่อย

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

บัญชีย่อย

ผู้ใช้ที่มีข้อมูลเข้าสู่ระบบที่ให้สิทธิ์เข้าถึงบัญชีของบุตรหลานจะดูและแก้ไขทรัพยากรที่เชื่อมโยงกับบัญชีของตนได้เท่านั้น บัญชีย่อยจะดูหรือแก้ไขทรัพยากรที่เป็นของบัญชีบุตรหลานหรือบัญชีหลักอื่นๆ ไม่ได้

บัญชีผู้ปกครอง

ผู้ใช้ที่มีข้อมูลเข้าสู่ระบบที่ให้สิทธิ์เข้าถึงบัญชีหลักจะดูและแก้ไขทรัพยากรสำหรับบัญชีหลักได้ นอกเหนือจากบัญชีย่อยที่เกี่ยวข้องทั้งหมด สำหรับการดำเนินการที่แสดงทรัพยากรที่ระบุทั้งหมด ผู้ใช้รายนี้จะได้รับคำตอบ รวมถึงข้อมูลของบัญชีและบัญชีย่อยทั้งหมด โปรดทราบว่าสำหรับคำขอประเภทอื่นๆ ที่กำหนดเป้าหมายทรัพยากรสำหรับ Child Seat บัญชีหลักจะต้องระบุพารามิเตอร์เส้นทาง accountId สำหรับบัญชีย่อย ไม่ใช่ accountId ของตนเอง

หมายเหตุ: คุณควรติดต่อผู้จัดการลูกค้าด้านเทคนิคหากต้องการกำหนดค่าโครงสร้างบัญชีที่มีบัญชีหลักและบัญชีย่อย

โมเดลข้อมูล REST API

ทรัพยากรเป็นเอนทิตีข้อมูลแต่ละรายการที่มีตัวระบุที่ไม่ซ้ำกัน ทรัพยากรบัญชีแสดงถึงรายการบัญชี Authorized Buyers และเป็นคลาสข้อมูลระดับรูทสำหรับ Ad Exchange Buyer API เมธอดของ API จะทำงานใน ทรัพยากรของบัญชีแต่ละรายการ และในคอลเล็กชันของทรัพยากรบัญชี

แหล่งข้อมูลเกี่ยวกับบัญชี ได้แก่ รหัสบัญชี, ข้อมูลที่ใช้ในการจับคู่คุกกี้, ตำแหน่งของผู้เสนอราคา, URL ที่จะส่งคำขอราคาเสนอ และคำขอเพื่อระบุจำนวนคำค้นหาสูงสุดต่อวินาทีที่ Ad Exchange จะส่ง

นอกจากทรัพยากรและการเก็บรวบรวมบัญชีแล้ว Ad Exchange Buyer API ยังกำหนดโครงสร้างข้อมูลต่อไปนี้ด้วย

สถานที่ตั้งของผู้เสนอราคา

สถานที่ตั้งของผู้เสนอราคาเป็นโครงสร้างที่ส่งคืนพร้อมกับทรัพยากรบัญชีเพื่อระบุ URL ที่ Ad Exchange ควรส่งคำขอราคาเสนอ และจำนวนคำค้นหาสูงสุดต่อวินาทีที่ Ad Exchange ควรส่ง ต่อไปนี้คือตัวอย่างตำแหน่งของผู้เสนอราคาที่แสดงใน JSON:

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

รายการ

รายการต่างๆ จะแสดงรายการบัญชี นี่คือตัวอย่างรายการในรูปแบบ JSON:

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

การดำเนินการที่รองรับ

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

การดำเนินการ	คำอธิบาย	การแมป HTTP ของ REST
list	แสดงรายการบัญชีทั้งหมดที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วในปัจจุบันเข้าถึงได้	GET ใน URI ของคอลเล็กชัน
รับ	รับทรัพยากรบัญชีที่เฉพาะเจาะจง	GET บน URI ทรัพยากร
อัปเดต	อัปเดตทรัพยากรบัญชีที่เฉพาะเจาะจง	PUT บน URI ทรัพยากร ซึ่งคุณส่งผ่านข้อมูลสำหรับทรัพยากรที่อัปเดต

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

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 ใน Ad Exchange Buyer API

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

รูปแบบเฉพาะของ API URI ได้แก่

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

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

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

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

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

นี่คือตัวอย่างของวิธีการทำงานใน Ad Exchange Buyer API

เรียกดูรายการบัญชีของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์แล้วดังนี้

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

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

JSON

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