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)

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

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

string (Timestamp format)

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

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

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

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

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

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 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 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-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)

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

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

GeminiInWorkspaceOptions

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

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