REST Resource: customers.policySchemas

資源：PolicySchema

代表政策結構定義的資源。

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)

使用 proto 描述元定義的結構定義。
fieldDescriptions[]

object (PolicySchemaFieldDescription)

僅供輸出。組成結構定義的每個欄位詳細說明。建議依這份清單的順序顯示欄位，而非依欄位編號顯示。
accessRestrictions[]

string

僅供輸出。與這項政策相關的特定存取權限制。
notices[]

object (PolicySchemaNoticeDescription)

僅供輸出。特殊通知訊息，與在結構定義的特定欄位中設定特定值有關。
supportUri

string

僅供輸出。這個結構定義相關支援文章的 URI。
schemaName

string

僅供輸出。政策結構定義的完整名稱。此值用於呼叫 BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies 或 BatchDeleteGroupPolicies 時，用於填入 PolicyValue 中的 policySchema 欄位。
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

如果是訊息和列舉類型，則會是類型名稱。如果名稱開頭為「.」，則代表完整。否則，會使用 C++ 型範圍規則尋找類型 (例如，系統會先搜尋這封郵件中的巢狀類型，然後在父項內部搜尋到根命名空間)。
defaultValue

string

如為數字類型，則包含值的原始文字表示法。如果是布林值，「true」或「false」。對於字串，包含預設文字內容 (沒有以任何方式逸出)。如果是位元組，包含 C 逸出值。>= 128 的所有位元組都會逸出。
oneofIndex

integer

設定後，請提供所含類型的 oneofDecl 清單中一人的索引。這個欄位是該項目的成員。
jsonName

string

這個欄位的 JSON 名稱。這個值是由通訊協定編譯器設定。如果使用者設定了「jsonName」選項，系統就會使用該選項的值否則，系統會將其轉換為駝峰式大小寫，從欄位名稱得出。
proto3Optional

boolean

如果為 true，則此為 proto3「選用」。proto3 欄位為選填欄位時，無論欄位類型為何，系統都會追蹤是否存在。

當 proto3Optional 為 true 時，這個欄位必須屬於其中一個項目，向這個欄位中的舊版 proto3 用戶端表明是否存在這個欄位。這是我們稱之為「合成」一，且這個欄位必須是唯一成員 (每個 proto3 選用欄位都有自己的合成資料)。合成單一項目僅存在於描述元中，不會產生任何 API。合成項目必須依照所有「真實」順序排序請多多包涵

針對訊息欄位，proto3Optional 不會建立任何語意變更，因為非重複訊息欄位一律會追蹤狀態。但依然會指出使用者是否為「非必要」的語意詳細資料不一定。這對於往返 .proto 檔案非常有幫助。為維持一致性，即使這不是追蹤狀態的必要資訊，訊息欄位也會提供合成項目。這點特別重要，因為剖析器無法分辨欄位是訊息或列舉，因此必須一律建立合成項目之一。

Proto2 選用欄位不會設定這個標記，因為它們已經用 LABEL_OPTIONAL 表示選用欄位。

標籤

列舉
LABEL_OPTIONAL 0 可保留，以免發生錯誤
LABEL_REPEATED
LABEL_REQUIRED 必要標籤只能在 proto2 中使用，因此在 proto3 和版本中明確禁止。在版本中，您可以使用 fieldPresence 功能取得這項行為。

類型

列舉
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 代碼分隔匯總。因為 proto2 之後，群組類型已淘汰且停止支援。不過，Proto3 實作仍應能剖析群組線格式，並將群組欄位視為不明欄位。在 Edition 中，可透過 messageEncoding 功能啟用群組線格式。
TYPE_MESSAGE 以長度分隔的匯總。
TYPE_BYTES 此為第 2 版的新功能。
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 使用 ZigZag 編碼。
TYPE_SINT64 使用 ZigZag 編碼。

EnumDescriptorProto

說明列舉類型。

JSON 表示法 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
欄位
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

說明列舉中的值。

JSON 表示法 
{
  "name": string,
  "number": integer
}
欄位
name

string
number

integer

OneofDescriptorProto

描述其中一種。

JSON 表示法 
{
  "name": string
}
欄位
name

string

PolicySchemaFieldDescription

提供 PolicySchema 中特定欄位的詳細資訊。

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

已淘汰，請改用 name 和 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

針對 PolicySchema 中的特定欄位，提供已知值的詳細資訊。

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

會叫用必要欄位的欄位值。如果 FieldCondition 為空白，表示凡是指派給這個欄位的值，都會觸發強制實行必要欄位。
requiredFields[]

string

因欄位條件而必須填寫的欄位。

FieldConstraints

任何範圍限制的相關資訊。

JSON 表示法 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
欄位
numericRangeConstraint

object (NumericRangeConstraint)

數值欄位的允許範圍。
uploadedFileConstraints

object (UploadedFileConstraints)

上傳檔案政策檔案的限制。如果存在這項政策，就必須上傳含這個 proto 所指定限制條件的檔案，讓系統擷取網址。

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

可針對某項設定上傳的檔案類型。

列舉
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

針對 PolicySchema 中的欄位中，提供與特定值相關的特別通知訊息。

JSON 表示法 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
欄位
field

string

僅供輸出。與通知相關聯的欄位名稱。
noticeValue

string

僅供輸出。有通知的欄位值。將欄位設為這個值時，可能需要使用者確認通知訊息，才能設定值。
noticeMessage

string

僅供輸出。通知訊息會與欄位值建立關聯。
acknowledgementRequired

boolean

僅供輸出。使用者是否必須先確認通知訊息，才能設定值。

TargetResource

目標資源類型

列舉
TARGET_RESOURCE_UNSPECIFIED 未指定的目標資源。
ORG_UNIT 機構單位目標資源。
GROUP 群組目標資源

PolicyApiLifecycle

生命週期資訊。

JSON 表示法 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
欄位
deprecatedInFavorOf[]

string

倘若這項政策因其他政策而遭到淘汰，則新政策的完整命名空間將會顯示在 PolicyAPI 中。只有在 policyApiLifecycleStage 為 API_DEPRECATED 時才能設定。
scheduledToDeprecatePolicies[]

string

對應至已淘汰 InFavorOf，該政策將因推出而已淘汰的舊政策完整命名空間。
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

指出 Policy API 目前的生命週期階段。
description

string

目前生命週期的說明。
endSupport

object (Date)

目前政策的結束日期。如果您在支援服務期過後嘗試修改政策，會導致要求錯誤 (400 錯誤)。只有在 policyApiLifecycleStage 為 API_DEPRECATED 時才能設定。

PolicyApiLifecycleEnum

政策 API 的生命週期階段。

列舉
API_UNSPECIFIED 未指定 Policy Api 生命週期。
API_PREVIEW 政策尚未生效，但會通知開發人員政策格式。這個階段可轉移至 API_DEVELOPEMNT 或 API_CURRENT。
API_DEVELOPMENT 政策可能會以回溯不相容的方式變更格式 (破壞性變更)。這個階段可轉移至 API_CURRENT 或 API_DEPRECATED。這應該用於僅限 TTs 推出的政策，或是向特定客戶推出，以供緊急使用。
API_CURRENT 官方格式的政策。政策能以回溯相容性變更格式 (非破壞性變更)。範例：這項政策可能會引入一個新欄位，當欄位遮罩妥善使用時，系統會將其視為非破壞性變更。這個階段可轉移至 API_DEPRECATED。
API_DEPRECATED 請停止使用這項政策。這項政策已淘汰，日後可能會移除。該政策很有可能是因新政策而引入了新政策。

日期

代表完整或部分的日曆日期，例如生日。您可以指明時段和時區，或者在其他地方指定時間或時區。日期以公曆為基準。可能代表下列其中一項：

  • 完整日期，具有非零的年、月和日值。
  • 日期為 0 的月份和日期，例如週年紀念日。
  • 有 1 年，第 0 個月卻為 0 天。
  • 年和月，但數字為零 (例如信用卡到期日)。

相關類型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
欄位
year

integer

日期的年份。這個值必須介於 1 至 9999，或 0 之間可指定不含年份的日期。
month

integer

一年中的月份。必須介於 1 到 12 之間，或 0 可以指定不含月份和日期的年份。
day

integer

一個月中的第幾天。這個值必須介於 1 至 31 之間，且有效的年份和月份；或 0 可讓您指定本身或年份和月份，但這些日期不明顯。

平台

這列舉了 Chrome 支援的不同平台群組。

列舉
PLATFORM_UNSPECIFIED 未指定的平台。
CHROME_OS ChromeOS。
CHROME_BROWSER OSX/Windows/Linux 版 Chrome 瀏覽器。
CHROME_BROWSER_FOR_ANDROID Android 版 Chrome 瀏覽器。
CHROME_BROWSER_FOR_IOS iOS 版 Chrome 瀏覽器。

方法

get

 透過資源名稱，取得客戶的特定政策結構定義。

list

 取得政策結構定義清單，其中符合指定客戶的指定篩選器值。