REST Resource: deployments.configs

משאב: הגדרה

הגדרה של פריסה.

ייצוג JSON 
{
  "name": string,
  "title": string,
  "description": string,
  "defaultUpdateDescription": {
    object (UpdateDescription)
  },
  "localizedUpdateDescriptions": [
    {
      object (LocalizedUpdateDescription)
    }
  ],
  "urgencyMode": enum (UrgencyMode),
  "scheduledInstallDelay": enum (ScheduledInstallDelay),
  "wifiOnlyTime": enum (WifiOnlyTime),
  "updateMaintenanceWindow": {
    object (TimeWindow)
  },
  "packageSizeAwareBatteryThreshold": boolean,
  "offPeakUpdate": {
    object (OffPeakUpdate)
  },
  "countryRestriction": {
    object (IncludeExclude)
  },
  "mobileNetworkRestriction": {
    object (IncludeExclude)
  },
  "deviceBuildPropertyRestriction": {
    object (IncludeExclude)
  },
  "mobileNetworkCarrierRestriction": {
    object (IncludeExclude)
  },
  "updateRequiredSetup": boolean,
  "minimalSpaceRequired": enum (SpaceNeed),
  "immediateRelease": boolean,
  "rolloutSteps": [
    {
      object (RolloutStep)
    }
  ],
  "securityUpdate": boolean,
  "details": {
    object (ConfigDetails)
  },
  "allowEncryptedScheduledInstall": boolean,
  "reminderDialogSettings": {
    object (ReminderDialogSettings)
  }
}
שדות
name

string

פלט בלבד. שם התצורה. חשוב לשים לב שזהו המזהה הייחודי של האובייקטים של Config. הוא ייווצר על ידי השרת כשיווצר Config חדש.
title

string

אפשרות. שם התצורה.
description

string

אפשרות. תיאור התצורה.
defaultUpdateDescription

object (UpdateDescription)

חובה. טקסט ברירת המחדל של ממשק המשתמש שנעשה בו שימוש כשלוקאל המכשיר לא תואם ללוקאלים שצוינו ב-localizedUpdateDescriptions.
localizedUpdateDescriptions[]

object (LocalizedUpdateDescription)

אפשרות. רשימה של תיאורי עדכונים שהותאמו לשוק המקומי, שיקבלו עדיפות על פני defaultUpdateDescription אם אחד מהם תואם ללוקאל של המכשיר.
urgencyMode

enum (UrgencyMode)

אפשרות. דחיפות העדכון שקובעת איך המשתמשים יתבקשו לבחור. אם לא מציינים שום אפשרות, המערכת תשתמש בברירת המחדל של MANDATORY.
scheduledInstallDelay

enum (ScheduledInstallDelay)

אפשרות. עיכוב שקובע מתי העדכון יתוזמן להתקנה בלילה. אם לא צוין ערך, ברירת המחדל היא NEVER.
wifiOnlyTime

enum (WifiOnlyTime)

אפשרות. ברירת המחדל היא SEVEN_DAYS אם נשאר WIFI_ONLY_TIME_UNSPECIFIED.

הערה: הערך יהיה FOREVER אם הערך של urgencyMode הוא RECOMMENDED.
updateMaintenanceWindow

object (TimeWindow)

אפשרות. חלון הזמן של ההתקנה של ה-OTA.
packageSizeAwareBatteryThreshold

boolean

אפשרות. אם לעדכון צריכים להיות ערכי סף שונים של סוללה להתקנה, בהתאם לגודל שלו.
offPeakUpdate

object (OffPeakUpdate)

אפשרות. אובייקט העדכון מחוץ לשעות השיא.
countryRestriction

object (IncludeExclude)

אפשרות. המדינות האפשריות להכללה/להחרגה.
mobileNetworkRestriction

object (IncludeExclude)

אפשרות. הרשתות הסלולריות האפשריות הכלולות או לא נכללות, שזוהו באמצעות קודי mcc/mnc. הערה: יש להשתמש באפשרות הזו אך ורק ל-mobileNetworkCarrierRestriction. לא ניתן להגדיר את שני השדות בו-זמנית.
deviceBuildPropertyRestriction

object (IncludeExclude)

אפשרות. הגבלה אפשרית על מאפיינים של build של מכשיר שכולל או לא נכלל.
mobileNetworkCarrierRestriction

object (IncludeExclude)

אפשרות. הספקים האפשריים של רשתות סלולריות אפשריות להכללה או להחרגה. הערה: יש להשתמש באפשרות הזו אך ורק ל-mobileNetworkRestriction. לא ניתן להגדיר את שני השדות בו-זמנית.

כדי לראות את המיפויים, עיינו בקוד מדינה של נייד וקוד רשת סלולרית.
updateRequiredSetup

boolean

אפשרות. שדה זה מציין אם נדרש עדכון במהלך אשף ההגדרה. ברירת המחדל היא False.
minimalSpaceRequired

enum (SpaceNeed)

אפשרות. נפח האחסון צריך להיות מינימלי. אם הערך הוא UNSPECIFIED, השרת לא יגדיר מגבלה. נדרשת גרסה 6.1.11 ואילך של Google Play Services.
immediateRelease

boolean

אפשרות. נדרש אחד מהערכים immediateRelease או rolloutSteps. האם יש לפרסם את העדכון באופן מיידי. אם הערך הוא True, צריך לבטל את ההגדרה של rolloutSteps.
rolloutSteps[]

object (RolloutStep)

אפשרות. נדרש אחד מהערכים rolloutSteps או immediateRelease. RolloutSteps חייבים להיות לפי הסדר: time_ms ו-שבר צריכים להיות לא במגמת ירידה. בשלב האחרון צריך להיות שבר == 100.
securityUpdate

boolean

אפשרות. סימון העדכון כעדכון אבטחה. הנתונים האלה מועברים למכשיר כדי לתאם את התצוגה של הודעת העדכון הנכונה. כלומר, להציג את הטקסט 'מחיל עדכון אבטחה' במקום 'מחיל עדכון מערכת'. נדרשת רמת API 22 ואילך ו-Google Play Services מגרסה 9.4 ואילך.
details

object (ConfigDetails)

פלט בלבד. פרטים נוספים על הגדרה. רק השרת יחזיר את המזהה הזה בעת החזרת התצורה.
allowEncryptedScheduledInstall

boolean

אפשרות. האם מותר לתזמן התקנה של חבילה במכשירים מוצפנים או לא.
reminderDialogSettings

object (ReminderDialogSettings)

אפשרות. הגדרות של תיבת הדו-שיח של חלון העזר שמזכירה למשתמשים שיש להם עדכון בהמתנה.

UpdateDescription

תיאור העדכון נשלח למכשיר.

ייצוג JSON 
{
  "description": string,
  "title": string,
  "dialogMessage": string,
  "postSuccessMessage": string,
  "postFailureMessage": string
}
שדות
description

string

טקסט תיאור העדכון.
title

string

שם התיאור של העדכון.
dialogMessage

string

הודעת הדו-שיח של העדכון.
postSuccessMessage

string

ההודעה על העדכון בהצלחה שהתחילו לפרסם. נדרשת רמת API 14 ומעלה.
postFailureMessage

string

הודעה על כשל בפרסום של העדכון. נדרשת רמת API 14 ומעלה.

LocalizedUpdateDescription

תיאור העדכון על סמך הלוקאל.

ייצוג JSON 
{
  "locales": [
    string
  ],
  "updateDescription": {
    object (UpdateDescription)
  }
}
שדות
locales[]

string

הלוקאלים שתואמים ללוקאלים של המכשיר.
updateDescription

object (UpdateDescription)

תיאור העדכון שנשלח למכשיר.

UrgencyMode

מצב הדחיפות של השדרוג.

טיפוסים בני מנייה (enums)
MODE_UNSPECIFIED לא צוין.
RECOMMENDED מומלץ לשדרג. המשתמש יתבקש להוריד ולהתקין את העדכון.
MANDATORY חובה לשדרג. הורדת העדכון תתבצע באופן אוטומטי, אבל המשתמש יתבקש להתחיל בהתקנה.
AUTOMATIC שדרוג אוטומטי. המערכת תוריד ותתקין את העדכון באופן אוטומטי.

ScheduledInstallDelay

חלון העיכוב בין מועד זמינות העדכון למועד שבו ההתקנה מתוזמנת באופן אוטומטי.

טיפוסים בני מנייה (enums)
SCHEDULED_INSTALL_DELAY_UNSPECIFIED ערך ברירת המחדל. המערכת תתייחס אליך בתור 'אף פעם'.
SCHEDULED_INSTALL_DELAY_NEVER אף פעם לא להעביר את הבקשה להתקנה אוטומטית.
SCHEDULED_INSTALL_DELAY_ZERO_DAYS חלון אפס ימים (באופן מיידי)
SCHEDULED_INSTALL_DELAY_ONE_DAY חלון של יום אחד.
SCHEDULED_INSTALL_DELAY_TWO_DAYS חלון של יומיים.
SCHEDULED_INSTALL_DELAY_THREE_DAYS חלון של שלושה ימים.
SCHEDULED_INSTALL_DELAY_FOUR_DAYS חלון של ארבעה ימים.
SCHEDULED_INSTALL_DELAY_FIVE_DAYS חלון של חמישה ימים.
SCHEDULED_INSTALL_DELAY_TEN_DAYS חלון של עשרה ימים.
SCHEDULED_INSTALL_DELAY_FIFTEEN_DAYS חלון של 15 ימים.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS חלון של 30 יום.

WifiOnlyTime

ההורדה לא תאפשר שימוש ברשת סלולרית במשך התקופה הזו אחרי שהעדכון יהיה זמין.

טיפוסים בני מנייה (enums)
WIFI_ONLY_TIME_UNSPECIFIED לא צוין.
NONE לא חסום.
TWENTY_FOUR_HOURS חלון לעשרים וארבע שעות.
THREE_DAYS חלון של שלושה ימים.
SEVEN_DAYS חלון של שבעה ימים.
FOURTEEN_DAYS חלון לארבעה-עשר ימים.
TWENTY_ONE_DAYS חלון לעשרים יום אחד.
FOREVER חלון לתמיד.

TimeWindow

חלון זמן שמגדיר את שעת ההתחלה של היום ואת שעת הסיום ביום.

ייצוג JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "stopTime": {
    object (TimeOfDay)
  }
}
שדות
startTime

object (TimeOfDay)

שעת ההתחלה של החלון.
stopTime

object (TimeOfDay)

זמן עצירת החלון.

TimeOfDay

מייצג את השעה ביום. התאריך ואזור הזמן אינם משמעותיים או מצוינים במקום אחר. ממשק API עשוי לבחור לאפשר שניות מעבר. הסוגים הקשורים הם google.type.Date ו-google.protobuf.Timestamp.

ייצוג JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
שדות
hours

integer

שעות ביום בפורמט 24 שעות. צריך להיות בין 0 ל-23. ממשק API עשוי לאפשר את הערך '24:00:00' בתרחישים כמו שעת הסגירה של העסק.
minutes

integer

דקות בשעה ביום. הערך חייב להיות בין 0 ל-59.
seconds

integer

שניות של דקות מזמן. בדרך כלל צריך להיות מספר בין 0 ל-59. ממשק API עשוי להתיר את הערך 60 אם הוא מאפשר שניות מדלגות.
nanos

integer

שברים של שניות בננו-שניות. חייב להיות בין 0 ל-999,999,999.

OffPeakUpdate

מגבלת העדכונים מחוץ לתקופת השיא.

ייצוג JSON 
{
  "updateOffPeakWindow": {
    object (TimeWindow)
  },
  "updateOffPeakDays": enum (UpdateOffPeakDays),
  "updateOperatorRestriction": enum (CellularOperatorRestriction)
}
שדות
updateOffPeakWindow

object (TimeWindow)

חלון הזמן מחוץ לתקופת השיא להורדת העדכון. נדרשת גרסה 6.7.72 ואילך של Google Play Services.
updateOffPeakDays

enum (UpdateOffPeakDays)

אפשרות. אם הערך הוא OFF_PEAK_DAYS_UNSPECIFIED, השרת ישתמש בערך ברירת המחדל OFF_PEAK_UPDATE_ONE_DAY. יש צורך ב-Google Play Services מגרסה 6.5 ואילך.
updateOperatorRestriction

enum (CellularOperatorRestriction)

אפשרות. אם לא מציינים ערך, השרת ישתמש בערך ברירת המחדל ALL_NETWORK_ALLOWED. נדרשת גרסה 6.7.72 ואילך של Google Play Services.

UpdateOffPeakDays

מספר הימים שבהם כדאי לנסות להוריד את העדכון בחלון מחוץ לשעות השיא.

טיפוסים בני מנייה (enums)
OFF_PEAK_DAYS_UNSPECIFIED לא צוין.
OFF_PEAK_UPDATE_ONE_DAY יום אחד.
OFF_PEAK_UPDATE_THREE_DAYS 3 ימים.
OFF_PEAK_UPDATE_SEVEN_DAYS 7 ימים.
OFF_PEAK_UPDATE_FOURTEEN_DAYS 14 ימים.
OFF_PEAK_UPDATE_THIRTY_DAYS 30 יום.

CellularOperatorRestriction

צריך להגדיר את הערך CELLULAR_OPERATOR_RESTRICTED כדי להחיל הגבלה על חלון מחוץ לשעות השיא, כך שהורדת ה-OTA תוגבל למפעיל הרשת הסלולרית שבה היא התקבלה לראשונה. מיועד למכשירים עם ריבוי כרטיסי SIM כשנעשה בהם שימוש בשילוב עם mobileNetworkRestriction כדי להגביל הורדות מחוץ לשעות השיא למפעיל ספציפי.

טיפוסים בני מנייה (enums)
OPERATOR_RESTRICTED_UNSPECIFIED לא צוין.
CELLULAR_OPERATOR_RESTRICTED חלון הזמן מחוץ לשעות השיא חל רק על המפעיל הסלולרי שבו ה-OTA התקבל לראשונה.
ALL_NETWORK_ALLOWED חלון הזמן מחוץ לשעות השיא חל בכל הרשתות.

IncludeExclude

כוללת או מחריגה תבניות מסוימות המופרדות בפסיקים.

ייצוג JSON 
{

  // Union field include_exclude can be only one of the following:
  "include": string,
  "exclude": string
  // End of list of possible types for union field include_exclude.
}
שדות
שדה איחוד include_exclude. כלל של הכללה או החרגה. הערך של include_exclude יכול להיות רק אחת מהאפשרויות הבאות:
include

string

דפוס כלול. אם מותר להשתמש בכמה ערכים, צריך להשתמש בפסיק כדי להפריד ביניהם.
exclude

string

דפוס מוחרג. אם מותר להשתמש בכמה ערכים, צריך להשתמש בפסיק כדי להפריד ביניהם.

SpaceNeed

דרישת השטח בבייטים.

טיפוסים בני מנייה (enums)
SPACE_NEED_UNSPECIFIED לא צוין.
ONE_HUNDRED_MB 100 MB.
ONE_HUNDRED_AND_FIFTY_MB 150 MB.
TWO_HUNDRED_AND_FIFTY_MB 250 MB.
FIVE_HUNDRED_MB 500 MB.

RolloutStep

רכיב השלב בהשקה.

ייצוג JSON 
{
  "rolloutTime": string,
  "fraction": number
}
שדות
rolloutTime

string (Timestamp format)

חותמת הזמן של ההשקה.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
fraction

number

שבר המחושב באחוזים בין 0.00 ל-100.00.

ConfigDetails

פרטי הגדרה.

ייצוג JSON 
{
  "postConditions": [
    {
      object (Condition)
    }
  ],
  "packages": [
    {
      object (PackageConfig)
    }
  ],
  "groups": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
שדות
postConditions[]

object (Condition)

התנאים שאחרי ההתקנה של הגדרת התצורה.
packages[]

object (PackageConfig)

החבילות המוגדרות של התצורה הזו. חשוב: סדר החבילות חשוב. אם מכשיר תואם לכמה קבוצות של תנאים מוקדמים, החבילה האחרונה התואמת תנצח ותחול על המכשיר.
groups[]

string

הקבוצות שמשויכות להגדרה הזאת.
versionTag

object (VersionTag)

פלט בלבד. גרסת התצורה.

ReminderDialogSettings

הגדרות לשליטה בתיבת דו-שיח לתזכורת בחלון נפרד, שמוצגת למשתמשים אחרי משך הזמן שצוין.

ייצוג JSON 
{
  "start": enum (Start),
  "remindMeLaterDuration": enum (RemindLaterDuration),
  "frequency": enum (Frequency)
}
שדות
start

enum (Start)

מתי להתחיל להציג את התזכורת?
remindMeLaterDuration

enum (RemindLaterDuration)

מוצג הלחצן 'אני רוצה לקבל תזכורת מאוחר יותר'.
frequency

enum (Frequency)

תזכורת התדירות מוצגת לאחר סגירה.

התחלה

מתי להציג תיבת דו-שיח לתזכורת לדוגמה, אם היא מוגדרת לערך START_TWO_DAYS, תוצג למשתמשים תזכורת יומיים אחרי קבלת העדכון. אם נותר START_UNSPECIFIED, ייעשה שימוש בברירת המחדל של START_SEVEN_DAYS.

טיפוסים בני מנייה (enums)
START_UNSPECIFIED לא צוין.
NEVER_START אין להתחיל את התזכורת אף פעם.
START_ZERO_DAYS מתחילים מיד.
START_TWO_DAYS מתחילים אחרי יומיים.
START_SEVEN_DAYS מתחילים אחרי שבעה ימים.
START_FOURTEEN_DAYS מתחילים אחרי 14 ימים. התג הבא: 6

RemindLaterDuration

למשך כמה זמן מוצג הלחצן 'אני רוצה לקבל תזכורת אחר כך' בתיבת הדו-שיח. יש לבחור באפשרות ALWAYS_SHOW כדי להציג את הלחצן כל הזמן וNEVER_SHOW כדי לא להציג אותו אף פעם. אם נותר LATER_DURATION_UNSPECIFIED, ייעשה שימוש בברירת המחדל של LATER_FOURTEEN_DAYS.

טיפוסים בני מנייה (enums)
LATER_DURATION_UNSPECIFIED לא צוין.
NEVER_SHOW אין להציג את הלחצן אף פעם.
ALWAYS_SHOW הלחצן תמיד מוצג.
LATER_SEVEN_DAYS הסרת הלחצן אחרי שבעה ימים.
LATER_FOURTEEN_DAYS לחצן הסרה אחרי 14 ימים.
LATER_TWENTY_ONE_DAYS לחצן הסרה אחרי עשרים יום.

תדירות

אחרי שהמשתמש סוגר את תיבת הדו-שיח של התזכורת, בתוך כמה זמן היא תוצג שוב. אם נותר FREQUENCY_UNSPECIFIED, ייעשה שימוש בברירת המחדל של FREQUENCY_SEVEN_DAYS.

טיפוסים בני מנייה (enums)
FREQUENCY_UNSPECIFIED לא צוין.
FREQUENCY_ONE_DAY הצגת התזכורת כל יום.
FREQUENCY_THREE_DAYS הצגת התזכורת כל שלושה ימים.
FREQUENCY_SEVEN_DAYS הצגת התזכורת כל 7 ימים.

שיטות

create

 הפונקציה יוצרת config ומחזירה את הערך החדש Config.

delete

 מוחק config.

disable

 משבית את כל הקבוצות המופעלות שיש להן את התצורה שצוינה.

get

 מקבל תצוגה של config.

list

 בתיבת הדו-שיח הזו רשומים configs של פריסה.

update

 מתבצע עדכון של config.

updatePackages

 מעדכנים את החבילות מתחת להגדרה.