Schema

تعريف المخطط لمصدر بيانات.

تمثيل JSON
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
الحقول
objectDefinitions[]

object (ObjectDefinition)

قائمة عناصر المستوى الأعلى لمصدر البيانات. الحد الأقصى لعدد العناصر هو 10.

operationIds[]

string

معرّفات العمليات الطويلة التشغيل (LROs) التي تعمل حاليًا لهذا المخطط. بعد تعديل المخطط، انتظر حتى تكتمل العمليات قبل فهرسة المحتوى الإضافي.

ObjectDefinition

تعريف عنصر داخل مصدر بيانات.

تمثيل JSON
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
الحقول
name

string

اسم الكائن، والذي يحدد نوعه بعد ذلك. يجب ضبط الحقل objectType لطلبات فهرسة العناصر على قيمة مساوٍ لهذه القيمة. على سبيل المثال، إذا كان name هو Document، ينبغي ضبط طلبات فهرسة العناصر من نوع "Document" على objectType تساوي Document. يجب تسمية كل تعريف كائن بشكل فريد داخل مخطط. يجب أن يبدأ الاسم بحرف ويمكن أن يحتوي فقط على أحرف (A-Z أو a-z) أو أرقام (0-9). ويجب ألّا يزيد عدد الأحرف عن 256 حرفًا.

options

object (ObjectOptions)

تمثّل هذه السمة الخيارات الاختيارية الخاصة بالكائن.

propertyDefinitions[]

object (PropertyDefinition)

تعريفات السمة للعنصر. الحد الأقصى لعدد العناصر هو 1000.

ObjectOptions

تمثّل هذه السمة الخيارات لعنصر.

تمثيل JSON
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
الحقول
freshnessOptions

object (ObjectOptions.FreshnessOptions)

خيارات تحديث العنصر

displayOptions

object (ObjectDisplayOptions)

الخيارات التي تحدد كيفية عرض العنصر في صفحة نتائج Cloud Search.

suggestionFilteringOperators[]

string

عوامل التشغيل التي يمكن استخدامها لفلترة الاقتراحات بالنسبة إلى واجهة برمجة تطبيقات query.suggest، سيتم فقط الالتزام بعوامل التشغيل المذكورة هنا في FilterOptions. يتم توفير عاملي التشغيل TEXT وENUM فقط.

ملاحظة: "نوع الكائن"، "النوع" و"mimetype" متاحة حاليًا. هذه السمة مخصصة لإعداد عوامل التشغيل الخاصة بالمخطط.

على الرغم من أن هذه مصفوفة، يمكن تحديد عامل تشغيل واحد فقط. هذا صفيف قابل للتوسع في المستقبل.

لا تتوفّر عوامل التشغيل التي يتم ربطها بمواقع متعددة ضمن العنصر نفسه. إذا كان العامل يمتد عبر أنواع مختلفة من الكائنات، يجب تعيين هذا الخيار مرة واحدة لكل تعريف كائن.

ObjectOptions.FreshnessOptions

يشير إلى خاصية التعديل المطلوب استخدامها عند ضبط ترتيب البحث لعنصر. وتشير التواريخ الأحدث والأكثر حداثة إلى جودة أعلى. استخدِم خاصية خيار الحداثة التي تناسب بياناتك على أفضل نحو. بالنسبة إلى مستندات مشاركة الملفات، يكون وقت آخر تعديل هو الأكثر صلة. بالنسبة إلى بيانات أحداث التقويم، يكون الوقت الذي يقع فيه الحدث مؤشر حداثة أكثر صلة. وبهذه الطريقة، يتم اعتبار أحداث التقويم التي تقع في وقت أقرب إلى وقت طلب البحث أعلى جودة ويتم ترتيبها وفقًا لذلك.

تمثيل JSON
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
الحقول
freshnessProperty

string

تشير هذه السمة إلى مستوى حداثة العنصر في الفهرس. وفي حال ضبطها، يجب أن تكون هذه السمة موقعًا من المستوى الأعلى ضمن property definitions كما يجب أن تكون timestamp type أو date type. بخلاف ذلك، تستخدم Indexing API updateTime كمؤشر حداثة. ويجب ألّا يزيد عدد الأحرف عن 256 حرفًا.

عند استخدام سمة لاحتساب مدى الحداثة، يتم ضبط القيمة تلقائيًا على عامَين من الوقت الحالي.

freshnessDuration

string (Duration format)

المدة التي يجب بعد انقضائها أن يصبح العنصر قديمًا. القيمة التلقائية هي 180 يومًا (بالثواني).

مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى وتنتهي بالأرقام "s" مثال: "3.5s"

ObjectDisplayOptions

خيارات العرض لعنصر.

تمثيل JSON
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
الحقول
objectDisplayLabel

string

تشير هذه السمة إلى تصنيف سهل الاستخدام ليتم عرضه في نتيجة البحث للإشارة إلى نوع العنصر. هذا اختياري؛ وإذا لم يتم توفيرها، لن يتم عرض تصنيف الكائن في سطر السياق لنتائج البحث. يجب ألّا يزيد عدد الأحرف عن 64 حرفًا.

metalines[]

object (ObjectDisplayOptions.Metaline)

تحدد السمات التي يتم عرضها في العلامات الوصفية لنتائج البحث. يتم عرض قيم الخصائص بالترتيب الموضح هنا. وإذا كان أحد المواقع يحتوي على قيم متعددة، سيتم عرض جميع القيم قبل السمات التالية. لهذا السبب، من الممارسات الجيدة تحديد خصائص المفرد قبل الخصائص المتكررة في هذه القائمة. يجب ضبط isReturnable على "صحيح" في كل السمات. الحد الأقصى لعدد السطور التعريفية هو 3.

ObjectDisplayOptions.Metaline

الوصفة هي قائمة من الخصائص التي يتم عرضها مع نتيجة البحث لتوفير السياق.

تمثيل JSON
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
الحقول
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

هذه قائمة بالسمات المعروضة الخاصة بالمجموعة الوصفية. يبلغ الحدّ الأقصى لعدد المواقع 5 مواقع.

ObjectDisplayOptions.DisplayedProperty

مرجع إلى خاصية من المستوى الأعلى داخل العنصر يجب عرضه في نتائج البحث. يتم عرض قيم الخصائص التي تم اختيارها في نتائج البحث مع display label لتلك السمة في حال تحديد قيمة. وفي حال عدم تحديد تصنيف عرض، ستظهر القيم فقط.

تمثيل JSON
{
  "propertyName": string
}
الحقول
propertyName

string

اسم خاصية المستوى الأعلى كما هو محدّد في تعريف السمة للعنصر. إذا لم يكن الاسم سمة محدّدة في المخطط، سيظهر خطأ عند محاولة تعديل المخطط.

PropertyDefinition

تعريف خاصية داخل كائن.

تمثيل JSON
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
الحقول
name

string

تمثّل هذه السمة اسم المكان المخصّص للاستئجار. إنّ طلبات فهرسة العناصر التي تم إرسالها إلى Indexing API يجب أن تضبط property name على قيمة مساوية لهذه القيمة. على سبيل المثال، إذا كان الاسم هو subject_line، فإن طلبات فهرسة عناصر المستندات التي تحتوي على حقول مواضيع يجب ضبط name لهذا الحقل على مساوية لـ subject_line. استخدِم الاسم كمعرّف لخاصية الكائن. بعد التسجيل كملكية لكائن، لا يمكنك إعادة استخدام هذا الاسم لموقع آخر داخل ذلك الكائن. يجب أن يبدأ الاسم بحرف ويمكن أن يحتوي فقط على أحرف (A-Z أو a-z) أو أرقام (0-9). ويجب ألّا يزيد عدد الأحرف عن 256 حرفًا.

isReturnable

boolean

تشير هذه السمة إلى أنّ السمة تحدّد البيانات التي يجب عرضها في نتائج البحث من خلال Query API. في حال ضبط هذه السياسة على true، يشير ذلك إلى أنّ مستخدمي Query API يمكنهم استخدام حقول السمات المطابقة في النتائج. ومع ذلك، يتطلب تخزين الحقول تخصيص المزيد من المساحة ويستخدم معدل نقل بيانات أكبر لطلبات البحث، ما يؤثر في الأداء على مجموعات البيانات الكبيرة. اضبط القيمة على true هنا فقط إذا كان الحقل مطلوبًا لنتائج البحث. لا يمكن أن يكون هذا الحقل صحيحًا بالنسبة إلى المواقع الإلكترونية التي يكون نوعها كائنًا.

isRepeatable

boolean

تشير هذه السمة إلى أنّه يُسمح باستخدام عدة قيم للسمة. على سبيل المثال، يمكن أن يحتوي المستند على وصف واحد فقط، ولكن يمكن أن يتضمّن تعليقات متعددة. لا يمكن أن تكون القيمة true للخصائص التي يكون نوعها قيمة منطقية. وفي حال ضبط هذه السياسة على "خطأ"، فإنّ الخصائص التي تحتوي على أكثر من قيمة تؤدي إلى رفض طلب الفهرسة لهذا العنصر.

isSortable

boolean

يشير هذا الحقل إلى أنّه يمكن استخدام السمة للترتيب. لا يمكن أن يكون هذا الحقل صحيحًا للسمات القابلة للتكرار. لا يمكن أن يكون صحيحًا بالنسبة إلى المواقع التي يكون نوعها كائنًا. يجب أن تكون سمة IsReturnable true لإعداد هذا الخيار. هذا الخيار متاح فقط للسمات المنطقية والتاريخ والمزدوج والعدد الصحيح والطابع الزمني.

isFacetable

boolean

تشير إلى إمكانية استخدام الخاصية لإنشاء الواجهات. لا يمكن أن يكون صحيحًا بالنسبة إلى المواقع التي يكون نوعها كائنًا. يجب أن تكون سمة IsReturnable true لإعداد هذا الخيار. لا يمكن استخدامها إلا للسمات المنطقية والتعداد والعدد الصحيح والنص.

isSuggestable

boolean

تشير إلى إمكانية استخدام السمة لإنشاء اقتراحات لطلب البحث.

isWildcardSearchable

boolean

يشير هذا الرمز إلى أنّه يمكن للمستخدمين البحث بحرف البدل عن هذا الموقع. يمكن استخدام هذه السمة فقط للخصائص النصية. يجب أن تكون سمة IsReturnable true لإعداد هذا الخيار. في مصدر بيانات معيّن، يمكن تصنيف 5 مواقع كحدّ أقصى على أنّها isWildcardSearchable. لمزيد من التفاصيل، راجِع تحديد خصائص العنصر.

displayOptions

object (PropertyDisplayOptions)

تشير هذه السمة إلى الخيارات التي تحدِّد كيفية عرض السمة في صفحة نتائج Cloud Search إذا كان محدّدًا لعرضها في display options للعنصر.

حقل الاتحاد property_options. الخيارات الخاصة بالنوع التي تحدّد كيفية فهرسة الموقع واستخدامه. في الحالة التي يجب أن تكون فيها الخيارات هي الخيارات التلقائية لنوع ما، يجب أن يظل هذا الحقل معيّنًا على أحد الأنواع. وفي حال عدم ضبط هذا الحقل، يتم رفض تعديلات المخطط. يمكن أن يكون property_options واحدًا فقط مما يلي:
integerPropertyOptions

object (IntegerPropertyOptions)

doublePropertyOptions

object (DoublePropertyOptions)

timestampPropertyOptions

object (TimestampPropertyOptions)

booleanPropertyOptions

object (BooleanPropertyOptions)

objectPropertyOptions

object (ObjectPropertyOptions)

enumPropertyOptions

object (EnumPropertyOptions)

datePropertyOptions

object (DatePropertyOptions)

textPropertyOptions

object (TextPropertyOptions)

htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

خيارات خصائص الأعداد الصحيحة.

تمثيل JSON
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
الحقول
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

يُستخدَم لتحديد الترتيب المُرتَّب لعدد صحيح. لا يمكن استخدام هذه السياسة إلا إذا كانت قيمة السمة isRepeatable خاطئة.

minimumValue

string (Int64Value format)

تمثّل هذه السمة القيمة الصغرى للسمة. يتم استخدام القيم الدنيا والقصوى للسمة لترتيب النتائج وفقًا للنوع ordered ranking. يتم قبول طلبات الفهرسة التي تتضمّن قيمًا أقل من الحد الأدنى، ويتم ترتيبها بالأهمية نفسها التي تحظى بها السلع المفهرسة باستخدام الحدّ الأدنى من القيمة.

maximumValue

string (Int64Value format)

تمثّل هذه السمة الحدّ الأقصى لقيمة الموقع. يتم استخدام القيم الدنيا والقصوى للسمة لترتيب النتائج وفقًا للنوع ordered ranking. يتم قبول طلبات الفهرسة التي تزيد قيمتها عن الحد الأقصى ويتم ترتيبها بالوزن نفسه كالسلع المُفهرَسة ذات القيمة القصوى.

operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

في حال تحديده، يصف كيف يجب استخدام العدد الصحيح كعامل تشغيل بحث.

integerFacetingOptions

object (IntegerFacetingOptions)

في حال تحديد هذه السمة، تقدّم وصفًا لخيارات تحديد واجهات الأعداد الصحيحة لخاصية العدد الصحيح. يجب وضع علامة isFacetable على خاصية العدد الصحيح.

IntegerPropertyOptions.OrderedRanking

يُستخدم لتحديد كيفية ترتيب قيمة عدد صحيح بالنسبة إلى القيم الأخرى. يشير العدد الصحيح ذو الترتيب الأعلى إلى أهمية أكبر. على سبيل المثال، في بعض مصادر البيانات، تشير الأولوية الأقل إلى أهمية أكبر بينما تشير الأولوية الأعلى في البعض الآخر إلى أهمية أكبر.

عمليات التعداد
NO_ORDER ما مِن ترتيب لترتيب الموقع. لا يتم تعديل النتائج حسب قيمة هذا الموقع.
ASCENDING تم ترتيب هذا الموقع تصاعديًا. وتشير القيم المنخفضة إلى الترتيب الأقل.
DESCENDING تم ترتيب هذا الموقع تنازليًا. وتشير القيم المنخفضة إلى الترتيب الأعلى.

IntegerPropertyOptions.IntegerOperatorOptions

يُستخدَم لتوفير عامل تشغيل بحث لخصائص الأعداد الصحيحة. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.

تمثيل JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
الحقول
operatorName

string

تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية العدد الصحيح. على سبيل المثال، إذا كانت قيمة filterName هي priority، وكان اسم الموقع هو priorityVal، تعرض طلبات البحث مثل priority:<value> نتائج فقط عندما تتطابق قيمة السمة priorityVal مع <value>. في المقابل، يؤدي البحث الذي يستخدم &lt;value&gt; نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها &lt;value&gt; مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

lessThanOperatorName

string

تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية العدد الصحيح باستخدام عامل التشغيل أقل من. على سبيل المثال، إذا كانت قيمة lessThanOperatorName هي priority below واسم الموقع الإلكتروني priorityVal، تعرِض طلبات البحث مثل priority below:<value> نتائج فقط عندما تكون قيمة السمة المسمّاة priorityVal أقل من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

greaterThanOperatorName

string

تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية العدد الصحيح باستخدام عامل التشغيل "أكبر من". على سبيل المثال، إذا كان اسم السمة maxThanOperatorName هو priority above واسم الموقع الإلكتروني priorityVal، تعرِض طلبات البحث مثل priority above:<value> نتائج فقط عندما تكون قيمة السمة المسمّاة priorityVal أكبر من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

DoublePropertyOptions

تمثّل هذه السمة خيارات المواقع المزدوجة.

تمثيل JSON
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
الحقول
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

وفي حال ضبطها، تصف كيفية استخدام القيمة المزدوجة كعامل تشغيل بحث.

DoublePropertyOptions.DoubleOperatorOptions

تُستخدَم لتوفير عامل تشغيل بحث للمواقع الإلكترونية المزدوجة. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.

تمثيل JSON
{
  "operatorName": string
}
الحقول
operatorName

string

يشير إلى اسم عامل التشغيل المطلوب في الاستعلام من أجل استخدام الخاصية المزدوجة في الفرز أو كواجهة. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

TimestampPropertyOptions

خيارات خصائص الطابع الزمني.

تمثيل JSON
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
الحقول
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

في حال ضبط هذه السمة، يوضِّح كيفية استخدام الطابع الزمني كعامل تشغيل بحث.

TimestampPropertyOptions.TimestampOperatorOptions

تُستخدَم لتوفير عامل تشغيل بحث في سمات الطابع الزمني. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.

تمثيل JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
الحقول
operatorName

string

يشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية الطابع الزمني. على سبيل المثال، إذا كان عامل التشغيل userName هو closedon وكان اسم الموقع هو CloseDate، تعرض طلبات البحث مثل closedon:<value> نتائج فقط تتطابق فيها قيمة السمة المُسمّاة CloseDate مع <value>. في المقابل، يؤدي البحث الذي يستخدم &lt;value&gt; نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها &lt;value&gt; مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

lessThanOperatorName

string

تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية الطابع الزمني باستخدام عامل التشغيل أقل من. على سبيل المثال، إذا كانت عملية lessThanOperatorName هي closedbefore وكان اسم الخاصية CloseDate، تعرض طلبات البحث مثل closedbefore:<value> نتائج فقط تكون فيها قيمة الخاصية المُسماة CloseDate أقدم من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

greaterThanOperatorName

string

تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية الطابع الزمني باستخدام عامل التشغيل "أكبر من". على سبيل المثال، إذا تم ضبط اسم أكبر ThanOperatorName على closedafter وكان اسم الموقع هو CloseDate، تعرض طلبات البحث مثل closedafter:<value> نتائج فقط تكون فيها قيمة الخاصية المُسمّاة CloseDate بعد <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

BooleanPropertyOptions

خيارات السمات المنطقية.

تمثيل JSON
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
الحقول
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

في حال ضبطها، تصف كيفية استخدام القيمة المنطقية كعامل تشغيل بحث.

BooleanPropertyOptions.BooleanOperatorOptions

يُستخدَم لتوفير عامل تشغيل بحث للخصائص المنطقية. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.

تمثيل JSON
{
  "operatorName": string
}
الحقول
operatorName

string

تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل الخاصية المنطقية. على سبيل المثال، إذا كان filterName مغلقًا وكان اسم الموقع isclosed، تعرض طلبات البحث مثل closed:<value> نتائج فقط عندما تتطابق قيمة السمة isClosed مع <value>. في المقابل، يؤدي البحث الذي يستخدم &lt;value&gt; نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها &lt;value&gt; مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

ObjectPropertyOptions

خيارات خصائص العنصر

تمثيل JSON
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
الحقول
subobjectProperties[]

object (PropertyDefinition)

خصائص الكائن الفرعي. تمثل هذه الخصائص كائنًا مدمجًا. على سبيل المثال، إذا كانت هذه السمة تمثّل عنوانًا بريديًا، يمكن تسمية عناصر SubobjectProperties street وcity وstate. الحد الأقصى لعدد العناصر هو 1000.

EnumPropertyOptions

تتيح لك خيارات خصائص enum تحديد مجموعة محدودة من السلاسل لمطابقة طلبات بحث المستخدمين، وضبط الترتيب لقيم السلسلة هذه، وتحديد اسم عامل تشغيل ليتم إقرانه بهذه السلاسل، حتى يتمكّن المستخدمون من تضييق نطاق النتائج لتقتصر على العناصر التي لها قيمة معيّنة فقط. على سبيل المثال، بالنسبة إلى العناصر في نظام تتبُّع الطلبات الذي يتضمن معلومات الأولوية، يمكنك تحديد p0 باعتبارها قيمة تعداد مسموح بها وربط هذا التعداد باسم عامل التشغيل الأولوية كي يتمكّن مستخدمو البحث من إضافة priority:p0 إلى طلب البحث لحصر مجموعة النتائج بالعناصر المفهرَسة ذات القيمة p0 فقط.

تمثيل JSON
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
الحقول
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

قائمة القيم المحتملة لخاصية التعداد. يجب أن توفّر كل EnumValueValues قيمة سلسلة. إذا حددت قيمة عدد صحيح لزوج واحد من قيم زوج التساوي، يجب أن توفر كل أزواج قيم القيم المحتملة عددًا صحيحًا. يجب أن تكون قيمة السلسلة وقيمة العدد الصحيح فريدة على جميع القيم المحتملة. بعد الضبط، لا يمكن إزالة القيم المحتملة أو تعديلها. إذا قدّمت ترتيبًا مرتَّبًا وتعتقد أنّه يمكنك إدراج قيم تعداد إضافية في المستقبل، اترك فجوات في قيم الأعداد الصحيحة الأولية للسماح بإضافة قيمة بين القيم المسجَّلة سابقًا. الحد الأقصى لعدد العناصر هو 100.

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

يُستخدَم لتحديد الترتيب المرتَّب للتعداد الذي يحدد كيفية استخدام قيم الأعداد الصحيحة المقدَّمة في أزواج قيم القيم المحتملة المتاحة لترتيب النتائج. في حال تحديد قيم عدد صحيح، يجب تقديم قيم عدد صحيح لجميع قيم EnumValue اللازمة المقدّمة لهذه السمة. لا يمكن استخدام هذه السياسة إلا إذا كانت قيمة السمة isRepeatable خاطئة.

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

في حال ضبط هذه السمة، يصف كيفية استخدام التعداد كعامل تشغيل.

EnumPropertyOptions.EnumValuePair

يحدد زوج قيمة التعداد شيئين: قيمة سلسلة مطلوبة وقيمة عدد صحيح اختيارية. تحدد قيمة السلسلة عبارة طلب البحث الضرورية المطلوبة لاسترداد هذا العنصر، مثل p0 لعنصر ذي أولوية. تحدّد قيمة العدد الصحيح ترتيب قيمة السلسلة تلك بالنسبة إلى القيم الأخرى المحتسبة للسمة نفسها. على سبيل المثال، يمكنك ربط p0 بـ 0 وتحديد زوج enum آخر مثل p1 و1. يجب استخدام قيمة العدد الصحيح مع ordered ranking لضبط ترتيب قيمة معيّنة بالنسبة إلى القيم الأخرى المحتسبة لاسم السمة نفسه. في هذا المثال، يؤدي ترتيب DESCENDING الخاص بسمات الأولوية إلى تحسين ترتيب العناصر المفهرسة باستخدام القيمة p0 مقارنةً بالعناصر المفهرَسة ذات القيمة p1. وبدون ترتيب ترتيب محدد، لا تؤثر قيمة العدد الصحيح في ترتيب العنصر.

تمثيل JSON
{
  "stringValue": string,
  "integerValue": integer
}
الحقول
stringValue

string

قيمة السلسلة لـ EnumValue الواردة. يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

integerValue

integer

قيمة العدد الصحيح لـ EnumValue الواردة والتي يجب أن تكون غير سالبة. اختياريّ.

EnumPropertyOptions.OrderedRanking

يتم استخدامه لتحديد اتجاه الترتيب لعدد EnumValuePair صحيح بالنسبة إلى قيم الأعداد الصحيحة الأخرى في EnumValue دراسة. بالنسبة إلى بعض السمات، تشير قيم الأعداد الصحيحة المنخفضة إلى أهمية أعلى، بينما يشير العدد الصحيح الأعلى إلى أهمية أعلى في البعض الآخر.

عمليات التعداد
NO_ORDER ما مِن ترتيب لترتيب الموقع. لا يتم تعديل النتائج حسب قيمة هذا الموقع.
ASCENDING تم ترتيب هذا الموقع تصاعديًا. وتشير القيم المنخفضة إلى الترتيب الأقل.
DESCENDING تم ترتيب هذا الموقع تنازليًا. وتشير القيم المنخفضة إلى الترتيب الأعلى.

EnumPropertyOptions.EnumOperatorOptions

يُستخدَم لتوفير عامل تشغيل بحث لخصائص enum. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه. على سبيل المثال، إذا لم يتم توفير أي عامل تشغيل لخاصية enum priority بالقيم المحتملة p0 وp1، سيعرض طلب البحث الذي يحتوي على المصطلح p0 عناصر تحتوي على p0 كقيمة السمة priority، بالإضافة إلى أي عناصر تحتوي على السلسلة p0 في حقول أخرى. إذا وفّرت اسم عامل تشغيل للتعداد، مثل priority، يمكن لمستخدمي البحث استخدام عامل التشغيل هذا لتحسين النتائج إلى العناصر التي تتضمّن p0 كقيمة السمة فقط، مع طلب البحث priority:p0.

تمثيل JSON
{
  "operatorName": string
}
الحقول
operatorName

string

يشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية enum. على سبيل المثال، إذا كانت قيمة filterName هي priority، وكان اسم الموقع هو priorityVal، تعرض طلبات البحث مثل priority:<value> نتائج فقط عندما تتطابق قيمة السمة priorityVal مع <value>. في المقابل، يؤدي البحث الذي يستخدم &lt;value&gt; نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها &lt;value&gt; مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

DatePropertyOptions

خيارات خصائص التاريخ.

تمثيل JSON
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
الحقول
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

في حال تحديده، يصف كيف يجب استخدام التاريخ كعامل تشغيل بحث.

DatePropertyOptions.DateOperatorOptions

اختياريّ. توفّر هذه السياسة عامل تشغيل بحث لخصائص التاريخ. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.

تمثيل JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
الحقول
operatorName

string

تشير إلى السلسلة الفعلية المطلوبة في طلب البحث لعزل خاصية التاريخ. على سبيل المثال، لنفترض أنّ كائن مخطط تتبُّع المشاكل يحتوي على خاصية باسم closeDate التي تحدّد عامل تشغيل يتضمّن عامل التشغيل closeDate. وعند إجراء عمليات بحث عن هذه البيانات، لا تعرض طلبات البحث مثل closedon:&lt;value&gt; نتائج إلا عندما تتطابق قيمة السمة closedon:&lt;value&gt; مع closedon:&lt;value&gt;. في المقابل، يؤدي البحث الذي يستخدم &lt;value&gt; نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها &lt;value&gt; مع قيمة أي سمات سلسلة أو نص ضمن حقل المحتوى لمصدر البيانات المفهرَس. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

lessThanOperatorName

string

تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية التاريخ باستخدام عامل التشغيل أقل من. على سبيل المثال، إذا كانت عملية lessThanOperatorName هي closedbefore وكان اسم الخاصية CloseDate، تعرض طلبات البحث مثل closedbefore:<value> نتائج فقط تكون فيها قيمة الخاصية المُسماة CloseDate أقدم من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

greaterThanOperatorName

string

تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية التاريخ باستخدام عامل التشغيل "أكبر من". على سبيل المثال، إذا تم ضبط اسم أكبر ThanOperatorName على closedafter وكان اسم الموقع هو CloseDate، تعرض طلبات البحث مثل closedafter:<value> نتائج فقط تكون فيها قيمة الخاصية المُسمّاة CloseDate بعد <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

TextPropertyOptions

خيارات خصائص النص

تمثيل JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
الحقول
retrievalImportance

object (RetrievalImportance)

يشير إلى أهمية جودة البحث للرموز المميزة داخل الحقل عند استخدامها للاسترجاع.

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

في حال تحديد هذه السمة، سنوضّح كيفية استخدام السمة كعامل تشغيل بحث.

RetrievalImportance

تمثيل JSON
{
  "importance": enum (RetrievalImportance.Importance)
}
الحقول
importance

enum (RetrievalImportance.Importance)

ويشير إلى أهمية الترتيب الممنوحة للخاصية عند مطابقتها أثناء الاسترجاع. وبعد الضبط، لا يمكن تغيير أهمية الرمز المميّز لإحدى السمات.

RetrievalImportance.Importance

عمليات التعداد
DEFAULT تعامل مع المطابقة كمطابقة نص أساسي.
HIGHEST التعامل مع المطابقة على أنها مطابقة لعنوان العنصر.
HIGH تعامل مع المطابقة بأهمية أعلى من النص الأساسي.
LOW تعامل مع المطابقة بأهمية أقل من النص الأساسي.
NONE لا تطابق هذا الحقل أثناء الاسترجاع. لا يزال من الممكن استخدام السمة لمطابقة عامل التشغيل والواجهات والاقتراح إذا رغبت في ذلك.

TextPropertyOptions.TextOperatorOptions

يُستخدَم لتوفير عامل تشغيل بحث للخصائص النصية. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.

تمثيل JSON
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
الحقول
operatorName

string

يشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل الخاصية النصية. على سبيل المثال، إذا كانت قيمة filterName هي subject واسم الخاصية subjectLine، تعرض طلبات البحث مثل subject:<value> نتائج فقط حيث تتطابق قيمة السمة subjectLine مع <value>. في المقابل، يؤدي البحث الذي يستخدم نفس &lt;value&gt; بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها &lt;value&gt; مع قيمة أي خصائص نصية أو نص داخل حقل محتوى العنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

exactMatchWithOperator

boolean

إذا كانت القيمة true، يتم تحويل القيمة النصية إلى رمز مميّز كقيمة بسيطة واحدة في عمليات البحث عن عوامل التشغيل وتطابقات الواجهات. على سبيل المثال، إذا كان اسم عامل التشغيل هو "genre" والقيمة هي "الخيال العلمي" قيود طلب البحث "genre:science" و"genre:خيال" لا تتطابق مع العنصر؛ "genre:خيال علمي" بالفعل. تُعدّ مطابقة القيمة النصية حسّاسة لحالة الأحرف ولا تزيل الرموز الخاصة. أما إذا كانت القيمة "false"، فسيتم تحويل النص إلى رمز مميّز. على سبيل المثال، إذا كانت القيمة هي "الخيال العلمي" طلبات البحث "genre:science" و"genre:خيال" يطابق العنصر.

HtmlPropertyOptions

خيارات خصائص HTML.

تمثيل JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
الحقول
retrievalImportance

object (RetrievalImportance)

يشير إلى أهمية جودة البحث للرموز المميزة داخل الحقل عند استخدامها للاسترجاع. لا يمكن ضبطها إلا على DEFAULT أو NONE.

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

في حال تحديد هذه السمة، سنوضّح كيفية استخدام السمة كعامل تشغيل بحث.

HtmlPropertyOptions.HtmlOperatorOptions

يُستخدَم لتوفير عامل تشغيل بحث لخصائص html. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.

تمثيل JSON
{
  "operatorName": string
}
الحقول
operatorName

string

تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية html. على سبيل المثال، إذا كانت قيمة filterName هي subject واسم الخاصية subjectLine، تعرض طلبات البحث مثل subject:<value> نتائج فقط حيث تتطابق قيمة السمة subjectLine مع <value>. في المقابل، يؤدي البحث الذي يستخدم نفس &lt;value&gt; بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها &lt;value&gt; مع قيمة أي خصائص html أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا.

PropertyDisplayOptions

خيارات العرض الخاصة بالموقع.

تمثيل JSON
{
  "displayLabel": string
}
الحقول
displayLabel

string

تشير هذه السمة إلى تصنيف سهل الاستخدام للسمة، ويتم استخدامه إذا كانت السمة محدَّدة ليتم عرضها في ObjectDisplayOptions. وفي حال توفير هذه السمة، سيظهر تصنيف العرض أمام قيم الخصائص عندما تكون السمة جزءًا من خيارات عرض العناصر. على سبيل المثال، إذا كانت قيمة السمة هي "1"، قد لا تكون القيمة في حد ذاتها سياقًا مفيدًا للمستخدم. إذا كان الاسم المعروض الذي تم تقديمه هو "الأولوية"، يرى المستخدم "الأولوية : 1". في نتائج البحث مما يوفر سياقًا واضحًا لمستخدمي البحث. هذا اختياري؛ وإذا لم يتم تقديمها، فسيتم عرض قيم الخصائص فقط. يجب ألّا يزيد عدد الأحرف عن 64 حرفًا.