REST Resource: drives

منبع: Drive

نمایندگی یک درایو مشترک

برخی از روش‌های منبع (مانند drives.update ) به یک driveId نیاز دارند. از روش drives.list برای بازیابی شناسه درایو مشترک استفاده کنید.

نمایندگی JSON 
{
  "id": string,
  "name": string,
  "colorRgb": string,
  "kind": string,
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRename": boolean,
    "canRenameDrive": boolean,
    "canChangeDriveBackground": boolean,
    "canShare": boolean,
    "canChangeCopyRequiresWriterPermissionRestriction": boolean,
    "canChangeDomainUsersOnlyRestriction": boolean,
    "canChangeDriveMembersOnlyRestriction": boolean,
    "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": boolean,
    "canResetDriveRestrictions": boolean,
    "canDeleteChildren": boolean,
    "canTrashChildren": boolean
  },
  "themeId": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": number,
    "yCoordinate": number,
    "width": number
  },
  "createdTime": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
فیلدها
id

string

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

name

string

نام این درایو مشترک.

colorRgb

string

رنگ این درایو مشترک به عنوان یک رشته هگزا RGB. فقط می‌توان آن را روی یک درخواست drive.drives.update تنظیم کرد که themeId را تنظیم نمی‌کند.

kind

string

فقط خروجی مشخص می کند که این چه نوع منبعی است. مقدار: رشته ثابت "drive#drive" .

capabilities

object

فقط خروجی قابلیت هایی که کاربر فعلی در این درایو مشترک دارد.

capabilities.canAddChildren

boolean

فقط خروجی آیا کاربر فعلی می‌تواند کودکان را به پوشه‌های این درایو مشترک اضافه کند یا خیر.

capabilities.canComment

boolean

فقط خروجی اینکه آیا کاربر فعلی می‌تواند روی فایل‌های این درایو مشترک نظر دهد یا خیر.

capabilities.canCopy

boolean

فقط خروجی آیا کاربر فعلی می‌تواند فایل‌ها را در این درایو مشترک کپی کند یا خیر.

capabilities.canDeleteDrive

boolean

فقط خروجی آیا کاربر فعلی می‌تواند این درایو مشترک را حذف کند یا خیر. اگر موارد حذف نشده در درایو مشترک وجود داشته باشد، ممکن است تلاش برای حذف درایو مشترک همچنان ناموفق باشد.

capabilities.canDownload

boolean

فقط خروجی آیا کاربر فعلی می‌تواند فایل‌ها را در این درایو مشترک بارگیری کند یا خیر.

capabilities.canEdit

boolean

فقط خروجی آیا کاربر فعلی می‌تواند فایل‌ها را در این درایو مشترک ویرایش کند یا خیر

capabilities.canListChildren

boolean

فقط خروجی آیا کاربر فعلی می‌تواند فرزندان پوشه‌ها را در این درایو مشترک فهرست کند یا خیر.

capabilities.canManageMembers

boolean

فقط خروجی آیا کاربر فعلی می‌تواند اعضا را به این درایو مشترک اضافه کند یا آنها را حذف کند یا نقش آنها را تغییر دهد.

capabilities.canReadRevisions

boolean

فقط خروجی آیا کاربر فعلی می‌تواند منبع بازبینی فایل‌ها را در این درایو مشترک بخواند یا خیر.

capabilities.canRename

boolean

فقط خروجی اینکه آیا کاربر فعلی می‌تواند نام فایل‌ها یا پوشه‌ها را در این درایو مشترک تغییر دهد.

capabilities.canRenameDrive

boolean

فقط خروجی آیا کاربر فعلی می‌تواند نام این درایو مشترک را تغییر دهد یا خیر.

capabilities.canChangeDriveBackground

boolean

فقط خروجی آیا کاربر فعلی می‌تواند پس‌زمینه این درایو مشترک را تغییر دهد یا خیر.

capabilities.canShare

boolean

فقط خروجی آیا کاربر فعلی می‌تواند فایل‌ها یا پوشه‌ها را در این درایو مشترک به اشتراک بگذارد.

capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

فقط خروجی آیا کاربر فعلی می‌تواند محدودیت copyRequiresWriterPermission این درایو مشترک را تغییر دهد یا خیر.

capabilities.canChangeDomainUsersOnlyRestriction

boolean

فقط خروجی آیا کاربر فعلی می‌تواند محدودیت domainUsersOnly این درایو مشترک را تغییر دهد یا خیر.

capabilities.canChangeDriveMembersOnlyRestriction

boolean

فقط خروجی آیا کاربر فعلی می‌تواند محدودیت driveMembersOnly این درایو مشترک را تغییر دهد یا خیر.

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

فقط خروجی آیا کاربر فعلی می‌تواند محدودیت sharingFoldersRequiresOrganizerPermission این درایو مشترک را تغییر دهد یا خیر.

capabilities.canResetDriveRestrictions

boolean

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

capabilities.canDeleteChildren

boolean

فقط خروجی آیا کاربر فعلی می‌تواند کودکان را از پوشه‌های این درایو مشترک حذف کند یا خیر.

capabilities.canTrashChildren

boolean

فقط خروجی آیا کاربر فعلی می‌تواند کودکان را از پوشه‌های این درایو مشترک حذف کند یا خیر.

themeId

string

شناسه تمی که تصویر و رنگ پس‌زمینه از آن تنظیم می‌شود. مجموعه driveThemes ممکن را می توان از یک پاسخ drive.about.get بازیابی کرد. هنگامی که در یک درخواست drive.drives.create مشخص نشده باشد، یک تم تصادفی انتخاب می شود که از آن تصویر پس زمینه و رنگ تنظیم می شود. این یک فیلد فقط برای نوشتن است. فقط می‌توان آن را روی درخواست‌هایی تنظیم کرد که colorRgb یا backgroundImageFile را تنظیم نمی‌کنند.

backgroundImageFile

object

یک فایل تصویر و پارامترهای برش که از آن یک تصویر پس‌زمینه برای این درایو مشترک تنظیم می‌شود. این یک فیلد فقط نوشتن است. فقط می‌توان آن را روی درخواست‌های drive.drives.update که themeId را تنظیم نمی‌کنند، تنظیم کرد. وقتی مشخص شد، تمام فیلدهای backgroundImageFile باید تنظیم شوند.

backgroundImageFile.id

string

شناسه یک فایل تصویری در Google Drive برای استفاده برای تصویر پس‌زمینه.

backgroundImageFile.xCoordinate

number

مختصات X گوشه سمت چپ بالای ناحیه برش در تصویر پس زمینه. این مقدار در محدوده بسته 0 تا 1 است. این مقدار نشان دهنده فاصله افقی از سمت چپ کل تصویر تا سمت چپ منطقه برش تقسیم بر عرض کل تصویر است.

backgroundImageFile.yCoordinate

number

مختصات Y گوشه سمت چپ بالای ناحیه برش در تصویر پس زمینه. این مقدار در محدوده بسته 0 تا 1 است. این مقدار نشان دهنده فاصله عمودی از سمت بالای کل تصویر تا قسمت بالای منطقه برش تقسیم بر ارتفاع کل تصویر است.

backgroundImageFile.width

number

عرض تصویر برش خورده در محدوده بسته 0 تا 1. این مقدار نشان دهنده عرض تصویر برش خورده تقسیم بر عرض کل تصویر است. ارتفاع با اعمال نسبت ابعاد عرض به ارتفاع 80 به 9 محاسبه می شود. تصویر حاصل باید حداقل 1280 پیکسل عرض و 144 پیکسل ارتفاع داشته باشد.

createdTime

string

فقط خروجی زمانی که درایو مشترک ایجاد شد (RFC 3339 date-time).

hidden

boolean

اینکه آیا درایو مشترک از نمای پیش‌فرض پنهان است یا خیر.

restrictions

object

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

restrictions.copyRequiresWriterPermission

boolean

گزینه‌های کپی، چاپ یا بارگیری فایل‌ها در این درایو مشترک، باید برای خوانندگان و نظر دهندگان غیرفعال باشد. وقتی این محدودیت روی true تنظیم شود، فیلد با نام مشابه را برای هر فایلی در داخل این درایو مشترک به true تغییر می‌دهد.

restrictions.domainUsersOnly

boolean

اینکه آیا دسترسی به این درایو مشترک و موارد داخل این درایو مشترک محدود به کاربران دامنه‌ای است که این درایو مشترک به آن تعلق دارد. این محدودیت ممکن است توسط سایر خط‌مشی‌های اشتراک‌گذاری که خارج از این درایو مشترک کنترل می‌شوند لغو شود.

restrictions.driveMembersOnly

boolean

آیا دسترسی به موارد داخل این درایو مشترک محدود به اعضای آن است یا خیر.

restrictions.adminManagedRestrictions

boolean

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

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

اگر درست باشد، فقط کاربران دارای نقش سازمان‌دهنده می‌توانند پوشه‌ها را به اشتراک بگذارند. اگر نادرست باشد، کاربرانی که نقش سازمان‌دهنده یا سازمان‌دهنده فایل را دارند می‌توانند پوشه‌ها را به اشتراک بگذارند.

orgUnitId

string

فقط خروجی واحد سازمانی این درایو مشترک. این فیلد فقط در پاسخ‌های drives.list زمانی پر می‌شود که پارامتر useDomainAdminAccess روی true تنظیم شده باشد.

روش ها

create

 یک درایو مشترک ایجاد می کند.

delete

 درایو مشترکی را که کاربر organizer آن است، برای همیشه حذف می‌کند.

get

 فراداده درایو مشترک را با شناسه دریافت می کند.

hide

 یک درایو مشترک را از نمای پیش فرض پنهان می کند.

list

درایوهای مشترک کاربر را فهرست می کند.

unhide

 یک درایو مشترک را به نمای پیش فرض بازیابی می کند.

update

 متادیتا را برای یک درایو مشترک به روز می کند.