คู่มือเริ่มต้นใช้งาน Python

สร้างแอปพลิเคชันบรรทัดคำสั่ง Python ที่ส่งคำขอไปยัง Google ปฏิทิน API

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

คู่มือเริ่มต้นใช้งานฉบับย่อนี้ใช้ไลบรารีของไคลเอ็นต์ API ที่ Google Workspace แนะนำเพื่อจัดการรายละเอียดบางอย่างของขั้นตอนการตรวจสอบสิทธิ์และการให้สิทธิ์

วัตถุประสงค์

ตั้งค่าสภาพแวดล้อม
ติดตั้งไลบรารีของไคลเอ็นต์
ตั้งค่าตัวอย่าง
เรียกใช้ตัวอย่าง

ข้อกำหนดเบื้องต้น

คุณต้องมีข้อกำหนดเบื้องต้นต่อไปนี้จึงจะเรียกใช้คู่มือเริ่มต้นใช้งานฉบับย่อนี้ได้

Python 3.10.7 ขึ้นไป
เครื่องมือการจัดการแพ็กเกจ pip
โปรเจ็กต์ Google Cloud

บัญชี Google ที่เปิดใช้ Google ปฏิทิน

ตั้งค่าสภาพแวดล้อม

ตั้งค่าสภาพแวดล้อมให้เสร็จสมบูรณ์ตามคู่มือเริ่มต้นใช้งานฉบับย่อนี้

เปิดใช้ API

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

ในคอนโซล Google Cloud ให้เปิดใช้ Google ปฏิทิน API

เปิดใช้ API

กำหนดค่าหน้าจอขอความยินยอม OAuth

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

ในคอนโซล Google API ให้ไปที่เมนู > แพลตฟอร์มการตรวจสอบสิทธิ์ของ Google > การสร้างแบรนด์
ไปที่การสร้างแบรนด์
หากกำหนดค่าแพลตฟอร์มการตรวจสอบสิทธิ์ของ Google ไว้แล้ว คุณสามารถกำหนดค่าการตั้งค่าหน้าจอขอความยินยอม OAuth ต่อไปนี้ใน การสร้างแบรนด์, กลุ่มเป้าหมาย และ การเข้าถึงข้อมูล หากเห็นข้อความที่ระบุว่า Google Auth platform not configured yet ให้คลิก Get Started ดังนี้

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

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

ให้สิทธิ์ข้อมูลเข้าสู่ระบบสำหรับแอปพลิเคชันบนเดสก์ท็อป

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

ในคอนโซล Google API ให้ไปที่เมนู > แพลตฟอร์มการตรวจสอบสิทธิ์ของ Google > ไคลเอ็นต์
ไปที่ไคลเอ็นต์
คลิกสร้างไคลเอ็นต์
คลิกประเภทแอปพลิเคชัน > แอปบนเดสก์ท็อป
พิมพ์ชื่อของข้อมูลเข้าสู่ระบบในช่องชื่อ ชื่อนี้จะแสดงในคอนโซล Google API เท่านั้น
คลิกสร้าง
ข้อมูลเข้าสู่ระบบที่สร้างขึ้นใหม่จะปรากฏในส่วน "รหัสไคลเอ็นต์ OAuth 2.0"
บันทึกไฟล์ JSON ที่ดาวน์โหลดเป็น credentials.json แล้วย้ายไฟล์ไปยังไดเรกทอรีงาน

ติดตั้งไลบรารีของไคลเอ็นต์ Google

ติดตั้งไลบรารีของไคลเอ็นต์ Google สำหรับ Python ดังนี้
```
python3 -m pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
```

กำหนดค่าตัวอย่าง

สร้างไฟล์ชื่อ quickstart.py ในไดเรกทอรีงาน

ใส่โค้ดต่อไปนี้ใน quickstart.py

calendar/quickstart/quickstart.py

ดูใน GitHub

import datetime
import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# If modifying these scopes, delete the file token.json.
SCOPES = ["https://www.googleapis.com/auth/calendar.readonly"]


def main():
  """Shows basic usage of the Google Calendar API.
  Prints the start and name of the next 10 events on the user's calendar.
  """
  creds = None
  # The file token.json stores the user's access and refresh tokens, and is
  # created automatically when the authorization flow completes for the first
  # time.
  if os.path.exists("token.json"):
    creds = Credentials.from_authorized_user_file("token.json", SCOPES)
  # If there are no (valid) credentials available, let the user log in.
  if not creds or not creds.valid:
    if creds and creds.expired and creds.refresh_token:
      creds.refresh(Request())
    else:
      flow = InstalledAppFlow.from_client_secrets_file(
          "credentials.json", SCOPES
      )
      creds = flow.run_local_server(port=0)
    # Save the credentials for the next run
    with open("token.json", "w") as token:
      token.write(creds.to_json())

  try:
    service = build("calendar", "v3", credentials=creds)

    # Call the Calendar API
    now = datetime.datetime.now(tz=datetime.timezone.utc).isoformat()
    print("Getting the upcoming 10 events")
    events_result = (
        service.events()
        .list(
            calendarId="primary",
            timeMin=now,
            maxResults=10,
            singleEvents=True,
            orderBy="startTime",
        )
        .execute()
    )
    events = events_result.get("items", [])

    if not events:
      print("No upcoming events found.")
      return

    # Prints the start and name of the next 10 events
    for event in events:
      start = event["start"].get("dateTime", event["start"].get("date"))
      print(start, event["summary"])

  except HttpError as error:
    print(f"An error occurred: {error}")


if __name__ == "__main__":
  main()

เรียกใช้ตัวอย่าง

สร้างและเรียกใช้ตัวอย่างในไดเรกทอรีงานของคุณดังนี้
```
python3 quickstart.py
```

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

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

ขั้นตอนถัดไป

ลองใช้ Google Workspace API ในโปรแกรมสำรวจ APIs