คู่มือเริ่มต้นฉบับย่อจะอธิบายวิธีตั้งค่าและเรียกใช้แอปที่เรียกใช้ Google Workspace API
การเริ่มต้นใช้งาน Google Workspace อย่างรวดเร็วจะใช้ไลบรารีของไคลเอ็นต์ API เพื่อจัดการรายละเอียดบางอย่างเกี่ยวกับขั้นตอนการตรวจสอบสิทธิ์และการให้สิทธิ์ เราขอแนะนำให้คุณใช้ไลบรารีของไคลเอ็นต์สำหรับแอปของคุณเอง การเริ่มต้นอย่างรวดเร็วนี้ใช้วิธีการตรวจสอบสิทธิ์แบบง่ายซึ่งเหมาะสมกับสภาพแวดล้อมการทดสอบ สำหรับสภาพแวดล้อมการใช้งานจริง เราขอแนะนำให้เรียนรู้เกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ก่อนเลือกข้อมูลเข้าสู่ระบบที่เหมาะสำหรับแอปของคุณ
สร้างแอปพลิเคชันบรรทัดคำสั่ง Python ที่ส่งคำขอไปยัง Google เอกสาร API
วัตถุประสงค์
- ตั้งค่าสภาพแวดล้อมของคุณ
- ติดตั้งไลบรารีของไคลเอ็นต์
- ตั้งค่าตัวอย่าง
- เรียกใช้ตัวอย่าง
สิ่งที่ต้องดำเนินการก่อน
คุณต้องมีข้อกำหนดเบื้องต้นต่อไปนี้เพื่อเรียกใช้การเริ่มต้นอย่างรวดเร็วนี้
- Python 3.10.7 ขึ้นไป
- เครื่องมือจัดการแพ็กเกจ pip
- โปรเจ็กต์ Google Cloud
- บัญชี Google
ตั้งค่าสภาพแวดล้อมของคุณ
ตั้งค่าสภาพแวดล้อมเพื่อให้การเริ่มต้นอย่างรวดเร็วนี้เสร็จสมบูรณ์
เปิดใช้ API
ก่อนใช้ Google APIs คุณต้องเปิดใช้ API เหล่านี้ในโปรเจ็กต์ Google Cloud คุณสามารถเปิด API ได้ตั้งแต่ 1 รายการขึ้นไปในโปรเจ็กต์ Google Cloud เดียวเปิดใช้ Google เอกสาร 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 เท่านั้น
- คลิกสร้าง หน้าจอที่สร้างไคลเอ็นต์ OAuth จะปรากฏขึ้น ซึ่งจะแสดงรหัสไคลเอ็นต์ใหม่และรหัสลับไคลเอ็นต์ของคุณ
- คลิกตกลง ข้อมูลเข้าสู่ระบบที่สร้างขึ้นใหม่จะปรากฏในส่วนรหัสไคลเอ็นต์ OAuth 2.0
- บันทึกไฟล์ JSON ที่ดาวน์โหลดเป็น
credentials.json
และย้ายไฟล์ไปยังไดเรกทอรีที่ใช้งานอยู่
ติดตั้งไลบรารีของไคลเอ็นต์ Google
ติดตั้งไลบรารีของไคลเอ็นต์ Google สำหรับ Python โดยใช้คำสั่งต่อไปนี้
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
กำหนดค่าตัวอย่าง
- สร้างไฟล์ชื่อ
quickstart.py
ในไดเรกทอรีการทำงาน รวมรหัสต่อไปนี้ใน
quickstart.py
:
เรียกใช้ตัวอย่าง
ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างด้วยคำสั่งต่อไปนี้
python3 quickstart.py
-
ครั้งแรกที่เรียกใช้ตัวอย่าง ระบบจะแสดงข้อความให้คุณให้สิทธิ์เข้าถึงดังนี้
- หากยังไม่ได้ลงชื่อเข้าใช้บัญชี Google ให้ลงชื่อเข้าใช้เมื่อได้รับข้อความแจ้ง หากคุณลงชื่อเข้าใช้หลายบัญชี ให้เลือกบัญชีเดียวที่จะใช้สำหรับการให้สิทธิ์
- คลิกยอมรับ
แอปพลิเคชัน Python จะเรียกใช้และเรียก Google เอกสาร API
ข้อมูลการให้สิทธิ์จะเก็บอยู่ในระบบไฟล์ ดังนั้นเมื่อคุณเรียกใช้โค้ดตัวอย่างในครั้งถัดไป คุณจะไม่ได้รับข้อความแจ้งให้ให้สิทธิ์
ขั้นตอนถัดไป
- แก้ปัญหาการตรวจสอบสิทธิ์และการให้สิทธิ์
- เอกสารอ้างอิงสำหรับ Docs API
- เอกสารประกอบเกี่ยวกับไคลเอ็นต์ Google APIs สำหรับ Python
- เอกสารประกอบ PyDoc ของ Google เอกสาร API