REST Resource: customers.policySchemas

Kaynak: PolicySchema

Politika şemasını temsil eden kaynak.

JSON gösterimi 
{
  "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)
  ]
}
Alanlar
name

string

Biçim: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Yalnızca çıkış. Kullanıcı tüketimiyle ilgili politika şemasıyla ilgili açıklama.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Yalnızca çıkış. Politika değerinin hedefini belirlemek için kullanılacak ek anahtar adları. Bir policyTargetKey belirtirken, burada belirtilen ek anahtarların her birinin additionalTargetKeys haritasına dahil edilmesi gerekir.
definition

object (FileDescriptorProto)

Proto açıklayıcıyı kullanan şema tanımı.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Yalnızca çıkış. Şemanın parçası olan her alanın ayrıntılı açıklaması. Alanlar, alan numarasına göre değil, bu listedeki sıralamaya göre görüntülenmeleri önerilir.
accessRestrictions[]

string

Yalnızca çıkış. Bu politikayla ilgili belirli erişim kısıtlamaları.
notices[]

object (PolicySchemaNoticeDescription)

Yalnızca çıkış. Şemadaki belirli alanlarda belirli değerlerin ayarlanmasıyla ilgili özel bildirim mesajları.
supportUri

string

Yalnızca çıkış. Bu şema için ilgili destek makalesinin URI'si.
schemaName

string

Yalnızca çıkış. Politika şemasının tam adı. Bu değer, BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies veya BatchDeleteGroupPolicies çağrılırken PolicyValue içindeki policySchema alanını doldurmak için kullanılır.
validTargetResources[]

enum (TargetResource)

Yalnızca çıkış. Politika için geçerli hedef kaynaklar hakkında bilgi.
policyApiLifecycle

object (PolicyApiLifecycle)

Yalnızca çıkış. Mevcut yaşam döngüsü bilgileri.
categoryTitle

string

Bir ayarın ait olduğu kategorinin başlığı.
supportedPlatforms[]

enum (Platform)

Yalnızca çıkış. Liste, politikanın yalnızca bu platformlardaki cihazlara/kullanıcılara uygulanacağını belirtir.

AdditionalTargetKeyName

Politika değerinin hedefini tanımlamak için kullanılacak ek anahtar adları.

JSON gösterimi 
{
  "key": string,
  "keyDescription": string
}
Alanlar
key

string

Anahtar adı.
keyDescription

string

Anahtar açıklaması.

FileDescriptorProto

.proto dosyasının tamamını açıklar.

JSON gösterimi 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Alanlar
name

string

kaynak ağacın köküne göre dosya adı
package

string

ör. "foo", "foo.bar" vb.
messageType[]

object (DescriptorProto)

Bu dosyadaki tüm üst düzey tanımlar.
enumType[]

object (EnumDescriptorProto)
syntax

string

Proto dosyasının söz dizimi. Desteklenen değerler: "proto2", "proto3" ve "editions".

edition mevcutsa bu değer "editions" olmalıdır.

DescriptorProto

Mesaj türünü açıklar.

JSON gösterimi 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Alanlar
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Bir iletideki alanı açıklar.

JSON gösterimi 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Alanlar
name

string
number

integer
label

enum (Label)
type

enum (Type)

typeName ayarlanmışsa bunun ayarlanmasına gerek yoktur. Hem bu hem de typeName ayarlanırsa bu, TYPE_ENUM, TYPE_MESSAGE veya TYPE_GROUP değerlerinden biri olmalıdır.
typeName

string

Mesaj ve sıralama türleri için türün adıdır. Ad "." ile başlıyorsa tam olarak kabul edilmektedir. Aksi takdirde, türü bulmak için C++ benzeri kapsam kuralları kullanılır (yani, önce bu iletideki iç içe yerleştirilmiş türler, ardından kök ad alanına kadar üst öğe içinde aranır).
defaultValue

string

Sayısal türlerde, değerin orijinal metin gösterimini içerir. Boolelar için "true" veya "false" olarak ayarlayın. Dizelerde, varsayılan metin içeriklerini içerir (hiçbir şekilde çıkış karaktersizdir). Baytlar için, kod dışına alınan C değerini içerir. 128 veya daha büyük tüm baytlar atlanır.
oneofIndex

integer

Ayarlanırsa, kapsayıcı türünün oneofDecl listesindekilerden birinin dizinini verir. Bu alan, söz konusu alanın bir üyesidir.
jsonName

string

Bu alanın JSON adı. Değer, protokol derleyici tarafından ayarlanır. Kullanıcı bir "jsonName" ayarlamışsa seçeneği sunulursa söz konusu seçeneğin değeri kullanılır. Aksi takdirde, alanın adından camelCase'e dönüştürülerek çıkarılır.
proto3Optional

boolean

Doğru ise bu bir proto3 "isteğe bağlı"dır. Bir proto3 alanı isteğe bağlı olduğunda alan türünden bağımsız olarak varlığı izler.

proto3Optional değerine ayarlanırsa bu alan için varlığın izlendiğini eski proto3 istemcilerine bildirmek için bu alanın bir tanesine ait olması gerekir. Bu, "sentetik" olarak bilinir. biri ve bu alan kendi tek üyesi olmalıdır (isteğe bağlı her proto3 alanı kendi sentetik alanına sahiptir). Sentetikler yalnızca tanımlayıcıda bulunur ve herhangi bir API oluşturmaz. Yapay olanlar "gerçek"ten sonra sıralanmalıdır biri.

Tekrarlanmayan mesaj alanları varlığı her zaman izlediğinden, mesaj alanlarında proto3Optional herhangi bir anlam değişikliği oluşturmaz. Ancak yine de kullanıcının "isteğe bağlı" yazıp yazmadığına ilişkin anlamsal ayrıntıyı belirtir. hakkında bilgi edindiniz. Bu, .proto dosyasının gidişatı sırasında faydalı olabilir. Tutarlılık amacıyla, varlığı izlemek zorunlu olmasa da mesaj alanlarına sentetik bir alan ekliyoruz. Bu özellikle önemlidir, ayrıştırıcı bir alanın mesaj mı yoksa numaralandırma mı olduğunu belirleyemeyeceği için her zaman sentetik bir alan oluşturmalıdır.

Proto2'deki isteğe bağlı alanlar, zaten LABEL_OPTIONAL ile isteğe bağlı olduğunu belirttiği için bu işareti ayarlamaz.

Şirket

Sıralamalar
LABEL_OPTIONAL 0, hatalar için ayrılmıştır
LABEL_REPEATED
LABEL_REQUIRED Gerekli etikete yalnızca proto2'de izin verilir. proto3 ve Sürümlerde bunu yapmak açıkça yasaktır. Sürümlerde bu davranışı elde etmek için fieldPresence özelliği kullanılabilir.

Tür

Sıralamalar
TYPE_DOUBLE 0, hatalar için ayrılmıştır. Sipariş, geçmişteki nedenlerden dolayı tuhaf.
TYPE_FLOAT
TYPE_INT64 ZigZag olarak kodlanmamıştır. Negatif sayılar 10 bayttır. Negatif değerler olasılığı varsa TYPE_SINT64'ü kullanın.
TYPE_UINT64
TYPE_INT32 ZigZag olarak kodlanmamıştır. Negatif sayılar 10 bayttır. Negatif değerler olması muhtemelse TYPE_SINT32 değerini kullanın.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Etiketle ayrılmış toplama. grup türü kullanımdan kaldırıldı ve proto2'den sonra desteklenmemektedir. Bununla birlikte, Proto3 uygulamalarının grup kablo biçimini ayrıştırabilmesi ve grup alanlarını bilinmeyen alanlar olarak işleyebilmesi gerekir. Sürümlerde, grup kablo biçimi messageEncoding özelliği aracılığıyla etkinleştirilebilir.
TYPE_MESSAGE Uzunlukla ayrılmış toplama.
TYPE_BYTES Sürüm 2'deki yenilikler.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 ZigZag kodlamasını kullanır.
TYPE_SINT64 ZigZag kodlamasını kullanır.

EnumDescriptorProto

Bir numaralandırma türünü açıklar.

JSON gösterimi 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Alanlar
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Bir numaralandırma içindeki bir değeri açıklar.

JSON gösterimi 
{
  "name": string,
  "number": integer
}
Alanlar
name

string
number

integer

OneofDescriptorProto

Biri açıklar.

JSON gösterimi 
{
  "name": string
}
Alanlar
name

string

PolicySchemaFieldDescription

PolicySchema'nın parçası olan belirli bir alan için ayrıntılı bilgi sağlar.

JSON gösterimi 
{
  "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)
  }
}
Alanlar
field

string

Yalnızca çıkış. Bu açıklamayla ilişkilendirilen alanın adı.
description
(deprecated)

string

Kullanımdan kaldırıldı. Bunun yerine name ve FieldDescription öğelerini kullanın. Alan için açıklama.
inputConstraint

string

Yalnızca çıkış. Alanın değerleriyle ilişkili tüm giriş kısıtlamaları.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Yalnızca çıkış. Alanda bilinen bir değer grubu varsa bu alan, söz konusu değerler için bir açıklama sağlar.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Yalnızca çıkış. Alan, birden çok alanı tanımlayan bir mesaj türüyse bu alanda iç içe yerleştirilmiş alanların açıklamasını sağlar. Alanlar, alan numarasına göre değil, bu listedeki sıralamaya göre görüntülenmeleri önerilir.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Yalnızca çıkış. Alanların ve değerlerin listesini sağlar. Bu alanın ayarlanmasına izin verilebilmesi için alanlardan en az birinin karşılık gelen değere sahip olması gerekir.
requiredItems[]

object (PolicySchemaRequiredItems)

Yalnızca çıkış. Bu alanda belirli bir değer varsa ayarlanması gereken alanların listesini sağlar.
defaultValue

value (Value format)

Yalnızca çıkış. Politika ayarlanmazsa istemci varsayılanı.
name

string

Yalnızca çıkış. Alanın adı.
fieldDescription

string

Yalnızca çıkış. Alanın açıklaması.
fieldConstraints

object (FieldConstraints)

Yalnızca çıkış. Alana ilişkin değerlerle ilişkili herhangi bir giriş kısıtlaması hakkındaki bilgiler.

PolicySchemaFieldKnownValueDescription

PolicySchema'daki belirli bir alan için izin verilen bilinen bir değerle ilgili ayrıntılı bilgi sağlar.

JSON gösterimi 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Alanlar
value

string

Yalnızca çıkış. Alan için ayarlanabilecek değerin dize gösterimi.
description

string

Yalnızca çıkış. Bu değer için ek açıklama.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Yalnızca çıkış. Bu değerin geçerli olması için alan koşulları gerekli.

PolicySchemaFieldDependencies

Bu alanın ve başka bir alanın ayarlanmasına izin verilmesi için sahip olması gereken değer.

JSON gösterimi 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Alanlar
sourceField

string

Bu alanın bağlı olduğu kaynak alan.
sourceFieldValue

string

Bu alanın ayarlanmasına izin verilmesi için kaynak alanda olması gereken değer.

PolicySchemaRequiredItems

Bu alanın değerine göre zorunlu hale gelecek alanlar.

JSON gösterimi 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Alanlar
fieldConditions[]

string

Zorunlu alan yaptırımını tetikleyen alanın değerleri. Boş bir FieldConditions, bu alana atanan herhangi bir değerin zorunlu alan yaptırımını tetikleyeceği anlamına gelir.
requiredFields[]

string

Alan koşullarının sonucu olarak zorunlu olan alanlar.

FieldConstraints

Tüm aralık kısıtlamalarıyla ilgili bilgiler.

JSON gösterimi 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Alanlar
numericRangeConstraint

object (NumericRangeConstraint)

Sayısal alanlar için izin verilen aralık.
uploadedFileConstraints

object (UploadedFileConstraints)

Bir dosya politikasının yüklenen dosyasıyla ilgili kısıtlamalar. Varsa bu politika, bu protokolde belirtilen kısıtlamalara sahip bir dosya yükleyerek getirilebilecek bir URL gerektirir.

NumericRangeConstraint

En az birinin ayarlandığı üst ve/veya alt sınırlara yönelik bir kısıtlama.

JSON gösterimi 
{
  "minimum": string,
  "maximum": string
}
Alanlar
minimum

string (int64 format)

Minimum değer.
maximum

string (int64 format)

Maksimum değer.

UploadedFileConstraints

Bir dosya politikasının yüklenen dosyasıyla ilgili kısıtlamalar.

JSON gösterimi 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Alanlar
supportedContentTypes[]

enum (ContentType)

Bir ayar için yüklenebilecek dosya türleri.
sizeLimitBytes

string (int64 format)

Bir ayar için yüklenen dosyaların bayt cinsinden boyut sınırı.

ContentType

Bir ayar için yüklenebilecek dosya türleri.

Sıralamalar
CONTENT_TYPE_UNSPECIFIED Belirtilmemiş içerik türü.
CONTENT_TYPE_PLAIN_TEXT Düz metin.
CONTENT_TYPE_HTML HTML'ye dokunun.
CONTENT_TYPE_IMAGE_JPEG JPEG
CONTENT_TYPE_IMAGE_GIF GIF olarak kaydedildiğinden emin olun.
CONTENT_TYPE_IMAGE_PNG .PNG.
CONTENT_TYPE_JSON JSON biçimindedir.
CONTENT_TYPE_ZIP ZIP.
CONTENT_TYPE_GZIP GZIP'e dokunun.
CONTENT_TYPE_CSV CSV dosyası olarak kaydedin.
CONTENT_TYPE_YAML YAML dosyasıdır.
CONTENT_TYPE_IMAGE_WEBP WEBP.

PolicySchemaNoticeDescription

PolicySchema'nın parçası olan bir alandaki belirli bir değerle ilgili özel bildirim mesajları sağlar.

JSON gösterimi 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Alanlar
field

string

Yalnızca çıkış. Bildirimle ilişkili alan adı.
noticeValue

string

Yalnızca çıkış. Bildirim içeren alanın değeri. Alan bu değere ayarlanırken değerin ayarlanması için kullanıcının bildirim mesajını onaylaması gerekebilir.
noticeMessage

string

Yalnızca çıkış. Alanın değeriyle ilişkilendirilen bildirim mesajı.
acknowledgementRequired

boolean

Yalnızca çıkış. Değerin ayarlanabilmesi için kullanıcının bildirim mesajını onaylamasının gerekip gerekmediği.

TargetResource

Hedef kaynak türleri

Sıralamalar
TARGET_RESOURCE_UNSPECIFIED Belirtilmemiş hedef kaynak.
ORG_UNIT Kuruluş Birimi hedef kaynağı.
GROUP Grup hedef kaynağı.

PolicyApiLifecycle

Yaşam döngüsü bilgileri.

JSON gösterimi 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
Alanlar
deprecatedInFavorOf[]

string

Bu politikanın kullanımdan kaldırılması ve başka bir politikanın tercih edilmesi halinde, yeni politikaların PolicyAPI'de gösterileceği şekliyle tam nitelikli ad alanları. Yalnızca policyApiLifecycleStage API_DEPRECATED ise ayarlanabilir.
scheduledToDeprecatePolicies[]

string

Kullanımdan kaldırılan InFavorOf'a karşılık olarak, bu politikanın yürürlüğe girmesi nedeniyle kullanımdan kaldırılacak eski politikaların tam nitelikli ad alanları.
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Policy API'nin mevcut yaşam döngüsü aşamasını belirtir.
description

string

Mevcut yaşam döngüsüyle ilgili açıklama.
endSupport

object (Date)

Mevcut politikanın desteklenme tarihi. Bir politikayı, destek bitiş tarihinden sonra değiştirmeye çalışırsanız Hatalı İstek (400 hatası) alırsınız. Yalnızca policyApiLifecycleStage API_DEPRECATED ise ayarlanabilir.

PolicyApiLifecycleEnum

Policy API'nin yaşam döngüsü aşaması.

Sıralamalar
API_UNSPECIFIED Policy Api Yaşam Döngüsü Belirtilmemiş.
API_PREVIEW Politika henüz çalışmıyor ancak geliştiricilere biçim hakkında bilgi veriliyor. Bu aşama API_DEVELOPEMNT veya API_CURRENT'e aktarılabilir.
API_DEVELOPMENT Politika, biçimi geriye dönük olarak uyumsuz şekilde değiştirebilir (bozucu değişiklik). Bu aşama API_CURRENT veya API_DEPRECATED sürümüne aktarılabilir. Bu özellik, yalnızca TT'lerin kullanımına sunulan politikalar için kullanılabilir veya belirli müşterilerin acil durum kullanımına yönelik olarak kullanıma sunulabilir.
API_CURRENT Politika, resmi biçimdedir. Politika, biçimi geriye dönük olarak uyumlu şekilde değiştirebilir (değişiklik olmayan değişiklik). Örnek: Bu politika, alan maskeleri düzgün bir şekilde kullanıldığında, zararsız değişiklik olarak kabul edilen yeni bir alanı kullanıma sunabilir. Bu aşama API_DEPRECATED alanına aktarılabilir.
API_DEPRECATED Lütfen bu politikayı kullanmayı bırakın. Bu politikanın desteği sonlandırılmıştır ve gelecekte kaldırılacaktır. Büyük olasılıkla, bunun yerini alacak yeni bir politika yürürlüğe girmiştir.

Tarih

Takvimin tamamını veya bir kısmını temsil eder (ör. doğum günü). Günün saati ve saat dilimi başka bir yerde belirtilmiş veya önemsiz. Tarih, Miladi Takvim'e göredir. Bu, aşağıdakilerden birini temsil edebilir:

  • Sıfır olmayan yıl, ay ve gün değerleriyle tam tarih.
  • Bir ay ve gün ile sıfır yıl (örneğin, bir yıl dönümü).
  • Tek başına bir yıl, sıfır ay ve sıfır gün.
  • Sıfır gün içeren bir yıl ve ay (örneğin, kredi kartı son kullanma tarihi).

İlgili türler:

JSON gösterimi 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Alanlar
year

integer

Tarihin yılı. 1 ile 9999 arasında veya yıl içermeyen bir tarihi belirtmek için 0 arasında olmalıdır.
month

integer

Bir yılın ayı. 1 ile 12 arasında veya ay ve gün içermeyen bir yılı belirtmek için 0 arasında olmalıdır.
day

integer

Ayın günü. 1 ile 31 arasında bir değer olmalı ve yıl ve ay için geçerlidir. Yalnızca yılı belirtmek için 0 değerini veya günün önemli olmadığı bir yılı ve ayı belirtmek için 0 değerini girin.

Platform

Bu, Chrome'un desteklediği farklı platform gruplarının sıralamasıdır.

Sıralamalar
PLATFORM_UNSPECIFIED Belirtilmemiş platform.
CHROME_OS ChromeOS.
CHROME_BROWSER OSX/Windows/Linux için Chrome Tarayıcı.
CHROME_BROWSER_FOR_ANDROID Android için Chrome Tarayıcı.
CHROME_BROWSER_FOR_IOS iOS için Chrome Tarayıcı.

Yöntemler

get

 Bir müşteri için kaynak adına göre belirli bir politika şeması alın.

list

 Belirli bir müşteri için belirtilen filtre değeriyle eşleşen politika şemalarının listesini alır.