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)

تمثّل هذه السمة وقت بدء طلب البحث. التحديد بتوقيت غرينيتش. ويتم تقريب القيمة إلى 12 صباحًا في التاريخ المحدّد.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

endTime

string (Timestamp format)

وقت انتهاء طلب البحث. التحديد بتوقيت غرينيتش. ويتم تقريب القيمة إلى 12 صباحًا في التاريخ المحدّد.

طابع زمني بتنسيق 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 هي ACCOUNT.

orgUnitInfo

object (OrgUnitInfo)

تكون هذه السمة مطلوبة عندما تكون قيمة SearchMethod هي ORG_UNIT.

sharedDriveInfo

object (SharedDriveInfo)

تكون هذه السمة مطلوبة عندما تكون قيمة SearchMethod هي SHARED_DRIVE.

hangoutsChatInfo

object (HangoutsChatInfo)

تكون هذه السمة مطلوبة عندما تكون قيمة SearchMethod هي ROOM. (قراءة فقط)

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)

ضبط الخيارات الخاصة بالبحث في "تقويم Google"

DataScope

مصدر البيانات للبحث.

عمليات التعداد
DATA_SCOPE_UNSPECIFIED لم يتم تحديد مصدر بيانات.
ALL_DATA جميع البيانات المتاحة.
HELD_DATA البيانات فقط قيد تجميد البيانات.
UNPROCESSED_DATA فقط البيانات التي لم تعالجها Vault حتى الآن. (Gmail و"مجموعات Google" فقط)

SearchMethod

نوع الكيان للبحث.

عمليات التعداد
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" والتي سيتم البحث فيها

تمثيل JSON
{
  "urls": [
    string
  ]
}
الحقول
urls[]

string

قائمة بعناوين URL المنشورة للمواقع الإلكترونية

TeamDriveInfo

مساحات Drive المشتركة للبحث

تمثيل JSON
{
  "teamDriveIds": [
    string
  ]
}
الحقول
teamDriveIds[]
(deprecated)

string

قائمة بأرقام تعريف مساحات Drive المشتركة، على النحو المنصوص عليه في Drive API.

MailOptions

خيارات إضافية لبحث Gmail

تمثيل JSON
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
الحقول
excludeDrafts

boolean

اضبط القيمة على true لاستبعاد المسودات.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

لتحديد ما إذا كان يجب أن تتضمن النتائج محتوى مشفَّرًا أو محتوى غير مشفّر أو كليهما. إعداد تلقائي على تضمين كليهما.

ClientSideEncryptedOption

إذا كانت مؤسستك تستخدم ميزة التشفير من جهة العميل في Google Workspace، ستظهر حالة تشفير المحتوى.

عمليات التعداد
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، مع تصدير محتوى آخر نسخة تم حفظها قبل الساعة 12:00 صباحًا بالتوقيت العالمي المنسق (UTC) في التاريخ المحدد. أدخِل التاريخ بالتوقيت العالمي المنسّق (UTC).

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

includeTeamDrives
(deprecated)

boolean

تم الضبط على "صحيح" لتضمين "مساحة Drive المشتركة".

includeSharedDrives

boolean

اضبط القيمة على true لتضمين مساحات التخزين السحابي المشتركة.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

يمكنك تحديد ما إذا كانت النتائج تتضمن فقط المحتوى المشفَّر باستخدام ميزة التشفير من جهة العميل في Google Workspace أو المحتوى غير المشفَّر فقط أو كليهما. الإعداد التلقائي لكليهما. غير متاح حاليًا في Drive.

HangoutsChatOptions

خيارات إضافية للبحث في Google Chat

تمثيل JSON
{
  "includeRooms": boolean
}
الحقول
includeRooms

boolean

بالنسبة إلى عمليات البحث حسب الحساب أو الوحدة التنظيمية، يمكنك ضبط القيمة على صحيح لتضمين الغرف.

VoiceOptions

خيارات إضافية للبحث الصوتي

تمثيل JSON
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
الحقول
coveredData[]

enum (VoiceCoveredData)

أنواع البيانات للبحث

CalendarOptions

خيارات إضافية للبحث في "تقويم Google"

تمثيل JSON
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
الحقول
locationQuery[]

string

يطابق فقط الأحداث التي يشتمل موقعها الجغرافي على جميع الكلمات في المجموعة المحدّدة. وإذا كانت السلسلة تحتوي على عبارات مُقتبَسة، لن تتطابق هذه الطريقة إلا مع الأحداث التي يحتوي موقعها الجغرافي على العبارة نفسها. يتم اعتبار الإدخالات في المجموعة في "and".

مثال على تقسيم الكلمات: ["New Zealand"] مقابل ["New","Zealand"] "نيوزيلندا": تمت مطابقتها بكل من "نيوزيلندا وأفضل": لا تتم المطابقة إلا مع اللاحقة

peopleQuery[]

string

يطابق فقط تلك الأحداث التي يحتوي ضيوفها على جميع الكلمات في المجموعة المحددة. يتم اعتبار الإدخالات في المجموعة في "and".

minusWords[]

string

يطابق فقط الأحداث التي لا تحتوي على أي من الكلمات في المجموعة المحددة في العنوان أو الوصف أو الموقع أو الحضور. يتم النظر في الإدخالات في المجموعة في "or".

responseStatuses[]

enum (AttendeeResponse)

لا تتم مطابقة سوى الأحداث التي قدّم المالك أحد هذه الردود لها. إذا كانت المجموعة فارغة أو تحتوي على ATTENDEE_RESPONSE_UNSPECIFIED، لن تحتاج إلى فلترة الردود.

versionDate

string (Timestamp format)

يمكنك البحث في النسخة الحالية من حدث "تقويم Google"، مع تصدير محتوى آخر نسخة تم حفظها قبل الساعة 12:00 صباحًا بالتوقيت العالمي المنسق (UTC) في التاريخ المحدد. أدخِل التاريخ بالتوقيت العالمي المنسّق (UTC).

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

AttendeeResponse

ردّ المستخدم على دعوة.

عمليات التعداد
ATTENDEE_RESPONSE_UNSPECIFIED لم يتم تحديد رد الضيف. إذا تم ضبط هذا الإعداد، لن يتم إجراء فلترة للردود، وسيتم تجاهل جميع ردود الضيوف الأخرى التي تشكّل جزءًا من خيارات طلب البحث.
ATTENDEE_RESPONSE_NEEDS_ACTION تمت دعوة المشارك لكنه لم يرد بعد.
ATTENDEE_RESPONSE_ACCEPTED يخطط المشارك للحضور.
ATTENDEE_RESPONSE_DECLINED لا يخطط المشارك للحضور.
ATTENDEE_RESPONSE_TENTATIVE يتوقع المشارك أن يحضر.