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 עם 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). הערך מעוגל לחצות הלילה בתאריך שצוין.

הפונקציה משתמשת ב-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.
שדה איחוד 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

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

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

string

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

DriveDocumentInfo

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

ייצוג ב-JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
שדות
שדה איחוד 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 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-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' on)

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