REST Resource: customers.policySchemas

Tài nguyên: PolicySchema

Tài nguyên đại diện cho một giản đồ chính sách.

Biểu diễn dưới dạng 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)
  ]
}
Trường
name

string

Định dạng: name=customer/{customer}/policySchemas/{schema_workspace}
policyDescription

string

Chỉ có đầu ra. Nội dung mô tả giản đồ chính sách về mức tiêu thụ của người dùng.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Chỉ có đầu ra. Tên khoá bổ sung sẽ được dùng để xác định mục tiêu của giá trị chính sách. Khi chỉ định policyTargetKey, mỗi khoá bổ sung được chỉ định ở đây sẽ phải được đưa vào bản đồ additionalTargetKeys.
definition

object (FileDescriptorProto)

Định nghĩa giản đồ bằng phần mô tả proto.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Chỉ có đầu ra. Nội dung mô tả chi tiết về từng trường là một phần của giản đồ. Bạn nên hiển thị các trường theo thứ tự trong danh sách này, chứ không phải theo số trường.
accessRestrictions[]

string

Chỉ có đầu ra. Các quy định hạn chế truy cập cụ thể liên quan đến chính sách này.
notices[]

object (PolicySchemaNoticeDescription)

Chỉ có đầu ra. Các thông báo đặc biệt liên quan đến việc đặt một số giá trị trong một số trường nhất định trong giản đồ.
supportUri

string

Chỉ có đầu ra. URI tới bài viết hỗ trợ có liên quan cho giản đồ này.
schemaName

string

Chỉ có đầu ra. Tên đủ điều kiện của giản đồ chính sách. Giá trị này dùng để điền vào trường policySchema trong PolicyValue khi gọi BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies hoặc BatchDeleteGroupPolicies.
validTargetResources[]

enum (TargetResource)

Chỉ có đầu ra. Thông tin về các tài nguyên mục tiêu có thể áp dụng cho chính sách.
policyApiLifecycle

object (PolicyApiLifecycle)

Chỉ có đầu ra. Thông tin về vòng đời hiện tại.
categoryTitle

string

Tiêu đề của danh mục chứa một chế độ cài đặt.
supportedPlatforms[]

enum (Platform)

Chỉ có đầu ra. Danh sách cho biết rằng chính sách sẽ chỉ áp dụng cho thiết bị/người dùng trên những nền tảng này.

AdditionalTargetKeyName

Tên khoá bổ sung sẽ được dùng để xác định mục tiêu của giá trị chính sách.

Biểu diễn dưới dạng JSON 
{
  "key": string,
  "keyDescription": string
}
Trường
key

string

Tên khoá.
keyDescription

string

Nội dung mô tả chính.

FileDescriptorProto

Mô tả một tệp .proto hoàn chỉnh.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Trường
name

string

tên tệp, so với gốc của cây nguồn
package

string

ví dụ: "foo", "foo.bar", v.v.
messageType[]

object (DescriptorProto)

Tất cả định nghĩa cấp cao nhất trong tệp này.
enumType[]

object (EnumDescriptorProto)
syntax

string

Cú pháp của tệp proto. Các giá trị được hỗ trợ là "proto2", "proto3" và "editions".

Nếu có edition, thì giá trị này phải là "phiên bản".

DescriptorProto

Mô tả một loại thông báo.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Trường
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Mô tả một trường trong thư.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Trường
name

string
number

integer
label

enum (Label)
type

enum (Type)

Nếu đã đặt typeName, thì bạn không cần đặt giá trị này. Nếu cả này và typeName được đặt, thì đây phải là một trong hai giá trị TYPE_ENUM, TYPE_MESSAGE hoặc TYPE_GROUP.
typeName

string

Đối với loại thông báo và loại enum, đây là tên của loại. Nếu tên bắt đầu bằng ".", thì tên đó đủ điều kiện. Nếu không, các quy tắc xác định phạm vi giống như C++ sẽ được dùng để tìm kiểu (tức là trước tiên, các kiểu lồng trong thông báo này được tìm kiếm, sau đó trong vùng chứa mẹ cho đến không gian tên gốc).
defaultValue

string

Đối với loại số, hãy chứa đại diện bằng văn bản gốc của giá trị. Đối với boolean, "true" hoặc "false". Đối với chuỗi, chứa nội dung văn bản mặc định (không được thoát theo bất kỳ cách nào). Đối với byte, hãy chứa giá trị thoát C. Tất cả các byte >= 128 đều được thoát.
oneofIndex

integer

Nếu được đặt, hãy cung cấp chỉ mục của một trong các giá trị này thuộc danh sách oneofdecl của loại chứa. Trường này là một thành phần của trường đó.
jsonName

string

Tên JSON của trường này. Giá trị do trình biên dịch giao thức đặt. Nếu người dùng đã đặt "jsonName" trên trường này, thì giá trị của lựa chọn đó sẽ được sử dụng. Nếu không, giá trị này được suy ra từ tên của trường bằng cách chuyển đổi trường đó theo quy ước camelCase.
proto3Optional

boolean

Nếu đúng, thì đây là "không bắt buộc" proto3. Khi trường proto3 là không bắt buộc, trường này sẽ theo dõi sự hiện diện bất kể loại trường.

Khi proto3optional có giá trị là true, trường này phải thuộc một trường nào đó để báo hiệu cho các ứng dụng khách proto3 cũ rằng sự hiện diện được theo dõi cho trường này. Đây được gọi là "mô-đun tổng hợp" oneof và trường này phải là thành phần duy nhất (mỗi trường không bắt buộc proto3 sẽ có một trường tổng hợp riêng). Các giá trị tổng hợp chỉ tồn tại trong phần mô tả và không tạo ra API nào. Phải sắp xếp các mặt hàng tổng hợp sau tất cả các mặt hàng là "thực" một trong hai.

Đối với các trường thông báo, proto3optional không tạo ra bất kỳ thay đổi nào về ngữ nghĩa, vì các trường thông báo không lặp lại luôn theo dõi sự hiện diện. Tuy nhiên, mã này vẫn cho biết chi tiết ngữ nghĩa về việc liệu người dùng có viết "không bắt buộc" hay không hoặc không. Cách này có thể hữu ích khi loại bỏ tệp .proto. Để đảm bảo tính nhất quán, chúng tôi cũng cung cấp cho các trường thông báo dưới dạng một trường tổng hợp, mặc dù không bắt buộc phải theo dõi sự hiện diện. Điều này đặc biệt quan trọng vì trình phân tích cú pháp không thể phân biệt một trường là thông báo hay enum, vì vậy, trình phân tích cú pháp phải luôn tạo một trường tổng hợp.

Các trường không bắt buộc của Proto2 không đặt cờ này vì các trường này đã cho biết là không bắt buộc bằng LABEL_OPTIONAL.

Hãng nhạc

Enum
LABEL_OPTIONAL 0 dành riêng cho lỗi
LABEL_REPEATED
LABEL_REQUIRED Bạn chỉ được phép sử dụng nhãn bắt buộc trong proto2. Trong proto3 và các Phiên bản, hành vi này bị nghiêm cấm rõ ràng. Trong Phiên bản, bạn có thể dùng tính năng fieldPresence để thực hiện hành vi này.

Loại

Enum
TYPE_DOUBLE 0 được dành riêng cho lỗi. Thứ tự không phù hợp do các nguyên nhân trước đây.
TYPE_FLOAT
TYPE_INT64 Không được mã hoá ZigZag. Số âm có kích thước là 10 byte. Sử dụng TYPE_SINT64 nếu có khả năng có giá trị âm.
TYPE_UINT64
TYPE_INT32 Không được mã hoá ZigZag. Số âm có kích thước là 10 byte. Sử dụng TYPE_SINT32 nếu có khả năng có giá trị âm.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Thông tin tổng hợp được phân tách bằng thẻ. group type không được dùng nữa và không được hỗ trợ sau proto2. Tuy nhiên, các hoạt động triển khai Proto3 vẫn có thể phân tích cú pháp định dạng dây nhóm và coi các trường nhóm là các trường không xác định. Trong Phiên bản, bạn có thể bật định dạng dây nhóm thông qua tính năng messageEncoding.
TYPE_MESSAGE Tệp tổng hợp được phân cách theo độ dài.
TYPE_BYTES Tính năng mới trong phiên bản 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Sử dụng mã hoá ZigZag.
TYPE_SINT64 Sử dụng mã hoá ZigZag.

EnumDescriptorProto

Mô tả một loại enum.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Trường
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Mô tả một giá trị trong một enum.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "number": integer
}
Trường
name

string
number

integer

OneofDescriptorProto

Mô tả một trong số đó.

Biểu diễn dưới dạng JSON 
{
  "name": string
}
Trường
name

string

PolicySchemaFieldDescription

Cung cấp thông tin chi tiết cho một trường cụ thể thuộc PolicySchema.

Biểu diễn dưới dạng 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)
  }
}
Trường
field

string

Chỉ có đầu ra. Tên của trường cho liên kết với mô tả này.
description
(deprecated)

string

Không dùng nữa. Thay vào đó, hãy sử dụng tên và trườngMô tả. Nội dung mô tả cho trường.
inputConstraint

string

Chỉ có đầu ra. Mọi quy tắc ràng buộc đối với dữ liệu đầu vào được liên kết với các giá trị cho trường này.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Chỉ có đầu ra. Nếu trường này có một tập hợp các giá trị đã biết, thì trường này sẽ cung cấp nội dung mô tả cho các giá trị đó.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Chỉ có đầu ra. Cung cấp thông tin mô tả về các trường lồng trong trường này nếu trường đó là một loại thông báo xác định nhiều trường. Bạn nên hiển thị các trường theo thứ tự trong danh sách này, chứ không phải theo số trường.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Chỉ có đầu ra. Cung cấp danh sách các trường và giá trị. Ít nhất một trong các trường phải có giá trị tương ứng thì trường này mới được phép đặt.
requiredItems[]

object (PolicySchemaRequiredItems)

Chỉ có đầu ra. Cung cấp danh sách các trường bắt buộc phải thiết lập nếu trường này có một giá trị nhất định.
defaultValue

value (Value format)

Chỉ có đầu ra. Theo giá trị mặc định của ứng dụng, nếu bạn không đặt chính sách này.
name

string

Chỉ có đầu ra. Tên của trường.
fieldDescription

string

Chỉ có đầu ra. Nội dung mô tả về trường.
fieldConstraints

object (FieldConstraints)

Chỉ có đầu ra. Thông tin về mọi điều kiện ràng buộc đối với dữ liệu đầu vào được liên kết với các giá trị cho trường này.

PolicySchemaFieldKnownValueDescription

Cung cấp thông tin chi tiết về một giá trị đã biết được phép cho một trường cụ thể trong PolicySchema.

Biểu diễn dưới dạng JSON 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Trường
value

string

Chỉ có đầu ra. Chuỗi đại diện của giá trị có thể đặt cho trường.
description

string

Chỉ có đầu ra. Nội dung mô tả bổ sung về giá trị này.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Chỉ có đầu ra. Điều kiện trường bắt buộc để giá trị này hợp lệ.

PolicySchemaFieldDependencies

Trường và giá trị mà trường này phải có cho một trường khác được phép đặt.

Biểu diễn dưới dạng JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Trường
sourceField

string

Trường nguồn mà trường này phụ thuộc vào.
sourceFieldValue

string

Giá trị mà trường nguồn phải có cho trường này để được phép đặt.

PolicySchemaRequiredItems

Các trường sẽ trở thành bắt buộc dựa trên giá trị của trường này.

Biểu diễn dưới dạng JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Trường
fieldConditions[]

string

(Các) giá trị của trường kích hoạt quá trình thực thi tại trường bắt buộc. Trường điều kiện trường trống ngụ ý rằng mọi giá trị được chỉ định cho trường này sẽ kích hoạt quy trình thực thi trường bắt buộc.
requiredFields[]

string

Các trường bắt buộc do các điều kiện của trường.

FieldConstraints

Thông tin về mọi giới hạn đối với phạm vi.

Biểu diễn dưới dạng JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Trường
numericRangeConstraint

object (NumericRangeConstraint)

Phạm vi cho phép dành cho các trường số.
uploadedFileConstraints

object (UploadedFileConstraints)

Các quy tắc ràng buộc đối với tệp đã tải lên của chính sách về tệp. Nếu có, chính sách này yêu cầu một URL có thể tìm nạp được bằng cách tải tệp lên kèm theo các quy tắc ràng buộc được chỉ định trong proto này.

NumericRangeConstraint

Một quy tắc ràng buộc trên giới hạn trên và/hoặc giới hạn dưới, trong đó có ít nhất một quy tắc ràng buộc đang được đặt.

Biểu diễn dưới dạng JSON 
{
  "minimum": string,
  "maximum": string
}
Trường
minimum

string (int64 format)

Giá trị nhỏ nhất.
maximum

string (int64 format)

Giá trị tối đa.

UploadedFileConstraints

Các quy tắc ràng buộc đối với tệp đã tải lên của chính sách về tệp.

Biểu diễn dưới dạng JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Trường
supportedContentTypes[]

enum (ContentType)

Các loại tệp có thể được tải lên cho một chế độ cài đặt.
sizeLimitBytes

string (int64 format)

Giới hạn kích thước của các tệp đã tải lên cho một chế độ cài đặt, tính bằng byte.

ContentType

Các loại tệp có thể được tải lên cho một chế độ cài đặt.

Enum
CONTENT_TYPE_UNSPECIFIED Loại nội dung không xác định.
CONTENT_TYPE_PLAIN_TEXT Văn bản thuần túy.
CONTENT_TYPE_HTML HTML.
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF Ảnh GIF.
CONTENT_TYPE_IMAGE_PNG PNG.
CONTENT_TYPE_JSON JSON.
CONTENT_TYPE_ZIP ZIP.
CONTENT_TYPE_GZIP Tệp ZIP.
CONTENT_TYPE_CSV CSV.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP WEBP.

PolicySchemaNoticeDescription

Cung cấp các thông báo đặc biệt liên quan đến một giá trị cụ thể trong một trường thuộc PolicySchema.

Biểu diễn dưới dạng JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Trường
field

string

Chỉ có đầu ra. Tên trường liên kết với thông báo.
noticeValue

string

Chỉ có đầu ra. Giá trị của trường có thông báo. Khi đặt trường này thành giá trị này, người dùng có thể phải xác nhận nội dung thông báo để đặt giá trị đó.
noticeMessage

string

Chỉ có đầu ra. Nội dung thông báo liên kết với giá trị của trường.
acknowledgementRequired

boolean

Chỉ có đầu ra. Liệu người dùng có cần xác nhận nội dung thông báo trước khi có thể đặt giá trị này hay không.

TargetResource

Loại tài nguyên mục tiêu

Enum
TARGET_RESOURCE_UNSPECIFIED Tài nguyên mục tiêu chưa được chỉ định.
ORG_UNIT Tài nguyên nhắm mục tiêu của Đơn vị tổ chức.
GROUP tài nguyên mục tiêu của nhóm.

PolicyApiLifecycle

Thông tin về vòng đời.

Biểu diễn dưới dạng JSON 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
Trường
deprecatedInFavorOf[]

string

Trong trường hợp chính sách này không được dùng nữa và thay vào đó là một chính sách khác, (các) không gian tên đủ điều kiện của các chính sách mới sẽ xuất hiện trong PolicyAPI. Chỉ có thể đặt nếu policyApiLifecycleContext được sử dụng là API_DEPREDeprecated.
scheduledToDeprecatePolicies[]

string

Tương ứng với deprecatedInFavorOf, (các) vùng chứa tên đủ điều kiện của các chính sách cũ sẽ không được dùng nữa do chính sách này ra mắt.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Cho biết giai đoạn vòng đời hiện tại của API chính sách.
description

string

Nội dung mô tả về vòng đời hiện tại.
endSupport

object (Date)

Ngày kết thúc hỗ trợ chính sách hiện tại. Việc cố gắng sửa đổi một chính sách sau ngày ngừng hỗ trợ chính sách đó sẽ dẫn đến Yêu cầu không hợp lệ (lỗi 400). Chỉ có thể đặt nếu policyApiLifecycleContext được sử dụng là API_DEPREDeprecated.

PolicyApiLifecycleEnum

Giai đoạn vòng đời của API chính sách.

Enum
API_UNSPECIFIED Vòng đời API chính sách không xác định.
API_PREVIEW Chính sách chưa hoạt động nhưng đang thông báo cho nhà phát triển về định dạng. Giai đoạn này có thể chuyển tới API_DESdkMNT hoặc API_CURRENT.
API_DEVELOPMENT Chính sách có thể thay đổi định dạng theo cách không tương thích ngược (thay đổi có thể gây lỗi). Giai đoạn này có thể chuyển sang API_CURRENT hoặc API_DEPRE Yêu cầu Chính sách này có thể áp dụng cho các chính sách chỉ áp dụng cho TT hoặc được áp dụng cho các khách hàng được chọn để sử dụng trong trường hợp khẩn cấp.
API_CURRENT Chính sách ở định dạng chính thức. Chính sách có thể thay đổi định dạng theo cách tương thích ngược (thay đổi không gây lỗi). Ví dụ: chính sách này có thể giới thiệu một trường mới, được coi là thay đổi không gây ra lỗi, khi mặt nạ trường được sử dụng đúng cách. Giai đoạn này có thể chuyển sang API_DEPRE Tỷ lệ mắc lỗi.
API_DEPRECATED Vui lòng ngừng sử dụng chính sách này. Chính sách này không được dùng nữa và có thể/sẽ bị loại bỏ trong tương lai. Rất có thể chúng tôi đã đưa ra một chính sách mới để thay thế cho chính sách này.

Ngày

Đại diện cho toàn bộ hoặc một phần ngày theo lịch, chẳng hạn như ngày sinh nhật. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không đáng kể. Ngày này có liên quan đến Lịch Gregory. Thông tin này có thể là một trong những trường hợp sau:

  • Ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0.
  • Tháng và ngày, thể hiện giá trị năm 0 (ví dụ: ngày kỷ niệm).
  • Một năm riêng biệt, tháng không tháng và ngày không tháng.
  • Năm và tháng, không có ngày (ví dụ: ngày hết hạn thẻ tín dụng).

Các loại có liên quan:

Biểu diễn dưới dạng JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Trường
year

integer

Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 để chỉ định ngày không có năm.
month

integer

Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 để chỉ định một năm không có tháng và ngày.
day

integer

Ngày trong tháng. Phải có giá trị từ 1 đến 31 và có giá trị hợp lệ trong năm và tháng, hoặc bằng 0 để chỉ định một năm độc lập hoặc là một năm và tháng mà ngày không quan trọng.

Nền tảng

Đây là danh sách các nhóm nền tảng mà Chrome được hỗ trợ.

Enum
PLATFORM_UNSPECIFIED Nền tảng chưa được chỉ định.
CHROME_OS ChromeOS.
CHROME_BROWSER Trình duyệt Chrome dành cho OSX/Windows/Linux.
CHROME_BROWSER_FOR_ANDROID Trình duyệt Chrome dành cho Android.
CHROME_BROWSER_FOR_IOS Trình duyệt Chrome dành cho iOS.

Phương thức

get

 Nhận giản đồ chính sách cụ thể cho khách hàng theo tên tài nguyên của khách hàng.

list

 Lấy danh sách giản đồ chính sách khớp với một giá trị bộ lọc đã chỉ định cho một khách hàng nhất định.