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
}
الحقول
name

string

التنسيق: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

النتائج فقط. وصف حول مخطط السياسة لاستهلاك المستخدمين.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

النتائج فقط. أسماء مفاتيح إضافية سيتم استخدامها لتحديد الهدف من قيمة السياسة. عند تحديد policyTargetKey، يجب تضمين كل من المفاتيح الإضافية المحددة هنا في خريطة additionalTargetKeys.
definition

object (FileDescriptorProto)

تعريف المخطط باستخدام الواصف الأولي.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

النتائج فقط. وصف تفصيلي لكل حقل يُعد جزءًا من المخطط.
accessRestrictions[]

string

النتائج فقط. قيود الوصول المحددة المرتبطة بهذه السياسة.
notices[]

object (PolicySchemaNoticeDescription)

النتائج فقط. رسائل الإشعارات الخاصة المتعلقة بضبط قيم معيّنة في حقول معيّنة في المخطط.
supportUri

string

النتائج فقط. معرّف موارد منتظم (URI) لمقالة الدعم ذات الصلة بهذا المخطط
schemaName

string

النتائج فقط. تمثّل هذه السمة الاسم المؤهّل بالكامل لمخطط السياسة. يتم استخدام هذه القيمة لملء الحقل policySchema في PolicyValue عند استدعاء orgunits.batchInherit orgunits.batchModify groups.batchModify أو groups.batchDelete.
validTargetResources[]

enum (TargetResource)

النتائج فقط. معلومات عن الموارد المستهدَفة السارية للسياسة.
policyApiLifecycle

object (PolicyApiLifecycle)

النتائج فقط. معلومات دورة الحياة الحالية.
categoryTitle

string

عنوان الفئة التي ينتمي إليها الإعداد.

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" و "الإصدارات".

في حال توفُّر edition، يجب أن تكون هذه القيمة "إصدارات".

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

بالنسبة للأنواع الرقمية، يحتوي على تمثيل النص الأصلي للقيمة. للقيم المنطقية، "صحيح" أو "خطأ". بالنسبة إلى السلاسل، تحتوي على المحتوى النصي التلقائي (لا يتم إفلاته بأي شكل من الأشكال). بالنسبة إلى وحدات البايت، يحتوي على القيمة C التي تم تجاوزها. يتم تخطي جميع وحدات البايت >= 128.
oneofIndex

integer

في حال ضبطها، سيتم توفير فهرس واحد من في قائمة oneofDecl الخاصة بالنوع الذي يحتوي على القيمة. هذا الحقل هو عضو في هذا الحقل.
jsonName

string

اسم JSON لهذا الحقل يتم تحديد القيمة من خلال المحول البرمجي للبروتوكول. وإذا ضبط المستخدم خيار "jsonName" في هذا الحقل، سيتم استخدام قيمة هذا الخيار. وإلا، يتم استنتاجها من اسم الحقل بتحويله إلى حالة CamlCase.
proto3Optional

boolean

إذا كانت true، يكون هذا Proto3 "اختياريًا". عندما يكون حقل proto3 اختياريًا، فإنه يتتبّع التواجد بغض النظر عن نوع الحقل.

عندما تكون قيمة proto3Optional صحيحة، يجب أن ينتمي هذا الحقل إلى أحد الحقلين لإرسال إشارة إلى عملاء proto3 القدامى بأنه يتم تتبع التواجد لهذا الحقل. وتُعرف هذه الحقل باسم "مادة اصطناعية"، ويجب أن يكون هذا الحقل العضو الوحيد فيه (يحصل كل حقل اختياري للنموذج الأوّلي على حقل اصطناعي خاص به). تتوفّر الأعمدة الاصطناعية في الوصف فقط، ولا تنشئ أي واجهة برمجة تطبيقات. ويجب طلب المنتجات الاصطناعية بعد كل الأحرف "الحقيقية".

بالنسبة إلى حقول الرسائل، لا يُنشئ proto3Optional أي تغيير دلالي، لأنّ حقول الرسائل غير المتكرّرة تتتبّع التواجد دائمًا. ومع ذلك، فهي لا تزال تشير إلى التفاصيل الدلالية لما إذا كان المستخدم كتب كلمة "اختياري" أم لا. يمكن أن يكون هذا مفيدًا في عملية ذهاب وعودة ملف .proto. ولضمان الاتساق، نمنح حقول الرسائل صفًا اصطناعيًا أيضًا، على الرغم من أنّ ذلك ليس شرطًا لتتبُّع التواجد. ويحظى ذلك بأهمية خاصة، لأنّ المحلِّل لا يمكنه معرفة ما إذا كان الحقل عبارة عن رسالة أم تعدادًا، لذا يجب أن ينشئ دائمًا حقلاً اصطناعيًا.

لا يتم ضبط هذه العلامة في حقول Proto2 الاختيارية، لأنها تشير إلى أنّها اختيارية باستخدام LABEL_OPTIONAL.

التصنيف

عمليات التعداد
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 (EnumValueDescriptorProto)
    }
  ]
}
الحقول
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

لوصف قيمة ضمن التعداد.

تمثيل JSON 
{
  "name": string,
  "number": integer
}
الحقول
name

string
number

integer

OneofDescriptorProto

يصف واحد مما يلي.

تمثيل 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

تمّ الإيقاف. استخدِم الاسم والحقل الوصف بدلاً من ذلك. تمثّل هذه السمة وصف الحقل.
inputConstraint

string

النتائج فقط. أي قيود إدخال مرتبطة بقيم الحقل.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

النتائج فقط. إذا كان الحقل يحتوي على مجموعة من القيم المعروفة، سيقدّم هذا الحقل وصفًا لهذه القيم.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

النتائج فقط. تقدِّم وصفًا للحقول المضمّنة في هذا الحقل، إذا كان الحقل عبارة عن نوع رسالة يحدِّد حقولاً متعددة.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

النتائج فقط. توفّر هذه السياسة قائمة بالحقول والقيم. يجب أن يحتوي حقل واحد على الأقل من الحقول على القيمة المقابلة حتى يتم السماح بضبط هذا الحقل.
requiredItems[]

object (PolicySchemaRequiredItems)

النتائج فقط. توفّر هذه السياسة قائمة بالحقول المطلوب ضبطها إذا كان هذا الحقل يحتوي على قيمة معيّنة.
defaultValue

value (Value format)

النتائج فقط. الإعداد التلقائي للعميل في حال ترك السياسة بدون ضبط.
name

string

النتائج فقط. اسم الحقل.
fieldDescription

string

النتائج فقط. تمثّل هذه السمة وصف الحقل.
fieldConstraints

object (FieldConstraints)

النتائج فقط. معلومات عن أي قيود إدخال مرتبطة بقيم الحقل.

PolicySchemaFieldKnownValueDescription

توفِّر معلومات تفصيلية عن قيمة معروفة مسموح بها لحقل معيّن في PolicySchema.

تمثيل JSON 
{
  "value": string,
  "description": string
}
الحقول
value

string

النتائج فقط. إعادة عرض السلسلة للقيمة التي يمكن ضبطها للحقل.
description

string

النتائج فقط. وصف إضافي لهذه القيمة.

PolicySchemaFieldDependencies

الحقل والقيمة التي يجب أن يحتوي عليها للسماح بضبط حقل آخر.

تمثيل JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
الحقول
sourceField

string

حقل المصدر الذي يعتمد عليه هذا الحقل.
sourceFieldValue

string

القيمة التي يجب أن يحتوي عليها حقل المصدر ليتم السماح بتعيين هذا الحقل.

PolicySchemaRequiredItems

الحقول التي ستصبح مطلوبة استنادًا إلى قيمة هذا الحقل.

تمثيل JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
الحقول
fieldConditions[]

string

قيم الحقل التي تستدعي فرض الحقل المطلوب. يعني الحقل الفارغ حالة الحقل أن أي قيمة تم تعيينها لهذا الحقل ستؤدي إلى تفعيل فرض الحقل المطلوب.
requiredFields[]

string

الحقول المطلوبة نتيجة لظروف الحقل.

FieldConstraints

معلومات حول أي قيود على النطاق.

تمثيل JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
الحقول
numericRangeConstraint

object (NumericRangeConstraint)

النطاق المسموح به للحقول الرقمية.
uploadedFileConstraints

object (UploadedFileConstraints)

القيود على الملف الذي تم تحميله لسياسة ملف وفي حال توفُّرها، تتطلّب هذه السياسة عنوان URL يمكن جلبه عن طريق تحميل ملف بالقيود المحدّدة في هذا النموذج الأوّلي.

NumericRangeConstraint

قيد على الحدين العلوي و/أو السفلي، مع تعيين واحد على الأقل.

تمثيل 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 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

string

النتائج فقط. اسم الحقل المرتبط بالإشعار.
noticeValue

string

النتائج فقط. قيمة الحقل الذي يحتوي على إشعار. عند ضبط الحقل على هذه القيمة، قد يُطلب من المستخدم الإقرار برسالة الإشعار حتى يتم ضبط القيمة.
noticeMessage

string

النتائج فقط. ترتبط رسالة الإشعار بقيمة الحقل.
acknowledgementRequired

boolean

النتائج فقط. ما إذا كان المستخدم بحاجة إلى الإقرار برسالة الإشعار قبل ضبط القيمة.

TargetResource

أنواع الموارد المستهدفة

عمليات التعداد
TARGET_RESOURCE_UNSPECIFIED مورد مستهدف غير محدّد
ORG_UNIT المورد المستهدف للوحدة التنظيمية.
GROUP مورد هدف المجموعة

PolicyApiLifecycle

تمثيل JSON 
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
الحقول
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

تشير هذه السمة إلى مرحلة دورة الحياة الحالية لواجهة برمجة التطبيقات Policy API.
description

string

وصف عن دورة الحياة الحالية
endSupport

object (Date)

تاريخ انتهاء صلاحية السياسة الحالية
deprecatedInFavorOf[]

string

في حال إيقاف هذه السياسة لصالح سياسة أخرى، يتم تحديد مساحات الاسم المؤهّلة بالكامل للسياسات الجديدة كما ستظهر في PolicyAPI.

PolicyApiLifecycleEnum

عمليات التعداد
API_UNSPECIFIED غير محدد
API_PREVIEW لا تعمل السياسة بعد، ولكنها تمنح مطوّري البرامج تنبيهات بشأن تنسيق المحتوى. يمكن أن يتم نقل هذه المرحلة إلى API_DE المطابقةMNT أو API_CURRENT.
API_DEVELOPMENT يمكن أن تؤدي السياسة إلى تغيير التنسيق بطريقة غير متوافقة مع الإصدارات السابقة (يعطّل التغيير). يمكن نقل هذه المرحلة إلى API_CURRENT أو API_DEPRECATED. يمكن استخدام هذه الميزة للسياسات التي تم إطلاقها فقط لأجهزة "تحويل النص إلى كلام" أو إطلاقها لعملاء محدَّدين للاستخدام في حالات الطوارئ.
API_CURRENT السياسة بالتنسيق الرسمي. يمكن أن تغيّر السياسة التنسيق بطريقة متوافقة مع الأنظمة القديمة (تغيير غير مؤثِّر). مثال: يمكن أن تقدم هذه السياسة حقلاً جديدًا، ما يُعتبر تغييرًا غير مؤثِّر، عند استخدام أقنعة الحقول بشكل صحيح. يمكن نقل هذه المرحلة إلى API_DEPRECATED.
API_DEPRECATED يُرجى التوقف عن استخدام هذه السياسة. تم إيقاف هذه السياسة نهائيًا، وقد تتم إزالتها في المستقبل. من المرجّح أنّه تم طرح سياسة جديدة بدلاً من هذه السياسة.

التاريخ

تمثّل تاريخًا كاملاً أو جزئيًا في التقويم، مثل تاريخ الميلاد. تم تحديد الوقت من اليوم والمنطقة الزمنية في مكان آخر أو هما غير مهمين. التاريخ مرتبط بالتقويم الميلادي. يمكن أن يمثّل ذلك أحد الأنواع التالية:

  • تاريخ كامل، مع قيم غير صفرية للسنة والشهر واليوم.
  • شهر ويوم مع السنة صفر (على سبيل المثال، ذكرى سنوية).
  • سنة من تلقاء نفسها، مع عدم تحديد شهر ويوم صفر.
  • سنة وشهر بدون يوم (على سبيل المثال، تاريخ انتهاء صلاحية بطاقة الائتمان).

أنواع ذات صلة:

تمثيل JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
الحقول
year

integer

سنة من التاريخ. يجب أن تتراوح القيمة بين 1 و9999، أو 0 لتحديد تاريخ بدون سنة.
month

integer

شهر من السنة يجب أن تتراوح القيمة من 1 إلى 12 أو 0 لتحديد عام بدون شهر ويوم.
day

integer

يوم من الشهر. يجب أن تتراوح القيمة من 1 إلى 31 وأن تكون صالحة للسنة والشهر أو يجب أن تكون القيمة 0 لتحديد سنة بحد ذاتها أو عام وشهر لا يكون فيه اليوم مهمًا.

الطُرق

get

 احصل على مخطط سياسة معيّن للعميل من خلال اسم مورده.

list

 الحصول على قائمة بمخطّطات السياسات التي تتطابق مع قيمة فلتر محدّدة لعميل معيّن