Query

تعریف پرس‌وجوی مورد استفاده برای جستجو و خروجی گرفتن.

نمایش JSON 
{
  "corpus": enum (CorpusType),
  "dataScope": enum (DataScope),
  "searchMethod": enum (SearchMethod),
  "method": enum (SearchMethod),
  "terms": string,
  "startTime": string,
  "endTime": string,
  "teamDriveInfo": {
    object (TeamDriveInfo)
  },
  "timeZone": string,

  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }

  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
}
فیلدها
corpus

enum ( CorpusType )

سرویس Google Workspace برای جستجو.

dataScope

enum ( DataScope )

منبع داده برای جستجو.

searchMethod
(deprecated)

enum ( SearchMethod )

روش جستجوی مورد استفاده.

method

enum ( SearchMethod )

موجودیتی که باید جستجو شود. این فیلد جایگزین searchMethod می‌شود تا از درایوهای اشتراکی پشتیبانی کند. وقتی searchMethod برابر با TEAM_DRIVE باشد، پاسخ این فیلد SHARED_DRIVE خواهد بود.

terms

string

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

startTime

string ( Timestamp format)

زمان شروع جستجو. بر حسب GMT مشخص کنید. مقدار به ساعت ۱۲ بامداد در تاریخ مشخص شده گرد می‌شود.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

endTime

string ( Timestamp format)

زمان پایان جستجوی عبارت. بر حسب GMT مشخص کنید. مقدار به ساعت ۱۲ بامداد در تاریخ مشخص شده گرد می‌شود.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

teamDriveInfo
(deprecated)

object ( TeamDriveInfo )

وقتی SearchMethod برابر با TEAM_DRIVE باشد، الزامی است.

timeZone

string

نام منطقه زمانی. باید یک نام IANA TZ باشد، مانند "America/Los_Angeles". برای فهرستی از نام‌های منطقه زمانی، به منطقه زمانی مراجعه کنید. برای اطلاعات بیشتر در مورد نحوه استفاده Vault از مناطق زمانی، به مرکز راهنمایی Vault مراجعه کنید.

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

object ( AccountInfo )

وقتی SearchMethod برابر با ACCOUNT باشد، الزامی است.

orgUnitInfo

object ( OrgUnitInfo )

وقتی SearchMethod برابر با ORG_UNIT باشد، الزامی است.

sharedDriveInfo

object ( SharedDriveInfo )

زمانی که SearchMethod برابر با SHARED_DRIVE باشد، الزامی است.

hangoutsChatInfo

object ( HangoutsChatInfo )

وقتی SearchMethod برابر با ROOM باشد، الزامی است. (فقط خواندنی)

sitesUrlInfo

object ( SitesUrlInfo )

زمانی که SearchMethod برابر با SITES_URL باشد، الزامی است.

driveDocumentInfo

object ( DriveDocumentInfo )

وقتی SearchMethod برابر با DRIVE_DOCUMENT باشد، الزامی است.

فیلد متحد corpus_options_field . گزینه‌های جستجوی اضافی برای سرویس‌های خاص. corpus_options_field فقط می‌تواند یکی از موارد زیر باشد:
mailOptions

object ( MailOptions )

گزینه‌های مخصوص جستجوی جیمیل را تنظیم کنید.

driveOptions

object ( DriveOptions )

گزینه‌های مخصوص جستجوی درایو را تنظیم کنید.

hangoutsChatOptions

object ( HangoutsChatOptions )

گزینه‌های مخصوص جستجوی چت را تنظیم کنید. (فقط خواندنی)

voiceOptions

object ( VoiceOptions )

گزینه‌های مخصوص جستجوی صوتی را تنظیم کنید.

calendarOptions

object ( CalendarOptions )

گزینه‌های جستجوی خاص تقویم را تنظیم کنید.

geminiOptions

object ( GeminiOptions )

گزینه‌های خاص جستجوی Gemini را تنظیم کنید.

محدوده داده

منبع داده‌ها برای جستجو.

انوم‌ها
DATA_SCOPE_UNSPECIFIED منبع داده‌ای مشخص نشده است.
ALL_DATA تمام داده‌های موجود.
HELD_DATA فقط داده‌ها در حالت انتظار هستند.
UNPROCESSED_DATA فقط داده‌هایی که هنوز توسط Vault پردازش نشده‌اند. (فقط Gmail و Groups)

روش جستجو

نوع موجودیت برای جستجو.

انوم‌ها
SEARCH_METHOD_UNSPECIFIED یک روش جستجو باید مشخص شود، در غیر این صورت رد می‌شود.
ACCOUNT داده‌های حساب‌های مشخص‌شده در AccountInfo را جستجو کنید.
ORG_UNIT جستجوی داده‌های تمام حساب‌ها در واحد سازمانی مشخص شده در OrgUnitInfo .
TEAM_DRIVE

داده‌های موجود در Team Drive مشخص شده در teamDriveInfo را جستجو کنید.

ENTIRE_ORG جستجوی داده‌های همه حساب‌های کاربری در سازمان. فقط برای Gmail پشتیبانی می‌شود. در صورت مشخص شدن، نیازی به مشخص کردن AccountInfo یا OrgUnitInfo ندارید.
ROOM جستجوی پیام‌ها در فضاهای چت مشخص‌شده در HangoutsChatInfo .
SITES_URL جستجو برای سایت‌ها بر اساس URL های منتشر شده سایت که در SitesUrlInfo مشخص شده‌اند.
SHARED_DRIVE فایل‌های موجود در درایوهای مشترک مشخص شده در SharedDriveInfo را جستجو کنید.
DRIVE_DOCUMENT اسناد مشخص شده در DriveDocumentInfo را بازیابی کنید.

اطلاعات حساب

حساب‌های کاربری برای جستجو

نمایش JSON 
{
  "emails": [
    string
  ]
}
فیلدها
emails[]

string

مجموعه‌ای از حساب‌ها برای جستجو.

اطلاعات واحد سازمانی

واحد سازمانی مورد جستجو

نمایش JSON 
{
  "orgUnitId": string
}
فیلدها
orgUnitId

string

نام واحد سازمانی مورد جستجو، همانطور که توسط Admin SDK Directory API ارائه شده است.

اطلاعات اشتراک‌گذاری‌شده

درایوهای مشترک برای جستجو

نمایش JSON 
{
  "sharedDriveIds": [
    string
  ]
}
فیلدها
sharedDriveIds[]

string

فهرستی از شناسه‌های درایو اشتراکی، همانطور که توسط Drive API ارائه شده است.

اطلاعات چت هنگ‌اوتس

فضاهای چت برای جستجو

نمایش JSON 
{
  "roomId": [
    string
  ]
}
فیلدها
roomId[]

string

فهرستی از شناسه‌های فضاهای چت، همانطور که توسط API چت ارائه شده است. محدودیت خروجی از ۵۰۰ فضای چت در هر درخواست وجود دارد.

اطلاعات سایت

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

نمایش JSON 
{
  "urls": [
    string
  ]
}
فیلدها
urls[]

string

فهرستی از آدرس‌های اینترنتی منتشر شده سایت.

اطلاعات سند درایو

اسناد Drive برای جستجو.

نمایش JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
فیلدها
identifier فیلد Union. قالب بازیابی اسناد Drive. identifier می‌تواند فقط یکی از موارد زیر باشد:
documentIds

object ( DriveDocumentIds )

اسناد Drive را با شناسه سند مشخص کنید.

شناسه‌های سند درایو

اسناد Drive را با شناسه سند مشخص کنید.

نمایش JSON 
{
  "ids": [
    string
  ]
}
فیلدها
ids[]

string

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

اطلاعات تیم‌درایو

تیم برای جستجو تلاش می‌کند

نمایش JSON 
{
  "teamDriveIds": [
    string
  ]
}
فیلدها
teamDriveIds[]
(deprecated)

string

فهرست شناسه‌های تیم درایو، همانطور که توسط Drive API ارائه شده است.

گزینه‌های ایمیل

گزینه‌های اضافی برای جستجوی جیمیل

نمایش JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
فیلدها
excludeDrafts

boolean

برای حذف پیش‌نویس‌ها، روی true تنظیم کنید.

clientSideEncryptedOption

enum ( ClientSideEncryptedOption )

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

گزینه رمزگذاری شده سمت کلاینت

اگر سازمان شما از رمزگذاری سمت کلاینت Google Workspace استفاده می‌کند، وضعیت رمزگذاری محتوا

انوم‌ها
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED وضعیت رمزگذاری مشخص نشده است. نتایج شامل محتوای رمزگذاری شده و رمزگذاری نشده سمت کلاینت است.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY محتوای رمزگذاری شده و رمزگذاری نشده سمت کلاینت را در نتایج لحاظ کنید.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED فقط محتوای رمزگذاری شده سمت کلاینت را وارد کنید.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED فقط محتوای رمزگذاری نشده را وارد کنید.

گزینه‌های درایو

گزینه‌های اضافی برای جستجوی درایو.

نمایش JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
فیلدها
versionDate

string ( Timestamp format)

نسخه فعلی فایل Drive را جستجو کنید، اما محتویات آخرین نسخه ذخیره شده قبل از ساعت ۱۲:۰۰ بامداد به وقت جهانی در تاریخ مشخص شده را صادر کنید. تاریخ را به واحد UTC وارد کنید.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

includeTeamDrives
(deprecated)

boolean

برای شامل شدن رانندگی تیمی، روی درست تنظیم کنید.

includeSharedDrives
(deprecated)

boolean

برای شامل کردن درایوهای اشتراکی، روی true تنظیم کنید.

clientSideEncryptedOption

enum ( ClientSideEncryptedOption )

تنظیم کنید که آیا نتایج فقط شامل محتوای رمزگذاری شده با محتوای رمزگذاری شده سمت کلاینت Google Workspace ، فقط محتوای رمزگذاری نشده یا هر دو باشد. پیش‌فرض روی هر دو. در حال حاضر برای Drive پشتیبانی می‌شود.

sharedDrivesOption

enum ( SharedDrivesOption )

اختیاری. گزینه‌هایی برای گنجاندن یا حذف اسناد در درایوهای مشترک. توصیه می‌کنیم از این فیلد به جای includeSharedDrives استفاده کنید. این فیلد هنگام تنظیم، includeSharedDrives و includeTeamDrives را لغو می‌کند.

گزینه SharedDrives

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

انوم‌ها
SHARED_DRIVES_OPTION_UNSPECIFIED هیچ گزینه درایو اشتراکی مشخص نشده است.
NOT_INCLUDED اگر منبعی در یک درایو مشترک باشد، در جستجو لحاظ نمی‌شود.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER منابع درایو اشتراکی فقط در مواردی لحاظ می‌شوند که حساب کاربری در یک منبع مشارکت داشته باشد اما عضو درایو اشتراکی نباشد. این موضوع به گزینه «فقط در صورتی لحاظ می‌شود که اسناد مستقیماً به اشتراک گذاشته شوند (نه به دلیل عضویت در درایو اشتراکی)» در رابط کاربری Vault مربوط می‌شود. (قبلاً «includeSharedDrives» غیرفعال بود)
INCLUDED منابع موجود در درایوهای مشترک در جستجو لحاظ می‌شوند. (قبلاً "includeSharedDrives" فعال بود)

گزینه‌های HangoutsChat

گزینه‌های اضافی برای جستجوی گوگل چت

نمایش JSON 
{
  "includeRooms": boolean
}
فیلدها
includeRooms

boolean

برای جستجو بر اساس حساب یا واحد سازمانی، برای شامل شدن اتاق‌ها، روی درست تنظیم کنید.

گزینه‌های صوتی

گزینه‌های اضافی برای جستجوی صوتی

نمایش JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
فیلدها
coveredData[]

enum ( VoiceCoveredData )

انواع داده برای جستجو

گزینه‌های تقویم

گزینه‌های اضافی برای جستجوی تقویم

نمایش JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
فیلدها
locationQuery[]

string

فقط با رویدادهایی مطابقت دارد که مکان آنها شامل تمام کلمات موجود در مجموعه داده شده باشد. اگر رشته حاوی عبارات نقل قول شده باشد، این روش فقط با رویدادهایی مطابقت دارد که مکان آنها شامل عبارت دقیق است. ورودی‌های موجود در مجموعه در "و" در نظر گرفته می‌شوند.

مثال تقسیم کلمه: ["نیوزیلند"] در مقابل ["جدید"،"زیلند"] "نیوزیلند": با هر دو مورد مطابقت دارد. "نیوزیلند جدید و بهتر": فقط با مورد بعدی مطابقت دارد.

peopleQuery[]

string

فقط با رویدادهایی مطابقت دارد که شرکت‌کنندگان آنها شامل تمام کلمات موجود در مجموعه داده شده باشند. ورودی‌های موجود در مجموعه با "و" در نظر گرفته می‌شوند.

minusWords[]

string

فقط با رویدادهایی مطابقت دارد که هیچ یک از کلمات موجود در مجموعه داده شده در عنوان، توضیحات، مکان یا شرکت‌کنندگان را نداشته باشند. ورودی‌های موجود در مجموعه در "یا" در نظر گرفته می‌شوند.

responseStatuses[]

enum ( AttendeeResponse )

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

versionDate

string ( Timestamp format)

نسخه فعلی رویداد تقویم را جستجو کنید، اما محتویات آخرین نسخه ذخیره شده قبل از ساعت ۱۲:۰۰ بامداد به وقت جهانی در تاریخ مشخص شده را صادر کنید. تاریخ را به واحد UTC وارد کنید.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

پاسخ شرکت‌کننده

پاسخ کاربر به یک دعوتنامه.

انوم‌ها
ATTENDEE_RESPONSE_UNSPECIFIED پاسخ شرکت‌کننده نامشخص است. اگر این تنظیم شود، هیچ فیلتری روی پاسخ‌ها انجام نخواهد شد و سایر پاسخ‌های شرکت‌کننده که بخشی از گزینه‌های پرس‌وجو هستند، نادیده گرفته می‌شوند.
ATTENDEE_RESPONSE_NEEDS_ACTION از شرکت‌کننده دعوت شده اما هنوز پاسخی نداده است.
ATTENDEE_RESPONSE_ACCEPTED شرکت کننده قصد شرکت دارد.
ATTENDEE_RESPONSE_DECLINED شرکت کننده قصد شرکت ندارد.
ATTENDEE_RESPONSE_TENTATIVE شرکت‌کننده انتظار دارد که احتمالاً در جلسه شرکت کند.

GeminiOptions

این نوع هیچ فیلدی ندارد.

گزینه‌های اضافی برای جستجوی Gemini