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 が存在する場合、この値は「editions」にする必要があります。

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 リストにある oneof のインデックスを指定します。このフィールドは oneof のメンバーです。
jsonName

string

このフィールドの JSON 名。値はプロトコル コンパイラによって設定されます。ユーザーが "jsonName" を設定している場合、オプションを指定しなければ、そのオプションの値が使用されます。それ以外の場合は、キャメルケースに変換することでフィールド名から推測します。
proto3Optional

boolean

true の場合、これは proto3 の「オプション」です。proto3 フィールドが省略可能な場合、フィールド タイプに関係なくプレゼンスが追跡されます。

proto3Optional が true の場合、このフィールドは oneof に属している必要があります。これは、このフィールドのプレゼンスが追跡されていることを古い proto3 クライアントに知らせるためです。これは「合成」と呼ばれ、oneof であり、このフィールドはその唯一のメンバーでなければなりません（proto3 の各オプション フィールドには、独自の合成 oneof が割り当てられます）。合成 oneof は記述子にのみ存在し、API は生成しません。合成 oneof はすべての「real」の後に並べる必要がありますoneofs。

メッセージ フィールドの場合、繰り返し以外のメッセージ フィールドは常にプレゼンスを追跡するため、proto3Optional はセマンティックな変更を行いません。ただし、ユーザーが「オプション」と記述したかどうかのセマンティックな詳細は示しています。判断できますこれは .proto ファイルのラウンド トリップに役立ちます。一貫性を保つために、メッセージ フィールドには、存在を追跡する必要はありませんが、合成 oneof も付与しています。パーサーはフィールドがメッセージか列挙型かを判断できないため、常に合成されたフィールドを作成する必要があります。そのため、これは特に重要です。

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 の実装では、グループ ワイヤー形式を解析し、グループ フィールドを不明なフィールドとして扱うことができます。エディションでは、messageEncoding 機能を使用してグループ転送形式を有効にできます。
TYPE_MESSAGE 長さで区切られた集計。
TYPE_BYTES バージョン 2 で追加されました。
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 ジグザグ エンコードを使用します。
TYPE_SINT64 ジグザグ エンコードを使用します。

EnumDescriptorProto

列挙型を表します。

JSON 表現 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
フィールド
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

列挙型内の値を記述します。

JSON 表現 
{
  "name": string,
  "number": integer
}
フィールド
name

string
number

integer

OneofDescriptorProto

oneof を記述します。

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)

出力専用。フィールドと値のリストを提供します。このフィールドを設定できるようにするには、少なくとも 1 つのフィールドに対応する値が必要です。
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

必須フィールドを適用するフィールドの値。空の fieldConditions は、このフィールドに割り当てられた値によって必須フィールドが適用されることを意味します。
requiredFields[]

string

フィールド条件の結果として必要となるフィールド。

FieldConstraints

範囲制約に関する情報。

JSON 表現 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
フィールド
numericRangeConstraint

object (NumericRangeConstraint)

数値フィールドの許容範囲。
uploadedFileConstraints

object (UploadedFileConstraints)

ファイル ポリシーでアップロードされたファイルに対する制約。このポリシーが存在する場合、このポリシーには、この proto で指定された制約を持つファイルをアップロードすることで取得できる URL が必要です。

NumericRangeConstraint

上限または下限の制約。少なくとも 1 つが設定されます。

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 できます。
CONTENT_TYPE_ZIP ZIP
CONTENT_TYPE_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

predictedInFavorOf に対応する、このポリシーの導入により非推奨になる古いポリシーの完全修飾名前空間。
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

ポリシー API の現在のライフサイクル ステージを示します。
description

string

現在のライフサイクルに関する説明。
endSupport

object (Date)

現在のポリシーのサポート終了日。サポート終了日以降にポリシーを変更しようとすると、不正なリクエスト（400 エラー）が発生します。policyApiLifecycleStage が API_DEPRECATED の場合にのみ設定できます。

PolicyApiLifecycleEnum

Policy API のライフサイクル ステージ。

列挙型
API_UNSPECIFIED ポリシー API のライフサイクルが指定されていません。
API_PREVIEW ポリシーはまだ機能していませんが、デベロッパーに形式についてお知らせしています。このステージは API_DEVELOPEMNT または 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 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。1～31 で、その年と月に対して有効である必要があります。または、日が重要でない場合に、年のみか年と月を指定するには 0 にする必要があります。

プラットフォーム

これは、Chrome がサポートされているさまざまなプラットフォーム グループの列挙です。

列挙型
PLATFORM_UNSPECIFIED プラットフォームが指定されていません。
CHROME_OS ChromeOS です。
CHROME_BROWSER OS X/Windows/Linux 版 Chrome ブラウザ。
CHROME_BROWSER_FOR_ANDROID Android 向け Chrome ブラウザ。
CHROME_BROWSER_FOR_IOS iOS 版 Chrome ブラウザ。

メソッド

get

 リソース名で顧客の特定のポリシー スキーマを取得します。

list

 指定した顧客のフィルタ値に一致するポリシー スキーマのリストを取得します。