במדריכים למתחילים מוסבר איך מגדירים ומפעילים אפליקציה שמפעילה קריאה ל-Google Workspace API.
המדריכים למתחילים של Google Workspace משתמשים בספריות הלקוח של ה-API כדי לטפל פרטים על תהליך האימות וההרשאה. מומלץ להשתמש בספריות הלקוח עבור האפליקציות שלכם. המדריך למתחילים הזה משתמש גישת אימות פשוטה שמתאימה לבדיקות הסביבה. בסביבת ייצור, מומלץ ללמוד על אימות והרשאה לפני בחירת פרטי הכניסה שמתאימים לאפליקציה שלכם.
יצירת אפליקציית שורת פקודה ב-Python ששולחת בקשות ל-Google Apps Script API.
מטרות
- מגדירים את הסביבה.
- מתקינים את ספריית הלקוח.
- הגדרת הדוגמה.
- מריצים את הדוגמה.
דרישות מוקדמות
כדי להפעיל את המדריך למתחילים הזה, צריך לעמוד בדרישות המוקדמות הבאות:
- Python 3.10.7 ומעלה
- תמונה של PIP כלי לניהול חבילות
- פרויקט של Google Cloud.
- חשבון Google שבו Google Drive מופעל.
הגדרת הסביבה
כדי להשלים את המדריך למתחילים הזה, עליכם להגדיר את הסביבה.
הפעלת ה-API
לפני שמשתמשים ב-Google APIs, צריך להפעיל אותם בפרויקט ב-Google Cloud. אפשר להפעיל ממשק API אחד או יותר בפרויקט אחד ב-Google Cloud.במסוף Google Cloud, מפעילים את Google Apps Script API.
הגדרת מסך ההסכמה של OAuth
אם אתם משתמשים בפרויקט חדש ב-Google Cloud כדי להשלים את המדריך למתחילים הזה, צריך להגדיר במסך ההסכמה ל-OAuth ולהוסיף את עצמכם כמשתמש/ת בדיקה. אם כבר סיימתם את השלב הזה בפרויקט שלכם ב-Cloud, דלגו לחלק הבא.
- במסוף Google Cloud, עוברים לתפריט > APIs & Services > OAuth consent screen.
- בקטע User type בוחרים באפשרות Internal ולוחצים על Create.
- ממלאים את טופס הרישום של האפליקציה ולוחצים על שמירה והמשך.
בשלב הזה אפשר לדלג על הוספת היקפי הרשאות וללחוץ על שמירה והמשך. בעתיד, כשיוצרים אפליקציה לשימוש מחוץ לארגון ב-Google Workspace, צריך לשנות את סוג המשתמש ל-חיצוני, ואז להוסיף את היקפי ההרשאה הנדרשים לאפליקציה.
- בודקים את סיכום רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם האפליקציה נראה שהרישום תקין, לוחצים על חזרה למרכז הבקרה.
אישור פרטי כניסה לאפליקציה בשולחן העבודה
כדי לאמת משתמשי קצה ולגשת לנתוני המשתמשים באפליקציה: ליצור מזהה לקוח אחד או יותר של OAuth 2.0. מזהה לקוח משמש לזיהוי אפליקציה יחידה לשרתי OAuth של Google. אם האפליקציה שלכם פועלת בכמה פלטפורמות, צריך ליצור מזהה לקוח נפרד לכל פלטפורמה.- במסוף Google Cloud, עוברים לתפריט > APIs & Services > Credentials.
- לוחצים על Create Credentials > OAuth client ID.
- לוחצים על סוג אפליקציה > אפליקציית מחשב.
- בשדה Name, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף 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 Apps Script API.
פרטי ההרשאות מאוחסנים במערכת הקבצים, לכן בפעם הבאה שמריצים את הדוגמה לא תופיע בקשה להרשאה.
השלבים הבאים
- מסמכי עזרה בנושא Apps Script API
- מסמכי תיעוד של לקוח Google APIs ל-Python
- מסמכי תיעוד בנושא PyDoc של Google Apps Script