REST Resource: matters.holds

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

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

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

نمایش 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)

آخرین باری که این نگهدارنده تغییر داده شد.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

accounts[]

object ( HeldAccount )

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

orgUnit

object ( HeldOrgUnit )

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

corpus

enum ( CorpusType )

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

query

object ( CorpusQuery )

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

واحد سازمان برگزار شد

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

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

string

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

holdTime

string ( Timestamp format)

وقتی واحد سازمانی در حالت تعلیق قرار گرفت. این ویژگی تغییرناپذیر است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

کورپوس کوئری

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

نمایش JSON 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
فیلدها
فیلد یونیون corpus_query . در صورت تنظیم، باید با نوع سرویس مطابقت داشته باشد. corpus_query فقط می‌تواند یکی از موارد زیر باشد:
driveQuery

object ( HeldDriveQuery )

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

mailQuery

object ( HeldMailQuery )

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

groupsQuery

object ( HeldGroupsQuery )

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

hangoutsChatQuery

object ( HeldHangoutsChatQuery )

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

voiceQuery

object ( HeldVoiceQuery )

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

calendarQuery

object ( HeldCalendarQuery )

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

geminiQuery

object ( HeldGeminiQuery )

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

پرس و جو در حین رانندگی

گزینه‌های مربوط به درایو هولد (Drive Holds)

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

boolean

برای اضافه کردن فایل‌های موجود در درایوهای تیمی به فضای ذخیره‌سازی، مقدار را روی true تنظیم کنید.

includeSharedDriveFiles

boolean

برای اضافه کردن فایل‌های موجود در درایوهای مشترک به فضای ذخیره‌سازی، مقدار را روی true تنظیم کنید.

HeldMailQuery

گزینه‌های پرس‌وجو برای جیمیل موجود است.

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

string

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

startTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

endTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

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

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

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

string

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

startTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

endTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

HeldHangoutsChatQuery

گزینه‌های مربوط به چت.

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

boolean

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

پرس و جوی صدای برگزار شده

گزینه‌های مربوط به نگه‌داشتن صدا

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

enum ( VoiceCoveredData )

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

پرس و جو تقویم برگزار شده

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

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

HeldGeminiQuery

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

گزینه‌های مربوط به سهام جوزا

روش‌ها

addHeldAccounts

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

create

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

delete

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

get

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

list

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

removeHeldAccounts

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

update

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