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

نشان می دهد که ویژگی داده هایی را که باید از طریق API query در نتایج جستجو برگردانده شوند، شناسایی می کند. اگر روی true تنظیم شود، نشان می دهد که کاربران 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)
  },

  // Union field faceting_options can be only one of the following:
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
  // End of list of possible types for union field faceting_options.
}
فیلدها
orderedRanking

enum ( IntegerPropertyOptions.OrderedRanking )

برای تعیین رتبه بندی مرتب شده برای عدد صحیح استفاده می شود. فقط در صورتی قابل استفاده است که isRepeatable نادرست باشد.

minimumValue

string ( Int64Value format)

حداقل ارزش ملک. حداقل و حداکثر مقادیر برای اموال برای رتبه بندی نتایج بر اساس ordered ranking استفاده می شود. درخواست‌های نمایه‌سازی با مقادیر کمتر از حداقل پذیرفته می‌شوند و با همان وزن مواردی که با حداقل مقدار نمایه شده‌اند، رتبه‌بندی می‌شوند.

maximumValue

string ( Int64Value format)

حداکثر ارزش ملک. حداقل و حداکثر مقادیر برای اموال برای رتبه بندی نتایج بر اساس ordered ranking استفاده می شود. درخواست‌های نمایه‌سازی با مقادیر بیشتر از حداکثر پذیرفته می‌شوند و با همان وزنی که موارد نمایه‌سازی شده با حداکثر مقدار رتبه‌بندی می‌شوند، رتبه‌بندی می‌شوند.

operatorOptions

object ( IntegerPropertyOptions.IntegerOperatorOptions )

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

فیلد اتحادیه faceting_options .

faceting_options می تواند تنها یکی از موارد زیر باشد:

integerFacetingOptions

object ( IntegerFacetingOptions )

اگر تنظیم شود، گزینه های واژگونی اعداد صحیح را برای ویژگی عدد صحیح داده شده توصیف می کند. ویژگی عدد صحیح مربوطه باید isFacetable علامت گذاری شود.

IntegerPropertyOptions.OrderedRanking

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

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

IntegerPropertyOptions.IntegerOperatorOptions

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

نمایندگی 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

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

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

string

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

TimestampPropertyOptions

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

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

object ( TimestampPropertyOptions.TimestampOperatorOptions )

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

TimestampPropertyOptions.TimestampOperatorOptions

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

نمایندگی 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

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

نمایندگی 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 را به اولویت نام اپراتور گره بزنید تا کاربران جستجو بتوانند اولویت: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 استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو شده محدود کنند. به عنوان مثال، اگر برای یک ویژگی 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

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

نمایندگی 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

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

نمایندگی 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 استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را به فیلدهای خاص مرتبط با نوع مورد جستجو شده محدود کنند.

نمایندگی 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 کاراکتر است.

،

تعریف طرحواره برای منبع داده

نمایندگی 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

نشان می دهد که ویژگی داده هایی را که باید از طریق API query در نتایج جستجو برگردانده شوند، شناسایی می کند. اگر روی true تنظیم شود، نشان می دهد که کاربران API پرس و جو می توانند از فیلدهای ویژگی منطبق در نتایج استفاده کنند. با این حال، ذخیره سازی فیلدها به تخصیص فضای بیشتری نیاز دارد و از پهنای باند بیشتری برای پرس و جوهای جستجو استفاده می کند که بر عملکرد مجموعه داده های بزرگ تأثیر می گذارد. فقط در صورتی که این فیلد برای نتایج جستجو مورد نیاز باشد، در اینجا روی true تنظیم کنید. نمی تواند برای خواصی که نوع آنها یک شی است صادق باشد.

isRepeatable

boolean

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

isSortable

boolean

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

isFacetable

boolean

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

isSuggestable

boolean

نشان می دهد که این خاصیت می تواند برای تولید پیشنهادات پرس و جو استفاده شود.

isWildcardSearchable

boolean

نشان می دهد که کاربران می توانند جستجوی کارت Wildcard را برای این ویژگی انجام دهند. فقط برای خصوصیات متن پشتیبانی می شود. برای تنظیم این گزینه باید ISreturnable صادق باشد. در یک داده داده معین حداکثر 5 ویژگی را می توان به عنوان iswildcardsearkable مشخص کرد. برای اطلاعات بیشتر ، به ویژگی های شیء Define مراجعه کنید

displayOptions

object ( PropertyDisplayOptions )

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

Union Field 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)
  },

  // Union field faceting_options can be only one of the following:
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
  // End of list of possible types for union field faceting_options.
}
فیلدها
orderedRanking

enum ( IntegerPropertyOptions.OrderedRanking )

برای مشخص کردن رتبه سفارش داده شده برای عدد صحیح استفاده می شود. فقط در صورتی قابل استفاده است که isRepeatable استفاده است.

minimumValue

string ( Int64Value format)

حداقل مقدار خاصیت. از حداقل و حداکثر مقادیر خاصیت برای رتبه بندی نتایج با توجه به ordered ranking استفاده می شود. درخواست های نمایه سازی با مقادیر کمتر از حداقل با همان وزن مواردی که با حداقل مقدار فهرست بندی شده است ، پذیرفته و رتبه بندی می شوند.

maximumValue

string ( Int64Value format)

حداکثر مقدار خاصیت. از حداقل و حداکثر مقادیر خاصیت برای رتبه بندی نتایج با توجه به ordered ranking استفاده می شود. درخواست های نمایه سازی با مقادیر بیشتر از حداکثر با همان وزن مواردی که با حداکثر مقدار نمایه شده اند ، پذیرفته و رتبه بندی می شوند.

operatorOptions

object ( IntegerPropertyOptions.IntegerOperatorOptions )

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

Union Field faceting_options .

faceting_options فقط می تواند یکی از موارد زیر باشد:

integerFacetingOptions

object ( IntegerFacetingOptions )

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

integerpropertyoptions.orderedranking

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

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

IntegerPropertyOptions.integeroperatoroptions

برای تهیه یک اپراتور جستجو برای خصوصیات عدد صحیح استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را در زمینه های خاص مربوط به نوع مورد جستجو محدود کنند.

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

string

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

lessThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی خاصیت عدد صحیح با استفاده از اپراتور کمتر از آن نشان می دهد. به عنوان مثال ، اگر Lessthanoperatorname اولویت بندی باشد و نام این ملک اولویت داشته باشد ، پس از نمایش داده شده مانند اولویت بندی: <Value> نتایج را نشان می دهد که مقدار خاصیت به نام PriorityVal کمتر از <Value> است. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

greaterThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی خاصیت عدد صحیح با استفاده از اپراتور بیشتر از آن نشان می دهد. به عنوان مثال ، اگر Greatthanoperatorname اولویت داشته باشد و نام این ملک اولویت داشته باشد ، پس از نمایش داده شده مانند اولویتابووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووووت در آن قرار می گیرد. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

دو پروپریپتراسیون

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

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

object ( DoublePropertyOptions.DoubleOperatorOptions )

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

DoublePropertyOptions.DoubleOperatorOptions

برای تهیه یک اپراتور جستجو برای خصوصیات مضاعف استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را در زمینه های خاص مربوط به نوع مورد جستجو محدود کنند.

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

string

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

timestamppropertyoptions

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

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

object ( TimestampPropertyOptions.TimestampOperatorOptions )

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

timestamppropertyoptions.TimestampoperatorOptions

برای تهیه یک اپراتور جستجو برای خصوصیات Timestamp استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را در زمینه های خاص مربوط به نوع مورد جستجو محدود کنند.

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

string

به منظور جداسازی خاصیت Timestamp ، نام اپراتور مورد نیاز در پرس و جو را نشان می دهد. به عنوان مثال ، اگر Operatorname بسته است و نام این ملک بسته است ، پس از نمایش داده شده مانند Closeon: <Value> نتایج را نشان می دهد که مقدار خاصیت نامگذاری شده به نام های بسته <Value> . در مقابل ، جستجو که از همان <Value> بدون اپراتور استفاده می کند ، تمام مواردی را که <Value> با ارزش هر ویژگی رشته یا متن در قسمت محتوا برای مورد مطابقت دارد ، برمی گرداند. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

lessThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی ویژگی Timestamp با استفاده از اپراتور کمتر از آن نشان می دهد. به عنوان مثال ، اگر Lessthanoperatorname از قبل بسته شده است و نام این ملک بسته شده است ، پس از نمایش داده شده مانند Closebefore: <Value> نتایج را نشان می دهد که مقدار خاصیت به نام Clospate زودتر از <Value> است. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

greaterThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی ویژگی Timestamp با استفاده از اپراتور بیشتر از آن نشان می دهد. به عنوان مثال ، اگر Greatthanoperatorname بسته شده است و نام این ملک بسته شده است ، پس نمایش داده شدگان مانند CloseAfter: <Value> نتایج را نشان می دهد که مقدار خاصیت به نام Clospate دیرتر از <Value> است. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

booleanpropertyoptions

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

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

object ( BooleanPropertyOptions.BooleanOperatorOptions )

در صورت تنظیم ، توصیف می کند که چگونه از بولی به عنوان یک اپراتور جستجو استفاده می شود.

booleanpropertyoptions.booleanoperatoroptions

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

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

string

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

اشیاء

گزینه های خاصیت اشیاء.

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

object ( PropertyDefinition )

خواص زیر شیروانی. این خصوصیات نشان دهنده یک شیء تو در تو است. به عنوان مثال ، اگر این ملک یک آدرس پستی را نشان دهد ، ممکن است SubobjectProperties به نام خیابان ، شهر و ایالت نامگذاری شود. حداکثر تعداد عناصر 1000 است.

نهایت

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

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

object ( EnumPropertyOptions.EnumValuePair )

لیست مقادیر ممکن برای خاصیت شمارش. همه enumValuePairs باید یک مقدار رشته ارائه دهند. اگر مقدار عدد صحیح را برای یک enumvaluepair مشخص کنید ، تمام EnumValuePairs ممکن است یک مقدار عدد صحیح را ارائه دهند. هم مقدار رشته و هم مقدار عدد صحیح باید نسبت به تمام مقادیر ممکن بی نظیر باشد. پس از تنظیم ، مقادیر ممکن قابل حذف یا اصلاح نیست. اگر یک رتبه بندی سفارش داده شده را ارائه می دهید و فکر می کنید ممکن است مقادیر enum اضافی را در آینده وارد کنید ، شکاف ها را در مقادیر عدد صحیح اولیه بگذارید تا اجازه دهید یک مقدار بین مقادیر قبلی ثبت شده اضافه شود. حداکثر تعداد عناصر 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 استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را در زمینه های خاص مربوط به نوع مورد جستجو محدود کنند. به عنوان مثال ، اگر شما هیچ اپراتوری را برای ویژگی های اولویت enum با مقادیر احتمالی P0 و P1 ارائه نمی دهید ، پرس و جو که شامل اصطلاح P0 است که P0 را به عنوان مقدار خاصیت اولویت و همچنین مواردی که حاوی رشته P0 در زمینه های دیگر است ، باز می گرداند. اگر نام اپراتور را برای enum مانند اولویت ارائه می دهید ، پس کاربران می توانند از آن اپراتور استفاده کنند تا نتایج را فقط به مواردی که دارای P0 هستند ، با اولویت پرس و جو: P0 .

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

string

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

DatePropertyOptions

گزینه های ویژگی های تاریخ.

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

object ( DatePropertyOptions.DateOperatorOptions )

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

datepropertyoptions.dateoperatoroptions

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

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

string

رشته واقعی مورد نیاز در پرس و جو را به منظور جداسازی خاصیت تاریخ نشان می دهد. به عنوان مثال ، فرض کنید یک شیء Schema Tracking Object دارای یک ملک به نام Closeate است که یک اپراتور را با یک عملیات Clospon مشخص می کند. برای جستجوهای روی آن داده ها ، نمایش داده شدگان مانند Closeon: <Value> نتایج را نشان می دهد که مقدار خاصیت بسته مطابقت دارد <Value> . در مقابل ، جستجو که از همان <Value> بدون اپراتور استفاده می کند ، تمام مواردی را که <Value> با ارزش هر ویژگی رشته یا متن در قسمت محتوا برای مجموعه داده های فهرست بندی شده مطابقت دارد ، برمی گرداند. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

lessThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی ویژگی تاریخ با استفاده از اپراتور کمتر از آن نشان می دهد. به عنوان مثال ، اگر Lessthanoperatorname از قبل بسته شده است و نام این ملک بسته شده است ، پس از نمایش داده شده مانند Closebefore: <Value> نتایج را نشان می دهد که مقدار خاصیت به نام Clospate زودتر از <Value> است. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

greaterThanOperatorName

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی ویژگی تاریخ با استفاده از اپراتور بیشتر از آن نشان می دهد. به عنوان مثال ، اگر Greatthanoperatorname بسته شده است و نام این ملک بسته شده است ، پس نمایش داده شدگان مانند CloseAfter: <Value> نتایج را نشان می دهد که مقدار خاصیت به نام Clospate دیرتر از <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 )

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

بازیابی

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

TextPropertyOptions.TextOperatorOptions

برای تهیه یک اپراتور جستجو برای خصوصیات متن استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را در زمینه های خاص مربوط به نوع مورد جستجو محدود کنند.

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

string

برای جداسازی ویژگی متن ، نام اپراتور مورد نیاز در پرس و جو را نشان می دهد. به عنوان مثال ، اگر Operatorname موضوع باشد و نام ویژگی موضوع باشد ، پس از نمایش داده هایی مانند موضوع: <Value> نتایج را نشان می دهد که ارزش ویژگی نامگذاری شده با شماره <Value> مطابقت دارد. در مقابل ، جستجو که از همان <Value> بدون اپراتور استفاده می کند ، تمام مواردی را که <Value> با ارزش هر ویژگی متن یا متن در قسمت محتوا برای مورد مطابقت دارد ، برمی گرداند. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

exactMatchWithOperator

boolean

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

htmlpropertyoptions

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

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

object ( RetrievalImportance )

اهمیت کیفیت جستجو در نشانه های موجود در این زمینه را هنگام استفاده برای بازیابی نشان می دهد. فقط می تواند به طور پیش فرض یا هیچ یک تنظیم شود.

operatorOptions

object ( HtmlPropertyOptions.HtmlOperatorOptions )

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

htmlpropertyoptions.htmloperatoroptions

برای تهیه یک اپراتور جستجو برای خواص HTML استفاده می شود. این اختیاری است. اپراتورهای جستجو به کاربران اجازه می دهند پرس و جو را در زمینه های خاص مربوط به نوع مورد جستجو محدود کنند.

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

string

نام اپراتور مورد نیاز در پرس و جو را به منظور جداسازی خاصیت HTML نشان می دهد. به عنوان مثال ، اگر Operatorname موضوع باشد و نام ویژگی موضوع باشد ، پس از نمایش داده هایی مانند موضوع: <Value> نتایج را نشان می دهد که ارزش ویژگی نامگذاری شده با شماره <Value> مطابقت دارد. در مقابل ، جستجو که از همان <Value> بدون اپراتور استفاده می کند ، تمام مواردی را که در آن <Value> با مقدار هر ویژگی HTML یا متن در قسمت محتوا برای مورد مطابقت دارد ، باز می گرداند. نام اپراتور فقط می تواند حاوی حروف کوچک (AZ) باشد. حداکثر طول 32 کاراکتر است.

PropertDisplayOptions

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

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

string

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