במדריכים למתחילים מוסבר איך מגדירים ומפעילים אפליקציה שמפעילה קריאה ל-Google Workspace API.
במדריכים למתחילים של Google Workspace נעשה שימוש בספריות הלקוח של ה-API כדי לטפל בחלק מהפרטים של תהליך האימות וההרשאה. מומלץ להשתמש בספריות הלקוח באפליקציות שלכם. במדריך למתחילים הזה נעשה שימוש בגישה פשוטה לאימות שמתאימה לסביבת בדיקה. בסביבת ייצור, מומלץ ללמוד על אימות והרשאה לפני שבוחרים את פרטי הכניסה שמתאימים לאפליקציה.
יצירת אפליקציית שורת פקודה ב-Java ששולחת בקשות ל-Google Apps Script API.
מטרות
- מגדירים את הסביבה.
- מגדירים את המדגם.
- מריצים את הדוגמה.
דרישות מוקדמות
- Java מגרסה 1.8 ואילך.
- Gradle מגרסה 7.0 ואילך.
- פרויקט ב-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.
- ממלאים את טופס הרישום של האפליקציה ולוחצים על שמירה והמשך.
בשלב הזה, אפשר לדלג על הוספת היקפי הרשאה וללחוץ על Save and Continue (שמירה והמשך). בעתיד, כשיוצרים אפליקציה לשימוש מחוץ לארגון ב-Google Workspace, צריך לשנות את סוג המשתמש ל-חיצוני, ואז להוסיף את היקפי ההרשאה הנדרשים לאפליקציה.
- בודקים את סיכום רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרשמת האפליקציה נראית תקינה, לוחצים על Back to Dashboard.
מתן הרשאה לפרטי כניסה לאפליקציה למחשב
כדי לאמת משתמשי קצה ולגשת לנתוני המשתמשים באפליקציה, צריך ליצור מזהה לקוח אחד או יותר ב-OAuth 2.0. מזהה לקוח משמש לזיהוי אפליקציה אחת בשרתי OAuth של Google. אם האפליקציה פועלת בכמה פלטפורמות, צריך ליצור מזהה לקוח נפרד לכל פלטפורמה.- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > Credentials.
- לוחצים על Create Credentials (יצירת פרטי כניסה) > OAuth client ID (מזהה לקוח OAuth).
- לוחצים על Application type (סוג האפליקציה) > Desktop app (אפליקציה למחשב).
- בשדה Name, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.
- לוחצים על יצירה. יופיע המסך 'לקוח OAuth נוצר', שבו יוצגו מזהה הלקוח וסוד הלקוח החדשים.
- לוחצים על אישור. פרטי הכניסה שנוצרו מופיעים בקטע מזהי לקוח OAuth 2.0.
- שומרים את קובץ ה-JSON שהורדתם בתור
credentials.json
ומעבירים את הקובץ לספריית העבודה.
הכנת סביבת העבודה
בספריית העבודה, יוצרים מבנה פרויקט חדש:
gradle init --type basic mkdir -p src/main/java src/main/resources
בספרייה
src/main/resources/
, מעתיקים את הקובץcredentials.json
שהורדתם קודם.פותחים את קובץ ברירת המחדל
build.gradle
ומחליפים את התוכן שלו בקוד הבא:
הגדרת הדוגמה
בספרייה
src/main/java/
, יוצרים קובץ Java חדש עם שם שתואם לערךmainClassName
בקובץbuild.gradle
.מוסיפים את הקוד הבא לקובץ ה-Java החדש:
הרצת הדוגמה
מריצים את הדוגמה:
gradle run
-
בפעם הראשונה שתפעילו את הדוגמה, תתבקשו לאשר את הגישה:
- אם עדיין לא נכנסתם לחשבון Google, נכנסים אליו כשמופיעה בקשה לעשות זאת. אם נכנסתם לכמה חשבונות, בוחרים חשבון אחד לצורך ההרשאה.
- לוחצים על אישור.
אפליקציית Java פועלת ומפעילה את Google Apps Script API.
פרטי ההרשאה מאוחסנים במערכת הקבצים, כך שבפעם הבאה שתפעילו את הקוד לדוגמה לא תתבקשו להעניק הרשאה.
השלבים הבאים
- מסמכי עזרה בנושא Apps Script API
- משאבי עזרה ל-Google APIs Client for Java
- מסמכי תיעוד Javadoc של Google Apps Script API