REST Resource: customers.policySchemas

{
  "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)
  ]
}

string

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

string

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

object (AdditionalTargetKeyName)

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

object (FileDescriptorProto)

تعريف المخطط باستخدام واصف النماذج الأوّلية

object (PolicySchemaFieldDescription)

النتائج فقط. وصف تفصيلي لكل حقل يشكّل جزءًا من المخطط. يمكن عرض الحقول حسب الترتيب في هذه القائمة، وليس حسب رقم الحقل.

string

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

object (PolicySchemaNoticeDescription)

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

string

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

string

النتائج فقط. الاسم المؤهّل بالكامل لمخطط السياسة. يتم استخدام هذه القيمة لملء الحقل policySchema في PolicyValue عند طلب BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies أو BatchDeleteGroupPolicies.

enum (TargetResource)

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

object (PolicyApiLifecycle)

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

string

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

enum (Platform)

النتائج فقط. تشير "القائمة" إلى أنّ السياسة لن تسري إلا على الأجهزة/المستخدمين على هذه المنصات.

{
  "key": string,
  "keyDescription": string
}

string

الاسم الرئيسي.

string

وصف المفتاح

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

string

اسم الملف، نسبةً إلى جذر شجرة المصدر

string

مثلاً: "foo" أو "foo.bar" وما إلى ذلك

object (DescriptorProto)

جميع التعريفات ذات المستوى الأعلى في هذا الملف

object (EnumDescriptorProto)

string

بناء جملة ملف Proto. القيم المسموح بها هي "proto2" و"proto3" و"editions".

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

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

string

object (FieldDescriptorProto)

object (DescriptorProto)

object (EnumDescriptorProto)

object (OneofDescriptorProto)

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

string

integer

enum (Label)

enum (Type)

إذا تم ضبط typeName، لا يلزم ضبطها. إذا تم ضبط كل من هذا الحقل وtypeName، يجب أن يكون النوع TYPE_ENUM أو TYPE_MESSAGE أو TYPE_GROUP.

string

بالنسبة إلى أنواع الرسالة والتعداد، يكون هذا هو اسم النوع. وإذا كان الاسم يبدأ بـ "."، فهذا يعني أنّه مؤهَّل بالكامل. وبخلاف ذلك، يتم استخدام قواعد تحديد نطاق تشبه C++ للعثور على النوع (أي يتم البحث أولاً عن الأنواع المتداخلة داخل هذه الرسالة، ثم داخل الأصل، وصولاً إلى مساحة الاسم الجذر).

string

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

integer

في حال استخدام هذه السمة، يتم توفير فهرس a oneof في قائمة oneofDecl للنوع المحتوي. هذا الحقل عضو في ذلك الحقل.

string

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

boolean

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

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

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

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

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

string

object (EnumValueDescriptorProto)

{
  "name": string,
  "number": integer
}

string

integer

{
  "name": string
}

string

{
  "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)
  }
}

string

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

string

تمّ الإيقاف. استخدِم name وfieldDescription بدلاً من ذلك. وصف الحقل.

string

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

object (PolicySchemaFieldKnownValueDescription)

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

object (PolicySchemaFieldDescription)

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

object (PolicySchemaFieldDependencies)

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

object (PolicySchemaRequiredItems)

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

value (Value format)

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

string

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

string

النتائج فقط. وصف الحقل.

object (FieldConstraints)

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

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

string

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

string

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

object (PolicySchemaFieldDependencies)

النتائج فقط. شروط الحقل المطلوبة لكي تكون هذه القيمة صالحة.

{
  "sourceField": string,
  "sourceFieldValue": string
}

string

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

string

القيمة التي يجب أن يتضمّنها حقل المصدر للسماح بضبط هذا الحقل.

{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}

string

قيمة(قيم) الحقل التي أدت إلى فرض تنفيذ الحقل المطلوب. تشير شروط الحقل الفارغ إلى أنّ أيّ قيمة مخصّصة لهذا الحقل ستؤدي إلى فرض تنفيذ الحقل المطلوب.

string

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

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

object (NumericRangeConstraint)

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

object (UploadedFileConstraints)

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

{
  "minimum": string,
  "maximum": string
}

string (int64 format)

القيمة الصغرى.

string (int64 format)

القيمة القصوى.

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

enum (ContentType)

أنواع الملفات التي يمكن تحميلها لأحد الإعدادات.

string (int64 format)

الحد الأقصى لحجم الملفات المحمَّلة لأحد الإعدادات، بالبايت.

{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}

string

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

string

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

string

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

boolean

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

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

string

في حال إيقاف هذه السياسة لصالح سياسة أخرى، سيتم عرض مساحات الاسم المؤهلة بالكامل للسياسات الجديدة على النحو الذي ستظهر به في PolicyAPI. لا يمكن ضبطها إلا إذا كانت policyApiLifecycleStage API_DEPRECATED.

string

وبما يتوافق مع سياسة متوقّفة نهائيًا InFavorOf، فإنّ مساحات الاسم المؤهّلة بالكامل للسياسات القديمة سيتم إيقافها نهائيًا بسبب تطبيق هذه السياسة.

enum (PolicyApiLifecycleEnum)

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

string

وصف حول دورة الحياة الحالية.

object (Date)

تاريخ انتهاء التوافق مع السياسة الحالية ستؤدي محاولة تعديل إحدى السياسات بعد تاريخ انتهاء صلاحيتها إلى ظهور "طلب غير صالح" (الخطأ 400). لا يمكن ضبطها إلا إذا كانت policyApiLifecycleStage API_DEPRECATED.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

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

integer

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

integer

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