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)

وقت البدء لطلب البحث حدِّدها بتوقيت غرينتش. يتم تقريب القيمة إلى الساعة 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.
حقل الربط 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)

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

object (GeminiOptions)

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

DataScope

مصدر البيانات المطلوب البحث فيه

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

SearchMethod

نوع العنصر الذي سيتم البحث عنه

عمليات التعداد
SEARCH_METHOD_UNSPECIFIED يجب تحديد طريقة بحث وإلا سيتم رفضها.
ACCOUNT ابحث في بيانات الحسابات المحدّدة في AccountInfo.
ORG_UNIT ابحث في بيانات جميع الحسابات في الوحدة التنظيمية المحدّدة في OrgUnitInfo.
TEAM_DRIVE

ابحث عن البيانات في مساحة 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

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

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

string

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

DriveDocumentInfo

مستندات Drive التي سيتم البحث فيها

تمثيل JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
الحقول
حقل الربط identifier تنسيق استرداد مستندات Drive يمكن أن يكون التعليق identifier إحدى القيم التالية فقط:
documentIds

object (DriveDocumentIds)

حدِّد مستندات Drive حسب رقم تعريف المستند.

DriveDocumentIds

حدِّد مستندات Drive حسب رقم تعريف المستند.

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

string

الحقل مطلوب. قائمة بمعرّفات مستندات Drive

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),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
الحقول
versionDate

string (Timestamp format)

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

اضبط القيمة على "صحيح" لتضمين مساحة Drive المشتركة.
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" غير مفعّلة)
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

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

مثال على تقسيم الكلمات: ["نيوزيلندا"] مقابل ["نيو","زيلندا"] "نيوزيلندا": يتطابق مع كل من "نيو زيلندا": يتطابق مع الأخير فقط
peopleQuery[]

string

يطابق الأحداث التي يتضمّن المشاركون فيها جميع الكلمات في المجموعة المحدّدة فقط. يتم أخذ الإدخالات في المجموعة في الاعتبار باستخدام "و".
minusWords[]

string

تتطابق مع الأحداث التي لا تحتوي على أي من الكلمات في المجموعة المحدّدة في العنوان أو الوصف أو الموقع الجغرافي أو الضيوف فقط. يتم التعامل مع الإدخالات في المجموعة على أنّها "أو".
responseStatuses[]

enum (AttendeeResponse)

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

string (Timestamp format)

البحث في النسخة الحالية من حدث "تقويم Google"، ولكن تصدير محتوى آخر نسخة تم حفظها قبل الساعة 12:00 صباحًا بالتوقيت العالمي المنسق (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