Skema kebijakan

Kebijakan Chrome direpresentasikan sebagai skema kebijakan oleh Schema Service API. Setiap skema kebijakan memiliki nama unik untuk mengidentifikasinya. Ini adalah definisi setelan {i>field <i}dan jenisnya, serta deskripsi pengaturan yang dapat dibaca manusia di Bahasa Inggris.

Misalnya, di bawah ini adalah cara Schema Service API mewakili setelan yang memungkinkan tombol logout muncul di area notifikasi Chrome. A yang disederhanakan representasi dari setelan ini adalah bool showLogoutButtonInTray. Klik "Tampilkan contoh" di bawah ini untuk melihat bagaimana Schema Service API merepresentasikannya deskripsi tempat.

{
  "name": "customers/C0202nabg/policySchemas/chrome.users.ShowLogoutButton",
  "policyDescription": "Show logout button in tray.", // description of the policy
  "definition": { // definition of the settings (fields names and types)
    "messageType": [
      {
        "name": "ShowLogoutButton",
        "field": [
          {
            "name": "showLogoutButtonInTray", // the setting showLogoutButtonInTray
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL" // the setting showLogoutButtonInTray is of type boolean
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [ // human readable descriptions of the settings and their values
    {
      "field": "showLogoutButtonInTray",
      "knownValueDescriptions": [
        {
          "value": "true",
          "description": "Show logout button in tray." // description for showLogoutButtonInTray=true
        },
        {
          "value": "false",
          "description": "Do not show logout button in tray." // description for showLogoutButtonInTray=false
        }
      ]
    }
  ],
  "schemaName": "chrome.users.ShowLogoutButton" //  unique name to identify the policy
}
  

Nama skema kebijakan

name skema adalah ID uniknya, dengan format berikut: {namespace}.{leafName}.

Dalam contoh di atas, nama skema lengkapnya adalah chrome.users.ShowLogoutButton. Namespace ini adalah chrome.users. dan nama daunnya adalah ShowLogoutButton.

Kebijakan dengan cakupan serupa dikelompokkan dalam namespace yang sama. Misalnya, semua skema kebijakan pengguna diawali dengan namespace chrome.users. dan semua skema kebijakan printer diawali dengan namespace chrome.printers..

Namespace

Kunci skema kebijakan

Beberapa kebijakan memerlukan konteks tambahan untuk dilihat atau diubah. Contoh:

• Untuk mengubah kebijakan aplikasi, Anda perlu menentukan aplikasi mana dengan mengisi key="app_id".
• Untuk mengubah kebijakan setelan printer di Unit Organisasi, Anda harus tentukan printer mana dengan mengisi key="printer_id".

Skema kebijakan ini berisi bagian additionalTargetKeyNames yang menjelaskan kunci dan nilai yang akan diteruskan di permintaan API Anda.

Untuk mengetahui detail selengkapnya, buka Contoh kode.

{
  "name": "customers/C0202nabg/policySchemas/chrome.printers.AllowForUsers",
  "policyDescription": "Allows a printer for users in a given organization.",
  "additionalTargetKeyNames": [
    {
      "key": "printer_id",
      "keyDescription": "Id of printer as visible in Admin SDK printers API."
    }
  ],
  "definition": {
    "messageType": [
      {
        "name": "AllowForUsers",
        "field": [
          {
            "name": "allowForUsers",
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL"
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [
    {
      "field": "allowForUsers",
      "description": "Controls whether a printer is allowed for users in a given organization."
    }
  ],
  "schemaName": "chrome.printers.AllowForUsers"
}
  

Kebijakan aplikasi

Beberapa namespace di atas ditujukan untuk kebijakan aplikasi, seperti Aplikasi Pengguna, Aplikasi Kios, Kebijakan Aplikasi Sesi Tamu Terkelola dan Konfigurasi Aplikasi Kios. Kebijakan aplikasi memerlukan app_id.

app_id dibentuk dengan menggabungkan jenis aplikasi dan ID aplikasi. Contoh:

• chrome:mkaakpdehdafacodkgkpghoibnmamcme mewakili "Google Gambar" Aplikasi Chrome
• android:com.google.android.calendar mewakili "Google Kalender" aplikasi Android
• web:https://canvas.apps.chrome mewakili "Canvas" Aplikasi web

Kolom multi-nilai

Kolom dengan label LABEL_REPEATED mewakili kolom multi-nilai, seperti daftar atau array. Anda dapat memberikan beberapa nilai ke kolom ini. Untuk mengetahui detail selengkapnya, lihat Contoh kode.

Status skema kebijakan

Setiap kebijakan memiliki objek policyApiLifecycle untuk mewakili statusnya saat ini. Objek ini berisi kolom berikut dengan detail tentang konfigurasi status:

• Kolom policyApiLifecycleStage menunjukkan pada tahap mana dari berikut ini paling baik untuk menggambarkan status kebijakan saat ini.
• Kolom description memberikan detail selengkapnya tentang status kebijakan saat ini.
• Kolom endSupport menunjukkan tanggal dukungan akhir untuk kebijakan, jika ada didefinisikan.
• deprecatedInFavorOf hanya dapat disetel jika policyApiLifecycleStage adalah API_TIDAK DIGUNAKAN LAGI. Bagian ini menunjukkan namespace yang sepenuhnya memenuhi syarat untuk kebijakan baru kebijakan saat ini tidak digunakan lagi.
• Kolom scheduledToDeprecatePolicies sesuai dengan tidak digunakan lagiInFavorOf. Bagian ini menampilkan namespace lama yang sepenuhnya memenuhi syarat kebijakan yang tidak akan digunakan lagi karena diperkenalkannya kebijakan ini.

Tahapan siklus proses

{
  "name": "customers/C0202nabg/policySchemas/chrome.users.OutdatedPolicy",
  "policyDescription": "Just for demo, this is an outdated policy.",
  "definition": {
    "messageType": [
      {
        "name": "OutdatedPolicy",
        "field": [
          {
            "name": "outdatedField",
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL"
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [
    {
      "field": "outdatedField",
      "description": "This is an outdated field"
    }
  ],
  "schemaName": "chrome.users.OutdatedPolicy",
  "policyApiLifecycle": { // policy's current lifecycle status
    "policyApiLifecycleStage": "API_DEPRECATED",
    "description": "This policy is deprecated. Please stop using it",
    "endSupport": {
      "year": 2021,
      "month": 2,
      "day": 29
    }
    "deprecatedInFavorOf": "chrome.users.NewPolicy"
  }
}

{
  "name": "customers/C0202nabg/policySchemas/chrome.users.NewPolicy",
  "policyDescription": "Just for demo, this is a new policy.",
  "definition": {
    "messageType": [
      {
        "name": "NewPolicy",
        "field": [
          {
            "name": "newField",
            "number": 1,
            "label": "LABEL_OPTIONAL",
            "type": "TYPE_BOOL"
          }
        ]
      }
    ]
  },
  "fieldDescriptions": [
    {
      "field": "newField",
      "description": "This is an new field"
    }
  ],
  "schemaName": "chrome.users.NewPolicy",
  "policyApiLifecycle": { // policy's current lifecycle status
    "policyApiLifecycleStage": "API_CURRENT,
    "scheduledToDeprecatePolicies": "chrome.users.OutdatedPolicy"
  }
}
  

Pemberitahuan skema kebijakan

Beberapa kebijakan memiliki notices yang terkait dengan acknowledgement_required ditetapkan ke true untuk nilai tertentu dari kolom kebijakan tertentu. Untuk kebijakan tersebut, Anda perlu menyetel kolom konfirmasi khusus ke true sebelum Anda dapat menyetel dengan sejumlah nilai.

Untuk mengetahui detail selengkapnya, lihat Contoh kode.

Platform yang didukung

supportedPlatforms adalah daftar yang menunjukkan bahwa kebijakan hanya akan berlaku bagi perangkat atau pengguna di platform ini. Semua platform yang didukung tercantum di pada tabel berikut.

Platform yang didukung

Langkah berikutnya

• Mengaktifkan Chrome Policy API dan mengizinkan permintaan
• Menampilkan daftar skema kebijakan dengan API