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 را برابر با این مقدار قرار دهند. برای مثال، اگر نام Document باشد، در این صورت درخواست‌های نمایه‌سازی برای مواردی از نوع Document باید objectType را برابر با Document تنظیم کند. هر تعریف شی باید به طور منحصر به فرد در یک طرحواره نامگذاری شود. نام باید با یک حرف شروع شود و فقط شامل حروف (AZ، az) یا اعداد (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 )

گزینه هایی که تعیین می کنند شیء چگونه در صفحه نتایج جستجوی ابری نمایش داده شود.

suggestionFilteringOperators[]

string

اپراتورهایی که می توان از آنها برای فیلتر کردن پیشنهادات استفاده کرد. برای query.suggest API، فقط اپراتورهایی که در اینجا ذکر شده اند در FilterOptions مورد احترام قرار می گیرند. فقط اپراتورهای TEXT و ENUM پشتیبانی می شوند.

توجه: "objecttype"، "type" و "mimetype" قبلا پشتیبانی می شوند. این ویژگی برای پیکربندی عملگرهای خاص طرحواره است.

حتی اگر این یک آرایه است، فقط یک عملگر را می توان مشخص کرد. این آرایه ای برای توسعه پذیری آینده است.

عملگرهایی که به چندین ویژگی در یک شی نگاشت می شوند، پشتیبانی نمی شوند. اگر عملگر در انواع مختلف شیء باشد، این گزینه باید یک بار برای هر تعریف شی تنظیم شود.

ObjectOptions.FreshnessOptions

نشان می دهد که هنگام تنظیم رتبه بندی جستجو برای یک مورد از کدام ویژگی تازه استفاده شود. تاریخ های تازه تر و جدیدتر نشان دهنده کیفیت بالاتر است. از ویژگی گزینه freshness استفاده کنید که بهترین عملکرد را با داده های شما دارد. برای اسناد اشتراک گذاری فایل، آخرین زمان اصلاح شده بسیار مرتبط است. برای داده‌های رویداد تقویم، زمانی که رویداد رخ می‌دهد نشانگر تازگی مرتبط‌تری است. به این ترتیب، رویدادهای تقویمی که نزدیکتر به زمان جستجوی جستجو رخ می دهند، کیفیت بالاتری در نظر گرفته و بر اساس آن رتبه بندی می شوند.

نمایندگی JSON 
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
فیلدها
freshnessProperty

string

این خاصیت میزان تازگی جسم در ایندکس را نشان می دهد. اگر تنظیم شود، این ویژگی باید یک ویژگی سطح بالا در property definitions باشد و باید timestamp type یا date type باشد. در غیر این صورت، Indexing API از updateTime به عنوان نشانگر تازگی استفاده می کند. حداکثر طول 256 کاراکتر است.

هنگامی که یک ویژگی برای محاسبه تازگی استفاده می شود، مقدار آن به طور پیش فرض 2 سال از زمان فعلی است.

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 تنظیم کند. از نام به عنوان شناسه برای ویژگی شی استفاده کنید. پس از ثبت به عنوان یک ویژگی برای یک شی، نمی توانید از این نام برای ویژگی دیگری در آن شی استفاده کنید. نام باید با یک حرف شروع شود و فقط شامل حروف (AZ، az) یا اعداد (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 درست باشد. در یک منبع داده، حداکثر 5 ویژگی را می توان به عنوان isWildcardSearchable علامت گذاری کرد. برای جزئیات بیشتر، به تعریف ویژگی های شی مراجعه کنید

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

برای تعیین نحوه رتبه بندی یک مقدار صحیح نسبت به مقادیر دیگر استفاده می شود. یک عدد صحیح با رتبه بندی بالاتر نشان دهنده اهمیت بیشتر است. به عنوان مثال، در برخی از منابع داده، اولویت کمتر نشان دهنده اهمیت بالاتر است در حالی که در برخی دیگر اولویت بالاتر نشان دهنده اهمیت بالاتر است.

Enums
NO_ORDER هیچ ترتیب رتبه بندی برای ملک وجود ندارد. نتایج با مقدار این ویژگی تنظیم نمی‌شوند.
ASCENDING این ویژگی به ترتیب صعودی رتبه بندی شده است. مقادیر پایین تر نشان دهنده رتبه پایین تر است.
DESCENDING این ویژگی به ترتیب نزولی رتبه بندی شده است. مقادیر کمتر نشان دهنده رتبه بالاتر است.

IntegerPropertyOptions.IntegerOperatorOptions

برای ارائه یک عملگر جستجو برای خصوصیات عدد صحیح استفاده می شود. این اختیاری است. عملگرهای query.search به کاربران اجازه می‌دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو محدود کنند.

نمایندگی JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
فیلدها
operatorName

string

نام اپراتور مورد نیاز در پرس و جو برای جداسازی ویژگی عدد صحیح را نشان می دهد. به عنوان مثال، اگر operatorName اولویت باشد و نام ویژگی PriorityVal باشد، پرس و جوهایی مانند priority:<value> نتایج را فقط در جایی نشان می دهند که مقدار ویژگی با نام priorityVal با <value> مطابقت داشته باشد. در مقابل، جستجویی که از همان <value> بدون عملگر استفاده می‌کند، همه مواردی را که <value> با مقدار هر ویژگی رشته یا متن در فیلد محتوای مورد مطابقت دارد، برمی‌گرداند. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

lessThanOperatorName

string

نام عملگر مورد نیاز در پرس و جو را نشان می دهد تا خصوصیت عدد صحیح را با استفاده از عملگر کمتر از آن جدا کند. به عنوان مثال، اگر lessThanOperatorName prioritybelow و نام ویژگی PriorityVal باشد، پرس و جوهایی مانند prioritybelow:<value> نتایج را فقط در جایی نشان می دهند که مقدار ویژگی با نام priorityVal کمتر از <value> باشد. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

greaterThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی خاصیت عدد صحیح با استفاده از عملگر بزرگتر نشان می دهد. به عنوان مثال، اگر greaterThanOperatorName priorityabove و نام ویژگی PriorityVal باشد، پرس و جوهایی مانند priorityabove:<value> نتایج را فقط در جایی نشان می دهند که مقدار ویژگی با نام priorityVal بزرگتر از <value> باشد. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

DoublePropertyOptions

گزینه هایی برای خواص مضاعف.

نمایندگی JSON 
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
فیلدها
operatorOptions

object ( DoublePropertyOptions.DoubleOperatorOptions )

اگر تنظیم شود، نحوه استفاده از double را به عنوان اپراتور جستجو توضیح می دهد.

DoublePropertyOptions.DoubleOperatorOptions

برای ارائه یک عملگر جستجو برای ویژگی های دوگانه استفاده می شود. این اختیاری است. عملگرهای query.search به کاربران اجازه می‌دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو محدود کنند.

نمایندگی JSON 
{
  "operatorName": string
}
فیلدها
operatorName

string

نام اپراتور مورد نیاز در پرس و جو را نشان می دهد تا از ویژگی double در مرتب سازی یا به عنوان یک جنبه استفاده شود. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

TimestampPropertyOptions

گزینه های مربوط به ویژگی های مهر زمانی.

نمایندگی JSON 
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
فیلدها
operatorOptions

object ( TimestampPropertyOptions.TimestampOperatorOptions )

اگر تنظیم شود، نحوه استفاده از مهر زمانی را به عنوان اپراتور جستجو توضیح می دهد.

TimestampPropertyOptions.TimestampOperatorOptions

برای ارائه یک اپراتور جستجو برای خواص مهر زمانی استفاده می شود. این اختیاری است. عملگرهای query.search به کاربران اجازه می‌دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو محدود کنند.

نمایندگی JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
فیلدها
operatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی ویژگی timestamp نشان می دهد. برای مثال، اگر operatorName بسته باشد و نام ویژگی closeDate باشد، پرس و جوهایی مانند closeon:<value> نتایج را فقط در جایی نشان می‌دهند که مقدار ویژگی با نام closeDate با <value> مطابقت داشته باشد. در مقابل، جستجویی که از همان <value> بدون عملگر استفاده می‌کند، همه مواردی را که <value> با مقدار هر ویژگی رشته یا متن در فیلد محتوای مورد مطابقت دارد، برمی‌گرداند. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

lessThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را نشان می دهد تا خاصیت مهر زمانی را با استفاده از عملگر کمتر از آن جدا کند. به عنوان مثال، اگر lessThanOperatorName قبل از بسته شده باشد و نام ویژگی closeDate باشد، پرس و جوهایی مانند closebefore:<value> نتایج را فقط در جایی نشان می‌دهند که مقدار ویژگی با نام closeDate زودتر از <value> باشد. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

greaterThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را نشان می دهد تا خاصیت مهر زمانی را با استفاده از عملگر بزرگتر از هم جدا کند. برای مثال، اگر greaterThanOperatorName بعد از آن بسته شود و نام ویژگی بسته شده باشد، آنگاه پرس و جوهایی مانند بستن بعد: <value> نتایج را فقط در جایی نشان می دهد که مقدار ویژگی با نام closeDate دیرتر از <value> باشد. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

BooleanPropertyOptions

گزینه های خواص بولی

نمایندگی JSON 
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
فیلدها
operatorOptions

object ( BooleanPropertyOptions.BooleanOperatorOptions )

اگر تنظیم شود، نحوه استفاده از بولی را به عنوان عملگر جستجو توضیح می دهد.

BooleanPropertyOptions.BooleanOperatorOptions

برای ارائه یک عملگر جستجو برای خواص بولی استفاده می شود. این اختیاری است. عملگرهای query.search به کاربران اجازه می‌دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو محدود کنند.

نمایندگی JSON 
{
  "operatorName": string
}
فیلدها
operatorName

string

نام اپراتور مورد نیاز در پرس و جو را برای جداسازی خاصیت بولی نشان می دهد. برای مثال، اگر operatorName بسته باشد و نام ویژگی isClosed باشد، پرس و جوهایی مانند بسته:<value> نتایج را فقط در جایی نشان می‌دهند که مقدار ویژگی با نام isClosed با <value> مطابقت داشته باشد. در مقابل، جستجویی که از همان <value> بدون عملگر استفاده می‌کند، همه مواردی را که <value> با مقدار هر ویژگی رشته یا متن در فیلد محتوای مورد مطابقت دارد، برمی‌گرداند. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

ObjectPropertyOptions

گزینه های خواص شی

نمایندگی JSON 
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
فیلدها
subobjectProperties[]

object ( PropertyDefinition )

ویژگی های شی فرعی. این ویژگی ها یک شی تودرتو را نشان می دهند. برای مثال، اگر این ویژگی نشان دهنده یک آدرس پستی باشد، subobjectProperties ممکن است خیابان ، شهر و ایالت نامیده شود. حداکثر تعداد عناصر 1000 است.

EnumPropertyOptions

گزینه‌های مربوط به ویژگی‌های enum، که به شما امکان می‌دهند مجموعه‌ای از رشته‌ها را برای مطابقت با درخواست‌های کاربر تعریف کنید، رتبه‌بندی‌هایی را برای مقادیر رشته‌ها تنظیم کنید، و نام اپراتور را برای جفت شدن با آن رشته‌ها تعریف کنید تا کاربران بتوانند نتایج را به مواردی محدود کنند که دارای یک ارزش خاص به عنوان مثال، برای موارد موجود در یک سیستم ردیابی درخواست با اطلاعات اولویت، می توانید p0 را به عنوان یک مقدار enum مجاز تعریف کنید و این enum را به اولویت نام اپراتور گره بزنید تا کاربران جستجو بتوانند priority:p0 را به درخواست خود اضافه کنند تا مجموعه نتایج را محدود کند. فقط به مواردی که با مقدار p0 نمایه شده اند.

نمایندگی JSON 
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
فیلدها
possibleValues[]

object ( EnumPropertyOptions.EnumValuePair )

لیست مقادیر ممکن برای ویژگی enumeration. همه EnumValuePair ها باید یک مقدار رشته ارائه کنند. اگر یک مقدار صحیح برای یک EnumValuePair مشخص کنید، تمام EnumValuePair های ممکن باید یک مقدار صحیح ارائه کنند. هم مقدار رشته و هم مقدار صحیح باید در تمام مقادیر ممکن یکتا باشند. پس از تنظیم، مقادیر ممکن را نمی توان حذف یا تغییر داد. اگر رتبه‌بندی مرتبی ارائه می‌کنید و فکر می‌کنید ممکن است در آینده مقادیر بیشتری را وارد کنید، شکاف‌هایی در مقادیر صحیح اولیه بگذارید تا اجازه اضافه کردن یک مقدار بین مقادیر ثبت‌شده قبلی را بدهید. حداکثر تعداد عناصر 100 است.

orderedRanking

enum ( EnumPropertyOptions.OrderedRanking )

برای تعیین رتبه بندی مرتب شده برای شمارش استفاده می شود که تعیین می کند چگونه از مقادیر صحیح ارائه شده در EnumValuePairs ممکن برای رتبه بندی نتایج استفاده شود. اگر مشخص شده باشد، مقادیر صحیح باید برای تمام مقادیر EnumValuePair ممکن برای این ویژگی ارائه شود. فقط در صورتی قابل استفاده است که isRepeatable نادرست باشد.

operatorOptions

object ( EnumPropertyOptions.EnumOperatorOptions )

اگر تنظیم شود، نحوه استفاده از enum را به عنوان اپراتور جستجو توضیح می دهد.

EnumPropertyOptions.EnumValuePair

جفت مقدار شمارش دو چیز را تعریف می کند: یک مقدار رشته مورد نیاز و یک مقدار صحیح اختیاری. مقدار رشته عبارت پرس و جو ضروری مورد نیاز برای بازیابی آن مورد را تعریف می کند، مانند p0 برای یک آیتم اولویت. مقدار صحیح رتبه بندی آن مقدار رشته را نسبت به سایر مقادیر شمارش شده برای همان ویژگی تعیین می کند. برای مثال، ممکن است p0 را با 0 مرتبط کنید و یک جفت enum دیگری مانند p1 و 1 تعریف کنید. شما باید از مقدار صحیح در ترکیب با ordered ranking استفاده کنید تا رتبه بندی یک مقدار داده شده را نسبت به سایر مقادیر شمارش شده برای همان نام دارایی تنظیم کنید. در اینجا، ترتیب رتبه‌بندی نزولی برای ویژگی‌های اولویت‌دار منجر به افزایش رتبه‌بندی برای آیتم‌های نمایه‌شده با مقدار p0 در مقایسه با موارد نمایه‌شده با مقدار p1 می‌شود. بدون ترتیب رتبه بندی مشخص، مقدار صحیح هیچ تاثیری بر رتبه بندی آیتم ها ندارد.

نمایندگی JSON 
{
  "stringValue": string,
  "integerValue": integer
}
فیلدها
stringValue

string

مقدار رشته EnumValuePair. حداکثر طول 32 کاراکتر است.

integerValue

integer

مقدار صحیح EnumValuePair که باید غیر منفی باشد. اختیاری.

EnumPropertyOptions.OrderedRanking

برای تعیین جهت رتبه بندی یک عدد صحیح EnumValuePair نسبت به سایر مقادیر عدد صحیح EnumValuePair استفاده می شود. برای برخی از ویژگی ها، مقادیر صحیح پایین تر نشان دهنده اهمیت بالاتر است، در حالی که در برخی دیگر، عدد صحیح بالاتر نشان دهنده اهمیت بالاتر است.

Enums
NO_ORDER هیچ ترتیب رتبه بندی برای ملک وجود ندارد. نتایج با مقدار این ویژگی تنظیم نمی‌شوند.
ASCENDING این ویژگی به ترتیب صعودی رتبه بندی شده است. مقادیر پایین تر نشان دهنده رتبه پایین تر است.
DESCENDING این ویژگی به ترتیب نزولی رتبه بندی شده است. مقادیر کمتر نشان دهنده رتبه بالاتر است.

EnumPropertyOptions.EnumOperatorOptions

برای ارائه یک عملگر جستجو برای خواص enum استفاده می شود. این اختیاری است. عملگرهای query.search به کاربران اجازه می‌دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو محدود کنند. به عنوان مثال، اگر هیچ عملگری برای یک ویژگی enum اولویت با مقادیر احتمالی p0 و p1 ارائه نکنید، یک پرس و جو حاوی عبارت p0 مواردی را که دارای p0 به عنوان مقدار ویژگی اولویت هستند، و همچنین هر آیتمی که حاوی رشته p0 است را برمی گرداند. در زمینه های دیگر اگر یک نام عملگر برای enum ارائه دهید، مانند اولویت ، کاربران جستجو می‌توانند از آن عملگر برای اصلاح نتایج فقط به مواردی که p0 به عنوان مقدار این ویژگی دارند، با اولویت جستجو:p0 استفاده کنند.

نمایندگی JSON 
{
  "operatorName": string
}
فیلدها
operatorName

string

نام اپراتور مورد نیاز در پرس و جو را برای جداسازی خاصیت enum نشان می دهد. به عنوان مثال، اگر operatorName اولویت باشد و نام ویژگی PriorityVal باشد، پرس و جوهایی مانند priority:<value> نتایج را فقط در جایی نشان می دهند که مقدار ویژگی با نام priorityVal با <value> مطابقت داشته باشد. در مقابل، جستجویی که از همان <value> بدون عملگر استفاده می‌کند، همه مواردی را که <value> با مقدار هر ویژگی رشته یا متن در فیلد محتوای مورد مطابقت دارد، برمی‌گرداند. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

DatePropertyOptions

گزینه های مربوط به خواص تاریخ

نمایندگی JSON 
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
فیلدها
operatorOptions

object ( DatePropertyOptions.DateOperatorOptions )

اگر تنظیم شود، نحوه استفاده از تاریخ را به عنوان اپراتور جستجو توضیح می دهد.

DatePropertyOptions.DateOperatorOptions

اختیاری. یک عملگر جستجو برای ویژگی های تاریخ ارائه می دهد. عملگرهای query.search به کاربران اجازه می‌دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو محدود کنند.

نمایندگی JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
فیلدها
operatorName

string

رشته واقعی مورد نیاز در پرس و جو را برای جداسازی ویژگی date نشان می دهد. به عنوان مثال، فرض کنید یک شی طرح ردیابی مشکل دارای خاصیتی به نام closeDate است که یک اپراتور با operatorName of closeon را مشخص می کند. برای جستجوهای مربوط به آن داده، پرس و جوهایی مانند closeon:<value> نتایج را فقط در جایی نشان می دهند که مقدار ویژگی closeDate با <value> مطابقت داشته باشد. در مقابل، جستجویی که از همان <value> بدون عملگر استفاده می کند، همه مواردی را که در آنها <value> با مقدار هر ویژگی رشته یا متن در فیلد محتوای منبع داده نمایه شده مطابقت دارد، برمی گرداند. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

lessThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی ویژگی date با استفاده از عملگر کمتر از نشان می دهد. به عنوان مثال، اگر lessThanOperatorName قبل از بسته شده باشد و نام ویژگی closeDate باشد، پرس و جوهایی مانند closebefore:<value> نتایج را فقط در جایی نشان می‌دهند که مقدار ویژگی با نام closeDate زودتر از <value> باشد. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

greaterThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را نشان می دهد تا خصوصیت date را با استفاده از عملگر بزرگتر از هم جدا کند. برای مثال، اگر greaterThanOperatorName بعد از آن بسته شود و نام ویژگی بسته شده باشد، آنگاه پرس و جوهایی مانند بستن بعد: <value> نتایج را فقط در جایی نشان می دهد که مقدار ویژگی با نام closeDate دیرتر از <value> باشد. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

TextPropertyOptions

گزینه های ویژگی های متن

نمایندگی JSON 
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
فیلدها
retrievalImportance

object ( RetrievalImportance )

اهمیت کیفیت جستجوی توکن‌های درون فیلد را هنگام استفاده برای بازیابی نشان می‌دهد.

operatorOptions

object ( TextPropertyOptions.TextOperatorOptions )

اگر تنظیم شود، نحوه استفاده از ویژگی را به عنوان اپراتور جستجو توضیح می دهد.

اهمیت بازیابی

نمایندگی JSON 
{
  "importance": enum (RetrievalImportance.Importance)
}
فیلدها
importance

enum ( RetrievalImportance.Importance )

نشان‌دهنده اهمیت رتبه‌بندی داده شده به اموال در هنگام تطبیق آن در هنگام بازیابی است. پس از تنظیم، اهمیت نماد یک دارایی قابل تغییر نیست.

RetrievalImportance.Importance

Enums
DEFAULT با مسابقه مانند متن متنی رفتار کنید.
HIGHEST با مسابقه مانند مسابقه با عنوان مورد رفتار کنید.
HIGH به مسابقه با اهمیتی بالاتر از متن بدن برخورد کنید.
LOW به مسابقه با اهمیت کمتری نسبت به متن اصلی برخورد کنید.
NONE در هنگام بازیابی با این فیلد مطابقت نداشته باشید. این ویژگی همچنان می تواند برای تطبیق اپراتورها، نمایان شدن و در صورت تمایل پیشنهاد استفاده شود.

TextPropertyOptions.TextOperatorOptions

برای ارائه یک عملگر جستجو برای ویژگی های متن استفاده می شود. این اختیاری است. عملگرهای query.search به کاربران اجازه می‌دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو محدود کنند.

نمایندگی JSON 
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
فیلدها
operatorName

string

نام اپراتور مورد نیاز در پرس و جو برای جداسازی ویژگی متن را نشان می دهد. به عنوان مثال، اگر operatorName موضوع باشد و نام ویژگی SubjectLine باشد، پرس و جوهایی مانند subject:<value> فقط در جایی نتایج را نشان می دهند که مقدار ویژگی با نام subjectLine با <value> مطابقت داشته باشد. در مقابل، جستجویی که از همان <value> بدون عملگر استفاده می‌کند، همه مواردی را که <value> با مقدار هر ویژگی متن یا متنی در فیلد محتوای مورد مطابقت دارد، برمی‌گرداند. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

exactMatchWithOperator

boolean

اگر درست باشد، مقدار متن به عنوان یک مقدار اتمی در جستجوهای اپراتور و تطبیق‌های وجه نشانه گذاری می‌شود. به عنوان مثال، اگر نام اپراتور "ژانر" و مقدار آن "علمی-تخیلی" باشد، محدودیت های پرس و جو "ژانر: علم" و "ژانر: تخیلی" با آیتم مطابقت ندارد. "ژانر: علمی-تخیلی" انجام می دهد. تطبیق مقدار متن به حروف بزرگ و کوچک حساس است و کاراکترهای خاصی را حذف نمی کند. اگر غلط باشد، متن نشانه گذاری می شود. برای مثال، اگر مقدار "علمی-تخیلی" باشد، عبارت "ژانر: علم" و "ژانر: تخیلی" با آیتم مطابقت دارد.

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 نشان می دهد. به عنوان مثال، اگر operatorName موضوع باشد و نام ویژگی SubjectLine باشد، پرس و جوهایی مانند subject:<value> فقط در جایی نتایج را نشان می دهند که مقدار ویژگی با نام subjectLine با <value> مطابقت داشته باشد. در مقابل، جستجویی که از همان <value> بدون عملگر استفاده می‌کند، همه مواردی را که <value> با مقدار هر ویژگی html یا متنی در فیلد محتوای مورد مطابقت دارد، برمی‌گرداند. نام اپراتور فقط می تواند شامل حروف کوچک (az) باشد. حداکثر طول 32 کاراکتر است.

PropertyDisplayOptions

گزینه های نمایش برای یک ملک

نمایندگی JSON 
{
  "displayLabel": string
}
فیلدها
displayLabel

string

برچسب کاربر پسند برای ویژگی که اگر مشخص شده باشد که ویژگی در ObjectDisplayOptions نمایش داده شود، استفاده می شود. در صورت ارائه، زمانی که ویژگی بخشی از گزینه های نمایش شیء باشد، برچسب نمایش در مقابل مقادیر ویژگی نشان داده می شود. به عنوان مثال، اگر مقدار ویژگی "1" باشد، ممکن است مقدار به خودی خود زمینه مفیدی برای کاربر نباشد. اگر نام نمایش داده شده "اولویت" بود، کاربر "اولویت: 1" را در نتایج جستجو می بیند که زمینه روشنی را برای کاربران جستجو فراهم می کند. این اختیاری است. اگر داده نشود، فقط مقادیر ویژگی نمایش داده می شود. حداکثر طول 64 کاراکتر است.