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 على هذه القيمة. على سبيل المثال، إذا كان الاسم هو مستند، يجب ضبط 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 API، سيتمّ الالتزام بالمشغّلين المذكورين هنا فقط في FilterOptions. لا تتوفّر سوى عاملَي التشغيل TEXT وENUM.

ملاحظة: يمكن استخدام السمات "objecttype" و"type" و "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 على 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

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

isReturnable

boolean

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

isRepeatable

boolean

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

isSortable

boolean

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

isFacetable

boolean

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

isSuggestable

boolean

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

isWildcardSearchable

boolean

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

displayOptions

object (PropertyDisplayOptions)

الخيارات التي تحدّد كيفية عرض السمة في صفحة نتائج "بحث السحابة الإلكترونية" إذا تم تحديد عرضها في 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

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

يشير إلى اسم المشغِّل المطلوب في طلب البحث لفصل السمة المنطقية. على سبيل المثال، إذا كان operatorName هو 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)

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

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

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

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

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

EnumPropertyOptions.EnumValuePair

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

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

string

قيمة السلسلة لخيار EnumValuePair الحد الأقصى للطول هو 32 حرفًا.

integerValue

integer

القيمة الصحيحة لفئة EnumValuePair والتي يجب أن تكون غير سالبة. اختياريّ.

EnumPropertyOptions.OrderedRanking

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

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

lessThanOperatorName

string

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

greaterThanOperatorName

string

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

يشير إلى اسم المشغِّل المطلوب في طلب البحث لفصل سمة النص. على سبيل المثال، إذا كان operatorName هو 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، يتم تقسيم النص إلى وحدات. على سبيل المثال، إذا كانت القيمة هي "خيال علمي"، يتطابق طلبا البحث "genre:science" و "genre:fiction" مع العنصر.

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

PropertyDisplayOptions

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

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

string

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