データスキーマ: CMS ページ

paginationPagination 必須

カーソルによるページ分割のメタデータ。

例: {"has_more":false,"limit":20,"next_cursor":null}

periodAnalyticsPeriodData 必須

集計期間とその開始・終了。

例: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

例: "example"

追加フィールド: いいえ

data配列 <PageSummaryData > 必須

レスポンス例 · ApiResponse_list_PageSummaryData__.

例: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

追加フィールド: いいえ

dataPageDetailData 必須

レスポンス例 · PageDetailData.

例: {"body_html":"<p>Example</p>","created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","meta_description":"example","meta_keywords":["example"],"meta_title":"example","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

追加フィールド: いいえ

body_html文字列 | null任意

ページの HTML 本文。

文字列:maxLength: 100000

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

market_scope文字列任意

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

meta_description文字列 | null任意

選択した言語での検索エンジン向け説明。

文字列:maxLength: 160

meta_keywords配列 <文字列> | null任意

選択した言語での検索エンジン向けキーワード。

配列:maxItems: 20

配列 / 配列:maxLength: 60

meta_title文字列 | null任意

選択した言語での検索エンジン向けタイトル。

文字列:maxLength: 70

published真偽値任意

リソースが公開済みかどうか。

既定値: false

slug文字列 | null任意

選択した言語での URL パス部分。

文字列:maxLength: 160

title文字列必須

選択した言語でのタイトル。

minLength: 1maxLength: 300

例: "Example"

追加フィールド: いいえ

body_html文字列 | null必須

ページの HTML 本文。

例: "<p>Example</p>"

created_at文字列必須

作成時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (PageDetailData).

例: "example"

is_available真偽値必須

このコンテキストで対象を利用できるかどうか。

例: true

market_scope文字列必須

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

例: "all"

meta_description文字列 | null必須

選択した言語での検索エンジン向け説明。

例: "example"

meta_keywords配列 <文字列> | null必須

選択した言語での検索エンジン向けキーワード。

例: ["example"]

meta_title文字列 | null必須

選択した言語での検索エンジン向けタイトル。

例: "example"

number文字列必須

人向けの注文番号または申請番号。

例: "example"

published真偽値必須

リソースが公開済みかどうか。

例: false

slug文字列 | null必須

選択した言語での URL パス部分。

例: "example"

title文字列 | null必須

選択した言語でのタイトル。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

created_at文字列必須

作成時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (PageSummaryData).

例: "example"

is_available真偽値必須

このコンテキストで対象を利用できるかどうか。

例: true

market_scope文字列必須

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

例: "all"

number文字列必須

人向けの注文番号または申請番号。

例: "example"

published真偽値必須

リソースが公開済みかどうか。

例: false

slug文字列 | null必須

選択した言語での URL パス部分。

例: "example"

title文字列 | null必須

選択した言語でのタイトル。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

body_html文字列 | null任意

ページの HTML 本文。

文字列:maxLength: 100000

expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1maximum: 2147483647

例: 1

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

market_scope文字列任意

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

meta_description文字列 | null任意

選択した言語での検索エンジン向け説明。

文字列:maxLength: 160

meta_keywords配列 <文字列> | null任意

選択した言語での検索エンジン向けキーワード。

配列:maxItems: 20

配列 / 配列:maxLength: 60

meta_title文字列 | null任意

選択した言語での検索エンジン向けタイトル。

文字列:maxLength: 70

published真偽値任意

リソースが公開済みかどうか。

slug文字列 | null任意

選択した言語での URL パス部分。

文字列:maxLength: 160

title文字列 | null任意

選択した言語でのタイトル。

文字列:maxLength: 300

例: "Example"

追加フィールド: いいえ