REST Resource: files

منبع: فایل

فراداده (metadata) برای یک فایل.

برخی از متدهای منبع (مانند files.update ) به یک fileId نیاز دارند. از متد files.list برای بازیابی شناسه یک فایل استفاده کنید.

نمایش JSON
{
  "exportLinks": {
    string: string,
    ...
  },
  "parents": [
    string
  ],
  "owners": [
    {
      object (User)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "spaces": [
    string
  ],
  "properties": {
    string: value,
    ...
  },
  "appProperties": {
    string: value,
    ...
  },
  "permissionIds": [
    string
  ],
  "contentRestrictions": [
    {
      object (ContentRestriction)
    }
  ],
  "kind": string,
  "driveId": string,
  "fileExtension": string,
  "copyRequiresWriterPermission": boolean,
  "md5Checksum": string,
  "contentHints": {
    "indexableText": string,
    "thumbnail": {
      "image": string,
      "mimeType": string
    }
  },
  "writersCanShare": boolean,
  "viewedByMe": boolean,
  "mimeType": string,
  "thumbnailLink": string,
  "iconLink": string,
  "shared": boolean,
  "lastModifyingUser": {
    object (User)
  },
  "headRevisionId": string,
  "sharingUser": {
    object (User)
  },
  "webViewLink": string,
  "webContentLink": string,
  "size": string,
  "viewersCanCopyContent": boolean,
  "hasThumbnail": boolean,
  "folderColorRgb": string,
  "id": string,
  "name": string,
  "description": string,
  "starred": boolean,
  "trashed": boolean,
  "explicitlyTrashed": boolean,
  "createdTime": string,
  "modifiedTime": string,
  "modifiedByMeTime": string,
  "viewedByMeTime": string,
  "sharedWithMeTime": string,
  "quotaBytesUsed": string,
  "version": string,
  "originalFilename": string,
  "ownedByMe": boolean,
  "fullFileExtension": string,
  "isAppAuthorized": boolean,
  "teamDriveId": string,
  "capabilities": {
    "canChangeViewersCanCopyContent": boolean,
    "canMoveChildrenOutOfDrive": boolean,
    "canReadDrive": boolean,
    "canEdit": boolean,
    "canCopy": boolean,
    "canComment": boolean,
    "canAddChildren": boolean,
    "canDelete": boolean,
    "canDownload": boolean,
    "canListChildren": boolean,
    "canRemoveChildren": boolean,
    "canRename": boolean,
    "canTrash": boolean,
    "canReadRevisions": boolean,
    "canReadTeamDrive": boolean,
    "canMoveTeamDriveItem": boolean,
    "canChangeCopyRequiresWriterPermission": boolean,
    "canMoveItemIntoTeamDrive": boolean,
    "canUntrash": boolean,
    "canModifyContent": boolean,
    "canMoveItemWithinTeamDrive": boolean,
    "canMoveItemOutOfTeamDrive": boolean,
    "canDeleteChildren": boolean,
    "canMoveChildrenOutOfTeamDrive": boolean,
    "canMoveChildrenWithinTeamDrive": boolean,
    "canTrashChildren": boolean,
    "canMoveItemOutOfDrive": boolean,
    "canAddMyDriveParent": boolean,
    "canRemoveMyDriveParent": boolean,
    "canMoveItemWithinDrive": boolean,
    "canShare": boolean,
    "canMoveChildrenWithinDrive": boolean,
    "canModifyContentRestriction": boolean,
    "canAddFolderFromAnotherDrive": boolean,
    "canChangeSecurityUpdateEnabled": boolean,
    "canAcceptOwnership": boolean,
    "canReadLabels": boolean,
    "canModifyLabels": boolean,
    "canModifyEditorContentRestriction": boolean,
    "canModifyOwnerContentRestriction": boolean,
    "canRemoveContentRestriction": boolean,
    "canDisableInheritedPermissions": boolean,
    "canEnableInheritedPermissions": boolean,
    "canChangeItemDownloadRestriction": boolean
  },
  "hasAugmentedPermissions": boolean,
  "trashingUser": {
    object (User)
  },
  "thumbnailVersion": string,
  "trashedTime": string,
  "modifiedByMe": boolean,
  "imageMediaMetadata": {
    "flashUsed": boolean,
    "meteringMode": string,
    "sensor": string,
    "exposureMode": string,
    "colorSpace": string,
    "whiteBalance": string,
    "width": integer,
    "height": integer,
    "location": {
      "latitude": number,
      "longitude": number,
      "altitude": number
    },
    "rotation": integer,
    "time": string,
    "cameraMake": string,
    "cameraModel": string,
    "exposureTime": number,
    "aperture": number,
    "focalLength": number,
    "isoSpeed": integer,
    "exposureBias": number,
    "maxApertureValue": number,
    "subjectDistance": integer,
    "lens": string
  },
  "videoMediaMetadata": {
    "width": integer,
    "height": integer,
    "durationMillis": string
  },
  "shortcutDetails": {
    "targetId": string,
    "targetMimeType": string,
    "targetResourceKey": string
  },
  "resourceKey": string,
  "linkShareMetadata": {
    "securityUpdateEligible": boolean,
    "securityUpdateEnabled": boolean
  },
  "labelInfo": {
    "labels": [
      {
        object (Label)
      }
    ]
  },
  "sha1Checksum": string,
  "sha256Checksum": string,
  "inheritedPermissionsDisabled": boolean,
  "downloadRestrictions": {
    object (DownloadRestrictionsMetadata)
  }
}
فیلدها
parents[]

string

شناسه پوشه والد حاوی فایل.

یک فایل فقط می‌تواند یک پوشه والد داشته باشد؛ تعیین چندین والد پشتیبانی نمی‌شود.

اگر به عنوان بخشی از درخواست ایجاد مشخص نشده باشد، فایل مستقیماً در پوشه My Drive کاربر قرار می‌گیرد. اگر به عنوان بخشی از درخواست کپی مشخص نشده باشد، فایل از هر والد قابل کشف فایل منبع ارث می‌برد. درخواست‌های به‌روزرسانی باید از پارامترهای addParents و removeParents برای تغییر لیست والدها استفاده کنند.

owners[]

object ( User )

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

permissions[]

object ( Permission )

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

spaces[]

string

فقط خروجی. فهرست فضاهایی که حاوی فایل هستند. مقادیر پشتیبانی‌شده‌ی فعلی drive ، appDataFolder و photos هستند.

properties

map (key: string, value: value ( Value format))

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

ورودی‌های دارای مقادیر تهی (null) در درخواست‌های به‌روزرسانی و کپی پاک می‌شوند.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

appProperties

map (key: string, value: value ( Value format))

مجموعه‌ای از جفت‌های کلید-مقدار دلخواه که برای برنامه‌ی درخواست‌کننده خصوصی هستند.

ورودی‌های دارای مقادیر تهی (null) در درخواست‌های به‌روزرسانی و کپی پاک می‌شوند.

این ویژگی‌ها فقط با استفاده از یک درخواست احراز هویت شده قابل بازیابی هستند. یک درخواست احراز هویت شده از یک توکن دسترسی که با شناسه کلاینت OAuth 2.0 به دست آمده است استفاده می‌کند. شما نمی‌توانید از یک کلید API برای بازیابی ویژگی‌های خصوصی استفاده کنید.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

permissionIds[]

string

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

contentRestrictions[]

object ( ContentRestriction )

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

kind

string

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

driveId

string

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

fileExtension

string

فقط خروجی. آخرین جزء fullFileExtension . این فقط برای فایل‌هایی با محتوای دودویی در گوگل درایو در دسترس است.

copyRequiresWriterPermission

boolean

اینکه آیا گزینه‌های کپی، چاپ یا دانلود این فایل برای خوانندگان و نظردهندگان غیرفعال باشد یا خیر.

md5Checksum

string

فقط خروجی. مجموع بررسی MD5 برای محتوای فایل. این فقط برای فایل‌هایی با محتوای دودویی در گوگل درایو قابل استفاده است.

contentHints

object

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

contentHints.indexableText

string

متنی که باید برای بهبود جستجوهای تمام متن در فایل فهرست‌بندی شود. طول این متن به ۱۲۸ کیلوبایت محدود شده است و ممکن است حاوی عناصر HTML باشد.

contentHints.thumbnail

object

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

contentHints.thumbnail.image

string ( bytes format)

داده‌های تصویر بندانگشتی با URL-safe Base64 ( بخش ۵ RFC 4648 ) کدگذاری شده‌اند.

یک رشته کدگذاری شده با base64.

contentHints.thumbnail.mimeType

string

نوع MIME تصویر بندانگشتی.

writersCanShare

boolean

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

viewedByMe

boolean

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

mimeType

string

نوع MIME فایل.

اگر هیچ مقداری ارائه نشود، گوگل درایو تلاش می‌کند تا به طور خودکار مقدار مناسب را از محتوای آپلود شده تشخیص دهد. این مقدار قابل تغییر نیست مگر اینکه یک نسخه جدید آپلود شود.

اگر فایلی با نوع MIME گوگل داک ایجاد شود، در صورت امکان محتوای آپلود شده وارد می‌شود. فرمت‌های پشتیبانی شده برای وارد کردن در منبع about منتشر شده‌اند.

shared

boolean

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

lastModifyingUser

object ( User )

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

headRevisionId

string

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

sharingUser

object ( User )

فقط خروجی. کاربری که فایل را با کاربر درخواست‌کننده به اشتراک گذاشته است، در صورت وجود.

size

string ( int64 format)

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

viewersCanCopyContent
(deprecated)

boolean

منسوخ شده: به جای آن copyRequiresWriterPermission استفاده کنید.

hasThumbnail

boolean

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

folderColorRgb

string

رنگ یک پوشه یا میانبر به یک پوشه به صورت یک رشته هگز RGB. رنگ‌های پشتیبانی شده در فیلد folderColorPalette از منبع about منتشر می‌شوند.

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

id

string

شناسه فایل.

name

string

نام فایل. این نام لزوماً در یک پوشه منحصر به فرد نیست. توجه داشته باشید که برای موارد تغییرناپذیر مانند پوشه‌های سطح بالای درایوهای اشتراکی، پوشه ریشه My Drive و پوشه Application Data، نام ثابت است.

description

string

توضیح مختصری در مورد فایل.

starred

boolean

اینکه آیا کاربر فایل را ستاره‌دار کرده است یا خیر.

trashed

boolean

اینکه آیا فایل به طور صریح یا از یک پوشه والدِ حذف شده، حذف شده است یا خیر. فقط مالک می‌تواند یک فایل را حذف کند، اما سایر کاربران همچنان می‌توانند به فایل موجود در حذف شده مالک دسترسی داشته باشند تا زمانی که به طور دائم حذف شود.

explicitlyTrashed

boolean

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

createdTime

string

زمانی که فایل ایجاد شده است ( تاریخ-زمان RFC 3339 ).

modifiedTime

string

آخرین باری که فایل توسط کسی تغییر داده شده است ( RFC 3339 date-time ).

توجه داشته باشید که تنظیم modifiedTime modifiedByMeTime نیز برای کاربر به‌روزرسانی می‌کند.

modifiedByMeTime

string

فقط خروجی. آخرین باری که فایل توسط کاربر تغییر داده شده است ( RFC 3339 date-time ).

viewedByMeTime

string

آخرین باری که فایل توسط کاربر مشاهده شده است ( RFC 3339 date-time ).

sharedWithMeTime

string

فقط خروجی. در صورت وجود، زمانی که فایل با کاربر به اشتراک گذاشته شده است ( تاریخ-زمان RFC 3339 ).

quotaBytesUsed

string ( int64 format)

فقط خروجی. تعداد بایت‌های سهمیه ذخیره‌سازی استفاده‌شده توسط فایل. این شامل ویرایش اصلی و همچنین ویرایش‌های قبلی با فعال بودن keepForever می‌شود.

version

string ( int64 format)

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

originalFilename

string

نام فایل اصلی محتوای آپلود شده در صورت موجود بودن، یا در غیر این صورت مقدار اصلی فیلد name . این فقط برای فایل‌هایی با محتوای دودویی در Google Drive در دسترس است.

ownedByMe

boolean

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

fullFileExtension

string

فقط خروجی. پسوند کامل فایل از فیلد name استخراج می‌شود. ممکن است شامل چندین پسوند به هم پیوسته باشد، مانند "tar.gz". این فقط برای فایل‌هایی با محتوای دودویی در Google Drive در دسترس است.

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

isAppAuthorized

boolean

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

teamDriveId
(deprecated)

string

منسوخ شده: فقط خروجی. به جای آن driveId استفاده کنید.

capabilities

object

فقط خروجی. قابلیت‌هایی که کاربر فعلی در این فایل دارد. هر قابلیت مربوط به یک اقدام جزئی است که کاربر ممکن است انجام دهد. برای اطلاعات بیشتر، به بخش «درک قابلیت‌های فایل» مراجعه کنید.

capabilities.canChangeViewersCanCopyContent
(deprecated)

boolean

منسوخ شده: فقط خروجی.

capabilities.canMoveChildrenOutOfDrive

boolean

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

capabilities.canReadDrive

boolean

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

capabilities.canEdit

boolean

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

capabilities.canCopy

boolean

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

capabilities.canComment

boolean

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

capabilities.canAddChildren

boolean

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

capabilities.canDelete

boolean

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

capabilities.canDownload

boolean

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

capabilities.canListChildren

boolean

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

capabilities.canRemoveChildren

boolean

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

capabilities.canRename

boolean

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

capabilities.canTrash

boolean

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

capabilities.canReadRevisions

boolean

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

capabilities.canReadTeamDrive
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن canReadDrive استفاده کنید.

capabilities.canMoveTeamDriveItem
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن canMoveItemWithinDrive یا canMoveItemOutOfDrive استفاده کنید.

capabilities.canChangeCopyRequiresWriterPermission

boolean

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

capabilities.canMoveItemIntoTeamDrive
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن canMoveItemOutOfDrive استفاده کنید.

capabilities.canUntrash

boolean

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

capabilities.canModifyContent

boolean

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

capabilities.canMoveItemWithinTeamDrive
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن canMoveItemWithinDrive استفاده کنید.

capabilities.canMoveItemOutOfTeamDrive
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن canMoveItemOutOfDrive استفاده کنید.

capabilities.canDeleteChildren

boolean

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

capabilities.canMoveChildrenOutOfTeamDrive
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن canMoveChildrenOutOfDrive استفاده کنید.

capabilities.canMoveChildrenWithinTeamDrive
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن canMoveChildrenWithinDrive استفاده کنید.

capabilities.canTrashChildren

boolean

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

capabilities.canMoveItemOutOfDrive

boolean

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

capabilities.canAddMyDriveParent

boolean

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

capabilities.canRemoveMyDriveParent

boolean

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

capabilities.canMoveItemWithinDrive

boolean

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

capabilities.canShare

boolean

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

capabilities.canMoveChildrenWithinDrive

boolean

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

capabilities.canModifyContentRestriction
(deprecated)

boolean

منسوخ شده: فقط خروجی. از یکی از canModifyEditorContentRestriction ، canModifyOwnerContentRestriction یا canRemoveContentRestriction استفاده کنید.

capabilities.canAddFolderFromAnotherDrive

boolean

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

capabilities.canChangeSecurityUpdateEnabled

boolean

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

capabilities.canAcceptOwnership

boolean

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

capabilities.canReadLabels

boolean

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

capabilities.canModifyLabels

boolean

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

capabilities.canModifyEditorContentRestriction

boolean

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

capabilities.canModifyOwnerContentRestriction

boolean

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

capabilities.canRemoveContentRestriction

boolean

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

capabilities.canDisableInheritedPermissions

boolean

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

capabilities.canEnableInheritedPermissions

boolean

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

capabilities.canChangeItemDownloadRestriction

boolean

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

hasAugmentedPermissions

boolean

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

trashingUser

object ( User )

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

thumbnailVersion

string ( int64 format)

فقط خروجی. نسخه تصویر بندانگشتی برای استفاده در نامعتبرسازی حافظه پنهان تصویر بندانگشتی.

trashedTime

string

فقط خروجی. زمانی که آیتم حذف شده است ( تاریخ-زمان RFC 3339 ). فقط برای آیتم‌های موجود در درایوهای مشترک پر می‌شود.

modifiedByMe

boolean

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

imageMediaMetadata

object

فقط خروجی. فراداده‌های اضافی در مورد رسانه‌های تصویری، در صورت وجود.

imageMediaMetadata.flashUsed

boolean

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

imageMediaMetadata.meteringMode

string

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

imageMediaMetadata.sensor

string

فقط خروجی. نوع حسگری که برای ایجاد عکس استفاده شده است.

imageMediaMetadata.exposureMode

string

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

imageMediaMetadata.colorSpace

string

فقط خروجی. فضای رنگی عکس.

imageMediaMetadata.whiteBalance

string

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

imageMediaMetadata.width

integer

فقط خروجی. عرض تصویر بر حسب پیکسل.

imageMediaMetadata.height

integer

فقط خروجی. ارتفاع تصویر بر حسب پیکسل.

imageMediaMetadata.location

object

فقط خروجی. اطلاعات موقعیت جغرافیایی ذخیره شده در تصویر.

imageMediaMetadata.location.latitude

number

فقط خروجی. عرض جغرافیایی ذخیره شده در تصویر.

imageMediaMetadata.location.longitude

number

فقط خروجی. طول جغرافیایی ذخیره شده در تصویر.

imageMediaMetadata.location.altitude

number

فقط خروجی. ارتفاع ذخیره شده در تصویر.

imageMediaMetadata.rotation

integer

فقط خروجی. تعداد چرخش‌های ۹۰ درجه‌ای در جهت عقربه‌های ساعت که از جهت اصلی تصویر اعمال می‌شوند.

imageMediaMetadata.time

string

فقط خروجی. تاریخ و زمان گرفته شدن عکس (EXIF DateTime).

imageMediaMetadata.cameraMake

string

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

imageMediaMetadata.cameraModel

string

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

imageMediaMetadata.exposureTime

number

فقط خروجی. مدت زمان نوردهی، بر حسب ثانیه.

imageMediaMetadata.aperture

number

فقط خروجی. دیافراگمی که برای ایجاد عکس استفاده شده است (عدد f).

imageMediaMetadata.focalLength

number

فقط خروجی. فاصله کانونی مورد استفاده برای ایجاد عکس، بر حسب میلی‌متر.

imageMediaMetadata.isoSpeed

integer

فقط خروجی. سرعت ISO مورد استفاده برای ایجاد عکس.

imageMediaMetadata.exposureBias

number

فقط خروجی. بایاس نوردهی عکس (مقدار APEX).

imageMediaMetadata.maxApertureValue

number

فقط خروجی. کوچکترین عدد f لنز در فاصله کانونی مورد استفاده برای ایجاد عکس (مقدار APEX).

imageMediaMetadata.subjectDistance

integer

فقط خروجی. فاصله تا سوژه عکس، بر حسب متر.

imageMediaMetadata.lens

string

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

videoMediaMetadata

object

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

videoMediaMetadata.width

integer

فقط خروجی. عرض ویدیو بر حسب پیکسل.

videoMediaMetadata.height

integer

فقط خروجی. ارتفاع ویدیو بر حسب پیکسل.

videoMediaMetadata.durationMillis

string ( int64 format)

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

shortcutDetails

object

جزئیات فایل میانبر. فقط برای فایل‌های میانبری که فیلد mimeType آنها روی application/vnd.google-apps.shortcut تنظیم شده است، پر می‌شود. فقط می‌توان آن را روی درخواست‌های files.create تنظیم کرد.

shortcutDetails.targetId

string

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

shortcutDetails.targetMimeType

string

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

shortcutDetails.targetResourceKey

string

فقط خروجی. resourceKey برای فایل هدف.

resourceKey

string

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

linkShareMetadata.securityUpdateEligible

boolean

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

linkShareMetadata.securityUpdateEnabled

boolean

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

labelInfo

object

فقط خروجی. مروری بر برچسب‌های روی فایل.

labelInfo.labels[]

object ( Label )

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

sha1Checksum

string

فقط خروجی. در صورت وجود، مجموع بررسی SHA1 مرتبط با این فایل. این فیلد فقط برای فایل‌هایی که محتوای آنها در Google Drive ذخیره شده است، پر می‌شود؛ برای ویرایشگرهای اسناد یا فایل‌های میانبر پر نمی‌شود.

sha256Checksum

string

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

inheritedPermissionsDisabled

boolean

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

downloadRestrictions

object ( DownloadRestrictionsMetadata )

محدودیت‌های دانلود روی فایل اعمال شده است.

محدودیت محتوا

محدودیتی برای دسترسی به محتوای فایل.

نمایش JSON
{
  "readOnly": boolean,
  "reason": string,
  "type": string,
  "restrictingUser": {
    object (User)
  },
  "restrictionTime": string,
  "ownerRestricted": boolean,
  "systemRestricted": boolean
}
فیلدها
readOnly

boolean

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

reason

string

دلیل محدود شدن محتوای فایل. این مورد فقط در درخواست‌هایی که readOnly=true نیز تنظیم شده باشد، قابل تغییر است.

type

string

فقط خروجی. نوع محدودیت محتوا. در حال حاضر تنها مقدار ممکن globalContentRestriction است.

restrictingUser

object ( User )

فقط خروجی. کاربری که محدودیت محتوا را تنظیم کرده است. فقط در صورتی که readOnly=true ، مقداردهی می‌شود.

restrictionTime

string

فقط خروجی. زمانی که محدودیت محتوا اعمال شده است (با فرمت تاریخ-زمان RFC 3339 ). فقط در صورتی که readOnly=true ، مقداردهی می‌شود.

ownerRestricted

boolean

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

systemRestricted

boolean

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

محدودیت‌های دانلودفراداده

محدودیت‌های دانلود روی فایل اعمال شده است.

نمایش JSON
{
  "itemDownloadRestriction": {
    object (DownloadRestriction)
  },
  "effectiveDownloadRestrictionWithContext": {
    object (DownloadRestriction)
  }
}
فیلدها
itemDownloadRestriction

object ( DownloadRestriction )

محدودیت دانلود فایل مستقیماً توسط مالک یا سازمان‌دهنده اعمال می‌شود. این محدودیت تنظیمات درایو مشترک یا قوانین DLP را در نظر نمی‌گیرد.

effectiveDownloadRestrictionWithContext

object ( DownloadRestriction )

فقط خروجی. محدودیت دانلود مؤثر اعمال شده بر این فایل. این مورد تمام تنظیمات محدودیت و قوانین DLP را در نظر می‌گیرد.

محدودیت دانلود

محدودیتی برای کپی و دانلود فایل.

نمایش JSON
{
  "restrictedForReaders": boolean,
  "restrictedForWriters": boolean
}
فیلدها
restrictedForReaders

boolean

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

restrictedForWriters

boolean

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

روش‌ها

copy

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

create

یک فایل ایجاد می‌کند.

delete

فایلی که متعلق به کاربر است را بدون انتقال به سطل زباله، به طور دائم حذف می‌کند.

download

محتوای یک فایل را دانلود می‌کند.

emptyTrash

تمام فایل‌های حذف‌شده‌ی کاربر را به‌طور دائم حذف می‌کند.

export

یک سند Google Workspace را به نوع MIME درخواستی صادر می‌کند و محتوای بایت صادر شده را برمی‌گرداند.

generateIds

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

get

فراداده یا محتوای یک فایل را بر اساس شناسه (ID) آن دریافت می‌کند.

list

فایل‌های کاربر را فهرست می‌کند.

listLabels

برچسب‌های روی یک فایل را فهرست می‌کند.

modifyLabels

مجموعه برچسب‌های اعمال شده روی یک فایل را تغییر می‌دهد.

update

فراداده، محتوای یا هر دوی یک فایل را به‌روزرسانی می‌کند.

watch

تغییرات اعمال شده در یک فایل را تایید می‌کند.