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)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }
  // 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)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // 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). הערך יעוגל לשעה 00:00 בתאריך שצוין.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

שעת הסיום של שאילתה החיפוש. מציינים את השעה לפי שעון גריניץ' (GMT). הערך יעוגל לשעה 00:00 בתאריך שצוין.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

שם אזור הזמן. השם צריך להיות שם TZ של IANA, כמו '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)

מגדירים אפשרויות ספציפיות לחיפוש ב-Gmail.
driveOptions

object (DriveOptions)

להגדיר אפשרויות ספציפיות לחיפוש ב-Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

להגדיר אפשרויות ספציפיות לחיפוש ב-Chat. (לקריאה בלבד)
voiceOptions

object (VoiceOptions)

להגדיר אפשרויות ספציפיות לחיפוש קולי.
calendarOptions

object (CalendarOptions)

להגדיר אפשרויות ספציפיות לחיפוש ביומן.
geminiOptions

object (GeminiOptions)

להגדיר אפשרויות ספציפיות לחיפוש ב-Gemini.

DataScope

מקור הנתונים לחיפוש.

טיפוסים בני מנייה (enum)
DATA_SCOPE_UNSPECIFIED לא צוין מקור נתונים.
ALL_DATA כל הנתונים הזמינים.
HELD_DATA רק נתונים בהשהיה.
UNPROCESSED_DATA רק נתונים שעדיין לא עברו עיבוד על ידי Vault. (ב-Gmail ובקבוצות Google בלבד)

SearchMethod

סוג הישות לחיפוש.

טיפוסים בני מנייה (enum)
SEARCH_METHOD_UNSPECIFIED חובה לציין שיטת חיפוש, אחרת הבקשה תידחה.
ACCOUNT חיפוש בנתונים של החשבונות שצוינו ב-AccountInfo.
ORG_UNIT חיפוש הנתונים של כל החשבונות ביחידה הארגונית שצוינה ב-OrgUnitInfo.
TEAM_DRIVE

מחפשים את הנתונים באחסון השיתופי שצוין ב-teamDriveInfo.
ENTIRE_ORG לחפש את הנתונים של כל החשבונות בארגון. התכונה נתמכת רק ב-Gmail. אם מציינים את השדה הזה, אין צורך לציין את השדות AccountInfo או OrgUnitInfo.
ROOM חיפוש הודעות במרחבים המשותפים ב-Chat שצוינו ב-HangoutsChatInfo.
SITES_URL חיפוש אתרים לפי כתובות ה-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. בכל בקשה אפשר לייצא מ-500 מרחבים משותפים ב-Chat.

SitesUrlInfo

כתובות ה-URL שפורסמו של אתרים חדשים ב-Google Sites לחיפוש

ייצוג ב-JSON 
{
  "urls": [
    string
  ]
}
שדות
urls[]

string

רשימה של כתובות אתרים שפורסמו.

DriveDocumentInfo

המסמכים ב-Drive שרוצים לחפש בהם.

ייצוג ב-JSON 
{

  // Union field identifier can be only one of the following:
  "documentIds": {
    object (DriveDocumentIds)
  }
  // End of list of possible types for union field identifier.
}
שדות
שדה האיחוד identifier. הפורמט לאחזור המסמכים מ-Drive. הערך של identifier יכול להיות רק אחת מהאפשרויות הבאות:
documentIds

object (DriveDocumentIds)

לציין מסמכים ב-Drive לפי מזהה המסמך.

DriveDocumentIds

לציין מסמכים ב-Drive לפי מזהה המסמך.

ייצוג ב-JSON 
{
  "ids": [
    string
  ]
}
שדות
ids[]

string

חובה. רשימה של מזהי מסמכים ב-Drive.

TeamDriveInfo

תיקיות האחסון השיתופי שבהן רוצים לחפש

ייצוג ב-JSON 
{
  "teamDriveIds": [
    string
  ]
}
שדות
teamDriveIds[]
(deprecated)

string

רשימה של מזהי תיקיות אחסון שיתופי, כפי שסופקו על ידי Drive API.

MailOptions

אפשרויות נוספות לחיפוש ב-Gmail

ייצוג ב-JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
שדות
excludeDrafts

boolean

מגדירים את הערך כ-true כדי לא לכלול טיוטות.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

מציין אם התוצאות צריכות לכלול תוכן מוצפן, תוכן לא מוצפן או את שניהם. כברירת מחדל, המערכת כוללת את שניהם.

ClientSideEncryptedOption

אם הארגון שלכם משתמש בהצפנה מצד הלקוח ב-Google Workspace, סטטוס ההצפנה של התוכן

טיפוסים בני מנייה (enum)
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, אבל תוכן הגרסה האחרונה שנשמרה לפני השעה 12:00 (שעון UTC) בתאריך שצוין ייובא. מזינים את התאריך לפי שעון UTC.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

מגדירים את הערך כ-true כדי לכלול את האחסון השיתופי.
includeSharedDrives
(deprecated)

boolean

מגדירים את הערך true כדי לכלול תיקיות אחסון שיתופי.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

מגדירים אם התוצאות יכללו רק תוכן מוצפן באמצעות הצפנה מצד הלקוח ב-Google Workspace, רק תוכן לא מוצפן או את שניהם. ברירת המחדל היא 'שניהם'. נכון לעכשיו, התכונה נתמכת ב-Drive.
sharedDrivesOption

enum (SharedDrivesOption)

אופציונלי. אפשרויות להכללה או להחרגה של מסמכים בתיקיות אחסון שיתופי. מומלץ להשתמש בשדה הזה במקום ב-includeSharedDrives. השדה הזה מבטל את ההגדרות של includeSharedDrives ו-includeTeamDrives כשמגדירים אותו.

SharedDrivesOption

אפשרות לבחירת סוג המסמכים מהאחסון השיתופי שרוצים לכלול.

טיפוסים בני מנייה (enum)
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

התאמה רק לאירועים שהמיקום שלהם מכיל את כל המילים בקבוצה הנתונה. אם המחרוזת מכילה ביטויים במירכאות, השיטה הזו תתאים רק לאירועים שהמיקום שלהם מכיל את הביטוי המדויק. הרשומות בקבוצה נלקחות בחשבון בתנאי 'וגם'.

דוגמה לפיצול מילים: ["New Zealand"] לעומת ["New","Zealand"] "New Zealand": מתאים לשתי המחרוזות "New and better Zealand": מתאים רק למחרוזת השנייה
peopleQuery[]

string

תהיה התאמה רק לאירועים שהמשתתפים שלהם מכילים את כל המילים בקבוצה הנתונה. הרשומות בקבוצה נלקחות בחשבון בתנאי 'וגם'.
minusWords[]

string

התאמה רק לאירועים שלא מכילים אף אחת מהמילים בקבוצה הנתונה בכותרת, בתיאור, במיקום או ברשימת המשתתפים. הרשומות בקבוצה נחשבות כ'או'.
responseStatuses[]

enum (AttendeeResponse)

תואם רק לאירועים שהאחראי הגיש עליהם אחת מהתשובות האלה. אם הקבוצה ריקה או מכילה את הערך ATTENDEE_RESPONSE_UNSPECIFIED, לא יתבצע סינון של התשובות.
versionDate

string (Timestamp format)

Vault מחפש את הגרסה הנוכחית של האירוע ביומן, אבל התוכן שיוצאו הוא של הגרסה האחרונה שנשמרה לפני השעה 12:00 (שעון UTC) בתאריך שצוין. מזינים את התאריך לפי שעון UTC.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

AttendeeResponse

התגובה של המשתמש להזמנה.

טיפוסים בני מנייה (enum)
ATTENDEE_RESPONSE_UNSPECIFIED לא צוינה תשובת המשתתף. אם ההגדרה הזו מוגדרת, לא יתבצע סינון של התשובות. כל התשובות האחרות של המשתתפים שנכללות באפשרויות השאילתה יימחקו.
ATTENDEE_RESPONSE_NEEDS_ACTION המשתתף או המשתתפת הוזמנו, אבל עדיין לא הגיבו.
ATTENDEE_RESPONSE_ACCEPTED המשתתף מתכוון להשתתף.
ATTENDEE_RESPONSE_DECLINED המשתתף לא מתכוון להשתתף.
ATTENDEE_RESPONSE_TENTATIVE המשתתף צפוי להשתתף.

GeminiOptions

אין שדות לסוג הזה.

אפשרויות נוספות לחיפוש ב-Gemini