RemoteConfig

RemoteConfig מייצג תבנית של Remote Config.

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

הערך שנפתר של פרמטר נקבע באופן הבא:

בהינתן conditional values המתייחסים conditions true עבור מופע היישום, הערך שנפתר של הפרמטר הוא הערך המותנה name הוא המוקדם ביותר conditions list .

אחרת, אם לפרמטר יש default value , הערך שנפתר מוגדר לערך ברירת המחדל.

אחרת, לפרמטר אין ערך והוא מושמט מהתוצאה שמופע היישום מביא.

לדוגמה, נניח שיש לנו פרמטר מפתח fruit , עם ערך ברירת המחדל pear וערך מותנה תת-מפת {"is_ios": "apple", "is_in_20_percent": "banana"} כאשר "is_ios" ו- "is_20_percent" הם שמות של תנאים בסדר רשימת תנאים. הערך של fruit יוערך apple אם is_ios נכון. אחרת, אם is_in_20_percent true , fruit יערך banana , ואם is_ios ו- is_in_20_percent שניהם שקריים, fruit יהיו מוערכים pear . אם לא צוין ערך ברירת מחדל, ו- is_ios ו- is_in_20_percent היו שניהם false, שום ערך עבור fruit לא יוחזר משרת התצורה המרוחקת ללקוח.

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

ייצוג JSON
{
  "conditions": [
    {
      object (RemoteConfigCondition)
    }
  ],
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  },
  "version": {
    object (Version)
  },
  "parameterGroups": {
    string: {
      object (RemoteConfigParameterGroup)
    },
    ...
  }
}
שדות
conditions[]

object ( RemoteConfigCondition )

רשימת תנאים בסדר יורד לפי עדיפות.

הערכים של ערכי google.firebase.remoteconfig.v1.RemoteConfigCondition.name חייבים להיות ייחודיים.

parameters

map (key: string, value: object ( RemoteConfigParameter ))

מפה של מפתחות פרמטרים לערכי ברירת המחדל האופציונליים שלהם ולערכים מותנים אופציונליים.

אובייקט המכיל רשימה של "key": value . דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

version

object ( Version )

פלט בלבד, למעט description הגרסה . מטא נתונים המשויכים לגרסה מסוימת של תבנית. ניתן לציין שדה תיאור של גרסה בקריאות projects.updateRemoteConfig .

parameterGroups

map (key: string, value: object ( RemoteConfigParameterGroup ))

מפה של שמות קבוצות פרמטרים לפי התיאורים והפרמטרים המקובצים שלהם. שם קבוצה ניתן לשינוי אך חייב להיות ייחודי בין הקבוצות בתצורה. השם מוגבל ל-256 תווים ומיועד להיות קריא לאדם. כל תווי Unicode מותרים.

לקבוצות יש רשימה של פרמטרים המאפשרת למשתמשי ה-API לקבץ פרמטרים המשויכים לאותה תכונה או נושא יחד לגישה ארגונית קלה.

לדוגמה, קבוצת פרמטרים בשם "Search V2" עשויה לקבל את description "New Search Mobile View" ולהכיל פרמטרים לפריסה והגופן של החיפוש החדש.

אובייקט המכיל רשימה של "key": value . דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

RemoteConfigCondition

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

ייצוג JSON
{
  "name": string,
  "expression": string,
  "tagColor": enum (ConditionDisplayColor)
}
שדות
name

string

נדרש. שם לא ריק וייחודי של מצב זה.

expression

string

נדרש. ההיגיון של המצב הזה.

ראה את התיעוד לגבי ביטויי תנאי לתחביר הצפוי של שדה זה.

tagColor

enum ( ConditionDisplayColor )

אופציונאלי. הצבע המשויך לתנאי זה למטרות תצוגה במסוף Firebase. אי ציון ערך זה או בעל "CONDITION_DISPLAY_COLOR_UNSPECIFIED" מביא לכך שהקונסולה בוחרת צבע שרירותי לשיוך לתנאי.

מצב תצוגה צבע

רשימה של צבעים המשויכים לתנאים למטרות תצוגה.

תקצירים
CONDITION_DISPLAY_COLOR_UNSPECIFIED
BLUE כְּחוֹל
BROWN חום
CYAN טורקיז
DEEP_ORANGE נקרא "כתום אדום"
GREEN ירוק
INDIGO אִינדִיגוֹ
LIME ליים
ORANGE תפוז
PINK וָרוֹד
PURPLE סָגוֹל
TEAL ירוק כחלחל

RemoteConfigParameter

ערך פרמטר המשויך למפתח פרמטר ב- google.firebase.remoteconfig.v1.RemoteConfig.parameters .

לכל הפחות, ערך defaultValue או conditionalValues ​​צריך להיות נוכח כדי שהפרמטר ישפיע.

ייצוג JSON
{
  "defaultValue": {
    object (RemoteConfigParameterValue)
  },
  "conditionalValues": {
    string: {
      object (RemoteConfigParameterValue)
    },
    ...
  },
  "description": string,
  "valueType": enum (ParameterValueType)
}
שדות
defaultValue

object ( RemoteConfigParameterValue )

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

conditionalValues

map (key: string, value: object ( RemoteConfigParameterValue ))

אופציונלי - מפה ( condition name , ערך). condition_name של העדיפות הגבוהה ביותר (זה שרשום ראשון ברשימת התנאים של RemoteConfig) קובע את הערך של פרמטר זה.

אובייקט המכיל רשימה של "key": value . דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

description

string

אופציונאלי. תיאור עבור פרמטר זה. אורכו חייב להיות קטן או שווה ל-256 תווים. תיאור עשוי להכיל כל תווי Unicode.

valueType

enum ( ParameterValueType )

סוג הנתונים עבור כל הערכים של פרמטר זה בגרסה הנוכחית של התבנית. ברירת המחדל היא ParameterValueType.STRING אם לא צוין.

RemoteConfigParameterValue

משאב RemoteConfigParameterValue מכיל את הערך שיכול להיות לפרמטר.

ייצוג JSON
{

  // Union field value_option can be only one of the following:
  "value": string,
  "useInAppDefault": boolean,
  "personalizationValue": {
    object (PersonalizationValue)
  }
  // End of list of possible types for union field value_option.
}
שדות
value_option של שדה איחוד . RemoteConfigParameterValue מורכב ממחרוזת (ערך) או בוליאני (use_in_app_default, מוגדר כ-true אם רלוונטי). value_option יכול להיות רק אחד מהאפשרויות הבאות:
value

string

ערך המחרוזת שאליו מוגדר הפרמטר.

useInAppDefault

boolean

אם נכון, הפרמטר מושמט מערכי הפרמטרים המוחזרים ללקוח.

personalizationValue

object ( PersonalizationValue )

ערך דינמי, ספציפי למשתמש, המחושב בעת שליפת התצורה.

ערך אישי

מכיל את המידע הדרוש כדי להביא ערך מותאם אישית.

ייצוג JSON
{
  "personalizationId": string
}
שדות
personalizationId

string

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

ParameterValueType

סוגי נתונים מקובלים עבור ערכי פרמטרים.

תקצירים
PARAMETER_VALUE_TYPE_UNSPECIFIED תכלס עבור ערכי מנה לא מזוהים.
STRING מייצג ערכי מחרוזת.
BOOLEAN מייצג ערכים בוליאניים ("true" או "false").
NUMBER מייצג מספר שלם חיובי ושלילי וערכים צפים.
JSON מייצג ערכי JSON.

RemoteConfigParameterGroup

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

ייצוג JSON
{
  "description": string,
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  }
}
שדות
description

string

אופציונאלי. תיאור לקבוצה. אורכו חייב להיות קטן או שווה ל-256 תווים. תיאור עשוי להכיל כל תווי Unicode.

parameters

map (key: string, value: object ( RemoteConfigParameter ))

מפה של מפתחות פרמטרים לערכי ברירת המחדל האופציונליים שלהם וערכים מותנים אופציונליים עבור פרמטרים השייכים לקבוצה זו. פרמטר מופיע רק פעם אחת בכל RemoteConfig: פרמטר לא מקובץ מופיע ברמה העליונה; פרמטר המאורגן בתוך קבוצה מופיע במפת הפרמטרים של הקבוצה שלה.

אובייקט המכיל רשימה של "key": value . דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" } .