Schema

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

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

object (ObjectDefinition)

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

operationIds[]

string

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

تعريف العنصر

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

تمثيل 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 عنصر.

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

الخيارات لكائن.

تمثيل 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 فقط.

ملاحظة: يتم دعم "objecttype" و"type" و"mimetype" فعلاً. تم إعداد هذه الخاصية لتهيئة عوامل تشغيل خاصة بالمخطط.

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

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

ObjectOptions.FreshnessOptions

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

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

string

تشير هذه الخاصية إلى مستوى حداثة العنصر في الفهرس. في حال ضبطها، يجب أن تكون هذه الخاصية من المستوى الأعلى ضمن property definitions ويجب أن تكون timestamp type أو date type. بخلاف ذلك، تستخدم "واجهة برمجة التطبيقات للفهرسة" 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 على true. الحد الأقصى لعدد الأكسجين هو 3.

ObjectDisplayOptions.Metaline

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

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

object (ObjectDisplayOptions.DisplayedProperty)

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

ObjectDisplayOptions.DisplayedProperty

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

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

string

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

تعريف الخاصية

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

تمثيل 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

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

isReturnable

boolean

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

isRepeatable

boolean

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

isSortable

boolean

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

isFacetable

boolean

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

isSuggestable

boolean

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

isWildcardSearchable

boolean

يشير إلى أن المستخدمين يمكنهم إجراء بحث حرف بدل لهذا الموقع. هذا الإعداد متاح فقط للمواقع الإلكترونية النصية. يجب أن تكون قيمة IsReturnable صحيحة لإعداد هذا الخيار. في مصدر بيانات معين، يمكن وضع علامة على 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)

خيارات عدد صحيح

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

تمثيل 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

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

خيارات الممتلكات المزدوجة

خيارات المواقع المزدوجة.

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

object (DoublePropertyOptions.DoubleOperatorOptions)

في حالة التعيين، يصف كيفية استخدام الوظيفة المزدوجة كعامل تشغيل البحث.

DoublePropertyOptions.DoubleOperatorOptions

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

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

string

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

خيارات طابع الوقت

خيارات مواقع الطابع الزمني.

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

object (TimestampPropertyOptions.TimestampOperatorOptions)

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

TimestampPropertyOptions.TimestampOperatorOptions

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

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

string

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية الطابع الزمني باستخدام عامل التشغيل أكبر من. على سبيل المثال، إذا كان sameThanOperatorName 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

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

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

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

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

object (PropertyDefinition)

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

خيارات EnumProperty

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

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

object (EnumPropertyOptions.EnumValuePair)

قائمة القيم المحتملة لخاصية التعداد. يجب أن توفّر كل EnumValueإقران مجموعات قيمة سلسلة. إذا حددت قيمة عدد صحيح لـ EnumValueإقران واحد، فيجب أن تقدم جميع {0}numValueأزواج محتملين قيمة عدد صحيح. يجب أن تكون قيمة السلسلة والقيمة العددية فريدة على كل القيم المحتملة. بعد التعيين، لا يمكن إزالة القيم المحتملة أو تعديلها. إذا وفّرت ترتيبًا مرتبًا وتعتقد أنك قد تُدرِج قيم تعداد إضافية في المستقبل، اترك فجوات في القيم الصحيحة الأولية للسماح بإضافة قيمة بين القيم المسجّلة مسبقًا. الحد الأقصى لعدد العناصر هو 100 عنصر.

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

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

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

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

EnumPropertyOptions.EnumValueأزواج

يحدد زوج قيمة التعدين شيئين: قيمة سلسلة مطلوبة وقيمة عددية اختيارية. تحدّد قيمة السلسلة عبارة طلب البحث اللازمة لاسترداد هذا العنصر، مثل p0 لعنصر ذي أولوية. تحدد قيمة العدد الصحيح ترتيب قيمة السلسلة هذه بالنسبة إلى القيم العددية الأخرى للموقع نفسه. على سبيل المثال، يمكنك إقران p0 مع 0 وتحديد زوج تعداد آخر مثل 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 للمستخدمين تقييد طلب البحث بحقول معيّنة ذات صلة بنوع العنصر الذي يتم البحث فيه. على سبيل المثال، إذا لم توفّر عامل تشغيل لخاصية تعداد الأولوية بالقيم المحتملة p0 وp1، يعرض طلب البحث الذي يتضمن العبارة p0 العناصر التي تحتوي على p0 باعتبارها قيمة الخاصية priority، بالإضافة إلى أي عناصر تحتوي على السلسلة p0 في حقول أخرى. إذا قدّمت اسم عامل تشغيل للإحصاء، مثل priority، يمكن لمستخدمي البحث عندئذٍ استخدام عامل التشغيل هذا لتحسين النتائج إلى العناصر التي تحتوي على p0 كقيمة لهذه الخاصية، باستخدام طلب البحث priority:p0.

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

string

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

خيارات الموقع

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

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

object (DatePropertyOptions.DateOperatorOptions)

في حال الضبط، يتم توضيح كيفية استخدام التاريخ كعامل تشغيل البحث.

DatePropertyOptions.DateOperatorOptions

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

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

string

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

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

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

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

object (RetrievalImportance)

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

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

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

استرداد الأهمية

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

enum (RetrievalImportance.Importance)

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

استرداد الاستيراد

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

TextPropertyOptions.TextOperatorOptions

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

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

string

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

exactMatchWithOperator

boolean

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

خيارات HtmlProperty

خيارات مواقع 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. على سبيل المثال، إذا كان عامل التشغيل name هو subject وكان اسم الخاصية هو subjectLine، لن تعرض طلبات البحث مثل subject:<value> سوى النتائج التي تتطابق مع قيمة الخاصية المسماة subjectLine. لا يمكن أن يحتوي اسم عامل التشغيل سوى على أحرف صغيرة (a-z). الحد الأقصى للطول هو 32 حرفًا.

خيارات عرض الموقع

خيارات العرض لأحد المواقع.

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

string

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