רשימה של שיטות שקשורות למשאב הזה מופיעה בסוף הדף הזה.
ייצוגים של משאבים
משאב Enterprises מייצג את הקישור בין EMM לבין ארגון ספציפי. אפשר ליצור מופע של הקישור הזה בשתי דרכים שונות באמצעות ה-API הזה, באופן הבא:
- עבור לקוחות עם דומיין מנוהל של Google, התהליך כולל שימוש ב-
Enterprises.enroll
וב-Enterprises.setAccount
(בצירוף ארטיפקטים שמתקבלים ממסוף Admin ומ-Google API Console) והגשה ל-EMM באמצעות תהליך ידני פחות או יותר. - ללקוחות עם חשבונות Google Play מנוהלים, התהליך כולל שימוש ב-
Enterprises.generateSignupUrl
וב-Enterprises.completeSignup
בשילוב עם ממשק המשתמש של ההרשמה ל-Google Play מנוהל (מנגנון שסופק על ידי Google) כדי ליצור את הקישור בלי לבצע שלבים ידניים.
{ "kind": "androidenterprise#enterprise", "id": string, "primaryDomain": string, "name": string, "administrator": [ { "email": string } ], "googleAuthenticationSettings": { "googleAuthenticationRequired": string, "dedicatedDevicesAllowed": string, "createdAt": { "seconds": long, "nanos": integer }, "updatedAt": { "seconds": long, "nanos": integer } }, "enterpriseType": string, "managedGoogleDomainType": string }
שם הנכס | ערך | תיאור | הערות |
---|---|---|---|
administrator[] |
list |
אדמינים של הארגון. האפשרות הזו נתמכת רק בארגונים שנוצרו באמצעות התהליך שמתחיל ב-EMM. |
|
administrator[].email |
string |
כתובת האימייל של האדמין. | |
enterpriseType |
string |
סוג הארגון.
הערכים הקבילים הם:
|
|
googleAuthenticationSettings |
nested object |
הגדרות לאימות משתמשים שסופק על ידי Google. | |
googleAuthenticationSettings.createdAt |
nested object |
חותמת זמן של מועד היצירה או השינוי הראשון של ההגדרות. | |
googleAuthenticationSettings.createdAt.nanos |
integer |
שבריר שניות לא שלילי ברזולוציית ננו-שנייה. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שסופרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל. | |
googleAuthenticationSettings.createdAt.seconds |
long |
מייצגת את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ב-1970-01-01T00:00:00Z. הערך צריך להיות בין 0001-01-01T00:00:00Z לבין 9999-12-31T23:59:59Z, כולל. | |
googleAuthenticationSettings.dedicatedDevicesAllowed |
string |
האם מותרים מכשירים ייעודיים.
הערכים הקבילים הם:
|
|
googleAuthenticationSettings.googleAuthenticationRequired |
string |
האם נדרש אימות של Google.
הערכים הקבילים הם:
|
|
googleAuthenticationSettings.updatedAt |
nested object |
חותמת זמן של מועד השינוי האחרון של ההגדרות. | |
googleAuthenticationSettings.updatedAt.nanos |
integer |
שבריר שניות לא שלילי ברזולוציית ננו-שנייה. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שסופרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל. | |
googleAuthenticationSettings.updatedAt.seconds |
long |
מייצגת את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ב-1970-01-01T00:00:00Z. הערך צריך להיות בין 0001-01-01T00:00:00Z לבין 9999-12-31T23:59:59Z, כולל. | |
id |
string |
המזהה הייחודי של הארגון. |
|
id |
string |
המזהה הייחודי של הארגון. |
|
kind |
string |
||
managedGoogleDomainType |
string |
סוג הדומיין המנוהל של Google
הערכים הקבילים הם:
|
|
name |
string |
שם הארגון, לדוגמה, "Example, Inc". | |
primaryDomain |
string |
הדומיין הראשי של הארגון, כמו example.com. |
Methods
- acknowledgeNotificationSet
- Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
- completeSignup
- משלים את תהליך ההרשמה על ידי ציון של Completion token ו-Enterprise token. אסור לקרוא לבקשה הזו כמה פעמים עבור אסימון Enterprise נתון.
- createWebToken
- Returns a unique token to access an embeddable UI. כדי ליצור ממשק משתמש באינטרנט, מעבירים את הטוקן שנוצר אל ה-API של JavaScript ב-Google Play לארגונים. כל טוקן יכול לשמש רק להתחלת סשן אחד בממשק המשתמש. מידע נוסף זמין ב מאמרי העזרה של JavaScript API.
- הרשמה
- רישום ארגון לספק EMM לשיחות.
- generateEnterpriseUpgradeUrl
- יצירת כתובת URL לשדרוג הארגון כדי לשדרג קבוצת חשבונות קיימת של Google Play לארגונים לדומיין מנוהל ב-Google. פרטים נוספים זמינים במדריך לשדרוג מהדורות Enterprise.
- generateSignupUrl
- המערכת יוצרת כתובת URL להרשמה.
- get
- שליפת השם והדומיין של ארגון.
- getServiceAccount
- מחזירה חשבון שירות ופרטי כניסה. אפשר לקשר את חשבון השירות לארגון באמצעות הקריאה ל-setAccount. חשבון השירות ייחודי לארגון ול-EMM הזה, והוא יימחק אם הארגון יבוטל. האישורים מכילים נתונים של מפתח פרטי ולא מאוחסנים בצד השרת.
אפשר להפעיל את ה-method הזה רק אחרי שמפעילים את Enterprises.Enroll או את Enterprises.CompleteSignup, ולפני שמפעילים את Enterprises.SetAccount. בכל זמן אחר תוחזר שגיאה.
קריאות עוקבות אחרי הראשונה ייצרו קבוצה חדשה וייחודית של פרטי כניסה, ויבטלו את פרטי הכניסה שנוצרו קודם.
אחרי שחשבון השירות מקושר לארגון, אפשר לנהל אותו באמצעות המשאב serviceAccountKeys.
. - getStoreLayout
- מחזירה את פריסת החנות לארגון. אם לא הוגדר פריסת החנות, הפונקציה מחזירה את הערך 'basic' כסוג פריסת החנות, ולא מחזירה דף בית.
- list
- Lookup an enterprise by domain name. האפשרות הזו נתמכת רק בארגונים שנוצרו באמצעות תהליך היצירה שמתחיל ב-Google. אין צורך בחיפוש של המזהה עבור ארגונים שנוצרו באמצעות התהליך שמתחיל ב-EMM, כי ה-EMM מקבל את מזהה הארגון בקריאה החוזרת שצוינה בקריאה Enterprises.generateSignupUrl.
- pullNotificationSet
- שליפה והחזרה של קבוצת התראות עבור הארגונים שמשויכים לחשבון השירות שאומת עבור הבקשה. יכול להיות שקבוצת ההתראות תהיה ריקה אם אין התראות בהמתנה.
צריך לאשר קבלת התראות שהוחזרו תוך 20 שניות באמצעות קריאה ל-Enterprises.AcknowledgeNotificationSet, אלא אם קבוצת ההתראות ריקה.
התראות שלא אושרו תוך 20 שניות ייכללו בסופו של דבר שוב בתגובה לבקשה אחרת של PullNotificationSet, והתראות שלא אושרו אף פעם יימחקו בסופו של דבר בהתאם למדיניות של מערכת Pub/Sub ב-Google Cloud Platform.
יכול להיות שיתבצעו כמה בקשות בו-זמנית כדי לאחזר התראות. במקרה כזה, ההתראות שממתינות (אם יש כאלה) יפוצלו בין כל הקוראים, אם יש כאלה שממתינות.
אם אין התראות, מוחזרת רשימת התראות ריקה. יכול להיות שבבקשות הבאות יוחזרו יותר התראות כשהן יהיו זמינות. - sendTestPushNotification
- שליחת התראת בדיקה כדי לאמת את השילוב של EMM עם שירות Google Cloud Pub/Sub בארגון הזה.
- setAccount
- Sets the account that will be used to authenticate to the API as the enterprise.
- setStoreLayout
- הגדרת פריסת החנות בארגון. כברירת מחדל, הערך של storeLayoutType מוגדר כ-basic והפריסה הבסיסית של החנות מופעלת. הפריסה הבסיסית מכילה רק אפליקציות שאושרו על ידי האדמין, ושנוספו לסט המוצרים הזמין למשתמש (באמצעות הקריאה setAvailableProductSet). האפליקציות בדף ממוינות לפי הערך של מזהה המוצר. אם יוצרים פריסת חנות בהתאמה אישית (על ידי הגדרת storeLayoutType = "custom" והגדרת דף בית), פריסת החנות הבסיסית מושבתת.
- ביטול ההרשמה
- ביטול ההרשמה של ארגון ל-EMM לשיחות.