ACL، فراداده و محتوا Item
را به روز می کند. اگر Item
وجود نداشته باشد، آن را درج می کند. این روش به روز رسانی های جزئی را پشتیبانی نمی کند. فیلدهای بدون مقادیر ارائه شده در فهرست جستجوی ابری پاک می شوند.
این API برای اجرا به یک ادمین یا حساب سرویس نیاز دارد. حساب سرویس مورد استفاده در فهرست سفید منبع داده مربوطه است.
درخواست HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
item.name | نام مورد. قالب: منابع داده/{sourceId}/items/{itemId} این یک فیلد الزامی است. حداکثر طول 1536 کاراکتر است. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
فیلدها | |
---|---|
item.acl | لیست کنترل دسترسی برای این مورد. |
item.metadata | اطلاعات فراداده |
item.structuredData | داده های ساختار یافته برای آیتم که باید با تعریف شی ثبت شده در طرح منبع داده مطابقت داشته باشد. |
item.content | محتوای مورد باید نمایه شود و متن قابل جستجو شود. |
item.version | مورد نیاز. سیستم نمایه سازی نسخه را از منبع داده به عنوان یک رشته بایت ذخیره می کند و نسخه آیتم موجود در فهرست را با نسخه آیتم در صف با استفاده از ترتیب واژگانی مقایسه می کند. فهرستبندی جستجوی ابری هیچ مورد در صفی را با مقدار نسخه کمتر یا برابر با نسخه مورد نمایهشده فعلی فهرستبندی یا حذف نمیکند. حداکثر طول این فیلد 1024 بایت است. برای اطلاعات در مورد اینکه نسخه مورد چگونه بر فرآیند حذف تأثیر میگذارد، به ویرایشهای Handle پس از حذف دستی مراجعه کنید. رشته ای با کد base64. |
item.status | وضعیت مورد. فیلد فقط خروجی |
item.queue | صفی که این مورد به آن تعلق دارد. حداکثر طول 100 کاراکتر است. |
item.payload | کانکتور حالت اضافی می تواند برای این مورد ذخیره کند. حداکثر طول 10000 بایت است. رشته ای با کد base64. |
item.itemType | نوع این مورد |
connectorName | نام رابطی که این تماس را برقرار می کند. قالب: منابع داده/{sourceId}/connectors/{ID} |
mode | مورد نیاز. RequestMode برای این درخواست. |
debugOptions | گزینه های رایج اشکال زدایی |
indexItemOptions | |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Operation
است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud_search.indexing
-
https://www.googleapis.com/auth/cloud_search
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
IndexItemOptions
نمایندگی JSON |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
فیلدها | |
---|---|
allowUnknownGsuitePrincipals | مشخص میکند که آیا درخواست فهرست باید به اصول Google Workspace اجازه دهد که وجود ندارند یا حذف شدهاند. |