REST Resource: files

منبع: فایل

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

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

نمایش JSON
{
  "ownerNames": [
    string
  ],
  "exportLinks": {
    string: string,
    ...
  },
  "parents": [
    {
      object (ParentReference)
    }
  ],
  "owners": [
    {
      object (User)
    }
  ],
  "openWithLinks": {
    string: string,
    ...
  },
  "properties": [
    {
      object (Property)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "spaces": [
    string
  ],
  "permissionIds": [
    string
  ],
  "contentRestrictions": [
    {
      object (ContentRestriction)
    }
  ],
  "kind": string,
  "userPermission": {
    object (Permission)
  },
  "fileExtension": string,
  "md5Checksum": string,
  "selfLink": string,
  "lastModifyingUserName": string,
  "editable": boolean,
  "writersCanShare": boolean,
  "downloadUrl": string,
  "mimeType": string,
  "driveId": string,
  "thumbnailLink": string,
  "appDataContents": boolean,
  "webViewLink": string,
  "iconLink": string,
  "shared": boolean,
  "lastModifyingUser": {
    object (User)
  },
  "defaultOpenWithLink": string,
  "headRevisionId": string,
  "copyable": boolean,
  "etag": string,
  "sharingUser": {
    object (User)
  },
  "alternateLink": string,
  "embedLink": string,
  "webContentLink": string,
  "fileSize": string,
  "copyRequiresWriterPermission": boolean,
  "hasThumbnail": boolean,
  "folderColorRgb": string,
  "id": string,
  "title": string,
  "description": string,
  "labels": {
    "viewed": boolean,
    "restricted": boolean,
    "starred": boolean,
    "hidden": boolean,
    "trashed": boolean,
    "modified": boolean
  },
  "explicitlyTrashed": boolean,
  "createdDate": string,
  "modifiedDate": string,
  "modifiedByMeDate": string,
  "lastViewedByMeDate": string,
  "markedViewedByMeDate": string,
  "sharedWithMeDate": string,
  "quotaBytesUsed": string,
  "version": string,
  "indexableText": {
    "text": string
  },
  "originalFilename": string,
  "ownedByMe": boolean,
  "canComment": boolean,
  "shareable": boolean,
  "fullFileExtension": string,
  "isAppAuthorized": boolean,
  "teamDriveId": string,
  "capabilities": {
    "canChangeRestrictedDownload": 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
  },
  "hasAugmentedPermissions": boolean,
  "trashingUser": {
    object (User)
  },
  "canReadRevisions": boolean,
  "thumbnailVersion": string,
  "trashedDate": string,
  "thumbnail": {
    "image": string,
    "mimeType": string
  },
  "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,
    "date": 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
}
فیلدها
ownerNames[]

string

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

parents[]

object ( ParentReference )

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

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

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

owners[]

object ( User )

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

properties[]

object ( Property )

فهرست املاک.

permissions[]

object ( Permission )

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

spaces[]

string

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

permissionIds[]

string

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

contentRestrictions[]

object ( ContentRestriction )

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

kind

string

فقط خروجی. نوع فایل. این همیشه drive#file است.

userPermission

object ( Permission )

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

fileExtension

string

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

md5Checksum

string

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

lastModifyingUserName

string

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

editable
(deprecated)

boolean

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

writersCanShare

boolean

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

downloadUrl

string

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

mimeType

string

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

driveId

string

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

appDataContents

boolean

فقط خروجی. اینکه آیا این فایل در پوشه Application Data قرار دارد یا خیر.

shared

boolean

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

lastModifyingUser

object ( User )

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

headRevisionId

string

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

copyable
(deprecated)

boolean

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

etag

string

فقط خروجی. ETag فایل.

sharingUser

object ( User )

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

fileSize

string ( int64 format)

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

copyRequiresWriterPermission

boolean

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

hasThumbnail

boolean

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

folderColorRgb

string

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

id

string

شناسه فایل.

title

string

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

description

string

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

labels

object

گروهی از برچسب‌ها برای فایل.

labels.viewed

boolean

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

labels.restricted
(deprecated)

boolean

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

labels.starred

boolean

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

labels.hidden
(deprecated)

boolean

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

labels.trashed

boolean

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

labels.modified

boolean

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

explicitlyTrashed

boolean

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

createdDate

string

فقط خروجی. برای این فایل زمان ایجاد کنید (با فرمت برچسب زمانی RFC 3339).

modifiedDate

string

آخرین باری که این فایل توسط کسی تغییر داده شده است (با فرمت RFC 3339 timestamp). این فقط در هنگام به‌روزرسانی و با تنظیم پارامتر setModifiedDate قابل تغییر است.

modifiedByMeDate

string

فقط خروجی. آخرین باری که این فایل توسط کاربر تغییر داده شده است (با فرمت RFC 3339 timestamp). توجه داشته باشید که تنظیم modifiedDate، تاریخ modifiedByMe را برای کاربری که تاریخ را تنظیم کرده است، نیز به‌روزرسانی می‌کند.

lastViewedByMeDate

string

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

markedViewedByMeDate
(deprecated)

string

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

sharedWithMeDate

string

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

quotaBytesUsed

string ( int64 format)

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

version

string ( int64 format)

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

indexableText

object

ویژگی‌های متنی قابل فهرست‌بندی برای فایل (فقط قابل نوشتن)

indexableText.text

string

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

originalFilename

string

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

ownedByMe

boolean

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

canComment
(deprecated)

boolean

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

shareable
(deprecated)

boolean

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

fullFileExtension

string

فقط خروجی. پسوند کامل فایل؛ از عنوان استخراج می‌شود. ممکن است شامل چندین پسوند به هم پیوسته، مانند "tar.gz" باشد. حذف یک پسوند از عنوان، این فیلد را پاک نمی‌کند؛ با این حال، تغییر پسوند عنوان، این فیلد را به‌روزرسانی می‌کند. این فیلد فقط برای فایل‌هایی با محتوای ذخیره شده در گوگل درایو پر می‌شود؛ برای ویرایشگرهای اسناد یا فایل‌های میانبر پر نمی‌شود.

isAppAuthorized

boolean

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

teamDriveId
(deprecated)

string

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

capabilities

object

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

capabilities.canChangeRestrictedDownload
(deprecated)

boolean

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

capabilities.canMoveChildrenOutOfDrive

boolean

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

capabilities.canReadDrive

boolean

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

capabilities.canEdit

boolean

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

capabilities.canCopy

boolean

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

capabilities.canComment

boolean

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

capabilities.canAddChildren

boolean

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

capabilities.canDelete

boolean

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

capabilities.canDownload

boolean

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

capabilities.canListChildren

boolean

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

capabilities.canRemoveChildren

boolean

فقط خروجی. اینکه آیا کاربر فعلی می‌تواند فرزندان را از این پوشه حذف کند یا خیر. وقتی مورد پوشه نباشد، این مقدار همیشه نادرست است. برای پوشه‌ای در یک درایو مشترک، به جای آن 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

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

capabilities.canModifyContentRestriction
(deprecated)

boolean

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

capabilities.canAddFolderFromAnotherDrive

boolean

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

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

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

hasAugmentedPermissions

boolean

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

trashingUser

object ( User )

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

canReadRevisions
(deprecated)

boolean

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

thumbnailVersion

string ( int64 format)

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

trashedDate

string

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

thumbnail

object

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

thumbnail.image

string ( bytes format)

بایت‌های تصویر بندانگشتی که با کد Base64 و از طریق URL رمزگذاری شده‌اند. این کد باید با بخش ۵ از RFC 4648 مطابقت داشته باشد.

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

thumbnail.mimeType

string

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

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.date

string

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

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.insert تنظیم کرد.

shortcutDetails.targetId

string

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

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 مرتبط با این فایل. این فیلد فقط برای فایل‌هایی که محتوای آنها در گوگل درایو ذخیره شده است، پر می‌شود؛ برای ویرایشگرهای اسناد یا فایل‌های میانبر پر نمی‌شود.

sha256Checksum

string

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

inheritedPermissionsDisabled

boolean

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

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

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

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

boolean

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

reason

string

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

type

string

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

restrictingUser

object ( User )

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

restrictionDate

string

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

ownerRestricted

boolean

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

systemRestricted

boolean

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

روش‌ها

copy

یک کپی از فایل مشخص شده ایجاد می‌کند.

delete

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

emptyTrash

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

export

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

generateIds

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

get

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

insert

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

list

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

listLabels

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

modifyLabels

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

patch

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

touch

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

trash

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

untrash

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

update

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

watch

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