- Zasób: PolicySchema
- AdditionalTargetKeyName
- FileDescriptorProto
- DescriptorProto
- FieldDescriptorProto
- Etykieta
- Typ
- EnumDescriptorProto
- EnumValueDescriptorProto
- OneofDescriptorProto
- PolicySchemaFieldDescription
- PolicySchemaFieldKnownValueDescription
- PolicySchemaFieldDependencies
- PolicySchemaRequiredItems
- FieldConstraints
- NumericRangeConstraint
- UploadedFileConstraints
- ContentType
- PolicySchemaNoticeDescription
- TargetResource
- PolicyApiLifecycle
- PolicyApiLifecycleEnum
- Data
- Platform
- Metody
Zasób: PolicySchema
Zasób reprezentujący schemat zasad.
Zapis JSON |
---|
{ "name": string, "policyDescription": string, "additionalTargetKeyNames": [ { object ( |
Pola | |
---|---|
name |
Format: name=customers/{customer}/policySchemas/{schema_namespace} |
policyDescription |
Tylko dane wyjściowe. Opis schematu zasad na potrzeby wykorzystania przez użytkowników. |
additionalTargetKeyNames[] |
Tylko dane wyjściowe. Dodatkowe nazwy kluczy, które będą używane do identyfikowania celu wartości zasady. Określając parametr |
definition |
Definicja schematu za pomocą deskryptora protokołu. |
fieldDescriptions[] |
Tylko dane wyjściowe. Szczegółowy opis każdego pola, które jest częścią schematu. Sugerujemy wyświetlanie pól zgodnie z ich kolejnością na tej liście, a nie według numeru pola. |
accessRestrictions[] |
Tylko dane wyjściowe. Określone ograniczenia dostępu związane z tymi zasadami. |
notices[] |
Tylko dane wyjściowe. Specjalne uwagi dotyczące ustawiania określonych wartości w określonych polach schematu. |
supportUri |
Tylko dane wyjściowe. Identyfikator URI do artykułu pomocy powiązanego z tym schematem. |
schemaName |
Tylko dane wyjściowe. Pełna nazwa schematu zasad. Ta wartość służy do wypełnienia pola |
validTargetResources[] |
Tylko dane wyjściowe. Informacje o odpowiednich zasobach docelowych dla zasady. |
policyApiLifecycle |
Tylko dane wyjściowe. Aktualne informacje dotyczące cyklu życia. |
categoryTitle |
Tytuł kategorii, do której należy ustawienie. |
supportedPlatforms[] |
Tylko dane wyjściowe. Lista wskazuje, że zasada będzie stosowana tylko do urządzeń/użytkowników na tych platformach. |
AdditionalTargetKeyName
Dodatkowe nazwy kluczy, które będą używane do identyfikowania celu wartości zasady.
Zapis JSON |
---|
{ "key": string, "keyDescription": string } |
Pola | |
---|---|
key |
Nazwa klucza. |
keyDescription |
Opis klucza. |
FileDescriptorProto
Opisuje kompletny plik .proto.
Zapis JSON |
---|
{ "name": string, "package": string, "messageType": [ { object ( |
Pola | |
---|---|
name |
nazwa pliku względem poziomu głównego drzewa źródłowego |
package |
np. „foo”, „foo.bar” itp. |
messageType[] |
Wszystkie definicje najwyższego poziomu w tym pliku. |
enumType[] |
|
syntax |
Składnia pliku proto. Obsługiwane wartości to „proto2”, „proto3” i „editions”. Jeśli podano |
DescriptorProto
Opisuje typ wiadomości.
Zapis JSON |
---|
{ "name": string, "field": [ { object ( |
Pola | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
Opisuje pole w wiadomości.
Zapis JSON |
---|
{ "name": string, "number": integer, "label": enum ( |
Pola | |
---|---|
name |
|
number |
|
label |
|
type |
Jeśli parametr typeName jest ustawiony, nie trzeba go ustawiać. Jeśli ustawiono zarówno to, jak i typName, muszą to być wartości TYPE_ENUM, TYPE_MESSAGE lub TYPE_GROUP. |
typeName |
W przypadku typów wiadomości i wyliczeniowych jest to nazwa typu. Jeśli nazwa zaczyna się od znaku „.”, oznacza to, że jest w pełni kwalifikowana. W przeciwnym razie do określenia typu są używane reguły określania zakresu podobne do C++ (tzn. najpierw przeszukiwane są typy zagnieżdżone w wiadomości, a następnie w środku elementu nadrzędnego aż do głównej przestrzeni nazw). |
defaultValue |
W przypadku typów liczbowych zawiera reprezentację wartości w oryginalnym tekście. W przypadku wartości logicznych: „true” (prawda). lub „false”. W przypadku ciągów tekstowych zawiera domyślną zawartość tekstu (bez żadnych znaków zmiany znaczenia). W przypadku bajtów zawiera ciąg znaków o zmienionym znaczeniu C. Wszystkie bajty >= 128 są objęte zmianą znaczenia. |
oneofIndex |
Jeśli jest ustawiony, daje indeks elementu oneof na liście oneofDecl w elemencie zawierającym. To pole należy do tego pola. |
jsonName |
Nazwa tego pola w formacie JSON. Wartość jest ustawiana przez kompilator protokołu. Jeśli użytkownik ustawił „jsonName” , zostanie użyta wartość tej opcji. W przeciwnym razie jest usuwana z nazwy pola przez konwertowanie jej na rodzaj wielbłąda. |
proto3Optional |
Jeśli ma wartość true (prawda), jest to „opcjonalny” protokół proto3. Jeśli pole proto3 jest opcjonalne, śledzi obecność niezależnie od typu pola. Gdy proto3Optional ma wartość true (prawda), to pole musi należeć do 1of, aby zasygnalizować starym klientom proto3, że obecność jest śledzona dla tego pola. Ten element jest nazywany „syntetycznym” oneof, a to pole musi być jego jedynym elementem (każde pole opcjonalne proto3 ma własną wartość syntetyczną). Syntetyczny jeden z nich występuje tylko w deskryptorze i nie generuje żadnego interfejsu API. Syntetyczny Jeden z musi być uporządkowany po wszystkich „rzeczywistych” oneofs. W przypadku pól wiadomości proto3Optional nie powoduje żadnej zmiany semantycznej, ponieważ pola niepowtarzające się wiadomości zawsze śledzą obecność. Nadal jednak wskazuje semantyczny szczegół określający, czy użytkownik wpisał „opcjonalny”. lub nie. Może to być przydatne w przypadku segmentowania pliku .proto w obie strony. Aby zachować spójność, pola wiadomości mają też pola wiadomości syntetyczne, nawet jeśli śledzenie obecności nie jest wymagane. Jest to szczególnie ważne, ponieważ parser nie potrafi określić, czy pole jest komunikatem czy wyliczeniem, więc musi zawsze utworzyć syntetyczną wartość. Pola opcjonalne Proto2 nie ustawiają tej flagi, ponieważ wskazują one już jako opcjonalne w elemencie |
Etykieta
Wartości w polu enum | |
---|---|
LABEL_OPTIONAL |
Wartość 0 jest zarezerwowana dla błędów |
LABEL_REPEATED |
|
LABEL_REQUIRED |
Wymagana etykieta jest dozwolona tylko w protokole proto2. W proto3 i wersjach jest to wyraźnie zabronione. W wersjach można to robić za pomocą funkcji fieldPresence . |
Typ
Wartości w polu enum | |
---|---|
TYPE_DOUBLE |
Wartość 0 jest zarezerwowana dla błędów. Zamówienie jest dziwne z przyczyn historycznych. |
TYPE_FLOAT |
|
TYPE_INT64 |
Bez kodowania ZigZag. Liczba ujemna zajmuje 10 bajtów. Jeśli prawdopodobne są wartości ujemne, użyj TYPE_SINT64. |
TYPE_UINT64 |
|
TYPE_INT32 |
Bez kodowania ZigZag. Liczba ujemna zajmuje 10 bajtów. Jeśli prawdopodobne są wartości ujemne, użyj TYPE_SINT32. |
TYPE_FIXED64 |
|
TYPE_FIXED32 |
|
TYPE_BOOL |
|
TYPE_STRING |
|
TYPE_GROUP |
Dane zbiorcze rozdzielane tagami. Typ grupy został wycofany i nie jest obsługiwany po proto2. Implementacje Proto3 powinny jednak nadal analizować format przewodu grupowego i traktować pola grupy jako nieznane pola. W wersjach można włączyć format przewodu grupowego za pomocą funkcji messageEncoding . |
TYPE_MESSAGE |
Agregacja rozdzielana długością. |
TYPE_BYTES |
Nowość w wersji 2. |
TYPE_UINT32 |
|
TYPE_ENUM |
|
TYPE_SFIXED32 |
|
TYPE_SFIXED64 |
|
TYPE_SINT32 |
Używa kodowania ZigZag. |
TYPE_SINT64 |
Używa kodowania ZigZag. |
EnumDescriptorProto
Opisuje typ wyliczenia.
Zapis JSON |
---|
{
"name": string,
"value": [
{
object ( |
Pola | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
Opisuje wartość w ramach wyliczenia.
Zapis JSON |
---|
{ "name": string, "number": integer } |
Pola | |
---|---|
name |
|
number |
|
OneofDescriptorProto
Opisuje jeden z.
Zapis JSON |
---|
{ "name": string } |
Pola | |
---|---|
name |
|
PolicySchemaFieldDescription
Zawiera szczegółowe informacje o konkretnym polu, które jest częścią elementu PolicySchema.
Zapis JSON |
---|
{ "field": string, "description": string, "inputConstraint": string, "knownValueDescriptions": [ { object ( |
Pola | |
---|---|
field |
Tylko dane wyjściowe. Nazwa pola powiązanego z tym opisem. |
description |
Rola wycofana. Zamiast tego użyj atrybutów name i fieldDescription. Opis pola. |
inputConstraint |
Tylko dane wyjściowe. Wszelkie ograniczenia wejściowe związane z wartościami pola. |
knownValueDescriptions[] |
Tylko dane wyjściowe. Jeśli pole ma zestaw znanych wartości, to pole będzie zawierać ich opis. |
nestedFieldDescriptions[] |
Tylko dane wyjściowe. Zawiera opis pól zagnieżdżonych w tym polu, jeśli pole jest typem wiadomości definiującym wiele pól. Sugerujemy wyświetlanie pól zgodnie z ich kolejnością na tej liście, a nie według numeru pola. |
fieldDependencies[] |
Tylko dane wyjściowe. Udostępnia listę pól i wartości. Aby można było ustawić to pole, co najmniej jedno z nich musi mieć odpowiadającą wartość. |
requiredItems[] |
Tylko dane wyjściowe. Zawiera listę pól, które należy ustawić, jeśli to pole ma określoną wartość. |
defaultValue |
Tylko dane wyjściowe. Ustawienie domyślne klienta, jeśli zasada jest nieskonfigurowana. |
name |
Tylko dane wyjściowe. Nazwa pola. |
fieldDescription |
Tylko dane wyjściowe. Opis pola. |
fieldConstraints |
Tylko dane wyjściowe. Informacje o ograniczeniach wejściowych związanych z wartościami pola. |
PolicySchemaFieldKnownValueDescription
Zawiera szczegółowe informacje o znanej wartości, która jest dozwolona w przypadku określonego pola w schemacie zasad.
Zapis JSON |
---|
{
"value": string,
"description": string,
"fieldDependencies": [
{
object ( |
Pola | |
---|---|
value |
Tylko dane wyjściowe. Ponowne wystąpienie ciągu znaków wartości, którą można ustawić dla pola. |
description |
Tylko dane wyjściowe. Dodatkowy opis dla tej wartości. |
fieldDependencies[] |
Tylko dane wyjściowe. Warunki pola są wymagane, aby ta wartość była prawidłowa. |
PolicySchemaFieldDependencies
Pole i wartość, jaką musi ono mieć, aby można było ustawić inne pole.
Zapis JSON |
---|
{ "sourceField": string, "sourceFieldValue": string } |
Pola | |
---|---|
sourceField |
Pole źródłowe, od którego zależy to pole. |
sourceFieldValue |
Wartość, którą musi mieć pole źródłowe, by można było ustawić to pole. |
PolicySchemaRequiredItems
Pola, które będą wymagane w zależności od wartości w tym polu.
Zapis JSON |
---|
{ "fieldConditions": [ string ], "requiredFields": [ string ] } |
Pola | |
---|---|
fieldConditions[] |
Wartości pola, które powodują wymuszenie zastosowania wymaganych pól. Puste polefieldConditions oznacza, że każda wartość przypisana do tego pola spowoduje wymuszenie zastosowania wymaganego pola. |
requiredFields[] |
Pola, które są wymagane ze względu na warunki pól. |
FieldConstraints
Informacje o ograniczeniach dotyczących zakresu.
Zapis JSON |
---|
{ "numericRangeConstraint": { object ( |
Pola | |
---|---|
numericRangeConstraint |
Dozwolony zakres dla pól liczbowych. |
uploadedFileConstraints |
Ograniczenia dotyczące przesłanego pliku zasad dotyczących plików. Jeśli ta zasada jest dostępna, wymaga adresu URL, który można pobrać, przesyłając plik z ograniczeniami określonymi w tym proto. |
NumericRangeConstraint
Ograniczenie na górnych lub dolnych granicach, w których ustawiono co najmniej jedną.
Zapis JSON |
---|
{ "minimum": string, "maximum": string } |
Pola | |
---|---|
minimum |
Wartość minimalna. |
maximum |
Wartość maksymalna. |
UploadedFileConstraints
Ograniczenia dotyczące przesłanego pliku zasad dotyczących plików.
Zapis JSON |
---|
{
"supportedContentTypes": [
enum ( |
Pola | |
---|---|
supportedContentTypes[] |
Typy plików, które można przesyłać w przypadku ustawienia. |
sizeLimitBytes |
Limit rozmiaru przesyłanych plików związanych z ustawieniem (w bajtach). |
ContentType
Typy plików, które można przesyłać w przypadku ustawienia.
Wartości w polu enum | |
---|---|
CONTENT_TYPE_UNSPECIFIED |
Nieokreślony typ treści. |
CONTENT_TYPE_PLAIN_TEXT |
Zwykły tekst. |
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 |
pliku ZIP. |
CONTENT_TYPE_GZIP |
GZIP. |
CONTENT_TYPE_CSV |
CSV. |
CONTENT_TYPE_YAML |
YAML. |
CONTENT_TYPE_IMAGE_WEBP |
WebP |
PolicySchemaNoticeDescription
Wyświetla specjalne komunikaty powiadomień dotyczące określonej wartości w polu, które jest częścią elementu PolicySchema.
Zapis JSON |
---|
{ "field": string, "noticeValue": string, "noticeMessage": string, "acknowledgementRequired": boolean } |
Pola | |
---|---|
field |
Tylko dane wyjściowe. Nazwa pola powiązanego z powiadomieniem. |
noticeValue |
Tylko dane wyjściowe. Wartość pola, które zawiera powiadomienie. Ustawienie tej wartości może wymagać od użytkownika potwierdzenia komunikatu. |
noticeMessage |
Tylko dane wyjściowe. Komunikat powiadomienia jest powiązany z wartością pola. |
acknowledgementRequired |
Tylko dane wyjściowe. Określa, czy użytkownik musi potwierdzić wiadomość, zanim będzie można ustawić wartość. |
TargetResource
Typy zasobów docelowych
Wartości w polu enum | |
---|---|
TARGET_RESOURCE_UNSPECIFIED |
Nieokreślony zasób docelowy. |
ORG_UNIT |
Zasób docelowy jednostki organizacyjnej. |
GROUP |
zasób docelowy grupy. |
PolicyApiLifecycle
Informacje o cyklu życia.
Zapis JSON |
---|
{ "deprecatedInFavorOf": [ string ], "scheduledToDeprecatePolicies": [ string ], "policyApiLifecycleStage": enum ( |
Pola | |
---|---|
deprecatedInFavorOf[] |
W przypadku wycofania tej zasady i zastąpienia jej inną zasadą w pełni kwalifikowane przestrzenie nazw nowych zasad będą widoczne w interfejsie PolicyAPI. Można ją ustawić tylko wtedy, gdy zasada policyApiLifecycleStage ma wartość API_DEPRECATED. |
scheduledToDeprecatePolicies[] |
Odpowiada to wycofaniu InFavorOf, w pełni kwalifikowanej przestrzeni nazw starych zasad, które zostaną wycofane w związku z wprowadzeniem tych zasad. |
policyApiLifecycleStage |
Wskazuje bieżący etap cyklu życia interfejsu Policy API. |
description |
Opis bieżącego cyklu życia. |
endSupport |
Data zakończenia wsparcia dla obecnej zasady. Próba zmodyfikowania zasady po dacie zakończenia obsługi spowoduje wystąpienie nieprawidłowego żądania (błąd 400). Można ją ustawić tylko wtedy, gdy zasada policyApiLifecycleStage ma wartość API_DEPRECATED. |
PolicyApiLifecycleEnum
Etap cyklu życia zasad API.
Wartości w polu enum | |
---|---|
API_UNSPECIFIED |
Cykl życia interfejsu API zasad jest nieokreślony. |
API_PREVIEW |
Zasady jeszcze nie działają, ale powiadamiamy deweloperów o formacie. Ten etap może zostać przeniesiony do API_DE usługMNT lub API_CURRENT. |
API_DEVELOPMENT |
Zasada może zmienić format w sposób niezgodny wstecznie (zmiana psująca). Ten etap można przenieść do API_CURRENT lub API_DEPRECATED. Można go użyć w przypadku zasad uruchamianych tylko dla TT lub wybranych klientów w sytuacjach awaryjnych. |
API_CURRENT |
zasady w oficjalnym formacie. Zasada może zmieniać format w sposób zgodny wstecznie (zmiana nie powodująca uszkodzenia). Przykład: ta zasada może wprowadzić nowe pole, które jest uznawane za zmianę nienaruszającą, przy prawidłowym użyciu masek pól. Ten etap można przenieść do API_DEPRECATED. |
API_DEPRECATED |
Przestań używać tej zasady. Ta zasada jest wycofana i w przyszłości może zostać usunięta. Najprawdopodobniej wprowadzono nową zasadę, aby zastąpić tę obecną. |
Data
Reprezentuje całą datę lub jej część, na przykład datę urodzin. Pora dnia i strefa czasowa zostały określone w innym miejscu lub są nieistotne. Data zależy od kalendarza gregoriańskiego. Może to być jedna z tych wartości:
- Pełna data z wartościami niezerowymi dotyczącymi roku, miesiąca i dnia.
- Miesiąc i dzień bez roku (np. rocznica).
- Sam rok z zerowym miesiącem i zerowym dniem.
- Rok i miesiąc z zerową datą ważności (np. data ważności karty kredytowej).
Podobne typy:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Zapis JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Pola | |
---|---|
year |
Rok daty. Wartość musi mieścić się w zakresie od 1 do 9999 lub od 0 do określenia daty bez roku. |
month |
Miesiąc w roku. Musi mieścić się w zakresie od 1 do 12 lub 0, jeśli chcesz określić rok bez miesiąca i dnia. |
day |
Dzień miesiąca. Wartość musi należeć do zakresu od 1 do 31 i jest ważna dla roku i miesiąca. Wartość 0 pozwala określić pojedynczy rok lub rok i miesiąc, w którym dzień nie jest istotny. |
Platforma
To jest wyliczenie różnych grup platform, które obsługują Chrome.
Wartości w polu enum | |
---|---|
PLATFORM_UNSPECIFIED |
Nieokreślona platforma. |
CHROME_OS |
ChromeOS. |
CHROME_BROWSER |
Przeglądarka Chrome w systemach OSX/Windows/Linux. |
CHROME_BROWSER_FOR_ANDROID |
Przeglądarka Chrome na Androida. |
CHROME_BROWSER_FOR_IOS |
Przeglądarka Chrome na iOS. |
Metody |
|
---|---|
|
Pobierz określony schemat zasad dla klienta na podstawie jego nazwy zasobu. |
|
Pobiera listę schematów zasad, które pasują do określonej wartości filtra dla danego klienta. |