REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

نام مورد. قالب: منابع داده/{sourceId}/items/{itemId}

این یک فیلد الزامی است. حداکثر طول 1536 کاراکتر است.

object ( ItemAcl )

لیست کنترل دسترسی برای این مورد.

object ( ItemMetadata )

اطلاعات فراداده

object ( ItemStructuredData )

داده های ساختار یافته برای آیتم که باید با تعریف شی ثبت شده در طرح منبع داده مطابقت داشته باشد.

object ( ItemContent )

محتوای مورد باید نمایه شود و متن قابل جستجو شود.

string ( bytes format)

مورد نیاز. سیستم نمایه سازی نسخه را از منبع داده به عنوان یک رشته بایت ذخیره می کند و نسخه آیتم موجود در فهرست را با نسخه آیتم در صف با استفاده از ترتیب واژگانی مقایسه می کند.

فهرست‌بندی جستجوی ابری هیچ مورد در صفی را با مقدار نسخه کمتر یا برابر با نسخه مورد نمایه‌شده فعلی فهرست‌بندی یا حذف نمی‌کند. حداکثر طول این فیلد 1024 بایت است.

برای اطلاعات در مورد اینکه نسخه مورد چگونه بر فرآیند حذف تأثیر می‌گذارد، به ویرایش‌های Handle پس از حذف دستی مراجعه کنید.

رشته ای با کد base64.

object ( ItemStatus )

وضعیت مورد. فیلد فقط خروجی

string

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

string ( bytes format)

کانکتور حالت اضافی می تواند برای این مورد ذخیره کند. حداکثر طول 10000 بایت است.

رشته ای با کد base64.

enum ( Item.ItemType )

نوع این مورد

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

نام موردی که فهرست مجوز دسترسی (ACL) از آن به ارث می رسد. توجه: وراثت ACL فقط مجوزهای دسترسی به آیتم های فرزند را فراهم می کند و روابط ساختاری را تعریف نمی کند، و همچنین راه های مناسبی برای حذف گروه های بزرگ از موارد ارائه نمی دهد. حذف والد ACL از فهرست تنها مجوزهای دسترسی آیتم های فرزندی را که به والد در فیلد inheritAclFrom ارجاع می دهند، تغییر می دهد. مورد هنوز در فهرست است، اما ممکن است در نتایج جستجو قابل مشاهده نباشد. در مقابل، حذف یک آیتم کانتینر همچنین تمام مواردی را که از طریق فیلد containerName به کانتینر ارجاع می دهند، حذف می کند. حداکثر طول این فیلد 1536 کاراکتر است.

enum ( ItemAcl.AclInheritanceType )

نوع قوانین دسترسی را برای اعمال زمانی که یک مورد ACL خود را از والدین به ارث می برد، تنظیم می کند. این باید همیشه در کنار فیلد inheritAclFrom تنظیم شود. همچنین، وقتی فیلد inheritAclFrom تنظیم می شود، این فیلد باید روی AclInheritanceType معتبر تنظیم شود.

object ( Principal )

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

object ( Principal )

فهرست مدیرانی که صراحتاً از دسترسی به آیتم در نتایج جستجو محروم هستند. در حالی که به طور پیش‌فرض دسترسی اصولی ممنوع است، از خوانندگان محروم برای رسیدگی به استثناها و لغو لیست خوانندگان مجاز استفاده کنید. حداکثر تعداد عناصر 100 است.

object ( Principal )

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

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object ( GSuitePrincipal )

این مدیر یک کاربر، گروه یا دامنه Google Workspace است.

string

این اصلی کاربری است که با استفاده از یک هویت خارجی شناسایی شده است. فیلد نام باید نام منبع کاربر را با این قالب مشخص کند: IDsources/{sourceId}/users/{ID}

string

این اصل گروهی است که با استفاده از یک هویت خارجی شناسایی می شود. فیلد نام باید نام منبع گروه را با این قالب مشخص کند: IDsources/{sourceId}/groups/{ID}

{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}

string

عنوان مورد. اگر داده شود، این عنوان نمایش داده شده نتیجه query.search خواهد بود. حداکثر طول 2048 کاراکتر است.

string

پیوند به مخزن منبع که داده ها را ارائه می دهد. نتایج جستجو این پیوند را به عنوان اعمال می کند. فضای خالی یا نویسه‌های خاص ممکن است باعث شود که پیوندهای نتیجه جستجوی ابری اعلان تغییر مسیر را ایجاد کنند. برای جلوگیری از این امر، URL را رمزگذاری کنید. حداکثر طول 2048 کاراکتر است.

string

نام ظرف برای این مورد. حذف آیتم ظرف منجر به حذف خودکار این آیتم می شود. توجه: ACL ها از یک آیتم کانتینری به ارث برده نمی شوند. برای ارائه وراثت ACL برای یک آیتم، از فیلد inheritAclFrom استفاده کنید. حداکثر طول 1536 کاراکتر است.

string

نوع مورد. این باید با نام یک تعریف شی در طرح ثبت شده برای منبع داده مطابقت داشته باشد. به عنوان مثال، اگر طرح واره منبع داده حاوی یک تعریف شی با نام "document" باشد، در این صورت درخواست های نمایه سازی آیتم برای اشیاء از آن نوع باید objectType را روی "document" تنظیم کند. حداکثر طول 256 کاراکتر است.

string ( Timestamp format)

زمانی که آیتم در مخزن منبع ایجاد شد.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

string ( Timestamp format)

زمانی که مورد آخرین بار در مخزن منبع اصلاح شد.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

object ( Interaction )

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

string

کد زبان BCP-47 برای مورد، مانند "en-US" یا "sr-Latn". برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید. حداکثر طول 32 کاراکتر است.

string

نوع mime اصلی ItemContent.content در مخزن منبع. حداکثر طول 256 کاراکتر است.

object ( SearchQualityMetadata )

فراداده کیفیت جستجوی اضافی مورد

string

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

string

مقدار هش ارائه شده توسط تماس گیرنده API. این را می توان با روش items.push برای محاسبه حالت اصلاح شده استفاده کرد. حداکثر طول 2048 کاراکتر است.

object ( ContextAttribute )

مجموعه ای از ویژگی های نام گذاری شده مرتبط با آیتم. این می تواند برای تأثیرگذاری بر رتبه بندی مورد بر اساس زمینه در درخواست استفاده شود. حداکثر تعداد عناصر 10 است.

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum ( Interaction.InteractionType )

object ( Principal )

کاربری که روی مورد عمل کرده است.

string ( Timestamp format)

زمانی که کاربر روی آیتم اقدام کرد. اگر چندین اقدام از یک نوع برای یک کاربر وجود داشته باشد، فقط آخرین اقدام ثبت می شود.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

{
  "quality": number
}

number

نشانه ای از کیفیت مورد، که برای تأثیرگذاری بر کیفیت جستجو استفاده می شود. مقدار باید بین 0.0 (پایین ترین کیفیت) و 1.0 (بالاترین کیفیت) باشد. مقدار پیش فرض 0.0 است.

{
  "name": string,
  "values": [
    string
  ]
}

string

نام صفت. نباید خالی باشد. حداکثر طول 32 کاراکتر است. نام باید با یک حرف شروع شود و فقط شامل حروف (AZ، az) یا اعداد (0-9) باشد. نام قبل از تطبیق عادی (حروف کوچک) خواهد شد.

string

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

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object ( StructuredDataObject )

شی داده ساختار یافته که باید با تعریف شی ثبت شده در طرح برای منبع داده مطابقت داشته باشد.

string

مقدار هش ارائه شده توسط تماس گیرنده API. این را می توان با روش items.push برای محاسبه حالت اصلاح شده استفاده کرد. حداکثر طول 2048 کاراکتر است.

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object ( NamedProperty )

خواص برای شی حداکثر تعداد عناصر 1000 است.

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

نام ملک. این نام باید مطابق با نام دارایی باشد که برای تعریف شی در طرحواره ثبت شده است. حداکثر طول مجاز برای این ویژگی 256 کاراکتر است.

object ( NamedProperty.IntegerValues )

object ( NamedProperty.DoubleValues )

object ( NamedProperty.TimestampValues )

boolean

object ( NamedProperty.ObjectValues )

object ( NamedProperty.EnumValues )

object ( NamedProperty.DateValues )

object ( NamedProperty.TextValues )

object ( NamedProperty.HtmlValues )

{
  "values": [
    string
  ]
}

string ( int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string ( Timestamp format)

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object ( StructuredDataObject )

{
  "values": [
    string
  ]
}

string

حداکثر طول مجاز برای مقادیر رشته 32 کاراکتر است.

{
  "values": [
    {
      object (Date)
    }
  ]
}

object ( Date )

{
  "values": [
    string
  ]
}

string

حداکثر طول مجاز برای مقادیر متن 2048 کاراکتر است.

{
  "values": [
    string
  ]
}

string

حداکثر طول مجاز برای مقادیر html 2048 کاراکتر است.

{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}

enum ( ItemContent.ContentFormat )

string

اطلاعات هش شده توسط مشتری API برای محتوا محاسبه و ارائه شده است. می توان با روش items.push برای محاسبه حالت اصلاح شده استفاده کرد. حداکثر طول 2048 کاراکتر است.

string ( bytes format)

محتوایی که به صورت خطی در روش به‌روزرسانی ارائه می‌شود. حداکثر طول 102400 بایت (100 کیلوبایت) است.

رشته ای با کد base64.

object ( UploadItemRef )

شناسه مرجع محتوای بارگذاری شده قبلی را از طریق روش نوشتن بارگذاری کنید.

{
  "name": string
}

string

نام مرجع محتوا. حداکثر طول 2048 کاراکتر است.

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum ( ItemStatus.Code )

کد وضعیت

object ( ProcessingError )

جزئیات خطا در صورتی که مورد در حالت ERROR باشد.

object ( RepositoryError )

خطای مخزن توسط رابط گزارش شده است.

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum ( ProcessingErrorCode )

کد خطا که ماهیت خطا را نشان می دهد.

string

شرح خطا.

object ( FieldViolation )

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

{
  "field": string,
  "description": string
}

string

مسیر میدان با تخلف.

string

شرح خطا.

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum ( RepositoryError.Type )

نوع خطا.

integer

کدهای خطا با تعریف کدهای وضعیت HTTP مطابقت دارد.

string

پیامی که خطا را توضیح می دهد. حداکثر طول مجاز پیام 8192 کاراکتر است.