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)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // 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 منتصف الليل في التاريخ المحدّد.

يستخدم معيار 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.
حقل الربط 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

ابحث عن البيانات في مساحة التخزين السحابي المشتركة المحددة في 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 مساحة محادثة كحد أقصى لكل طلب.

SitesUrlInfo

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

تمثيل 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، حالة تشفير المحتوى

عمليات التعداد
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) في التاريخ المحدّد أدخِل التاريخ بالتوقيت العالمي المنسَّق.

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

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

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

خيارات إضافية للبحث في "تقويم 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)

البحث في النسخة الحالية من حدث "تقويم 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