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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

חותמת זמן ב-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 הוא חשבון.
orgUnitInfo

object (OrgUnitInfo)

חובה כאשר SearchMethod הוא ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

חובה אם הערך של SearchMethod הוא SHARED_drive.
hangoutsChatInfo

object (HangoutsChatInfo)

חובה כאשר SearchMethod הוא חדר. (לקריאה בלבד)
sitesUrlInfo

object (SitesUrlInfo)

חובה אם הערך של SearchMethod הוא sites_URL.
שדה איחוד corpus_options_field. אפשרויות חיפוש נוספות לשירותים ספציפיים. corpus_options_field יכול להיות רק אחת מהאפשרויות הבאות:
mailOptions

object (MailOptions)

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

object (DriveOptions)

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

object (HangoutsChatOptions)

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

object (VoiceOptions)

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

object (CalendarOptions)

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

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.

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 של אתרים שפורסמו.

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)
}
שדות
versionDate

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
includeTeamDrives
(deprecated)

boolean

יש להגדיר את הערך כ-True כדי לכלול את האחסון השיתופי.
includeSharedDrives

boolean

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

enum (ClientSideEncryptedOption)

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

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

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

דוגמה לפיצול מילים: ["ניו זילנד"] לעומת ["חדש","זילנד"] "ניו זילנד": נמצאה התאמה גם ל'ניו זילנד' וגם ל'זילנד טובה יותר': נמצאה התאמה רק לפי המאוחר יותר
peopleQuery[]

string

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

string

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

enum (AttendeeResponse)

מתאים רק לאירועים שעליהם האפוטרופוס נתן את אחת מהתגובות האלה. אם הקבוצה ריקה או מכילה ATTENDEE_Response_UNSPECIFIED לא יהיה סינון לפי התגובות.
versionDate

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

AttendeeResponse

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

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