Method: indexing.datasources.items.index

ACL، فراداده و محتوا Item را به روز می کند. اگر Item وجود نداشته باشد، آن را درج می کند. این روش به روز رسانی های جزئی را پشتیبانی نمی کند. فیلدهای بدون مقادیر ارائه شده در فهرست جستجوی ابری پاک می شوند.

این API برای اجرا به یک ادمین یا حساب سرویس نیاز دارد. حساب سرویس مورد استفاده در فهرست سفید منبع داده مربوطه است.

درخواست HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
item.name

string

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

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

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "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)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "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.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
فیلدها
item.acl

object ( ItemAcl )

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

item.metadata

object ( ItemMetadata )

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

item.structuredData

object ( ItemStructuredData )

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

item.content

object ( ItemContent )

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

item.version

string ( bytes format)

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

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

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

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

item.status

object ( ItemStatus )

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

item.queue

string

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

item.payload

string ( bytes format)

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

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

item.itemType

enum ( Item.ItemType )

نوع این مورد

connectorName

string

نام رابطی که این تماس را برقرار می کند.

قالب: منابع داده/{sourceId}/connectors/{ID}

mode

enum ( RequestMode.Mode )

مورد نیاز. RequestMode برای این درخواست.

debugOptions

object ( DebugOptions )

گزینه های رایج اشکال زدایی

indexItemOptions

object ( IndexItemOptions )

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Operation است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

IndexItemOptions

نمایندگی JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
فیلدها
allowUnknownGsuitePrincipals

boolean

مشخص می‌کند که آیا درخواست فهرست باید به اصول Google Workspace اجازه دهد که وجود ندارند یا حذف شده‌اند.