רשימה של ה-methods במשאב הזה מופיעה בסוף הדף.
ייצוגי משאבים
משאב Enterprise מייצג את הקישור בין EMM לבין ארגון ספציפי. אפשר ליצור את הקישור הזה באחת משתי דרכים שונות באמצעות ה-API הזה:
- עבור לקוחות דומיינים שמנוהלים על ידי Google, התהליך כולל שימוש ב-
Enterprises.enroll
וב-Enterprises.setAccount
(בשילוב עם ארטיפקטים שהתקבלו ממסוף 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 נתון אסימון.
- createWebToken
- מחזירה אסימון ייחודי כדי לגשת לממשק משתמש שניתן להטמעה. כדי ליצור ממשק משתמש באינטרנט, מעבירים את האסימון שנוצר ל-JavaScript של Google Play לארגונים API. ניתן להשתמש בכל אסימון רק כדי להתחיל סשן אחד בממשק המשתמש. לצפייה מסמכי תיעוד בנושא JavaScript API לקבלת מידע נוסף.
- הרשמה
- רישום ארגון עם ה-EMM להתקשרות.
- generateSignupUrl
- יוצרת כתובת URL להרשמה.
- הורדה
- אחזור השם והדומיין של ארגון.
- getServiceAccount
- מחזירה חשבון שירות ופרטי כניסה. חשבון השירות
ניתן לקשר לארגון על ידי קריאה ל-setAccount. חשבון השירות
הוא ייחודי לארגון ול-EMM, והוא יימחק אם
בלתי מוגבלת. פרטי הכניסה מכילים נתונים של מפתח פרטי ולא נשמרים
בצד השרת.
אפשר לקרוא לשיטה הזו רק אחרי השיחה Enterprises.enroll או Enterprises.CompleteSignup ולפני Enterprises.SetAccount; במקרים אחרים הוא יחזיר הודעת שגיאה.
הקריאות הבאות שיבוצעו לאחר הקריאה הראשונה ייצרו קבוצה חדשה וייחודית של פרטי הכניסה, ומבטלים את התוקף של פרטי הכניסה שנוצרו קודם לכן.
אחרי שמקשרים את חשבון השירות לארגון, אפשר לנהל אותו באמצעות המשאב serviceAccountKeys. - getStoreLayout
- מחזירה את פריסת החנות של הארגון. אם הפריסה של החנות לא מוגדר, מחזיר 'בסיסי' בתור סוג הפריסה של החנות, דף הבית.
- list
- חיפוש ארגון לפי שם דומיין. האפשרות הזו נתמכת רק עבור ארגונים שנוצרו באמצעות בתהליך היצירה. אין צורך לחפש את המזהה בארגונים שנוצרו דרך ביוזמת ה-EMM, כי ה-EMM לומד את מזהה הארגון הקריאה החוזרת שצוינה בקריאה Enterprises.generateSignupUrl.
- pullNotificationSet
- שולפת ומחזירה התראה שהוגדרה לארגונים שמשויכים אל
חשבון השירות שאומת בשביל הבקשה. קבוצת ההתראות עשויה
ריקה אם אין התראות בהמתנה.
אם הוגדרה התראה, צריך לאשר אותה תוך 20 שניות באמצעות קריאה ל-Enterprises.AcknowledgeNotificationSet, אלא אם קבוצת ההתראות ריקה.
התראות שלא יאושרו תוך 20 שניות: ייכללו שוב בסופו של דבר בתגובה ל-PullNotificationSet אחר בקשות שלא מאושרות, יימחקו בסופו של דבר בהתאם למדיניות המערכת של Google Cloud Platform Pub/Sub.
ייתכן לבצע מספר בקשות בו-זמנית כדי לאחזר התראות, ובמקרה כזה ההתראות בהמתנה (אם יש) מפוצלים בין כל מתקשרים, אם יש כאלה.
אם לא קיימות התראות, תוחזר רשימת התראות ריקה. הבקשות הבאות עשויות להחזיר התראות נוספות ברגע שהן זמינים. - sendTestPushNotification
- שולחת הודעת בדיקה כדי לאמת את שילוב ה-EMM עם שירות Google Cloud Pub/Sub לארגון הזה.
- setAccount
- מגדירים את החשבון שישמש לאימות ה-API בתור של הארגון.
- setStoreLayout
- הגדרת פריסת החנות בארגון. כברירת מחדל, storeLayoutType מוגדר כ'בסיסי' ופריסת החנות הבסיסית מופעלת. התוכנית הבסיסית הפריסה כוללת רק אפליקציות שאושרו על ידי האדמין, ושיש להן נוסף לקבוצת המוצרים הזמינה למשתמש (באמצעות הקריאה setAvailableProductSet). האפליקציות בדף ממוינות לפי סדר את ערך מזהה המוצר שלהם. אם יוצרים פריסת חנות מותאמת אישית (על ידי הגדרה storeLayoutType = "custom" והגדרת דף בית), החנות הבסיסית הפריסה מושבתת.
- ביטול הרשמה
- ביטול ההרשמה של ארגון מסוים ל-EMM להתקשרות.