REST Resource: customers.policySchemas

Tài nguyên: PolicySchema

Tài nguyên đại diện cho 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
}
Trường
name

string

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

string

Chỉ có đầu ra. Nội dung mô tả về giản đồ chính sách đối với mức sử dụng 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 phải được đưa vào bản đồ additionalTargetKeys.
definition

object (FileDescriptorProto)

Định nghĩa giản đồ bằng cách sử dụ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 thuộc giản đồ.
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ị nhất định trong một số trường nhất định trong giản đồ.
supportUri

string

Chỉ có đầu ra. URI đến bài viết hỗ trợ 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 được dùng để điền vào trường policySchema trong PolicyValue khi gọi orgunits.batchInherit orgunits.batchModify groups.batchModify hoặc groups.batchDelete.
validTargetResources[]

enum (TargetResource)

Chỉ có đầu ra. Thông tin về các tài nguyên mục tiêu hiện hành 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.

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, 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 một thông báo.

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 thuộc tính này. Nếu cả this và typeName đều được đặt, thì đây phải là TYPE_ENUM, TYPE_MESSAGE hoặc TYPE_GROUP.
typeName

string

Đối với loại thông báo và 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 phạm vi giống như C++ sẽ được dùng để tìm loại (tức là trước tiên, hệ thống sẽ tìm kiếm loại lồng nhau trong thông báo này, sau đó sẽ tìm kiếm trong thư mục mẹ cho đến không gian tên gốc).
defaultValue

string

Đối với các loại số, chứa bản trình bày văn bản gốc của giá trị. Đối với giá trị boolean, "true" hoặc "false". Đối với chuỗi, hãy chứa nội dung văn bản mặc định (không thoát theo bất kỳ cách nào). Đối với các 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 số các thuộc tính trong danh sách oneofDecl của loại chứa. Trường này là thành phần của trường đó.
jsonName

string

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

boolean

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

Khi proto3optional là true, trường này phải thuộc về một trường để 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. Trường này được gọi là một trong số "tổng hợp" và trường này phải là thành phần duy nhất của nó (mỗi trường tuỳ chọn proto3 có một trường tổng hợp riêng). Dữ liệu tổng hợp chỉ tồn tại trong phần mô tả và không tạo ra bất kỳ API nào. Thuộc tính tổng hợp phải được sắp xếp theo thứ tự sau tất cả thành phần "thực".

Đố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 thông tin chi tiết về ngữ nghĩa về việc người dùng có viết "không bắt buộc" hay không. Thao tác này có thể hữu ích khi khứ hồi 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 một giá trị tổng hợp, mặc dù bạn 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 tích cú pháp để nhận biết một trường là thông điệp hay enum. Vì vậy, công cụ này phải luôn tạo một trường dữ liệu tổng hợp.

Các trường không bắt buộc Proto2 không đặt cờ này vì chúng đã biểu thị là không bắt buộc bằng LABEL_OPTIONAL.

Nhãn

Enum
LABEL_OPTIONAL 0 được dành riêng cho lỗi
LABEL_REQUIRED
LABEL_REPEATED

Loại

Enum
TYPE_DOUBLE 0 được dành riêng cho các lỗi. Đơn đặt hàng lạ vì lý do trước đây.
TYPE_FLOAT
TYPE_INT64 Không được mã hoá ZigZag. Số âm mất 10 byte. Sử dụng TYPE_SINT64 nếu có khả năng có các giá trị âm.
TYPE_UINT64
TYPE_INT32 Không được mã hoá ZigZag. Số âm mất 10 byte. Sử dụng TYPE_SINT32 nếu có khả năng có các giá trị âm.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Dữ liệu tổng hợp được phân tách bằng thẻ. Loại nhóm không được dùng nữa và không được hỗ trợ trong proto3. Tuy nhiên, việc 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.
TYPE_MESSAGE Tệp tổng hợp được phân tá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 phương thức mã hoá ZigZag.
TYPE_SINT64 Sử dụng phương thức 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ố các yếu tố sau.

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 về 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 trường liên kết với nội dung 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ườngDescription. Nội dung mô tả cho trường.
inputConstraint

string

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

object (PolicySchemaFieldKnownValueDescription)

Chỉ có đầu ra. Nếu trường 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ị này.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Chỉ có đầu ra. Cung cấp nội dung mô tả về các trường lồng trong trường này, nếu trường đó là loại thông báo xác định nhiều 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 để có thể đặt trường này.
requiredItems[]

object (PolicySchemaRequiredItems)

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

value (Value format)

Chỉ có đầu ra. Ứng dụng sẽ mặc định 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 quy tắc ràng buộc đầu vào liên quan đến các giá trị của trường.

PolicySchemaFieldKnownValueDescription

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

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

string

Chỉ có đầu ra. Giá trị trả về chuỗi của giá trị có thể được đặt cho trường.
description

string

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

PolicySchemaFieldDependencies

Trường và giá trị của trường này phải có ở 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 việc thực thi trường bắt buộc. Trường điều kiện trống ngụ ý rằng bất kỳ giá trị nào được chỉ định cho trường này sẽ kích hoạt việc 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 quy tắc ràng buộc đố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 được phép cho trường số.
uploadedFileConstraints

object (UploadedFileConstraints)

Các quy tắc ràng buộc đối với tệp chính sách tệp đã tải lên. 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 có các điều kiện ràng buộc được chỉ định trong giao thức này.

NumericRangeConstraint

Một điều kiện ràng buộc đối với giới hạn trên và/hoặc giới hạn dưới, với ít nhất một giới hạn đượ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 chính sách tệp đã tải lên.

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ể 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ể tải lên cho một chế độ cài đặt.

Enum
CONTENT_TYPE_UNSPECIFIED Loại nội dung chưa được chỉ định.
CONTENT_TYPE_PLAIN_TEXT Văn bản thuần tuý.
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 Tệp ZIP.
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP WEBP (Quản lý trang web)

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 thì mới có thể đặt giá trị này.
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 thông báo trước khi đặt giá trị hay không.

TargetResource

Nhắm đến loại tài nguyên

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

PolicyApiLifecycle

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

enum (PolicyApiLifecycleEnum)

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

string

Mô tả về vòng đời hiện tại.
endSupport

object (Date)

Ngày kết thúc hỗ trợ cho chính sách hiện tại.
deprecatedInFavorOf[]

string

Trong trường hợp chính sách này không được dùng nữa và được thay thế bằng 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 như sẽ hiển thị trong PolicyAPI.

PolicyApiLifecycleEnum

Enum
API_UNSPECIFIED chưa xác định.
API_PREVIEW Chính sách chưa có hiệu lực nhưng sẽ thông báo cho nhà phát triển về định dạng. Giai đoạn này có thể chuyển sang API_DE trìMNT 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 (có thể gây lỗi thay đổi). Giai đoạn này có thể chuyển sang API_CURRENT hoặc API_DEPREWEEK. Bạn có thể sử dụng tính năng này cho những chính sách chỉ áp dụng cho TT hoặc mới triển khai cho một số khách hàng được chọn cho trường hợp 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ể đưa ra một trường mới được coi là thay đổi không gây lỗi khi sử dụng mặt nạ trường đúng cách. Giai đoạn này có thể chuyển sang API_DEPREWEEK.
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òn được dùng nữa và có thể/sẽ bị loại bỏ trong tương lai. Nhiều khả năng là một chính sách mới đã được đưa ra để thay thế 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. 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 Dương lịch. Điều này có thể đại diện cho một trong những điều 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, với năm 0 (ví dụ: ngày kỷ niệm).
  • Chỉ có một năm, có một tháng không có ngày nào.
  • 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 tháng. Phải từ 1 đến 9999 hoặc 0 để chỉ định ngày không có năm.
month

integer

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

integer

Ngày trong tháng. Giá trị phải từ 1 đến 31 và có giá trị trong năm và tháng, hoặc 0 để chỉ định một năm hoặc một năm và tháng không có ngày quan trọng.

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 họ.

list

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