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

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

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

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

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

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

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

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

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

• บัญชี Google ที่เปิดใช้ Google ไดรฟ์

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

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

เปิดใช้ API

ก่อนใช้ Google API คุณต้องเปิดใช้ API ในโปรเจ็กต์ Google Cloud คุณเปิด API อย่างน้อย 1 รายการในโปรเจ็กต์ Google Cloud เดียวได้

• เปิดใช้ Google Apps Script API ในคอนโซล Google Cloud

  เปิดใช้ API

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

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

1. ในคอนโซล Google Cloud ให้ไปที่เมนู menu > > การสร้างแบรนด์

   ไปที่การสร้างแบรนด์

2. หากกำหนดค่า แล้ว คุณจะกำหนดค่าการตั้งค่าหน้าจอขอความยินยอม OAuth ต่อไปนี้ได้ในการสร้างแบรนด์ กลุ่มเป้าหมาย และการเข้าถึงข้อมูล หากเห็นข้อความที่ระบุว่า ยังไม่ได้กำหนดค่า ให้คลิกเริ่มต้นใช้งาน
1. ในส่วนข้อมูลแอป ให้ป้อนชื่อแอปในชื่อแอป
2. ในอีเมลสนับสนุนสำหรับผู้ใช้ ให้เลือกอีเมลสนับสนุนที่ผู้ใช้สามารถติดต่อคุณได้หากมีข้อสงสัยเกี่ยวกับการยินยอม
3. คลิกถัดไป
4. เลือกภายในในส่วนผู้ชม
5. คลิกถัดไป
6. ในส่วนข้อมูลติดต่อ ให้ป้อนอีเมลที่คุณต้องการรับการแจ้งเตือนเกี่ยวกับการเปลี่ยนแปลงในโปรเจ็กต์
7. คลิกถัดไป
8. ในส่วนเสร็จสิ้น ให้อ่านนโยบายข้อมูลผู้ใช้ของบริการ Google API และหากยอมรับ ให้เลือกฉันยอมรับนโยบายข้อมูลผู้ใช้ของบริการ Google API
9. คลิกต่อไป
10. คลิกสร้าง
3. ในตอนนี้ คุณข้ามการเพิ่มขอบเขตได้ ในอนาคต เมื่อสร้างแอปเพื่อใช้ภายนอกองค์กร Google Workspace คุณจะต้องเปลี่ยนประเภทผู้ใช้เป็นภายนอก จากนั้น เพิ่มขอบเขตการให้สิทธิ์ที่แอปของคุณต้องการ ดูข้อมูลเพิ่มเติมได้ที่คู่มือกำหนดค่าความยินยอม OAuth ฉบับเต็ม

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

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

1. ในคอนโซล Google Cloud ให้ไปที่เมนู menu > > ไคลเอ็นต์

   ไปที่ลูกค้า

2. คลิกสร้างไคลเอ็นต์
3. คลิกประเภทแอปพลิเคชัน > แอปเดสก์ท็อป
4. ในช่องชื่อ ให้พิมพ์ชื่อของข้อมูลเข้าสู่ระบบ ชื่อนี้จะแสดงในคอนโซล Google Cloud เท่านั้น
5. คลิกสร้าง

   ข้อมูลเข้าสู่ระบบที่สร้างขึ้นใหม่จะปรากฏในส่วน "รหัสไคลเอ็นต์ OAuth 2.0"

6. บันทึกไฟล์ JSON ที่ดาวน์โหลดเป็น credentials.json แล้วย้ายไฟล์ ไปยังไดเรกทอรีการทำงาน

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

• ติดตั้งไลบรารีของไคลเอ็นต์ Google สำหรับ Python โดยทำดังนี้

  pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib 

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

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

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

   apps_script/quickstart/quickstart.py

   ดูใน GitHub
   """ Shows basic usage of the Apps Script API. Call the Apps Script API to create a new script project, upload a file to the project, and log the script's URL to the user. """ 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 import errors from googleapiclient.discovery import build  # If modifying these scopes, delete the file token.json. SCOPES = ["https://www.googleapis.com/auth/script.projects"]  SAMPLE_CODE = """ function helloWorld() {   console.log("Hello, world!"); } """.strip()  SAMPLE_MANIFEST = """ {   "timeZone": "America/New_York",   "exceptionLogging": "CLOUD" } """.strip()   def main():   """Calls the Apps Script API."""   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("script", "v1", credentials=creds)      # Call the Apps Script API     # Create a new project     request = {"title": "My Script"}     response = service.projects().create(body=request).execute()      # Upload two files to the project     request = {         "files": [             {"name": "hello", "type": "SERVER_JS", "source": SAMPLE_CODE},             {                 "name": "appsscript",                 "type": "JSON",                 "source": SAMPLE_MANIFEST,             },         ]     }     response = (         service.projects()         .updateContent(body=request, scriptId=response["scriptId"])         .execute()     )     print("https://script.google.com/d/" + response["scriptId"] + "/edit")   except errors.HttpError as error:     # The API encountered a problem.     print(error.content)   if __name__ == "__main__":   main()

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

1. ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างโดยทำดังนี้

   python3 quickstart.py 

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

   แอปพลิเคชัน Python ของคุณจะเรียกใช้ Google Apps Script API

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

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

• เอกสารอ้างอิง Apps Script API
• เอกสารประกอบเกี่ยวกับไคลเอ็นต์ Google APIs สำหรับ Python
• เอกสารประกอบ PyDoc ของ Google Apps Script API