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)

คำจำกัดความของสคีมาโดยใช้ Proto Descriptor

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 ค่าที่รองรับคือ "Prott2", "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 ไว้ หากมีการตั้งค่าทั้ง this และ typeName ค่านี้ต้องเป็น TYPE_ENUM, TYPE_MESSAGE หรือ TYPE_GROUP

string

สำหรับประเภทข้อความและ enum นี่คือชื่อของประเภท หากชื่อขึ้นต้นด้วย "." แสดงว่าชื่อแบบเต็ม มิฉะนั้น กฎที่กำหนดขอบเขตเหมือน C++ จะใช้เพื่อค้นหาประเภท (เช่น ระบบจะค้นหาประเภทที่ซ้อนกันภายในข้อความนี้ก่อน จากนั้นจะค้นหาภายในรายการระดับบนไปจนถึงเนมสเปซรูท)

string

สำหรับประเภทตัวเลข จะมีข้อความต้นฉบับแทนค่า สำหรับบูลีน "true" หรือ "false" สำหรับสตริง จะมีเนื้อหาข้อความเริ่มต้น (ไม่มีการกำหนดเป็นอักขระหลีกแต่อย่างใด) สำหรับไบต์ จะมีค่า C Escape ไบต์ทั้งหมดที่ >= 128 มีการกำหนดเป็นอักขระหลีก

integer

หากมีการตั้งค่า ให้จัดทำดัชนีของค่าใดค่าหนึ่งในรายการ oneofdecl ของประเภทที่มี ช่องนี้เป็นสมาชิกของช่องดังกล่าว

string

ชื่อ JSON ของฟิลด์นี้ ค่านี้ถูกกำหนดโดยคอมไพเลอร์โปรโตคอล หากผู้ใช้ตั้งค่า "jsonName" ในช่องนี้ ระบบจะใช้ค่าของตัวเลือกดังกล่าว มิฉะนั้นจะอนุมานจากชื่อฟิลด์โดยแปลงเป็น CamlCase

boolean

หากจริง พารามิเตอร์นี้คือ Proto3 "ไม่บังคับ" เมื่อไม่บังคับให้ช่อง Proto3 ช่องดังกล่าวจะติดตามการแสดงผลโดยไม่คำนึงถึงช่องประเภท

เมื่อ Proto3Optional ของคุณกลายเป็นจริง ช่องนี้จะต้องเป็นของฟิลด์ใดช่องหนึ่ง เพื่อส่งสัญญาณไปยังไคลเอ็นต์ Proto3 เก่าว่ามีการติดตามการมีอยู่สำหรับฟิลด์นี้ โครงสร้างนี้เรียกว่า "สังเคราะห์" ฟิลด์ใดฟิลด์หนึ่ง และฟิลด์นี้จะต้องเป็นสมาชิกเพียงคนเดียว (ฟิลด์ตัวเลือก PRO36 แต่ละรายการจะมีฟิลด์สังเคราะห์ของตัวเอง) หนึ่งในกลุ่มสังเคราะห์อยู่ในคำอธิบายเท่านั้น และจะไม่สร้าง API ใดๆ ธีมสังเคราะห์ต้องมีลำดับอยู่หลัง "ของจริง" ทั้งหมด อย่างใดอย่างหนึ่ง

สำหรับช่องข้อความ protocol3Optional จะไม่สร้างการเปลี่ยนแปลงเชิงความหมายเนื่องจากช่องข้อความแบบไม่ซ้ำจะติดตามการแสดงข้อมูลเสมอ อย่างไรก็ตาม ข้อมูลนี้ยังคงระบุรายละเอียดเชิงความหมายว่าผู้ใช้เขียนว่า "ไม่บังคับ" หรือไม่ หรือไม่ ซึ่งอาจเป็นประโยชน์ในการส่งไฟล์ .prof ไป-กลับ เราจะใส่ฟิลด์สังเคราะห์อย่างใดอย่างหนึ่งให้กับฟิลด์ข้อความด้วย ถึงจะไม่ต้องติดตามการมีอยู่ก็ตาม ซึ่งเป็นเรื่องที่สำคัญอย่างยิ่ง เนื่องจากโปรแกรมแยกวิเคราะห์ไม่สามารถบอกได้ว่าช่องหนึ่งเป็นข้อความหรือ enum จึงต้องสร้างช่องสังเคราะห์ขึ้นเสมอ

ช่องที่ไม่บังคับของ 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

เลิกใช้งานแล้ว โปรดใช้ชื่อและ FieldDescription แทน คำอธิบายสำหรับช่อง

string

เอาต์พุตเท่านั้น ข้อจำกัดอินพุตใดๆ ที่เกี่ยวข้องกับค่าสำหรับช่อง

object (PolicySchemaFieldKnownValueDescription)

เอาต์พุตเท่านั้น หากช่องนี้มีชุดค่าที่รู้จัก ช่องนี้จะมีคำอธิบายสำหรับค่าเหล่านี้

object (PolicySchemaFieldDescription)

เอาต์พุตเท่านั้น ระบุคำอธิบายของช่องที่ฝังอยู่ในช่องนี้ หากช่องนี้เป็นประเภทข้อความที่กำหนดหลายช่อง ช่องต่างๆ แนะนำให้แสดงตามอันดับในรายการนี้ ไม่ใช่ตามหมายเลขช่อง

object (PolicySchemaFieldDependencies)

เอาต์พุตเท่านั้น มีรายการช่องและค่า อย่างน้อย 1 ช่องต้องมีค่าที่เกี่ยวข้อง จึงจะตั้งค่าช่องนี้ได้

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)

ระบุขั้นตอนวงจรปัจจุบันของ API นโยบาย

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 เพื่อระบุปีเพียงอย่างเดียว หรือ 1 ปีและเดือนที่วันไม่มีนัยสำคัญ