Locale
Terakhir diperbarui: 22 Juni 2026
Locale adalah pengaturan bahasa yang didukung oleh sebuah Space. Setiap Locale memiliki kode bahasa (code, misalnya ko-KR), penanda apakah ia merupakan Locale default dari Space (default), penanda apakah ia opsional saat pengisian field wajib (optional), dan Locale yang dicari sebagai gantinya ketika nilai tidak ada (fallbackCode). CDA (Content Delivery API) menyampaikan daftar ini dalam mode baca saja. Membuat atau mengubah Locale adalah wewenang CMA Locale.
Nilai parameter kueri locale yang Anda kirim saat mengambil Content atau Media adalah persis code dari Locale ini. Untuk mengetahui kode mana yang dapat dimasukkan, baca terlebih dahulu daftar Locale yang didukung Space melalui endpoint ini, lalu gunakan code yang ada di dalamnya.
Struktur resource
Berikut adalah bentuk yang disampaikan CDA untuk satu Locale ("Korean (South Korea)") dari Space demo. Bersama dengan sys (properti sistem), ia memiliki optional sebagai properti isi dari Locale.
{
"sys": {
"id": "3trmXRM3RqbgSnifyg7OGfZoXmkOU8",
"type": "Locale",
"space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
"name": "Korean (South Korea)",
"default": false,
"code": "ko-KR",
"createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"createdAt": "2026-06-15T15:14:11.710Z",
"updatedAt": "2026-06-17T10:43:32.034Z",
"updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"version": 3
},
"optional": false
}Kunci utama:
sys.code: kode bahasa dari Locale ini. Masukkan nilai ini ke parameterlocalesaat mengambil Content atau Media.sys.default: penanda apakah Locale ini merupakan Locale default dari Space. Sebuah Space memiliki satu Locale default, dan hanya pada Locale itudefaultbernilaitrue.sys.name: nama yang dapat dibaca manusia (misalnya"Korean (South Korea)"). Pada parameter pengambilan, gunakancode, bukan nama ini.optional: penanda apakah Locale ini boleh dibiarkan kosong saat mengisi field wajib (required). Kedua Locale pada contoh di atas sama-sama memilikioptionalbernilaifalse.fallbackCode:codedari Locale lain yang dicari sebagai gantinya ketika nilai tidak ada (opsional). Hanya muncul di respons jika telah diatur. Pada contoh di atas, ini tidak diatur sehingga kuncinya tidak terlihat.
Properti sistem (sys) dan isi
space, createdBy, dan updatedBy masuk dalam bentuk Refer ({ "sys": { "id", "type": "Refer", "targetType" } }).
| Properti | Tipe | Deskripsi |
|---|---|---|
id | string | Identifikasi unik resource. |
type | string | Jenis resource. Locale selalu "Locale". |
space | Refer<Space> | Space tempat Locale ini berada. |
name | string | Nama yang dapat dibaca manusia (misalnya "Korean (South Korea)"). |
code | string | Kode bahasa (misalnya ko-KR). Menjadi nilai locale saat mengambil Content atau Media. |
default | boolean | Penanda apakah merupakan Locale default dari Space. Hanya satu yang true dalam sebuah Space. |
createdBy | Refer<User> | Pengguna yang membuat. |
createdAt | string (date-time) | Waktu pembuatan. |
updatedBy | Refer<User> | Pengguna yang terakhir mengubah. |
updatedAt | string (date-time) | Waktu perubahan terakhir. |
version | integer | Versi saat ini. Naik setiap kali diubah. |
Locale adalah resource pengaturan dari Space, bukan snapshot publikasi, sehingga revision, status, dan publish yang ada pada sys dari Content tidak disertakan.
Properti isi:
| Properti | Tipe | Deskripsi |
|---|---|---|
optional | boolean | Penanda apakah Locale ini boleh dibiarkan kosong saat mengisi field wajib (required). Locale default umumnya bernilai false (harus diisi). |
fallbackCode | string | code dari Locale yang dicari sebagai gantinya ketika nilai tidak ada (opsional, dapat dirantai). Jika tidak diatur, kunci itu sendiri tidak ada di respons. |
Catatan perilaku
Locale yang default-nya true harus diisi saat membuat Content, dan pada pengambilan Content atau Media Anda menentukan locale dengan code tersebut untuk menerima nilai bahasa itu. Jika fallbackCode diatur, ketika Locale yang diminta tidak memiliki nilai, sistem beralih ke Locale yang ditunjuk fallbackCode untuk mencari nilai (jika Locale itu juga memiliki fallbackCode, rantai terus berlanjut). Locale tanpa fallbackCode akan langsung menjadi null ketika nilainya tidak ada. Aturan Locale default, fallback, dan pengisian wajib dibahas di Multibahasa (konsep).
API
Base URL untuk endpoint di bawah ini adalah https://cda.weegloo.com/v1, dan diperlukan Bearer token yang mengautentikasi CDA pada header Authorization. Karena daftar Locale adalah pengaturan bahasa itu sendiri, ia tidak menerima parameter kueri locale, berbeda dengan pengambilan Content atau Media.
Dokumen terkait
- Ikhtisar CDA: keseluruhan CDA dan perilaku penyampaian umum.
- CDA Content: menerima penyampaian Content dengan menentukan bahasa melalui locale.
- Multibahasa (konsep): aturan Locale default, fallback, dan pengisian wajib.
