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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

การเรียก API มี 2 วิธี ได้แก่

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

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

การดำเนินการของ 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