Schema

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

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

object (ObjectDefinition)

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

operationIds[]

string

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

ObjectDefinition

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

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

string

اسم الكائن الذي يحدد بعد ذلك نوعه. يجب أن تؤدي طلبات فهرسة العناصر إلى ضبط الحقل objectType على مساوٍ لهذه القيمة. على سبيل المثال، إذا كان name هو مستند، يجب أن تؤدي طلبات الفهرسة للعناصر من النوع "مستند" إلى ضبط objectType على قيمة مستندة. يجب تسمية كل تعريف كائن بشكل فريد داخل المخطط. يجب أن يبدأ الاسم بحرف ويمكن أن يحتوي فقط على أحرف (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. وبخلاف ذلك، تستخدم واجهة برمجة التطبيقات للفهرسة 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

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

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

isRepeatable

boolean

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

isSortable

boolean

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

isFacetable

boolean

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

isSuggestable

boolean

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

isWildcardSearchable

boolean

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

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

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

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

ObjectPropertyOptions

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

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

object (PropertyDefinition)

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

EnumPropertyOptions

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

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

object (EnumPropertyOptions.EnumValuePair)

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

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

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

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

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

EnumPropertyOptions.EnumValuePair

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

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

string

قيمة سلسلة EnumValuePartner الحد الأقصى لعدد الأحرف المسموح به هو 32 حرفًا.

integerValue

integer

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

EnumPropertyOptions.OrderedRanking

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

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

EnumPropertyOptions.EnumOperatorOptions

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

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

string

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

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

exactMatchWithOperator

boolean

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

HtmlPropertyOptions

خيارات مواقع html.

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

object (RetrievalImportance)

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

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

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

HtmlPropertyOptions.HtmlOperatorOptions

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

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

string

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

PropertyDisplayOptions

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

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

string

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