انتقل إلى المحتوى
ShopentlyLearn

مخططات البيانات: صفحات CMS

مخططات البيانات: صفحات CMS. حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

مخططات البيانات

البيانات الوصفية للاستجابة

AnalyticsPageMeta · المخطط · مخططات البيانات: صفحات 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"

حقول إضافية: لا

عرض القائمة — صفحات CMS — الاستجابة

ApiResponse_list_PageSummaryData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
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"}

حقول إضافية: لا

جلب — صفحات CMS — الاستجابة

ApiResponse_PageDetailData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
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"}

حقول إضافية: لا

إنشاء — صفحات CMS — محتوى الطلب

PageCreate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
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"

حقول إضافية: لا

جلب — صفحات CMS — الاستجابة

PageDetailData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
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

حقول إضافية: لا

عرض القائمة — صفحات CMS — الاستجابة

PageSummaryData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
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

حقول إضافية: لا

تحديث — صفحات CMS — محتوى الطلب

PageUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
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"

حقول إضافية: لا