REST Resource: matters.holds

منبع: نگه دارید

یک نگه داشتن توقف از پاک کردن داده‌های حساب‌های خاص یا همه اعضای یک واحد سازمانی توسط سرویس Google Workspace مشخص شده جلوگیری می‌کند.

برای کار با منابع Vault، حساب باید دارای امتیازات Vault مورد نیاز و دسترسی به موضوع باشد. برای دسترسی به یک موضوع، حساب باید موضوع را ایجاد کرده باشد، موضوع را با آنها به اشتراک گذاشته باشد، یا دارای امتیاز View All Matters باشد.

نمایندگی JSON 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
فیلدها
holdId

string

شناسه منحصر به فرد غیرقابل تغییر نگهدارنده. در حین ایجاد اختصاص داده شده است.

name

string

نام نگهدارنده.

updateTime

string ( Timestamp format)

آخرین باری که این توقف اصلاح شد.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

accounts[]

object ( HeldAccount )

در صورت تنظیم، توقف برای حساب های مشخص شده اعمال می شود و orgUnit باید خالی باشد.

orgUnit

object ( HeldOrgUnit )

در صورت تنظیم، توقف برای همه اعضای واحد سازمانی اعمال می شود و حساب ها باید خالی باشد. این ویژگی قابل تغییر است. برای ذخیره‌های گروهی، حساب‌ها را تنظیم کنید.

corpus

enum ( CorpusType )

سرویسی که باید جستجو شود.

query

object ( CorpusQuery )

گزینه های خاص خدمات اگر تنظیم شود، CorpusQuery باید با CorpusType مطابقت داشته باشد.

HeldOrgUnit

واحد سازمانی تحت پوشش یک انبار. این ساختار تغییر ناپذیر است.

نمایندگی JSON 
{
  "orgUnitId": string,
  "holdTime": string
}
فیلدها
orgUnitId

string

شناسه تغییرناپذیر واحد سازمانی که توسط Admin SDK ارائه شده است.

holdTime

string ( Timestamp format)

زمانی که واحد سازمانی به حالت تعلیق درآمد. این خاصیت غیر قابل تغییر است.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

CorpusQuery

گزینه های خاص سرویس برای نگهداری.

نمایندگی JSON 
{

  // Union field corpus_query can be only one of the following:
  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
فیلدها
فیلد اتحادیه corpus_query . اگر تنظیم شود، باید با نوع سرویس مطابقت داشته باشد. corpus_query فقط می تواند یکی از موارد زیر باشد:
driveQuery

object ( HeldDriveQuery )

گزینه‌های خاص سرویس برای نگهدارنده‌های Drive. اگر تنظیم شود، CorpusType باید DRIVE باشد.

mailQuery

object ( HeldMailQuery )

گزینه های خاص سرویس برای Gmail نگه می دارد. اگر تنظیم شود، CorpusType باید MAIL باشد.

groupsQuery

object ( HeldGroupsQuery )

گزینه های خاص سرویس برای Groups Hold. اگر تنظیم شود، CorpusType باید GROUPS باشد.

hangoutsChatQuery

object ( HeldHangoutsChatQuery )

گزینه های مخصوص سرویس برای چت نگه می دارد. اگر تنظیم شود، CorpusType باید HANGOUTS_CHAT باشد.

voiceQuery

object ( HeldVoiceQuery )

گزینه های مخصوص سرویس برای Voice Hold. اگر تنظیم شود، CorpusType باید VOICE باشد.

calendarQuery

object ( HeldCalendarQuery )

گزینه‌های مخصوص سرویس برای نگهداری‌های تقویم. اگر تنظیم شود، CorpusType باید CALENDAR باشد.

HeldDriveQuery

گزینه‌های Drive نگه می‌دارد.

نمایندگی JSON 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
فیلدها
includeTeamDriveFiles
(deprecated)

boolean

برای گنجاندن فایل‌ها در Team Drives در حالت انتظار، روی true تنظیم کنید.

includeSharedDriveFiles

boolean

برای گنجاندن فایل‌ها در درایوهای مشترک در حالت انتظار، روی true تنظیم کنید.

HeldMailQuery

گزینه های پرس و جو برای Gmail نگه می دارد.

نمایندگی JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
فیلدها
terms

string

اپراتورهای جستجو برای اصلاح پیام‌های تحت پوشش نگه‌داشتن استفاده می‌کردند.

startTime

string ( Timestamp format)

زمان شروع پرس و جو در GMT مشخص کنید. مقدار در تاریخ مشخص شده به 12 صبح گرد می شود.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

زمان پایان پرس و جو در GMT مشخص کنید. مقدار در تاریخ مشخص شده به 12 صبح گرد می شود.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

HeldGroupsQuery

گزینه های پرس و جو برای نگهداری های گروهی.

نمایندگی JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
فیلدها
terms

string

اپراتورهای جستجو برای اصلاح پیام‌های تحت پوشش نگه‌داشتن استفاده می‌کردند.

startTime

string ( Timestamp format)

زمان شروع پرس و جو در GMT مشخص کنید. مقدار در تاریخ مشخص شده به 12 صبح گرد می شود.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

زمان پایان پرس و جو در GMT مشخص کنید. مقدار در تاریخ مشخص شده به 12 صبح گرد می شود.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

HeldHangoutsChatQuery

گزینه‌های چت نگه می‌دارد.

نمایندگی JSON 
{
  "includeRooms": boolean
}
فیلدها
includeRooms

boolean

برای گنجاندن پیام‌ها در فضاهای چت که کاربر عضو آن بود، روی true تنظیم کنید.

HeldVoiceQuery

گزینه‌های Voice نگه می‌دارد.

نمایندگی JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
فیلدها
coveredData[]

enum ( VoiceCoveredData )

لیستی از انواع داده های تحت پوشش نگهداری باید خالی نباشد ترتیب مهم نیست و موارد تکراری نادیده گرفته می شوند.

HeldCalendarQuery

این نوع هیچ فیلدی ندارد.

گزینه های مربوط به تقویم نگه می دارد.

روش ها

addHeldAccounts

 حساب‌ها را به انبار اضافه می‌کند.

create

 در موضوع مشخص شده یک نگهدارنده ایجاد می کند.

delete

 توقف مشخص شده را حذف می کند و حساب ها یا واحد سازمانی تحت پوشش آن را آزاد می کند.

get

 زمان مشخص شده را می گیرد.

list

 موارد موجود را در یک موضوع فهرست می کند.

removeHeldAccounts

 حساب های مشخص شده را از حالت نگهداری حذف می کند.

update

 دامنه (واحد یا حساب‌های سازمانی) و پارامترهای پرس‌وجو را به‌روزرسانی می‌کند.