PATCH/users/{userId}/drive/files/{fileId}/link

マイドライブのファイルのリンク共有を変更する。
アクセスタイプ accessType は、ANYONE と ORGANIZATION の間でのみ変更できる。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

file

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/users/{userId}/drive/files/{fileId}/link

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{externalKey})
  • 自身 ("me")

required
example : me 
fileId string 

ファイル ID


required
example : NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
accessType string 

リンク共有範囲

  • ORGANIZATION: 社内メンバー
  • SPECIFIC_PEOPLE: 許可した人のみ (OTP 認証)
  • ANYONE: 誰でもアクセス可能

Allowed values : ORGANIZATION, SPECIFIC_PEOPLE, ANYONE 
linkPermissionType string 

リンク権限タイプ
リンクを通してアクセスする場合、与えられた権限範囲での操作のみ行えます。

  • EDIT: 編集 (移動、削除、復元 等)、アップロード/コピー (上書き可能)、ダンロード、閲覧
  • UPLOAD_DOWNLOAD: アップロード/コピー (上書き不可)、ダンロード、閲覧
  • UPLOAD: アップロード/コピー (上書き不可)、閲覧
  • DOWNLOAD: ダンロード、閲覧
  • PREVIEW: 閲覧

Allowed values : EDIT, UPLOAD_DOWNLOAD, UPLOAD, DOWNLOAD, PREVIEW 
expirationTime string 

リンクの有効期限 (有効期限を削除する場合には明示的に NULL を指定)
ISO-8601 形式 : YYYY-MM-DDThh:mm:ssTZD

 
password string 

パスワード
アクセスタイプが ANYONE の場合のみ設定可能

注意
4〜16字の英数字、特殊文字で指定。
利用できる特殊文字 : $ ₩ ` - ~ ! @ : ; % ^ & = \ " ' , _ * + | ( ) { } [ ] . ? < > / #

 
specificPeople array (string) 

許可した人のみアクセス可能 (OTP 認証) なリンクのアクセス可能ユーザーリスト

 

Request Example

example

1{2  "accessType": "SPECIFIC_PEOPLE",3  "linkPermissionType": "PREVIEW",4  "expirationTime": "2020-12-16T19:40:15.15+09:00",5  "specificPeople": [6    "abc@example.com",7    "bcd@example.com"8  ]9}

Response

HTTP 200

OK

PropertyTypeDescription
accessType string 

リンク共有範囲

  • ORGANIZATION: 社内メンバー
  • SPECIFIC_PEOPLE: 許可した人のみ (OTP 認証)
  • ANYONE: 誰でもアクセス可能

Allowed values : ORGANIZATION, SPECIFIC_PEOPLE, ANYONE 
hasPassword boolean 

リンクのアクセスパスワードの有無

 
linkPermissionType string 

リンク権限タイプ
リンクを通してアクセスする場合、与えられた権限範囲での操作のみ行えます。

  • EDIT: 編集 (移動、削除、復元 等)、アップロード/コピー (上書き可能)、ダンロード、閲覧
  • UPLOAD_DOWNLOAD: アップロード/コピー (上書き不可)、ダンロード、閲覧
  • UPLOAD: アップロード/コピー (上書き不可)、閲覧
  • DOWNLOAD: ダンロード、閲覧
  • PREVIEW: 閲覧

Allowed values : EDIT, UPLOAD_DOWNLOAD, UPLOAD, DOWNLOAD, PREVIEW 
linkUrl string 

リンク URL


readOnly : true 
createdTime string 

リンク作成時刻


readOnly : true 
expirationTime string 

リンク有効期限 (有効期限がない場合には null)


nullable : true 
specificPeople array (string) 

許可した人のみアクセス可能 (OTP 認証) なリンクのアクセス可能ユーザーリスト


nullable : true 

Response Example

example

1{2  "accessType": "SPECIFIC_PEOPLE",3  "hasPassword": false,4  "linkUrl": "https://works.do/xzO8Bv",5  "createdTime": "2024-10-10T09:18:24+09:00",6  "expirationTime": "2024-10-17T09:18:24+09:00",7  "linkPermissionType": "EDIT",8  "specificPeople": [9    "abc@example.com"10  ]11}