การเริ่มต้นอย่างรวดเร็วอธิบายวิธีตั้งค่าและเรียกใช้แอปที่เรียกใช้ Google Workspace API
การเริ่มต้น Google Workspace อย่างรวดเร็วจะใช้ไลบรารีของไคลเอ็นต์ API ในการจัดการรายละเอียดบางอย่างของขั้นตอนการตรวจสอบสิทธิ์และการให้สิทธิ์ เราขอแนะนำให้คุณใช้ไลบรารีของไคลเอ็นต์สำหรับแอปของคุณเอง การเริ่มต้นอย่างรวดเร็วนี้ใช้วิธีการตรวจสอบสิทธิ์แบบง่ายที่เหมาะสำหรับสภาพแวดล้อมการทดสอบ สำหรับสภาพแวดล้อมของเวอร์ชันที่ใช้งานจริง เราขอแนะนำให้เรียนรู้เกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ก่อนที่จะเลือกข้อมูลเข้าสู่ระบบที่เหมาะสำหรับแอปของคุณ
สร้างเว็บแอปพลิเคชัน JavaScript ที่ส่งคำขอไปยัง Gmail API
วัตถุประสงค์
- ตั้งค่าสภาพแวดล้อมของคุณ
- ตั้งค่าตัวอย่าง
- เรียกใช้ตัวอย่าง
ข้อกำหนดเบื้องต้น
- Node.js และ npm ติดตั้งอยู่
- โปรเจ็กต์ Google Cloud
- บัญชี Google ที่เปิดใช้ Gmail
ตั้งค่าสภาพแวดล้อมของคุณ
หากต้องการทำการเริ่มต้นอย่างรวดเร็วนี้ให้เสร็จสมบูรณ์ ให้ตั้งค่าสภาพแวดล้อมของคุณ
เปิดใช้ API
ก่อนใช้ Google API คุณต้องเปิดใช้งานในโปรเจ็กต์ Google Cloud คุณเปิด API ได้อย่างน้อย 1 รายการในโปรเจ็กต์ Google Cloud โปรเจ็กต์เดียวเปิดใช้ Gmail API ในคอนโซล Google Cloud
กำหนดค่าหน้าจอขอความยินยอม OAuth
หากคุณใช้โปรเจ็กต์ Google Cloud ใหม่เพื่อเริ่มต้นใช้งานอย่างรวดเร็วนี้ให้เสร็จสมบูรณ์ ให้กำหนดค่าหน้าจอขอความยินยอม OAuth และเพิ่มตัวคุณเองเป็นผู้ใช้ทดสอบ หากทำตามขั้นตอนนี้สำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์เรียบร้อยแล้ว ให้ข้ามไปยังส่วนถัดไป
- ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > หน้าจอขอความยินยอม OAuth
- เลือกประเภทผู้ใช้ให้แอป แล้วคลิกสร้าง
- กรอกแบบฟอร์มการลงทะเบียนแอป แล้วคลิกบันทึกและดำเนินการต่อ
สำหรับตอนนี้ คุณสามารถข้ามการเพิ่มขอบเขตแล้วคลิกบันทึกและดำเนินการต่อ ในอนาคต เมื่อคุณสร้างแอปเพื่อใช้ภายนอก องค์กร Google Workspace คุณต้องเพิ่มและยืนยันขอบเขต การให้สิทธิ์ที่แอปของคุณต้องใช้
- หากคุณเลือกภายนอกเป็นประเภทผู้ใช้ ให้เพิ่มผู้ใช้ทดสอบโดยทำดังนี้
- ในส่วนผู้ใช้ทดสอบ ให้คลิกเพิ่มผู้ใช้
- ป้อนอีเมลของคุณและผู้ใช้ทดสอบรายอื่นๆ ที่ได้รับอนุญาต จากนั้นคลิกบันทึกและต่อไป
- ตรวจสอบสรุปการลงทะเบียนแอป หากต้องการเปลี่ยนแปลง ให้คลิกแก้ไข หากการลงทะเบียนแอปเรียบร้อยดี ให้คลิกกลับไปที่หน้าแดชบอร์ด
ให้สิทธิ์ข้อมูลเข้าสู่ระบบสำหรับเว็บแอปพลิเคชัน
หากต้องการตรวจสอบสิทธิ์เป็นผู้ใช้ปลายทางและเข้าถึงข้อมูลผู้ใช้ในแอป คุณต้องสร้างรหัสไคลเอ็นต์ OAuth 2.0 อย่างน้อย 1 รายการ รหัสไคลเอ็นต์ใช้เพื่อระบุแอปเดียวไปยังเซิร์ฟเวอร์ OAuth ของ Google หากแอปทำงานบนหลายแพลตฟอร์ม คุณต้องสร้างรหัสไคลเอ็นต์แยกกันสำหรับแต่ละแพลตฟอร์ม- ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > ข้อมูลเข้าสู่ระบบ
- คลิกสร้างข้อมูลเข้าสู่ระบบ > รหัสไคลเอ็นต์ OAuth
- คลิกประเภทแอปพลิเคชัน > เว็บแอปพลิเคชัน
- ในช่องชื่อ ให้พิมพ์ชื่อของข้อมูลเข้าสู่ระบบ ชื่อนี้จะแสดงเฉพาะในคอนโซล Google Cloud เท่านั้น
- เพิ่ม URI ที่ได้รับอนุญาตซึ่งเกี่ยวข้องกับแอปของคุณ ดังนี้
- แอปฝั่งไคลเอ็นต์ (JavaScript) - คลิกเพิ่ม URI ในส่วนต้นทาง JavaScript ที่ได้รับอนุญาต จากนั้นป้อน URI เพื่อใช้สำหรับคำขอของเบราว์เซอร์ ค่านี้ระบุโดเมนที่แอปพลิเคชันของคุณสามารถส่งคำขอ API ไปยังเซิร์ฟเวอร์ OAuth 2.0
- แอปฝั่งเซิร์ฟเวอร์ (Java, Python และอื่นๆ) - ในส่วน URI การเปลี่ยนเส้นทางที่ได้รับอนุญาต ให้คลิกเพิ่ม URI จากนั้น ป้อน URI ปลายทางที่เซิร์ฟเวอร์ OAuth 2.0 ส่งการตอบกลับได้
- คลิกสร้าง หน้าจอที่ไคลเอ็นต์ OAuth สร้างขึ้นจะปรากฏขึ้น ซึ่งแสดงรหัสไคลเอ็นต์และรหัสลับไคลเอ็นต์ใหม่ของคุณ
จดรหัสไคลเอ็นต์ และจะไม่ใช้รหัสลับไคลเอ็นต์สำหรับเว็บแอปพลิเคชัน
- คลิกตกลง ข้อมูลเข้าสู่ระบบที่สร้างขึ้นใหม่จะปรากฏในส่วนรหัสไคลเอ็นต์ OAuth 2.0
จดข้อมูลเข้าสู่ระบบเหล่านี้ไว้เนื่องจากคุณจำเป็นต้องใช้ในภายหลังในการเริ่มต้นอย่างรวดเร็วนี้
สร้างคีย์ API
- ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > ข้อมูลเข้าสู่ระบบ
- คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
- คีย์ API ใหม่จะปรากฏขึ้น
- คลิกคัดลอก เพื่อคัดลอกคีย์ API เพื่อใช้ในโค้ดของแอป คีย์ API ยังอยู่ในส่วน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์ด้วย
- คลิกจำกัดคีย์เพื่ออัปเดตการตั้งค่าขั้นสูงและจำกัดการใช้คีย์ API ดูรายละเอียดเพิ่มเติมได้ที่การใช้ข้อจํากัดของคีย์ API
ตั้งค่าตัวอย่าง
- ในไดเรกทอรีการทำงาน ให้สร้างไฟล์ชื่อ
index.html
ในไฟล์
index.html
ให้วางโค้ดตัวอย่างต่อไปนี้แทนที่รายการต่อไปนี้
YOUR_CLIENT_ID
: รหัสไคลเอ็นต์ที่คุณสร้างขึ้นเมื่อให้สิทธิ์ข้อมูลเข้าสู่ระบบสำหรับเว็บแอปพลิเคชันYOUR_API_KEY
: คีย์ API ที่คุณสร้างขึ้นเป็นข้อกำหนดเบื้องต้น
เรียกใช้ตัวอย่าง
ติดตั้งแพ็กเกจ http-server ในไดเรกทอรีการทำงาน
npm install http-server
ในไดเรกทอรีทำงาน ให้เริ่มต้นเว็บเซิร์ฟเวอร์
npx http-server -p 8000
ในเบราว์เซอร์ ให้ไปที่
http://localhost:8000
ครั้งแรกที่เรียกใช้ตัวอย่าง ระบบจะเตือนให้คุณอนุญาตการเข้าถึง
- หากคุณยังไม่ได้ลงชื่อเข้าใช้บัญชี Google ของคุณ ระบบจะแจ้งให้คุณลงชื่อเข้าใช้ หากคุณลงชื่อเข้าใช้หลายบัญชี ให้เลือกบัญชีที่จะใช้สำหรับการให้สิทธิ์
- คลิกยอมรับ
- คัดลอกโค้ดจากเบราว์เซอร์ วางลงในข้อความแจ้งบรรทัดคำสั่ง แล้วกด
Enter
ข้อมูลการให้สิทธิ์จะจัดเก็บไว้ในระบบไฟล์ ดังนั้นครั้งต่อไปที่คุณเรียกใช้โค้ดตัวอย่างดังกล่าว คุณจะไม่ได้รับการแจ้งเตือนสำหรับการให้สิทธิ์
คุณได้สร้างแอปพลิเคชัน JavaScript รายการแรกที่ส่งคำขอไปยัง Gmail API เรียบร้อยแล้ว
ขั้นตอนถัดไป
- แก้ปัญหาการตรวจสอบสิทธิ์และการให้สิทธิ์
- เอกสารประกอบอ้างอิงของ Gmail API
- ส่วน
google-api-javascript-client
ของ GitHub