REST Resource: customers.policySchemas

Resource: PolicySchema

Resource yang mewakili skema kebijakan.

Representasi 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)
  ]
}
Kolom
name

string

Format: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Hanya output. Deskripsi skema kebijakan untuk konsumsi pengguna.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Hanya output. Nama kunci tambahan yang akan digunakan untuk mengidentifikasi target nilai kebijakan. Saat menentukan policyTargetKey, setiap kunci tambahan yang ditentukan di sini harus disertakan dalam peta additionalTargetKeys.
definition

object (FileDescriptorProto)

Definisi skema menggunakan deskriptor proto.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Hanya output. Deskripsi mendetail tentang setiap kolom yang merupakan bagian dari skema. Kolom direkomendasikan untuk ditampilkan menurut urutan dalam daftar ini, bukan berdasarkan nomor kolom.
accessRestrictions[]

string

Hanya output. Batasan akses khusus yang terkait dengan kebijakan ini.
notices[]

object (PolicySchemaNoticeDescription)

Hanya output. Pesan pemberitahuan khusus yang terkait dengan setelan nilai tertentu di kolom tertentu dalam skema.
supportUri

string

Hanya output. URI ke artikel dukungan terkait untuk skema ini.
schemaName

string

Hanya output. Nama skema kebijakan yang sepenuhnya memenuhi syarat. Nilai ini digunakan untuk mengisi kolom policySchema di PolicyValue saat memanggil BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies atau BatchDeleteGroupPolicies.
validTargetResources[]

enum (TargetResource)

Hanya output. Informasi tentang resource target yang berlaku untuk kebijakan.
policyApiLifecycle

object (PolicyApiLifecycle)

Hanya output. Informasi siklus proses saat ini.
categoryTitle

string

Judul kategori tempat setelan berada.
supportedPlatforms[]

enum (Platform)

Hanya output. Daftar ini menunjukkan bahwa kebijakan hanya akan berlaku untuk perangkat/pengguna di platform tersebut.

AdditionalTargetKeyName

Nama kunci tambahan yang akan digunakan untuk mengidentifikasi target nilai kebijakan.

Representasi JSON 
{
  "key": string,
  "keyDescription": string
}
Kolom
key

string

Nama kunci.
keyDescription

string

Deskripsi kunci.

FileDescriptorProto

Menjelaskan file .proto yang lengkap.

Representasi JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Kolom
name

string

nama file, relatif terhadap akar pohon sumber
package

string

mis. "foo", "foo.bar", dll.
messageType[]

object (DescriptorProto)

Semua definisi tingkat atas dalam file ini.
enumType[]

object (EnumDescriptorProto)
syntax

string

Sintaksis file proto. Nilai yang didukung adalah "proto2", "proto3", dan "edisi".

Jika edition ada, nilai ini harus berupa "edisi".

DescriptorProto

Menjelaskan jenis pesan.

Representasi JSON 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Kolom
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Mendeskripsikan kolom dalam pesan.

Representasi JSON 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Kolom
name

string
number

integer
label

enum (Label)
type

enum (Type)

Jika typeName disetel, ini tidak perlu disetel. Jika ini dan typeName ditetapkan, keduanya harus berupa salah satu dari TYPE_ENUM, TYPE_MESSAGE, atau TYPE_GROUP.
typeName

string

Untuk jenis pesan dan enum, ini adalah nama jenis. Jika nama diawali dengan '.', berarti nama tersebut sepenuhnya memenuhi syarat. Jika tidak, aturan pencakupan yang mirip C++ akan digunakan untuk menemukan jenis (yaitu pertama-tama jenis yang disusun bertingkat dalam pesan ini ditelusuri, lalu di dalam induk, hingga namespace root).
defaultValue

string

Untuk jenis numerik, berisi representasi teks asli dari nilai. Untuk boolean, "true" atau "false". Untuk string, berisi konten teks default (tidak di-escape dengan cara apa pun). Untuk byte, berisi nilai escape C. Semua byte >= 128 di-escape.
oneofIndex

integer

Jika ditetapkan, memberikan indeks salah satu dalam daftar oneofDecl jenis yang memuat. Kolom ini adalah anggota dari opsi tersebut.
jsonName

string

Nama JSON kolom ini. Nilai ditetapkan oleh compiler protokol. Jika pengguna telah menetapkan "jsonName" di kolom ini, nilai opsi tersebut akan digunakan. Jika tidak, data tersebut disimpulkan dari nama kolom dengan mengonversinya menjadi camelCase.
proto3Optional

boolean

Jika true (benar), ini adalah proto3 "opsional". Jika kolom proto3 bersifat opsional, kolom tersebut akan melacak kehadiran, terlepas dari jenis kolomnya.

Jika proto3Optional bernilai benar, kolom ini harus menjadi milik salah satu untuk memberi tahu klien proto3 lama bahwa kehadiran dilacak untuk kolom ini. yang satu ini dikenal sebagai satu, dan kolom ini harus merupakan satu-satunya anggotanya (setiap kolom opsional proto3 mendapatkan satu-satunya yang sintetis). Salah satu sintetis hanya ada di deskriptor, dan tidak menghasilkan API apa pun. Produk sintetis harus diurutkan setelah semua kata "asli" satu.

Untuk kolom pesan, proto3Optional tidak membuat perubahan semantik apa pun karena kolom pesan yang tidak berulang selalu melacak kehadiran. Namun, hal ini masih menunjukkan detail semantik tentang apakah pengguna menulis "opsional" atau tidak atau tidak. Ini dapat berguna untuk membulatkan file .proto. Agar konsisten, kami juga memberikan kolom pesan sintetis, meskipun tidak diwajibkan untuk melacak kehadiran. Hal ini sangat penting karena parser tidak dapat mengetahui apakah kolom merupakan pesan atau enum, sehingga parser harus selalu membuat yang sintetis.

Kolom opsional Proto2 tidak menetapkan tanda ini, karena sudah menunjukkan opsional dengan LABEL_OPTIONAL.

Label

Enum
LABEL_OPTIONAL 0 dicadangkan untuk error
LABEL_REPEATED
LABEL_REQUIRED Label yang diperlukan hanya diizinkan dalam proto2. Dalam proto3 dan Edisi, hal ini dilarang secara eksplisit. Di Edisi, fitur fieldPresence dapat digunakan untuk mendapatkan perilaku ini.

Jenis

Enum
TYPE_DOUBLE Angka 0 dicadangkan untuk error. Urutannya aneh karena alasan historis.
TYPE_FLOAT
TYPE_INT64 Tidak dienkode ke ZigZag. Bilangan negatif mengambil 10 byte. Gunakan TYPE_SINT64 jika kemungkinan nilai negatif.
TYPE_UINT64
TYPE_INT32 Tidak dienkode ke ZigZag. Bilangan negatif mengambil 10 byte. Gunakan TYPE_SINT32 jika memungkinkan untuk nilai negatif.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Agregat yang dipisahkan tag. jenis grup tidak digunakan lagi dan tidak didukung setelah proto2. Namun, implementasi Proto3 harus tetap dapat mengurai format group wire dan memperlakukan kolom grup sebagai kolom yang tidak diketahui. Di Edisi, format group wire dapat diaktifkan melalui fitur messageEncoding.
TYPE_MESSAGE Agregat yang dibatasi panjang.
TYPE_BYTES Baru di versi 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Menggunakan encoding ZigZag.
TYPE_SINT64 Menggunakan encoding ZigZag.

EnumDescriptorProto

Menjelaskan jenis enum.

Representasi JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Kolom
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Menjelaskan nilai dalam enum.

Representasi JSON 
{
  "name": string,
  "number": integer
}
Kolom
name

string
number

integer

OneofDescriptorProto

Menjelaskan salah satunya.

Representasi JSON 
{
  "name": string
}
Kolom
name

string

PolicySchemaFieldDescription

Memberikan informasi mendetail untuk kolom tertentu yang merupakan bagian dari PolicySchema.

Representasi 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)
  }
}
Kolom
field

string

Hanya output. Nama kolom untuk dikaitkan dengan deskripsi ini.
description
(deprecated)

string

Tidak digunakan lagi. Sebagai gantinya, gunakan nama dan fieldDescription. Deskripsi untuk kolom.
inputConstraint

string

Hanya output. Batasan input apa pun yang terkait dengan nilai kolom.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Hanya output. Jika kolom memiliki kumpulan nilai yang diketahui, kolom ini akan memberikan deskripsi untuk nilai tersebut.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Hanya output. Memberikan deskripsi kolom yang disarangkan dalam kolom ini, jika kolom adalah jenis pesan yang menentukan beberapa kolom. Kolom direkomendasikan untuk ditampilkan menurut urutan dalam daftar ini, bukan berdasarkan nomor kolom.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Hanya output. Memberikan daftar kolom dan nilai. Setidaknya salah satu kolom harus memiliki nilai yang sesuai agar kolom ini dapat ditetapkan.
requiredItems[]

object (PolicySchemaRequiredItems)

Hanya output. Memberikan daftar kolom yang harus ditetapkan jika kolom ini memiliki nilai tertentu.
defaultValue

value (Value format)

Hanya output. Klien akan disetel ke default jika kebijakan tidak disetel.
name

string

Hanya output. Nama kolom.
fieldDescription

string

Hanya output. Deskripsi kolom.
fieldConstraints

object (FieldConstraints)

Hanya output. Informasi tentang batasan input apa pun yang terkait dengan nilai untuk kolom.

PolicySchemaFieldKnownValueDescription

Memberikan informasi mendetail tentang nilai yang diketahui yang diizinkan untuk kolom tertentu dalam PolicySchema.

Representasi JSON 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Kolom
value

string

Hanya output. Pengulangan string nilai yang dapat ditetapkan untuk kolom.
description

string

Hanya output. Deskripsi tambahan untuk nilai ini.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Hanya output. Kondisi kolom yang diperlukan agar nilai ini valid.

PolicySchemaFieldDependencies

Kolom dan nilai yang harus dimilikinya agar kolom lain diizinkan untuk ditetapkan.

Representasi JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Kolom
sourceField

string

Kolom sumber tempat kolom ini bergantung.
sourceFieldValue

string

Nilai yang harus dimiliki kolom sumber agar kolom ini diizinkan untuk ditetapkan.

PolicySchemaRequiredItems

Kolom yang akan wajib diisi berdasarkan nilai kolom ini.

Representasi JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Kolom
fieldConditions[]

string

Nilai kolom yang memicu penerapan kolom wajib diisi. fieldConditions kosong menyiratkan bahwa nilai apa pun yang ditetapkan ke kolom ini akan memicu penerapan kolom yang diperlukan.
requiredFields[]

string

Kolom yang wajib diisi sebagai konsekuensi kondisi kolom.

FieldConstraints

Informasi tentang batasan rentang apa pun.

Representasi JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Kolom
numericRangeConstraint

object (NumericRangeConstraint)

Rentang yang diizinkan untuk bidang angka.
uploadedFileConstraints

object (UploadedFileConstraints)

Batasan pada file kebijakan file yang diupload. Jika ada, kebijakan ini memerlukan URL yang dapat diambil dengan mengupload file dengan batasan yang ditentukan dalam proto ini.

NumericRangeConstraint

Batasan pada batas atas dan/atau bawah, dengan setidaknya satu batasan yang ditetapkan.

Representasi JSON 
{
  "minimum": string,
  "maximum": string
}
Kolom
minimum

string (int64 format)

Nilai minimum.
maximum

string (int64 format)

Nilai maksimum.

UploadedFileConstraints

Batasan pada file kebijakan file yang diupload.

Representasi JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Kolom
supportedContentTypes[]

enum (ContentType)

Jenis file yang dapat diupload untuk setelan.
sizeLimitBytes

string (int64 format)

Batas ukuran file yang diupload untuk sebuah setelan, dalam byte.

ContentType

Jenis file yang dapat diupload untuk setelan.

Enum
CONTENT_TYPE_UNSPECIFIED Jenis konten tidak ditentukan.
CONTENT_TYPE_PLAIN_TEXT Teks biasa.
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

Memberikan pesan pemberitahuan khusus yang terkait dengan nilai tertentu di kolom yang merupakan bagian dari PolicySchema.

Representasi JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Kolom
field

string

Hanya output. Nama kolom yang terkait dengan pemberitahuan.
noticeValue

string

Hanya output. Nilai kolom yang memiliki pemberitahuan. Saat menetapkan kolom ke nilai ini, pengguna mungkin diwajibkan untuk mengonfirmasi pesan pemberitahuan agar nilai dapat ditetapkan.
noticeMessage

string

Hanya output. Pesan pemberitahuan dikaitkan dengan nilai kolom.
acknowledgementRequired

boolean

Hanya output. Apakah pengguna perlu mengonfirmasi pesan pemberitahuan sebelum nilainya dapat ditetapkan.

TargetResource

Jenis resource target

Enum
TARGET_RESOURCE_UNSPECIFIED Resource target tidak ditentukan.
ORG_UNIT Resource target Unit Organisasi.
GROUP resource target grup.

PolicyApiLifecycle

Informasi siklus proses.

Representasi JSON 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
Kolom
deprecatedInFavorOf[]

string

Jika kebijakan ini tidak digunakan lagi dan digantikan dengan kebijakan lain, namespace kebijakan baru yang sepenuhnya memenuhi syarat seperti yang akan ditampilkan di PolicyAPI. Hanya dapat disetel jika policyApiLifecycleStage adalah API_DEPRECATED.
scheduledToDeprecatePolicies[]

string

Sesuai dengan kebijakan yang tidak digunakan lagi, namespace kebijakan lama yang sepenuhnya memenuhi syarat dan tidak akan digunakan lagi karena diperkenalkannya kebijakan ini.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Menunjukkan tahap siklus proses API kebijakan saat ini.
description

string

Deskripsi tentang siklus proses saat ini.
endSupport

object (Date)

Tanggal dukungan berakhir untuk kebijakan saat ini. Mencoba mengubah kebijakan setelah tanggal dukungan akhirnya akan menghasilkan Permintaan Buruk (error 400). Hanya dapat disetel jika policyApiLifecycleStage adalah API_DEPRECATED.

PolicyApiLifecycleEnum

Tahap siklus proses API kebijakan.

Enum
API_UNSPECIFIED Siklus Proses API Kebijakan Tidak Ditentukan.
API_PREVIEW Kebijakan belum berfungsi, tetapi akan memberikan informasi format kepada developer. Tahap ini dapat ditransfer ke API_DEVELOPEMNT atau API_CURRENT.
API_DEVELOPMENT Kebijakan dapat mengubah format sehingga tidak kompatibel dengan versi sebelumnya (perubahan yang dapat menyebabkan gangguan). Tahap ini dapat ditransfer ke API_CURRENT atau API_DEPRECATED. Tindakan ini dapat digunakan untuk kebijakan yang diluncurkan hanya untuk TT atau diluncurkan ke pelanggan tertentu untuk penggunaan darurat.
API_CURRENT Kebijakan dalam format resmi. Kebijakan dapat mengubah format agar kompatibel dengan versi lama (perubahan yang tidak dapat menyebabkan gangguan). Contoh: kebijakan ini dapat memperkenalkan kolom baru, yang dianggap sebagai perubahan yang tidak dapat menyebabkan gangguan, saat mask kolom digunakan dengan benar. Tahap ini dapat ditransfer ke API_DEPRECATED.
API_DEPRECATED Harap hentikan penggunaan kebijakan ini. Kebijakan ini tidak digunakan lagi dan mungkin/akan dihapus pada masa mendatang. Kemungkinan besar kebijakan baru telah diperkenalkan untuk menggantikan kebijakan ini.

Tanggal

Mewakili seluruh atau sebagian tanggal kalender, seperti ulang tahun. Waktu dan zona waktu ditentukan di tempat lain atau tidak signifikan. Tanggal ini relatif terhadap Kalender Gregorian. ID ini dapat mewakili salah satu dari hal berikut:

  • Tanggal lengkap, dengan nilai tahun, bulan, dan hari bukan nol.
  • Bulan dan hari, dengan tahun nol (misalnya, hari jadi).
  • Tahun saja, dengan bulan nol dan hari nol.
  • Tahun dan bulan, dengan hari nol (misalnya, tanggal habis masa berlaku kartu kredit).

Jenis terkait:

Representasi JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Kolom
year

integer

Tahun dalam tanggal. Harus dari 1 hingga 9999, atau 0 untuk menentukan tanggal tanpa tahun.
month

integer

Bulan dalam setahun. Harus dari 1 hingga 12, atau 0 untuk menentukan tahun tanpa bulan dan hari.
day

integer

Hari dalam sebulan. Harus dari 1 hingga 31 dan berlaku untuk tahun dan bulan, atau 0 untuk menentukan tahun saja atau tahun dan bulan jika hari dianggap tidak signifikan.

Platform

Ini adalah enum dari berbagai grup platform yang mendukung Chrome.

Enum
PLATFORM_UNSPECIFIED Platform tidak ditentukan.
CHROME_OS ChromeOS.
CHROME_BROWSER Browser Chrome untuk OSX/Windows/Linux.
CHROME_BROWSER_FOR_ANDROID Browser Chrome untuk Android.
CHROME_BROWSER_FOR_IOS Browser Chrome untuk iOS.

Metode

get

 Mendapatkan skema kebijakan tertentu untuk pelanggan berdasarkan nama resource-nya.

list

 Mendapatkan daftar skema kebijakan yang cocok dengan nilai filter yang ditentukan untuk pelanggan tertentu.