مخططات البيانات: تحليلات البحث وقواعده

periodAnalyticsPeriodData مطلوب

فترة التقرير وحدودها.

مثال: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}

request_idسلسلة نصيةمطلوب

معرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.

minLength: 1maxLength: 100

مثال: "example"

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

as_ofسلسلة نصيةمطلوب

الوقت الذي تشير إليه البيانات المعروضة.

format: "date-time"

مثال: "2026-01-02T00:00:00Z"

daysعدد صحيحمطلوب

فترة التقرير بالأيام.

مثال: 1

started_atسلسلة نصيةمطلوب

تاريخ البدء ووقته.

format: "date-time"

مثال: "2026-01-01T00:00:00Z"

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

dataمصفوفة <MetricData > مطلوب

مثال على الاستجابة · AnalyticsResponse_list_MetricData__.

مثال: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]

metaAnalyticsPageMeta | AnalyticsMeta مطلوب

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

مثال: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

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

dataمصفوفة <OccurrenceData > مطلوب

مثال على الاستجابة · AnalyticsResponse_list_OccurrenceData__.

مثال: [{"category_id":"example","category_result_count":1,"currency_code":"PLN","is_zero_results":false,"locale_code":"en","market_id":"example","max_price":"0.00","min_price":"0.00","occurred_at":"2026-01-01T12:00:00Z","page":1,"product_result_count":1,"query_display":"example","request_id":"example","results":[{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}],"sort_key":"example","source":"results"}]

metaAnalyticsPageMeta | AnalyticsMeta مطلوب

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

مثال: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

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

dataOverviewData مطلوب

مثال على الاستجابة · OverviewData.

مثال: {"click_through_rate":0,"clicked_searches":1,"recent":[{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}],"searches":1,"zero_result_rate":0,"zero_results":1}

metaAnalyticsPageMeta | AnalyticsMeta مطلوب

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

مثال: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

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

dataمصفوفة <RuleSummaryData > مطلوب

مثال على الاستجابة · ApiResponse_list_RuleSummaryData__.

مثال: [{"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_scope":"all","name":"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"}

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

dataRuleDetailData مطلوب

مثال على الاستجابة · RuleDetailData.

مثال: {"category_ids":["example"],"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_ids":["example"],"market_scope":"all","name":"Example","phrase_groups":[{"locale":"en","phrases":["example"]}],"product_ids":["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"}

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

clicksعدد صحيحمطلوب

عدد النقرات.

مثال: 1

last_seen_atسلسلة نصيةمطلوب

وقت آخر ظهور.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

query_displayسلسلة نصيةمطلوب

عبارة البحث المعروضة للمسؤول.

مثال: "example"

query_hashسلسلة نصيةمطلوب

معرّف ثابت لعبارة البحث المجمعة.

مثال: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

searchesعدد صحيحمطلوب

عدد عمليات البحث.

مثال: 1

zero_resultsعدد صحيحمطلوب

عدد عمليات البحث بلا نتائج.

مثال: 1

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

category_idسلسلة نصية | nullمطلوب

معرّف الفئة.

مثال: "example"

category_result_countعدد صحيحمطلوب

عدد نتائج الفئات.

مثال: 1

currency_codeسلسلة نصيةمطلوب

رمز العملة.

مثال: "PLN"

is_zero_resultsقيمة منطقيةمطلوب

ما إذا لم يُرجع البحث أي نتائج.

مثال: false

locale_codeسلسلة نصيةمطلوب

رمز اللغة.

مثال: "en"

market_idسلسلة نصيةمطلوب

معرّف السوق الذي تعيده نقطة نهاية السياق.

مثال: "example"

max_priceسلسلة نصية | nullمطلوب

أعلى سعر في النطاق المعروض.

مثال: "0.00"

min_priceسلسلة نصية | nullمطلوب

أدنى سعر في النطاق المعروض.

مثال: "0.00"

occurred_atسلسلة نصيةمطلوب

تاريخ الحدث ووقته.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

pageعدد صحيحمطلوب

معلومات صفحة CMS.

مثال: 1

product_result_countعدد صحيحمطلوب

عدد نتائج المنتجات في البحث.

مثال: 1

query_displayسلسلة نصيةمطلوب

عبارة البحث المعروضة للمسؤول.

مثال: "example"

request_idسلسلة نصيةمطلوب

معرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.

مثال: "example"

resultsمصفوفة <ResultSnapshotData > | nullمطلوب

نتائج البحث المسجلة.

مثال: [{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}]

sort_keyسلسلة نصيةمطلوب

مفتاح الترتيب.

مثال: "example"

sourceسلسلة نصيةمطلوب

مصدر النشاط المسجل.

القيود

enum

["results", "autocomplete"]

مثال: "results"

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

click_through_rateعددمطلوب

نسبة النقر إلى الظهور لبيانات البحث المحددة.

مثال: 0

clicked_searchesعدد صحيحمطلوب

عدد عمليات البحث التي تضمنت نقرة.

مثال: 1

recentمصفوفة <RecentSearchData > مطلوب

معلومات عمليات البحث الأخيرة.

مثال: [{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}]

searchesعدد صحيحمطلوب

عدد عمليات البحث.

مثال: 1

zero_result_rateعددمطلوب

نسبة عمليات البحث التي لم تُرجع نتائج.

مثال: 0

zero_resultsعدد صحيحمطلوب

عدد عمليات البحث بلا نتائج.

مثال: 1

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

حقول إضافية: نعم

is_zero_resultsقيمة منطقيةمطلوب

ما إذا لم يُرجع البحث أي نتائج.

مثال: false

locale_codeسلسلة نصيةمطلوب

رمز اللغة.

مثال: "en"

occurred_atسلسلة نصيةمطلوب

تاريخ الحدث ووقته.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

query_displayسلسلة نصيةمطلوب

عبارة البحث المعروضة للمسؤول.

مثال: "example"

query_hashسلسلة نصيةمطلوب

معرّف ثابت لعبارة البحث المجمعة.

مثال: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idسلسلة نصيةمطلوب

معرّف الطلب؛ في البيانات الوصفية للاستجابة يحدد طلب HTTP.

مثال: "example"

result_countعدد صحيحمطلوب

عدد نتائج البحث.

مثال: 1

sourceسلسلة نصيةمطلوب

مصدر النشاط المسجل.

القيود

enum

["results", "autocomplete"]

مثال: "results"

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

clickedقيمة منطقيةمطلوب

ما إذا تم النقر على النتيجة.

مثال: false

entity_idسلسلة نصيةمطلوب

معرّف الكيان المشار إليه.

مثال: "example"

entity_typeسلسلة نصيةمطلوب

نوع الكيان المشار إليه.

القيود

enum

["product", "category"]

مثال: "product"

image_urlسلسلة نصية | nullمطلوب

عنوان URL للصورة.

مثال: "https://example.invalid/product.jpg"

numberسلسلة نصية | nullمطلوب

رقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.

مثال: "example"

placement_sourceسلسلة نصيةمطلوب

المصدر الذي تم تقديم طلب الشراء من خلاله.

القيود

enum

["organic", "merchandising"]

مثال: "organic"

positionعدد صحيحمطلوب

الموضع في المجموعة المرتبة.

مثال: 1

skuسلسلة نصيةمطلوب

رمز وحدة حفظ المخزون.

مثال: "example"

slugسلسلة نصيةمطلوب

جزء مسار URL باللغة المحددة.

مثال: "example"

titleسلسلة نصيةمطلوب

العنوان باللغة المحددة.

مثال: "example"

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

category_idsمصفوفة <سلسلة نصية> اختياري

معرّفات الفئات المرتبطة.

maxItems: 100

مصفوفة:minLength: 1maxLength: 63

enabledقيمة منطقيةاختياري

ما إذا كان هذا الإعداد مفعّلًا.

القيمة الافتراضية: false

market_idsمصفوفة <سلسلة نصية> اختياري

معرّفات الأسواق المحددة.

maxItems: 1000

مصفوفة:minLength: 1maxLength: 63

market_scopeسلسلة نصيةاختياري

ما إذا كان المورد ينطبق على جميع الأسواق أو على الأسواق المحددة فقط.

القيود

enum

["all", "selected"]

nameسلسلة نصيةمطلوب

اسم المورد في السياق المناسب.

minLength: 1maxLength: 160

مثال: "Example"

phrasesمصفوفة <سلسلة نصية> مطلوب

العبارات المستخدمة في قاعدة البحث.

minItems: 1maxItems: 20

مصفوفة:minLength: 1maxLength: 255

مثال: ["example"]

product_idsمصفوفة <سلسلة نصية> اختياري

معرّفات المنتجات المرتبطة.

maxItems: 100

مصفوفة:minLength: 1maxLength: 63

مثال: ["example"]

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

category_idsمصفوفة <سلسلة نصية> مطلوب

معرّفات الفئات المرتبطة.

مثال: ["example"]

created_atسلسلة نصيةمطلوب

وقت الإنشاء.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

enabledقيمة منطقيةمطلوب

ما إذا كان هذا الإعداد مفعّلًا.

مثال: true

idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. (RuleDetailData).

مثال: "example"

is_availableقيمة منطقيةمطلوب

ما إذا كان العنصر متاحًا في هذا السياق.

مثال: true

market_idsمصفوفة <سلسلة نصية> مطلوب

معرّفات الأسواق المحددة.

مثال: ["example"]

market_scopeسلسلة نصيةمطلوب

ما إذا كان المورد ينطبق على جميع الأسواق أو على الأسواق المحددة فقط.

القيود

enum

["all", "selected"]

مثال: "all"

nameسلسلة نصيةمطلوب

اسم المورد في السياق المناسب.

مثال: "Example"

phrase_groupsمصفوفة <RulePhraseGroupData > مطلوب

مجموعات عبارات قواعد البحث.

مثال: [{"locale":"en","phrases":["example"]}]

product_idsمصفوفة <سلسلة نصية> مطلوب

معرّفات المنتجات المرتبطة.

مثال: ["example"]

updated_atسلسلة نصيةمطلوب

وقت آخر تحديث.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

versionعدد صحيحمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

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

localeسلسلة نصيةمطلوب

اللغة المحددة لهذا الطلب.

مثال: "en"

phrasesمصفوفة <سلسلة نصية> مطلوب

العبارات المستخدمة في قاعدة البحث.

مثال: ["example"]

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

created_atسلسلة نصيةمطلوب

وقت الإنشاء.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

enabledقيمة منطقيةمطلوب

ما إذا كان هذا الإعداد مفعّلًا.

مثال: true

idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. (RuleSummaryData).

مثال: "example"

is_availableقيمة منطقيةمطلوب

ما إذا كان العنصر متاحًا في هذا السياق.

مثال: true

market_scopeسلسلة نصيةمطلوب

ما إذا كان المورد ينطبق على جميع الأسواق أو على الأسواق المحددة فقط.

القيود

enum

["all", "selected"]

مثال: "all"

nameسلسلة نصيةمطلوب

اسم المورد في السياق المناسب.

مثال: "Example"

updated_atسلسلة نصيةمطلوب

وقت آخر تحديث.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

versionعدد صحيحمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

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

category_idsمصفوفة <سلسلة نصية> اختياري

معرّفات الفئات المرتبطة.

maxItems: 100

مصفوفة:minLength: 1maxLength: 63

enabledقيمة منطقيةاختياري

ما إذا كان هذا الإعداد مفعّلًا.

expected_versionعدد صحيحمطلوب

الإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.

minimum: 1maximum: 2147483647

مثال: 1

market_idsمصفوفة <سلسلة نصية> اختياري

معرّفات الأسواق المحددة.

maxItems: 1000

مصفوفة:minLength: 1maxLength: 63

market_scopeسلسلة نصيةاختياري

ما إذا كان المورد ينطبق على جميع الأسواق أو على الأسواق المحددة فقط.

القيود

enum

["all", "selected"]

nameسلسلة نصيةاختياري

اسم المورد في السياق المناسب.

minLength: 1maxLength: 160

مثال: "Example"

phrasesمصفوفة <سلسلة نصية> اختياري

العبارات المستخدمة في قاعدة البحث.

maxItems: 20

مصفوفة:minLength: 1maxLength: 255

product_idsمصفوفة <سلسلة نصية> اختياري

معرّفات المنتجات المرتبطة.

maxItems: 100

مصفوفة:minLength: 1maxLength: 63

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

حقول إضافية: نعم