สิ่งที่ต้องดำเนินการก่อน

ก่อนที่คุณจะสามารถเริ่มเขียนโค้ดแอปพลิเคชันไคลเอ็นต์แรกของคุณ มี สิ่งที่คุณต้องทำ หากคุณยังไม่ได้ทำ

สร้างโปรเจ็กต์สำหรับไคลเอ็นต์

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

คุณต้องทำสิ่งต่อไปนี้ก่อนจึงจะเริ่มใช้ Android Over The Air API ได้ ใช้ เครื่องมือตั้งค่า ซึ่งจะแนะนำขั้นตอนการสร้างโปรเจ็กต์ใน คอนโซล Google API, การเปิดใช้ API และการสร้างข้อมูลเข้าสู่ระบบ

เพิ่มโปรเจ็กต์ในรายการที่อนุญาตพิเศษ

Android Over The Air API ใช้ได้กับโปรเจ็กต์ที่ได้รับอนุญาตพิเศษเท่านั้น หากโปรเจ็กต์ไม่อยู่ในรายการที่อนุญาตพิเศษ คุณจะพบข้อผิดพลาด 404 รายการเมื่อพยายามใช้

หากต้องการให้อยู่ในรายการที่อนุญาตพิเศษ โปรดส่งอีเมลถึง TAM ของ Google เพื่อเพิ่มรหัสโปรเจ็กต์ใหม่ในรายการที่อนุญาตพิเศษ

คุณดูรหัสโปรเจ็กต์ได้ใน Cloud แดชบอร์ด ดูข้อมูลเพิ่มเติมได้ในเอกสารช่วยเหลือนี้

โปรดทราบว่ารหัสโปรเจ็กต์ควรอยู่ในรูปแบบ {company}-gota-api-{number}

หลังจากคุณได้รับการอนุญาตพิเศษแล้ว ให้เปิดใช้ Android Over The Air API สำหรับโครงการของคุณ แล้วดู วิธีการการให้สิทธิ์เพื่อดูรายละเอียดการเข้าถึง

โปรดทราบว่ามีเพียงรหัสโปรเจ็กต์ที่คุณระบุเท่านั้นที่จะใช้ Android Over The Air API ได้ พ ขอแนะนำอย่างยิ่งให้สร้างบัญชีบริการ (ตามที่อธิบายไว้ในการให้สิทธิ์) สำหรับการใช้ API แทนการใช้บัญชีส่วนตัวใดๆ

ลองใช้แดชบอร์ด Android ผ่านอากาศ (OTA)

เอกสารประกอบเกี่ยวกับ API นี้จะถือว่าคุณได้ใช้แดชบอร์ด Android Over The Air และคุ้นเคยกับแนวคิดการเขียนโปรแกรมเว็บและรูปแบบข้อมูลเว็บ

หากคุณยังไม่ได้ใช้แดชบอร์ด Android Over The Air ให้ลองอินเทอร์เฟซผู้ใช้ก่อนเริ่มเขียนโค้ด

ดูข้อมูลพื้นฐานเกี่ยวกับ REST

การเรียก API ทำได้ 2 วิธีดังนี้

หากคุณตัดสินใจไม่ใช้ไลบรารีของไคลเอ็นต์ คุณจะต้องทำความเข้าใจพื้นฐานของ REST

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 ใน Android Over The Air API

การดำเนินการของ Android Over The Air API จะแมปกับคำกริยา HTTP ของ REST โดยตรง

รูปแบบเฉพาะของ URI ของ Android Over The Air API มีดังนี้

https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters

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

ดูข้อมูลเบื้องต้นเกี่ยวกับ JSON

Android Over The Air API แสดงข้อมูลในรูปแบบ JSON

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