เบื้องหลัง

ก่อนจะเริ่ม

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

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

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

บัญชีย่อย

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

บัญชีหลัก

ผู้ใช้ที่มีข้อมูลเข้าสู่ระบบซึ่งให้สิทธิ์เข้าถึงบัญชีหลักจะดูได้ และแก้ไขทรัพยากรสำหรับบัญชีหลักนอกเหนือจากที่เกี่ยวข้องทั้งหมด บัญชีย่อย สำหรับการดำเนินการที่แสดงทรัพยากรที่ระบุทั้งหมด ผู้ใช้รายนี้ จะได้รับการตอบกลับรวมถึงข้อมูลสำหรับบัญชีและ บัญชีย่อย โปรดทราบว่าสำหรับคำขอประเภทอื่นๆ ที่กำหนดเป้าหมายเป็นทรัพยากรสำหรับที่นั่งเด็ก บัญชีหลักจะต้องระบุพารามิเตอร์เส้นทาง 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 เป็นคำสั้นๆ ของ "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 ใน Ad Exchange Buyer API

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

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

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