- ייצוג JSON
- DataScope
- SearchMethod
- AccountInfo
- OrgUnitInfo
- SharedDriveInfo
- HangoutsChatInfo
- SitesUrlInfo
- TeamDriveInfo
- MailOptions
- ClientSideEncryptedOption
- DriveOptions
- HangoutsChatOptions
- VoiceOptions
- CalendarOptions
- AttendeeResponse
הגדרת השאילתה המשמשת לחיפוש ולייצוא.
ייצוג JSON |
---|
{ "corpus": enum ( |
שדות | |
---|---|
corpus |
שירות Google Workspace שיש לחפש. |
dataScope |
מקור הנתונים לחיפוש. |
searchMethod |
שיטת החיפוש שבה כדאי להשתמש. |
method |
הישות שיש לחפש. השדה הזה מחליף את searchMethod כדי לתמוך בתיקיות אחסון שיתופי. כשהערך של searchMethod הוא TEAM_drive, התשובה בשדה הזה היא SHARED_drive. |
terms |
אופרטורים של חיפוש שספציפיים לשירות, לצורך סינון תוצאות חיפוש. |
startTime |
שעת ההתחלה של שאילתת החיפוש. יש לציין לפי שעון גריניץ' (GMT). הערך מעוגל ל-00:00 בתאריך שצוין. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
endTime |
שעת הסיום של שאילתת החיפוש. יש לציין לפי שעון גריניץ' (GMT). הערך מעוגל ל-00:00 בתאריך שצוין. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
teamDriveInfo |
שדה חובה כשהערך של SearchMethod הוא TEAM_drive. |
timeZone |
שם אזור הזמן. הוא צריך להיות שם IANA TZ, כמו "America/Los_Angeles". ניתן לראות רשימה של שמות של אזורי זמן בקטע אזורי זמן. למידע נוסף על האופן שבו Vault משתמש באזורי זמן, ניתן להיכנס למרכז העזרה של Vault. |
שדה איחוד search_method_field . כשנדרש, פרטי הישויות לחיפוש ב-search_method_field יכולים להיות רק אחת מהאפשרויות הבאות: |
|
accountInfo |
חובה כאשר SearchMethod הוא ACCOUNT. |
orgUnitInfo |
חובה כאשר SearchMethod הוא ORG_UNIT. |
sharedDriveInfo |
נדרש כאשר SearchMethod הוא SHARED_drive. |
hangoutsChatInfo |
חובה כאשר SearchMethod הוא ROOM. (לקריאה בלבד) |
sitesUrlInfo |
חובה כאשר SearchMethod הוא Website_URL. |
שדה איחוד corpus_options_field . אפשרויות חיפוש נוספות לשירותים ספציפיים. הערך של corpus_options_field יכול להיות רק אחת מהאפשרויות הבאות: |
|
mailOptions |
הגדרת אפשרויות ספציפיות לחיפוש ב-Gmail. |
driveOptions |
הגדרת אפשרויות ספציפיות לחיפוש ב-Drive. |
hangoutsChatOptions |
הגדרת אפשרויות ספציפיות לחיפוש ב-Chat. (לקריאה בלבד) |
voiceOptions |
הגדרת אפשרויות ספציפיות לחיפוש קולי. |
calendarOptions |
הגדרת אפשרויות ספציפיות לחיפוש ביומן Google. |
DataScope
מקור הנתונים לחיפוש.
טיפוסים בני מנייה (enums) | |
---|---|
DATA_SCOPE_UNSPECIFIED |
לא צוין מקור נתונים. |
ALL_DATA |
כל הנתונים הזמינים. |
HELD_DATA |
רק הנתונים בהחזקה. |
UNPROCESSED_DATA |
רק נתונים שלא עובדו עדיין ב-Vault. (Gmail וקבוצות Google בלבד) |
SearchMethod
סוג הישות עבור החיפוש.
טיפוסים בני מנייה (enums) | |
---|---|
SEARCH_METHOD_UNSPECIFIED |
יש לציין שיטת חיפוש, אחרת היא תידחה. |
ACCOUNT |
מחפשים את הנתונים של החשבונות שצוינו ב-AccountInfo. |
ORG_UNIT |
חיפוש בנתונים של כל החשבונות ביחידה הארגונית שצוינה ב-OrgUnitInfo. |
TEAM_DRIVE |
מחפשים את הנתונים באחסון השיתופי שצוינו ב-teamDriveInfo. |
ENTIRE_ORG |
חיפוש בנתונים של כל החשבונות בארגון. התכונה נתמכת רק ב-Gmail. כשהיא מוגדרת, אין צורך לציין AccountInfo או OrgUnitInfo. |
ROOM |
חיפוש הודעות במרחבי Chat משותפים שצוינו ב-HangoutsChatInfo. |
SITES_URL |
מחפשים אתרים לפי כתובות האתרים שפורסמו שצוינו ב-SitesUrlInfo. |
SHARED_DRIVE |
חיפוש בקבצים בתיקיות האחסון השיתופי שצוינו ב-SharedDriveInfo. |
AccountInfo
החשבונות שיש לחפש
ייצוג JSON |
---|
{ "emails": [ string ] } |
שדות | |
---|---|
emails[] |
קבוצת חשבונות לחיפוש. |
OrgUnitInfo
היחידה הארגונית שבה יש לחפש
ייצוג JSON |
---|
{ "orgUnitId": string } |
שדות | |
---|---|
orgUnitId |
שם היחידה הארגונית לחיפוש, כפי שסופק על ידי Admin SDK Directory API |
HangoutsChatInfo
המרחבים המשותפים ב-Chat שבהם רוצים לחפש
ייצוג JSON |
---|
{ "roomId": [ string ] } |
שדות | |
---|---|
roomId[] |
רשימת המזהים של המרחבים המשותפים ב-Chat, כפי שהם סופקו על ידי Chat API. אפשר לייצא מ-500 מרחבים משותפים ב-Chat לכל בקשה. |
SitesUrlInfo
כתובות האתרים שפורסמו בגרסה החדשה של Google Sites לחיפוש
ייצוג JSON |
---|
{ "urls": [ string ] } |
שדות | |
---|---|
urls[] |
רשימה של כתובות אתרים שפורסמו. |
TeamDriveInfo
תיקיות אחסון שיתופי לחיפוש
ייצוג JSON |
---|
{ "teamDriveIds": [ string ] } |
שדות | |
---|---|
teamDriveIds[] |
רשימת המזהים של אחסון שיתופי, כפי שסופקו על ידי Drive API. |
MailOptions
אפשרויות נוספות לחיפוש ב-Gmail
ייצוג JSON |
---|
{
"excludeDrafts": boolean,
"clientSideEncryptedOption": enum ( |
שדות | |
---|---|
excludeDrafts |
כדי להחריג טיוטות, צריך להגדיר את הערך כ-true. |
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 ( |
שדות | |
---|---|
versionDate |
חיפוש בגרסה הנוכחית של הקובץ ב-Drive, וייצוא התוכן של הגרסה האחרונה שנשמרה לפני השעה 12:00 (שעון UTC) בתאריך שצוין. מזינים את התאריך לפי שעון UTC. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
includeTeamDrives |
יש להגדיר את הערך True כדי לכלול אחסון שיתופי. |
includeSharedDrives |
צריך להגדיר את הערך true כדי לכלול תיקיות אחסון שיתופי. |
clientSideEncryptedOption |
אפשר להגדיר אם התוצאות יכללו רק תוכן שהוצפן באמצעות תוכן ההצפנה מצד הלקוח ב-Google Workspace, רק תוכן לא מוצפן או גם וגם. ברירת המחדל היא שתיהן. כרגע נתמך ב-Drive. |
HangoutsChatOptions
אפשרויות נוספות לחיפוש ב-Google Chat
ייצוג JSON |
---|
{ "includeRooms": boolean } |
שדות | |
---|---|
includeRooms |
לחיפושים לפי חשבון או יחידה ארגונית, צריך להגדיר את הערך true כדי לכלול חדרים. |
VoiceOptions
אפשרויות נוספות לחיפוש קולי
ייצוג JSON |
---|
{
"coveredData": [
enum ( |
שדות | |
---|---|
coveredData[] |
סוגי נתונים לחיפוש |
CalendarOptions
אפשרויות נוספות לחיפוש ביומן Google
ייצוג JSON |
---|
{
"locationQuery": [
string
],
"peopleQuery": [
string
],
"minusWords": [
string
],
"responseStatuses": [
enum ( |
שדות | |
---|---|
locationQuery[] |
התאמה רק לאירועים שהמיקום שלהם מכיל את כל המילים בקבוצה הנתונה. אם המחרוזת מכילה ביטויים מצוטטים, השיטה הזו תתאים רק לאירועים שהמיקום שלהם מכיל את הביטוי המדויק. הערכים בקבוצה נחשבים לתווים מסוג 'ו-'. דוגמה לפיצול מילים: ["ניו זילנד"] לעומת ["ניו זילנד","זילנד"] "ניו זילנד": התאמה לשני "ניו זילנד וטוב יותר": התאמה רק למועד מאוחר יותר |
peopleQuery[] |
תואם רק לאירועים שהמשתתפים בהם מכילים את כל המילים שבקבוצה הנתונה. הערכים בקבוצה נחשבים לתווים מסוג 'ו-'. |
minusWords[] |
התאמה רק לאירועים שלא מכילים אף אחת מהמילים שבקבוצה הנתונה בשם, בתיאור, במיקום או במשתתפים. הערכים בקבוצה נחשבים כ "או". |
responseStatuses[] |
תואם רק לאירועים שעבורם האפוטרופוס נתן אחת מהתשובות האלו. אם הקבוצה ריקה או מכילה ATTENDEE_SCREEN_UNSPECIFIED, לא יתבצע סינון של התשובות. |
versionDate |
חיפוש בגרסה הנוכחית של האירוע ביומן, וייצוא התוכן של הגרסה האחרונה שנשמרה לפני השעה 12:00 (שעון UTC) בתאריך שצוין. מזינים את התאריך לפי שעון UTC. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
AttendeeResponse
תגובת המשתמש להזמנה.
טיפוסים בני מנייה (enums) | |
---|---|
ATTENDEE_RESPONSE_UNSPECIFIED |
לא צוינה תגובה של המשתתף. אם המדיניות הזו מוגדרת לא מתבצע סינון של תשובות, המערכת תתעלם מכל שאר התשובות של המשתתפים שהן חלק מאפשרויות השאילתה. |
ATTENDEE_RESPONSE_NEEDS_ACTION |
המשתתף הוזמן אך עדיין לא הגיב. |
ATTENDEE_RESPONSE_ACCEPTED |
המשתתף/ת מתכנן/ת להשתתף. |
ATTENDEE_RESPONSE_DECLINED |
המשתתף/ת לא מתכנן/ת להשתתף. |
ATTENDEE_RESPONSE_TENTATIVE |
המשתתף/ת מצפה להשתתף. |