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)

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

يستخدم المعيار 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)

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

يستخدم المعيار 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)

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

object (GeminiOptions)

ضبط الخيارات الخاصة بالبحث في تطبيق Gemini
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

ضبط الخيارات الخاصة بالبحث في "Gemini في Workspace"
نهاية الحقول التي يستبعد كلّ منها الآخر

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
DRIVE_DOCUMENT استرداد المستندات المحدّدة في DriveDocumentInfo

AccountInfo

الحسابات المطلوب البحث فيها

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

string

مجموعة من الحسابات المطلوب البحث فيها

OrgUnitInfo

الوحدة التنظيمية المطلوب البحث فيها

تمثيل JSON 
{
  "orgUnitId": string
}
الحقول
orgUnitId

string

اسم الوحدة التنظيمية المطلوب البحث عنها، كما هو موضّح في واجهة برمجة تطبيقات الدليل في مدير SDK.

SharedDriveInfo

مساحات التخزين السحابي المشتركة المطلوب البحث فيها

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

string

قائمة بأرقام تعريف مساحات التخزين السحابي المشتركة، كما توفّرها Drive API

HangoutsChatInfo

مساحات Chat المطلوب البحث فيها

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

string

قائمة بأرقام تعريف مساحات Chat، كما توفّرها واجهة برمجة تطبيقات Chat هناك حدّ أقصى للتصدير من 500 مساحة في Chat لكل طلب.

SitesUrlInfo

عناوين URL للمواقع الإلكترونية المنشورة في الإصدار الجديد من "مواقع Google" المطلوب البحث فيها

تمثيل 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

مساحات Drive المشترَكة المطلوب البحث فيها

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

string

قائمة بأرقام تعريف مساحات التخزين السحابي المشتركة، كما توفّرها واجهة برمجة تطبيقات Drive.

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),
  "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

يجب ضبطها على "صحيح" لتضمين مساحة تخزين سحابي مشتركة.
includeSharedDrives
(deprecated)

boolean

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

enum (ClientSideEncryptedOption)

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

enum (SharedDrivesOption)

اختيارية: خيارات لتضمين المستندات في مساحات التخزين السحابي المشتركة أو استبعادها ننصح باستخدام هذا الحقل بدلاً من includeSharedDrives. يتجاوز هذا الحقل includeSharedDrives وincludeTeamDrives عند ضبطه.

SharedDrivesOption

خيار بشأن نوع مستندات مساحة التخزين السحابي المشتركة التي يجب تضمينها

عمليات التعداد
SHARED_DRIVES_OPTION_UNSPECIFIED لم يتم تحديد خيار مساحة التخزين السحابي المشتركة.
NOT_INCLUDED إذا كان المورد في مساحة تخزين سحابي مشتركة، لا يتم تضمينه في البحث.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER لا يتم تضمين موارد مساحة التخزين السحابي المشتركة إلا في الحالات التي يكون فيها الحساب متعاونًا في أحد الموارد ولكنه ليس عضوًا في مساحة التخزين السحابي المشتركة. يتوافق هذا مع الخيار "يتم تضمينها فقط إذا تمت مشاركة المستندات مباشرةً (وليس بسبب الاشتراك في مساحة التخزين السحابي المشتركة)" في واجهة مستخدم Vault. (كانت تُعرف سابقًا باسم "includeSharedDrives" off)
INCLUDED يتم تضمين الموارد في مساحات التخزين السحابي المشتركة في البحث. (كانت تُعرف سابقًا باسم "includeSharedDrives" في)

HangoutsChatOptions

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

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

boolean

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

VoiceOptions

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

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

enum (VoiceCoveredData)

أنواع البيانات المطلوب البحث فيها

CalendarOptions

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

تمثيل 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

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

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

GeminiOptions

هذا النوع لا يحتوي على حقول.

خيارات إضافية للبحث في تطبيق Gemini

GeminiInWorkspaceOptions

هذا النوع لا يحتوي على حقول.

خيارات إضافية لـ "Gemini في بحث Workspace"