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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceOptions)
  }
}
فیلدها
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)

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

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

string (Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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 مراجعه کنید.
جزئیات نهادهای موردنظر برای جستجو را درصورت نیاز مشخص می‌کند. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
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 باشد، الزامی است.
پایان فیلدهای متقابلاً انحصاری.
گزینه‌های جستجوی بیشتر برای سرویس‌های خاص. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
mailOptions

object (MailOptions)

تنظیم گزینه‌های خاص جستجوی Gmail.
driveOptions

object (DriveOptions)

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

object (HangoutsChatOptions)

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

object (VoiceOptions)

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

object (CalendarOptions)

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

object (GeminiOptions)

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

object (GeminiInWorkspaceOptions)

گزینه‌های خاص جستجوی «Gemini در Workspace» را تنظیم کنید.
پایان فیلدهای متقابلاً انحصاری.

DataScope

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

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

SearchMethod

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

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

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

AccountInfo

حساب‌های مورد جستجو

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

string

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

OrgUnitInfo

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

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

string

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

SharedDriveInfo

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

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

string

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

HangoutsChatInfo

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

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

string

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

SitesUrlInfo

نشانی‌های وب سایت منتشرشده از «نسخه جدید Google Sites» برای جستجو

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

string

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

DriveDocumentInfo

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

نمایش JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
فیلدها
قالب بازیابی اسناد Drive. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
documentIds

object (DriveDocumentIds)

اسناد Drive را با شناسه سند مشخص کنید.
پایان فیلدهای متقابلاً انحصاری.

DriveDocumentIds

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

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

string

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

TeamDriveInfo

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

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

string

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

MailOptions

گزینه‌های بیشتر برای جستجوی Gmail

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

boolean

برای مستثنی کردن پیش‌نویس‌ها، روی true تنظیم کنید.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

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

ClientSideEncryptedOption

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

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

DriveOptions

گزینه‌های بیشتر برای جستجوی Drive.

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

string (Timestamp format)

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

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

boolean

برای گنجاندن Team Drive، روی true تنظیم کنید.
includeSharedDrives
(deprecated)

boolean

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

enum (ClientSideEncryptedOption)

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

enum (SharedDrivesOption)

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

SharedDrivesOption

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

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

HangoutsChatOptions

گزینه‌های بیشتر برای جستجوی Google Chat

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

boolean

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

VoiceOptions

گزینه‌های بیشتر برای «جستجوی گفتاری»

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

enum (VoiceCoveredData)

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

CalendarOptions

گزینه‌های بیشتر برای جستجوی «تقویم»

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

string

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

نمونه تقسیم کلمه: [«نیوزیلند»] درمقابل [«نیو»، «زیلند»] «نیوزیلند»: با هر دو مطابقت دارد «نیو و زیلند بهتر»: فقط با دومی مطابقت دارد
peopleQuery[]

string

فقط با رویدادهایی مطابقت دارد که شرکت‌کنندگان آن‌ها حاوی همه کلمات در مجموعه ارائه‌شده باشند. ورودی‌های مجموعه در «و» درنظر گرفته می‌شوند.
minusWords[]

string

فقط با رویدادهایی مطابقت دارد که هیچ‌کدام از کلمات مجموعه ارائه‌شده را در عنوان، شرح، مکان، یا شرکت‌کنندگان نداشته باشند. ورودی‌های مجموعه در «یا» درنظر گرفته می‌شوند.
responseStatuses[]

enum (AttendeeResponse)

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

string (Timestamp format)

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

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

AttendeeResponse

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

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

GeminiOptions

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

گزینه‌های بیشتر برای جستجوی برنامه Gemini

GeminiInWorkspaceOptions

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

گزینه‌های بیشتر برای جستجوی «Gemini در Workspace»