יצירת אפליקציה של שורת פקודה ב-Java ששולחת בקשות ל-Google Slides API.
במדריכים אחרים למתחילים מוסבר איך להגדיר ולהריץ אפליקציה שקוראת ל-Google Workspace API. במדריך הנוכחי נשתמש בגישה פשוטה לאימות, שמתאימה לסביבת בדיקה. בסביבת ייצור, אנחנו ממליצים לכם לקרוא על אימות והרשאה לפני שאתם בוחרים את פרטי הגישה שמתאימים לאפליקציה שלכם.
במדריך הזה אנחנו משתמשים ב-API המומלץ של ספריות הלקוח ב-Google Workspace כדי לטפל בחלק מהפרטים של תהליך האימות וההרשאה.
מטרות
- מגדירים את הסביבה.
- מגדירים את הדוגמה.
- מריצים את הדוגמה.
דרישות מוקדמות
- Java מגרסה 11 ואילך.
- Gradle 7.0 ואילך.
- פרויקט ב-Google Cloud.
- חשבון Google.
הגדרת הסביבה
כדי לסיים את המדריך למתחילים הזה, אתם צריכים להגדיר את הסביבה.
מפעילים את ה-API
לפני שאתם משתמשים בממשקי Google API, אם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.במסוף Google Cloud, מפעילים את Google Slides API.
מגדירים את מסך ההסכמה של OAuth
אם אתם משתמשים במדריך הזה בפרויקט חדש ב-Google Cloud, אתם צריכים להגדיר את מסך ההסכמה ל-OAuth. אם כבר ביצעתם את השלב הזה בפרויקט שלכם ב-Cloud, אתם יכולים לדלג לקטע הבא.
- במסוף Google Cloud, עוברים אל תפריט > Google Auth platform > Branding.
- אם כבר הגדרתם את Google Auth platform, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטעים Branding, Audience וData Access. אם מופיעה ההודעה Google Auth platform not configured yet, לוחצים על Get Started:
- בקטע App Information בשדה App name, מזינים שם לאפליקציה.
- בקטע User support email, בוחרים כתובת אימייל לתמיכה שאליה משתמשים יפנו אם יש להם שאלות לגבי ההסכמה שלהם.
- לוחצים על Next.
- בקטע Audience, לוחצים על Internal.
- לוחצים על Next.
- בקטע Contact Information, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
- לוחצים על Next.
- בקטע Finish, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, מסמנים את התיבה I agree to the Google API Services: User Data Policy.
- לוחצים על Continue.
- לוחצים על Create.
- כרגע אתם יכולים לדלג על הוספת היקפי הרשאות. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון שלכם ב-Google Workspace, תצטרכו לשנות את סוג המשתמש ל-External. לאחר מכן מוסיפים את היקפי ההרשאות שהאפליקציה דורשת. למידע נוסף, אפשר לעיין במדריך המלא בנושא הגדרת הסכמה ל-OAuth.
מאשרים את פרטי הכניסה של האפליקציה למחשב
כדי לאמת משתמשי קצה ולגשת לנתוני משתמשים באפליקציה, צריך ליצור מזהה לקוח אחד או יותר ב-OAuth 2.0. מזהה הלקוח משמש לזיהוי של אפליקציה אחת בשרתי OAuth של Google. אם האפליקציה פועלת בכמה פלטפורמות, צריך ליצור מזהה לקוח נפרד לכל פלטפורמה.- במסוף Google Cloud, עוברים אל תפריט > Google Auth platform > Clients.
- לוחצים על Create Client.
- לוחצים על Application type > Desktop app.
- בשדה Name, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.
- לוחצים על Create.
פרטי הכניסה החדשים שנוצרו מופיעים בקטע OAuth 2.0 Client IDs.
- שומרים את קובץ ה-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, תתבקשו להיכנס אליו. אם נכנסתם לכמה חשבונות, בחרו חשבון אחד שבו תרצו להשתמש לצורך הרשאה.
- לוחצים על Accept.
אפליקציית Java שלכם פועלת ומפעילה את Google Slides API.
פרטי ההרשאה מאוחסנים במערכת הקבצים, כך שבפעם הבאה שתריצו את הקוד לדוגמה לא תתבקשו להעניק הרשאה.
השלבים הבאים
- התנסות עם ממשקי Google Workspace API ב-API Explorer
- פתרון בעיות באימות ובהרשאות
- מאמרי העזרה של Slides API
- מאמרי העזרה של Google APIs Client for Java
- מאמרי העזרה של Google Slides API Javadoc