- 资源:PolicySchema
- AdditionalTargetKeyName
- FileDescriptorProto
- DescriptorProtoDescriptorProto
- FieldDescriptorProto
- 标签
- 类型
- EnumDescriptorProto
- EnumValueDescriptorProto
- OneofDescriptorProto
- PolicySchemaFieldDescription
- PolicySchemaFieldKnownValueDescription
- PolicySchemaFieldDependencies
- PolicySchemaRequiredItems
- FieldConstraints
- NumericRangeConstraint
- UploadedFileConstraints
- ContentType
- PolicySchemaNoticeDescription
- TargetResource
- PolicyApiLifecycle
- PolicyApiLifecycleEnum
- Date
- 方法
资源:PolicySchema
表示政策架构的资源。
JSON 表示法 |
---|
{ "name": string, "policyDescription": string, "additionalTargetKeyNames": [ { object ( |
字段 | |
---|---|
name |
格式:name=customers/{customer}/policySchemas/{schema_namespace} |
policyDescription |
仅供输出。有关可供用户使用的政策架构的说明。 |
additionalTargetKeyNames[] |
仅供输出。其他键名,将用于标识政策值的目标。指定 |
definition |
使用 proto 描述符的架构定义。 |
fieldDescriptions[] |
仅供输出。架构中每个字段的详细说明。 |
accessRestrictions[] |
仅供输出。与此政策相关的特定访问权限限制。 |
notices[] |
仅供输出。与在架构的特定字段中设置特定值相关的特别注意事项消息。 |
supportUri |
仅供输出。此架构的相关支持文章的 URI。 |
schemaName |
仅供输出。政策架构的完全限定名称。此值用于在调用 |
validTargetResources[] |
仅供输出。与政策的适用目标资源相关的信息。 |
policyApiLifecycle |
仅供输出。当前生命周期信息。 |
categoryTitle |
设置所属类别的标题。 |
AdditionalTargetKeyName
其他键名,将用于标识政策值的目标。
JSON 表示法 |
---|
{ "key": string, "keyDescription": string } |
字段 | |
---|---|
key |
键名称。 |
keyDescription |
键说明。 |
FileDescriptorProto
描述一个完整的 .proto 文件。
JSON 表示法 |
---|
{ "name": string, "package": string, "messageType": [ { object ( |
字段 | |
---|---|
name |
文件名(相对于源代码树的根目录) |
package |
例如“foo”“foo.bar”等。 |
messageType[] |
此文件中的所有顶级定义。 |
enumType[] |
|
syntax |
proto 文件的语法。支持的值包括“proto2”“proto3”和“版本”。 如果存在 |
DescriptorProto
描述消息类型。
JSON 表示法 |
---|
{ "name": string, "field": [ { object ( |
字段 | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
描述消息中的字段。
JSON 表示法 |
---|
{ "name": string, "number": integer, "label": enum ( |
字段 | |
---|---|
name |
|
number |
|
label |
|
type |
如果设置了 typeName,则无需设置此字段。如果同时设置了此属性和 typeName,则此字段必须是 TYPE_ENUM、TYPE_MESSAGE 或 TYPE_GROUP 之一。 |
typeName |
对于消息和枚举类型,这是类型的名称。如果名称以“.”开头,则表示它是完全限定的。否则,将使用类似 C++ 的范围规则来查找类型(即首先搜索此消息中的嵌套类型,然后搜索父消息中的嵌套类型,一直到根命名空间)。 |
defaultValue |
对于数字类型,包含值的原始文本表示形式。对于布尔值,请使用“true”或“false”。对于字符串,包含默认文本内容(不以任何方式转义)。对于字节,包含 C 转义值。所有大于等于 128 的字节都会转义。 |
oneofIndex |
如果设置了此字段,则提供所包含类型的 oneofDecl 列表中 oneof 的索引。此字段是其中之一。 |
jsonName |
此字段的 JSON 名称。该值由协议编译器设置。如果用户在此字段中设置了“jsonName”选项,系统将使用该选项的值。否则,可以通过将字段名称转换为驼峰式大小写的形式,从字段名称中推断出来。 |
proto3Optional |
如果为 true,表示 proto3“可选”。如果 proto3 字段是可选的,则无论字段类型如何,它都会跟踪存在状态。 如果 proto3Optional 为 true,此字段必须属于其中之一,以向旧的 proto3 客户端表明系统已跟踪此字段的存在状态。这个字段称为“合成”字段,并且此字段必须是它的唯一成员(每个 proto3 可选字段都有自己的合成字段)。合成 oneof 仅存在于描述符中,不会生成任何 API。合成 Oneof 必须在所有“真实”oneof 之后进行排序。 对于消息字段,proto3Optional 不会创建任何语义更改,因为非重复消息字段始终会跟踪存在状态。不过,它仍然指示用户是否写“可选”的语义细节。这对于往返 .proto 文件非常有用。为了保持一致性,我们也为消息字段提供了合成字段,尽管这不是必须跟踪在线状态。这一点尤为重要,因为解析器无法分辨某个字段是消息还是枚举,因此它必须始终创建一个合成字段。 Proto2 可选字段不会设置此标志,因为它们已通过 |
标签
枚举 | |
---|---|
LABEL_OPTIONAL |
0 保留为错误值 |
LABEL_REQUIRED |
|
LABEL_REPEATED |
类型
枚举 | |
---|---|
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 |
标记分隔的汇总。组类型已弃用,在 proto3 中不受支持。但是,Proto3 实现应该仍然能够解析群组传输格式,并将群组字段视为未知字段。 |
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 ( |
字段 | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
描述枚举中的值。
JSON 表示法 |
---|
{ "name": string, "number": integer } |
字段 | |
---|---|
name |
|
number |
|
OneofDescriptorProto
描述其中一个。
JSON 表示法 |
---|
{ "name": string } |
字段 | |
---|---|
name |
|
PolicySchemaFieldDescription
提供属于 PolicySchema 一部分的特定字段的详细信息。
JSON 表示法 |
---|
{ "field": string, "description": string, "inputConstraint": string, "knownValueDescriptions": [ { object ( |
字段 | |
---|---|
field |
仅供输出。与此说明相关联的字段的名称。 |
description |
已弃用。请改用 name 和 fieldDescription。字段的说明。 |
inputConstraint |
仅供输出。与字段的值关联的任何输入限制条件。 |
knownValueDescriptions[] |
仅供输出。如果该字段具有一组已知值,则此字段将提供这些值的说明。 |
nestedFieldDescriptions[] |
仅供输出。提供嵌套在此字段中的字段的说明(如果相应字段是定义多个字段的消息类型)。 |
fieldDependencies[] |
仅供输出。提供字段和值的列表。必须至少有一个字段具有对应的值,才能设置此字段。 |
requiredItems[] |
仅供输出。提供在此字段具有特定值时必须设置的字段列表。 |
defaultValue |
仅供输出。如果此政策未设置,则为客户端默认值。 |
name |
仅供输出。字段的名称。 |
fieldDescription |
仅供输出。字段的说明。 |
fieldConstraints |
仅供输出。与字段的值相关联的任何输入限制条件的信息。 |
PolicySchemaFieldKnownValueDescription
提供有关 PolicySchema 中特定字段允许的已知值的详细信息。
JSON 表示法 |
---|
{ "value": string, "description": string } |
字段 | |
---|---|
value |
仅供输出。可为字段设置的值的字符串表示。 |
description |
仅供输出。此值的额外说明。 |
PolicySchemaFieldDependencies
此字段及其值必须具备,才能设置另一个字段。
JSON 表示法 |
---|
{ "sourceField": string, "sourceFieldValue": string } |
字段 | |
---|---|
sourceField |
此字段所依赖的来源字段。 |
sourceFieldValue |
来源字段必须具有的值才能设置此字段。 |
PolicySchemaRequiredItems
根据此字段的值而变为必填字段。
JSON 表示法 |
---|
{ "fieldConditions": [ string ], "requiredFields": [ string ] } |
字段 | |
---|---|
fieldConditions[] |
触发必填字段强制执行的字段的值。空 fieldConditions 表示分配给此字段的任何值都会引发必填字段强制执行。 |
requiredFields[] |
根据字段条件而必须填写的字段。 |
FieldConstraints
有关任何范围限制的信息。
JSON 表示法 |
---|
{ "numericRangeConstraint": { object ( |
字段 | |
---|---|
numericRangeConstraint |
数字字段允许的范围。 |
uploadedFileConstraints |
对上传的文件政策的限制。如果存在,此政策会要求提供一个网址,该网址可通过上传具有此 proto 中指定的限制条件的文件来提取。 |
NumericRangeConstraint
对上限和/或下限的限制,必须至少设置一项。
JSON 表示法 |
---|
{ "minimum": string, "maximum": string } |
字段 | |
---|---|
minimum |
最小值。 |
maximum |
最大值。 |
UploadedFileConstraints
对上传的文件政策的限制。
JSON 表示法 |
---|
{
"supportedContentTypes": [
enum ( |
字段 | |
---|---|
supportedContentTypes[] |
可为设置上传的文件类型。 |
sizeLimitBytes |
为设置上传的文件大小上限(以字节为单位)。 |
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 |
仅供输出。与通知关联的字段名称。 |
noticeValue |
仅供输出。具有通知的字段的值。如果将此字段设为此值,用户可能需要确认通知消息才能设置该值。 |
noticeMessage |
仅供输出。与字段的值相关联的通知消息。 |
acknowledgementRequired |
仅供输出。用户是否需要先确认通知消息,然后才能设置值。 |
TargetResource
目标资源类型
枚举 | |
---|---|
TARGET_RESOURCE_UNSPECIFIED |
未指定的目标资源。 |
ORG_UNIT |
组织部门目标资源。 |
GROUP |
群组目标资源。 |
PolicyApiLifecycle
JSON 表示法 |
---|
{ "policyApiLifecycleStage": enum ( |
字段 | |
---|---|
policyApiLifecycleStage |
指明政策 API 的当前生命周期阶段。 |
description |
关于当前生命周期的说明。 |
endSupport |
当前政策的支持日期。 |
deprecatedInFavorOf[] |
如果此政策被弃用并由另一项政策取代,系统将会在 PolicyAPI 中显示新政策的完全限定命名空间。 |
PolicyApiLifecycleEnum
枚举 | |
---|---|
API_UNSPECIFIED |
未指定状态。 |
API_PREVIEW |
政策尚未生效,但开发者可提前了解广告格式。此阶段可以转移到 API_DEVELOPEMNT 或 API_CURRENT。 |
API_DEVELOPMENT |
政策可能会以不向后兼容的方式更改格式(破坏性更改)。此阶段可以转移到 API_CURRENT 或 API_DEPRECATED。此政策可用于仅面向 TT 发布的政策,或已面向选定客户发布的政策,供紧急使用。 |
API_CURRENT |
采用官方格式的政策。政策可以向后兼容的方式更改格式(非重大更改)。示例:如果正确使用字段掩码,此政策可能会引入一个被视为非重大更改的新字段。此阶段可以转移到 API_DEPRECATED。 |
API_DEPRECATED |
请停止使用此政策。此政策已被弃用,日后可能会/将会被移除。很可能是引入了新政策来取代此政策。 |
日期
表示整个或部分日历日期,例如生日。一天中的时间和时区要么在别处指定,要么不重要。该日期相对于公历。它可以表示以下其中一项:
- 包含非零年、月和日值的完整日期。
- 月份和日期,年份为 0(例如周年纪念日)。
- 单独的一年,零月零日。
- 年份和月份,日期为零(例如信用卡失效日期)。
相关类型:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
JSON 表示法 |
---|
{ "year": integer, "month": integer, "day": integer } |
字段 | |
---|---|
year |
日期中的年份。必须是 1 到 9999 之间的数字,如果使用 0,则可以指定不含年份的日期。 |
month |
一年中的某月。必须是 1 到 12 之间的数字,如果为 0,则表示不包含月份和日期。 |
day |
一个月中的第几天。必须是 1 到 31 之间的数字,并且对年份和月份有效,或者为 0 表示单独指定年份,或者在日期不重要的情况下指定年份和月份。 |
方法 |
|
---|---|
|
按资源名称获取客户的特定政策架构。 |
|
获取与指定客户的指定过滤条件值匹配的政策架构列表。 |