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. האם יש להשיק את העדכון באופן מיידי. אם זה נכון, צריך לבטל את ההגדרה של rolloutSteps.
rolloutSteps[]

object (RolloutStep)

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

boolean

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

object (ConfigDetails)

פלט בלבד. פרטים נוספים על הגדרה השרת אמור להחזיר את זה רק במהלך החזרת ה-config.
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

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

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

ScheduledInstallDelay

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

טיפוסים בני מנייה (enum)
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 חלון של חמישה-עשר ימים.
SCHEDULED_INSTALL_DELAY_THIRTY_DAYS חלון של 30 יום.

WifiOnlyTime

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

טיפוסים בני מנייה (enum)
WIFI_ONLY_TIME_UNSPECIFIED לא צוין.
NONE לא חסום.
TWENTY_FOUR_HOURS חלון של 24 שעות.
THREE_DAYS חלון של שלושה ימים.
SEVEN_DAYS חלון של שבעה ימים.
FOURTEEN_DAYS חלון של 14 ימים.
TWENTY_ONE_DAYS חלון של 21 ימים.
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. נדרשת גרסה 6.5 ואילך של Google Play Services.
updateOperatorRestriction

enum (CellularOperatorRestriction)

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

UpdateOffPeakDays

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

טיפוסים בני מנייה (enum)
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, כדי להגביל את ההורדות מחוץ לנקודת השיא למפעיל ספציפי.

טיפוסים בני מנייה (enum)
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

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

טיפוסים בני מנייה (enum)
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 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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.

טיפוסים בני מנייה (enum)
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.

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

תדירות

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

טיפוסים בני מנייה (enum)
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

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