REST Resource: customers.policySchemas

משאב: סכימת מדיניות

משאב שמייצג סכימת מדיניות.

ייצוג JSON 
{
  "name": string,
  "policyDescription": string,
  "additionalTargetKeyNames": [
    {
      object (AdditionalTargetKeyName)
    }
  ],
  "definition": {
    object (FileDescriptorProto)
  },
  "fieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "accessRestrictions": [
    string
  ],
  "notices": [
    {
      object (PolicySchemaNoticeDescription)
    }
  ],
  "supportUri": string,
  "schemaName": string,
  "validTargetResources": [
    enum (TargetResource)
  ],
  "policyApiLifecycle": {
    object (PolicyApiLifecycle)
  },
  "categoryTitle": string,
  "supportedPlatforms": [
    enum (Platform)
  ]
}
שדות
name

string

פורמט: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

פלט בלבד. תיאור של סכימת המדיניות לצריכת משתמשים.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

פלט בלבד. שמות מפתח נוספים שישמשו לזיהוי היעד של ערך המדיניות. כשמציינים policyTargetKey, כל אחד מהמפתחות הנוספים שמצוינים כאן צריך להיכלל במפה additionalTargetKeys.
definition

object (FileDescriptorProto)

הגדרת סכימה באמצעות מתאר פרוטו.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

פלט בלבד. תיאור מפורט של כל שדה שנכלל בסכימה. המערכת מציעה שדות לפי הסדר ברשימה הזו ולא לפי מספר השדה.
accessRestrictions[]

string

פלט בלבד. הגבלות גישה ספציפיות שקשורות למדיניות הזו.
notices[]

object (PolicySchemaNoticeDescription)

פלט בלבד. הודעות מיוחדות הקשורות להגדרת ערכים מסוימים בשדות מסוימים בסכימה.
supportUri

string

פלט בלבד. URI למאמר תמיכה שקשור לסכימה הזו.
schemaName

string

פלט בלבד. השם המוגדר במלואו של סכימת המדיניות. הערך הזה משמש למילוי השדה policySchema ב-PolicyValue כשקוראים לפונקציה BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies או BatchDeleteGroupPolicies.
validTargetResources[]

enum (TargetResource)

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

object (PolicyApiLifecycle)

פלט בלבד. מידע על מחזור החיים הנוכחי.
categoryTitle

string

שם הקטגוריה שאליה משויכת ההגדרה.
supportedPlatforms[]

enum (Platform)

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

AdditionalTargetKeyName

שמות מפתח נוספים שישמשו לזיהוי היעד של ערך המדיניות.

ייצוג JSON 
{
  "key": string,
  "keyDescription": string
}
שדות
key

string

שם מפתח.
keyDescription

string

תיאור מפתח.

FileDescriptorProto

מתאר קובץ .proto מלא.

ייצוג JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
שדות
name

string

שם קובץ, ביחס לשורש של עץ המקור
package

string

לדוגמה 'foo', 'foo.bar' וכו'.
messageType[]

object (DescriptorProto)

כל ההגדרות ברמה העליונה בקובץ הזה.
enumType[]

object (EnumDescriptorProto)
syntax

string

התחביר של קובץ ה-proto. הערכים הנתמכים הם "proto2", "proto3" ו-"editions".

אם edition קיים, הערך הזה צריך להיות 'מהדורות'.

DescriptorProto

מתאר את סוג ההודעה.

ייצוג JSON 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
שדות
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

מתאר שדה בתוך הודעה.

ייצוג JSON 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
שדות
name

string
number

integer
label

enum (Label)
type

enum (Type)

אם השדה typeName מוגדר, אין צורך להגדיר אותו. אם גם זה וגם typeName מוגדרים, הערך צריך להיות אחד מהערכים TYPE_ENUM, TYPE_MESSAGE או TYPE_GROUP.
typeName

string

כשמדובר בהודעות ובטיפוסים 'טיפוסים בני מנייה (enum)', זה שם הסוג. אם השם מתחיל בתו '.', פירוש הדבר הוא שהוא כשיר לחלוטין. אחרת, נעשה שימוש בכללי היקף דמויי C++ כדי למצוא את הסוג (כלומר, קודם מחפשים את הסוגים המקוננים בהודעה הזו, ואז בתוך ההורה, עד למרחב השמות הבסיסי).
defaultValue

string

בסוגים מספריים, הערך מכיל את הייצוג המקורי של הטקסט. למטבעות בוליאניים, "true" או 'false'. במחרוזות, מכיל את תוכן הטקסט שמוגדר כברירת מחדל (בלי לסמן בתו בריחה (escape) בשום צורה). לבייטים, מכיל את הערך C, שסומן בתו בריחה (escape). כל הבייטים שגדולים מ-128 מסומנים בתווי בריחה (escape).
oneofIndex

integer

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

string

השם של קובץ JSON של השדה הזה. הערך נקבע על ידי מהדר הפרוטוקולים. אם המשתמש הגדיר קובץ JSONName בשדה הזה, המערכת תשתמש בערך של האפשרות הזו. אחרת, היא נגזרת משם השדה על ידי המרתו לקאמלקאסל.
proto3Optional

boolean

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

כאשר הערך של הפרמטר proto3Optional הוא True, השדה הזה חייב להשתייך לאחד מהבאים כדי לאותת ללקוחות proto3 ישנים שמבוצעת מעקב אחרי הנוכחות בשדה הזה. האחד הזה נקרא "סינתטי" אחד, והשדה הזה חייב להיות החבר היחיד שלו (כל שדה אופציונלי ב-proto3 מקבל שדה סינתטי משלו). מאפיינים סינתטיים קיימים במתאר בלבד והם לא יוצרים API כלשהו. יש להזמין נכסים סינתטיים אחרי הוספה של כל הפריטים ה"אמיתיים" אחת או יותר.

בשדות של הודעות, הפרמטר proto3Optional לא יוצר שינוי סמנטי, כי שדות של הודעות שאינם חוזרים תמיד עוקבים אחרי הנוכחות. עם זאת, עדיין מצוין הפרטים הסמנטיים אם המשתמש כתב 'אופציונלי'. או לא. האפשרות הזו יכולה להיות שימושית להעברת קובץ ה- .proto הלוך ושוב. כדי לשמור על עקביות, אנחנו נותנים לשדות ההודעות ערך סינתטי גם, למרות שהוא לא נדרש למעקב אחר הנוכחות. זה חשוב במיוחד כי המנתח לא יכול לזהות אם שדה הוא הודעה או 'טיפוסים בני מנייה (enum)', ולכן הוא צריך תמיד ליצור אחד מהם סינתטי.

בשדות האופציונליים של Proto2 לא מוגדר הסימון הזה, כי הם כבר מסומנים כאופציונליים אצל LABEL_OPTIONAL.

תווית

טיפוסים בני מנייה (enum)
LABEL_OPTIONAL הספרה 0 שמור לשגיאות
LABEL_REPEATED
LABEL_REQUIRED התווית הנדרשת מותרת רק ב-proto2. ב-proto3 וב- Editions הדבר אסור באופן מפורש. במהדורות, אפשר להשתמש בתכונה fieldPresence כדי לקבל את ההתנהגות הזו.

סוג

טיפוסים בני מנייה (enum)
TYPE_DOUBLE הספרה 0 שמור לשגיאות. הסדר מוזר בגלל סיבות היסטוריות.
TYPE_FLOAT
TYPE_INT64 לא מקודד ZigZag. מספרים שליליים הם באורך 10 בייטים. יש להשתמש ב-TYPE_SINT64 אם סביר להניח שיהיו ערכים שליליים.
TYPE_UINT64
TYPE_INT32 לא מקודד ZigZag. מספרים שליליים הם באורך 10 בייטים. יש להשתמש ב-TYPE_SINT32 אם סביר להניח שיהיו ערכים שליליים.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP קובץ מצטבר שמופרד בתגים. group type (סוג הקבוצה) הוצא משימוש ולא נתמך אחרי proto2. עם זאת, הטמעות Proto3 עדיין יוכלו לנתח את פורמט הכבל של הקבוצה ולהתייחס לשדות של הקבוצה כשדות לא ידועים. במהדורות, אפשר להפעיל את פורמט הכבלים הקבוצתיים באמצעות התכונה messageEncoding.
TYPE_MESSAGE קובץ אגרגציה מופרד באורך.
TYPE_BYTES חדש בגרסה 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 נעשה שימוש בקידוד ZigZag.
TYPE_SINT64 נעשה שימוש בקידוד ZigZag.

EnumDescriptorProto

מתאר סוג טיפוסים בני מנייה (enum).

ייצוג JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
שדות
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

מתאר ערך בתוך טיפוס enum.

ייצוג JSON 
{
  "name": string,
  "number": integer
}
שדות
name

string
number

integer

OneofDescriptorProto

מתאר אחד מבין השניים.

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

string

PolicySchemaFieldDescription

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

ייצוג JSON 
{
  "field": string,
  "description": string,
  "inputConstraint": string,
  "knownValueDescriptions": [
    {
      object (PolicySchemaFieldKnownValueDescription)
    }
  ],
  "nestedFieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ],
  "requiredItems": [
    {
      object (PolicySchemaRequiredItems)
    }
  ],
  "defaultValue": value,
  "name": string,
  "fieldDescription": string,
  "fieldConstraints": {
    object (FieldConstraints)
  }
}
שדות
field

string

פלט בלבד. שם השדה שמשויך לתיאור הזה.
description
(deprecated)

string

הוצא משימוש. במקום זאת, צריך להשתמש בשם וב-FieldDescription. תיאור השדה.
inputConstraint

string

פלט בלבד. כל מגבלות קלט שמשויכות לערכים בשדה.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

פלט בלבד. אם השדה מכיל קבוצה של ערכים ידועים, השדה הזה יספק תיאור של הערכים האלה.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

פלט בלבד. מספק את התיאור של השדות שהוצבו בשדה הזה, אם השדה הוא סוג הודעה שמגדיר כמה שדות. המערכת מציעה שדות לפי הסדר ברשימה הזו ולא לפי מספר השדה.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

פלט בלבד. מספקת רשימה של שדות וערכים. כדי שאפשר יהיה להגדיר את השדה הזה, לפחות אחד מהשדות חייב להכיל את הערך המתאים.
requiredItems[]

object (PolicySchemaRequiredItems)

פלט בלבד. מספקת רשימה של שדות שצריך להגדיר אם השדה הזה מכיל ערך מסוים.
defaultValue

value (Value format)

פלט בלבד. ברירת המחדל של הלקוח אם המדיניות לא מוגדרת.
name

string

פלט בלבד. שם השדה.
fieldDescription

string

פלט בלבד. תיאור השדה.
fieldConstraints

object (FieldConstraints)

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

PolicySchemaFieldKnownValueDescription

מספקת מידע מפורט על ערך ידוע שמותר לשדה מסוים בסכימת מדיניות.

ייצוג JSON 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
שדות
value

string

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

string

פלט בלבד. תיאור נוסף לערך הזה.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

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

PolicySchemaFieldDependencies

השדה והערך שהוא חייב להכיל כדי לאפשר הגדרה של שדה אחר.

ייצוג JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
שדות
sourceField

string

שדה המקור שבו השדה הזה תלוי.
sourceFieldValue

string

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

PolicySchemaRequiredItems

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

ייצוג JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
שדות
fieldConditions[]

string

הערכים בשדות שגורמים לאכיפה נדרשת של השדה. אם השדה ריק, התנאי מרמז על כך שכל ערך שמוקצה לשדה הזה יגרום לאכיפה נדרשת של השדה.
requiredFields[]

string

השדות הנדרשים כתוצאה מתנאי השדה.

FieldConstraints

מידע על מגבלות טווח.

ייצוג JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
שדות
numericRangeConstraint

object (NumericRangeConstraint)

הטווח המותר לשדות מספריים.
uploadedFileConstraints

object (UploadedFileConstraints)

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

NumericRangeConstraint

מגבלה על גבול עליון ו/או תחתון, עם הגדרה אחת לפחות.

ייצוג JSON 
{
  "minimum": string,
  "maximum": string
}
שדות
minimum

string (int64 format)

ערך מינימלי.
maximum

string (int64 format)

ערך מקסימלי.

UploadedFileConstraints

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

ייצוג JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
שדות
supportedContentTypes[]

enum (ContentType)

סוגי קבצים שאפשר להעלות במסגרת הגדרה מסוימת.
sizeLimitBytes

string (int64 format)

מגבלת הגודל בבייטים של קבצים שניתן להעלות להגדרה מסוימת.

ContentType

סוגי קבצים שאפשר להעלות במסגרת הגדרה מסוימת.

טיפוסים בני מנייה (enum)
CONTENT_TYPE_UNSPECIFIED סוג התוכן לא צוין.
CONTENT_TYPE_PLAIN_TEXT טקסט פשוט.
CONTENT_TYPE_HTML HTML.
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF GIF.
CONTENT_TYPE_IMAGE_PNG PNG.
CONTENT_TYPE_JSON JSON.
CONTENT_TYPE_ZIP ZIP.
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP WEBP

PolicySchemaNoticeDescription

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

ייצוג JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
שדות
field

string

פלט בלבד. שם השדה שמשויך להודעה.
noticeValue

string

פלט בלבד. הערך בשדה שיש בו הודעה. אם מגדירים בשדה את הערך הזה, יכול להיות שהמשתמש יצטרך לאשר את הודעת ההתראה כדי שיהיה מוגדר.
noticeMessage

string

פלט בלבד. הודעת ההודעה שמשויכת לערך בשדה.
acknowledgementRequired

boolean

פלט בלבד. האם המשתמש צריך לאשר את הודעת ההתראה לפני שניתן להגדיר את הערך.

TargetResource

סוגים של משאבי יעד

טיפוסים בני מנייה (enum)
TARGET_RESOURCE_UNSPECIFIED משאב היעד לא צוין.
ORG_UNIT משאב יעד של יחידה ארגונית.
GROUP למשאב היעד של הקבוצה.

PolicyApiLifecycle

מידע על מחזור החיים.

ייצוג JSON 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
שדות
deprecatedInFavorOf[]

string

במקרה שהמדיניות הזו הוצאה משימוש לטובת מדיניות אחרת, מרחבי השמות המלאים של כללי המדיניות החדשים יופיעו ב-PolicyAPI. אפשר להגדיר רק אם המדיניות ApiLifecycleStage היא API_DEPRECATED.
scheduledToDeprecatePolicies[]

string

בהתאם ל-InFavorOf שהוצאו משימוש, מרחבי השמות שהוגדרו במלואם של כללי המדיניות הישנים יוצאו משימוש עקב הצגת המדיניות הזו.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

הצגת השלב הנוכחי של מחזור החיים של ה-API של המדיניות.
description

string

תיאור של מחזור החיים הנוכחי.
endSupport

object (Date)

תאריך סיום התמיכה במדיניות הנוכחית. ניסיון לשנות מדיניות לאחר תאריך התמיכה שלה יגרום להצגה של 'בקשה שגויה' (שגיאה 400). אפשר להגדיר רק אם המדיניות ApiLifecycleStage היא API_DEPRECATED.

PolicyApiLifecycleEnum

שלב מחזור החיים של ה-API של המדיניות.

טיפוסים בני מנייה (enum)
API_UNSPECIFIED מחזור החיים של Policy Api לא צוין.
API_PREVIEW המדיניות עדיין לא פועלת, אבל היא מספקת למפתחים מידע על הפורמט. השלב הזה יכול לעבור ל-API_DE{1/}MNT או ל-API_CURRENT.
API_DEVELOPMENT המדיניות יכולה לשנות את הפורמט באופן שאינו תואם לאחור (שינוי בפגיעה). ניתן להעביר את השלב הזה ל-API_CURRENT או ל-API_DEPRECATED. אפשר להשתמש באפשרות הזו רק עבור מדיניות שהושקה רק עבור 'דברים שאפשר לעשות' (TT) או שהושקה ללקוחות נבחרים לשימוש במקרה חירום.
API_CURRENT המדיניות בפורמט רשמי. המדיניות יכולה לשנות את הפורמט באופן של תאימות לאחור (שינוי ללא תקלות). דוגמה: המדיניות הזו יכולה לכלול שדה חדש, שנחשב לשינוי לא גורם לשיבושים, אם משתמשים בצורה נכונה במסכות של שדות. ניתן להעביר את השלב הזה אל API_DEPRECATED.
API_DEPRECATED יש להפסיק להשתמש במדיניות הזו. המדיניות הזו הוצאה משימוש וייתכן שהיא תוסר בעתיד. סביר להניח שהוספת מדיניות חדשה כדי להחליף את המדיניות הזו.

תאריך

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

  • תאריך מלא, עם ערכים שונים של שנה, חודש ויום.
  • חודש ויום, עם שנה אפס (למשל יום נישואין).
  • שנה בפני עצמה, עם חודש אפס ויום אפס.
  • שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגה של כרטיס אשראי).

סוגים קשורים:

ייצוג JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה שבה חל התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. הערך חייב להיות 1 עד 12, או 0 כדי לציין שנה בלי חודש ויום.
day

integer

היום בחודש. הערך צריך להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם אין חשיבות לציון יום מסוים.

פלטפורמה

זהו enum של קבוצות הפלטפורמות השונות שבהן Chrome נתמך.

טיפוסים בני מנייה (enum)
PLATFORM_UNSPECIFIED הפלטפורמה לא צוינה.
CHROME_OS ChromeOS.
CHROME_BROWSER דפדפן Chrome ל-OSX/Windows/Linux.
CHROME_BROWSER_FOR_ANDROID דפדפן Chrome ל-Android.
CHROME_BROWSER_FOR_IOS דפדפן Chrome ל-iOS.

שיטות

get

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

list

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