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,

  // Union field search_method_field can be only one of the following:
  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  }
  // End of list of possible types for union field search_method_field.

  // Union field corpus_options_field can be only one of the following:
  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
فیلدها
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 مشخص کنید. مقدار در تاریخ مشخص شده به 12 صبح گرد می شود.

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

endTime

string ( Timestamp format)

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

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

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 باشد، الزامی است.

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

object ( MailOptions )

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

driveOptions

object ( DriveOptions )

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

hangoutsChatOptions

object ( HangoutsChatOptions )

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

voiceOptions

object ( VoiceOptions )

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

calendarOptions

object ( CalendarOptions )

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

DataScope

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

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

روش جستجو

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

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

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

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

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

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

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

string

فهرستی از شناسه‌های فضاهای گپ، که توسط Chat API ارائه شده است. محدودیتی برای صادرات از 500 فضای چت در هر درخواست وجود دارد.

SitesUrlInfo

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

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

string

لیستی از URLهای سایت منتشر شده

TeamDriveInfo

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

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

string

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

MailOptions

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

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

boolean

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

clientSideEncryptedOption

enum ( ClientSideEncryptedOption )

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

ClientSideEncryptedOption

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

Enums
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)
}
فیلدها
versionDate

string ( Timestamp format)

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

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

includeTeamDrives
(deprecated)

boolean

روی true تنظیم کنید تا Team Drive را نیز در بر گیرد.

includeSharedDrives

boolean

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

clientSideEncryptedOption

enum ( ClientSideEncryptedOption )

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

HangoutsChatOptions

گزینه های اضافی برای جستجوی Google Chat

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

boolean

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

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

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

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

enum ( VoiceCoveredData )

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

CalendarOptions

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

نمایندگی 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)

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

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

پاسخگوی حاضرین

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

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