בסוף הדף הזה תוכלו למצוא רשימה של שיטות למשאב הזה.
ייצוגים של משאבים
משאב 'ארגון' מייצג את הקישור בין ספק EMM לארגון ספציפי. ניתן ליצור את הקישור הזה באחת משתי דרכים שונות באמצעות ה-API הזה באופן הבא:
- עבור לקוחות עם דומיין מנוהל של Google, התהליך כרוך בשימוש ב-
Enterprises.enroll
וב-Enterprises.setAccount
(בשילוב עם פריטי מידע שנוצרו בתהליך הפיתוח (Artifact) שהתקבלו ממסוף Admin וממסוף Google API), ונשלחים ל-EMM בתהליך ידני יותר או פחות. - עבור לקוחות של חשבונות Google Play מנוהלים, התהליך כולל שימוש ב-
Enterprises.generateSignupUrl
וב-Enterprises.completeSignup
בשילוב עם ממשק המשתמש של ההרשמה ל-Google Play לארגונים (המנגנון ש-Google מספקת) כדי ליצור את הקישור ללא שלבים ידניים.
{ "kind": "androidenterprise#enterprise", "id": string, "primaryDomain": string, "name": string, "administrator": [ { "email": string } ] }
שם הנכס | תמורה לכסף | תיאור | הערות |
---|---|---|---|
administrator[] |
list |
אדמינים בארגון. ההגדרה הזו נתמכת רק בארגונים שנוצרו באמצעות תהליך EMM. |
|
administrator[].email |
string |
כתובת האימייל של האדמין. | |
id |
string |
המזהה הייחודי של הארגון. |
|
kind |
string |
||
name |
string |
שם הארגון. למשל, 'Example, Inc'. | |
primaryDomain |
string |
הדומיין הראשי של הארגון, למשל example.com. |
שיטות
- acknowledgeNotificationSet
- אישור ההתראות שהתקבלו מ-Enterprises.PullNotificationSet,כדי למנוע מהשיחות הבאות להחזיר את אותן ההתראות.
- completeSignup
- מסיים את תהליך ההרשמה על ידי ציון אסימון ההשלמה ואסימון Enterprise. אין לקרוא לבקשה הזו מספר פעמים לאסימון Enterprise נתון.
- createWebToken
- מחזיר אסימון ייחודי כדי לגשת לממשק משתמש שאפשר להטמיע. כדי ליצור ממשק משתמש באינטרנט, צריך להעביר את האסימון שנוצר אל API ל-JavaScript המנוהל ב-Google Play. כל אסימון יכול לשמש רק להתחלת סשן אחד של ממשק משתמש. למידע נוסף, קראו את התיעוד של JavaScript API.
- לרשום
- רישום ארגון עם ה-EMM שמתקשר.
- generateSignupUrl
- יוצרת כתובת URL להרשמה.
- get
- מאחזר את השם והדומיין של ארגון.
- getServiceAccount
- מחזיר חשבון שירות ופרטי כניסה. אפשר לקשר את חשבון השירות לארגון באמצעות קריאה ל-setAccount. חשבון השירות הוא ייחודי לארגון ול-EMM, והוא יימחק אם הארגון לא יהיה מקושר. פרטי הכניסה מכילים נתונים של מפתח פרטי ולא נשמרים בצד השרת.
אפשר לקרוא לשיטה הזו רק אחרי קריאה ל-Enterprises.Register או Enterprises.CompleteRegister, ולפני Enterprises.SetAccount. בפעמים אחרות היא תחזיר הודעת שגיאה.
הקריאות הבאות אחרי ההפעלה הראשונה ייצרו קבוצה חדשה וייחודית של פרטי כניסה, ויבטלו את התוקף של פרטי הכניסה הקודמים שנוצרו.
אחרי שחשבון השירות מקושר לארגון, אפשר לנהל אותו באמצעות המשאב serviceAccountKeys. - getStoreLayout
- מחזירה את פריסת החנות של הארגון. אם פריסת החנות לא הוגדרה, סוג הפריסה של החנות הוא 'בסיסי', ללא דף בית.
- list
- מחפש ארגון לפי שם דומיין. האפשרות הזו נתמכת רק בארגונים שנוצרו באמצעות תהליך היצירה ביוזמת Google. בארגונים שנוצרו באמצעות תהליך EMM, ה-EMM לא צריך לחפש את המזהה, כי ה-EMM לומד את מזהה הארגון בקריאה החוזרת (callback) שצוינה בקריאה ל-Enterprises.generateRegisterUrl.
- pullNotificationSet
- שולפת ומחזירה התראה שהוגדרה לארגונים שמשויכים לחשבון השירות שאומת לבקשה. אם אין התראות בהמתנה, יכול להיות שקבוצת ההתראות תהיה ריקה.
צריך לאשר קריאה של קבוצת התראות שחוזרת תוך 20 שניות על ידי קריאה ל-Enterprises.AcknowledgeNotificationSet, אלא אם הגדרת ההתראות ריקה.
התראות שלא יאושרו בתוך 20 שניות ייכללו בסופו של דבר שוב בתגובה לבקשת PullNotificationSet אחרת, והודעות שלא יאושרו בסופו של דבר יימחקו בהתאם למדיניות מערכת Pub/Sub של Google Cloud Platform.
ניתן לבצע מספר בקשות בו-זמנית כדי לאחזר התראות, ובמקרה כזה ההתראות הממתינות (אם יש) יפוצלו בין כל מתקשרים, אם יש כאלה.
אם לא מופיעות התראות, תוחזר רשימת התראות ריקה. בעקבות זאת, יכול להיות שהן יחזירו התראות נוספות ברגע שהן יהיו זמינות. - sendTestPushNotification
- נשלחת הודעת בדיקה כדי לאמת את השילוב של EMM עם שירות Google Cloud Pub/Sub בארגון הזה.
- setAccount
- ההגדרה קובעת את החשבון שישמש לאימות ה-API כארגון.
- setStoreLayout
- ההגדרה קובעת את פריסת החנות של הארגון. כברירת מחדל, storeLayoutType מוגדר כ "בסיסי" ופריסת החנות הבסיסית מופעלת. הפריסה הבסיסית מכילה רק אפליקציות שאושרו על ידי האדמין ונוספו לקבוצת המוצרים הזמינה עבור משתמש (באמצעות הקריאה setAvailableProductSet). האפליקציות בדף ממוינות לפי ערך מזהה המוצר שלהן. אם יוצרים פריסת חנות מותאמת אישית (על ידי הגדרת storeLayoutType = "custom" והגדרת דף בית), פריסת החנות הבסיסית מושבתת.
- לבטל הרשמה
- מבטל את ההרשמה של ארגון ל-EMM שמתקשר.