ウェブリンク - Box Dev Docs

APIバージョン 2024.0 ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string

例 11446498このウェブリンクの一意の識別子。

type

string

例 web_link値は常にweb_linkになります。次の値に固定: web_link

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルがBoxのサーバー上に作成された日時。

created_by

ユーザー (Mini)object

このウェブリンクを作成したユーザー。

description

string

例 Example pageウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。

etag

string

例 1このウェブリンクのエンティティタグ。If-Matchヘッダーで使用します。

item_status

string

例 activeこの項目が削除されたかどうか。値には、active、trashed (ファイルがごみ箱に移動された場合)、deleted (ファイルが完全に削除された場合) があります。次の値のいずれか1つ: active,trashed,deleted

modified_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルがBoxサーバー上で最後に更新された日時。

modified_by

ユーザー (Mini)object

このウェブリンクを最後に変更したユーザー。

name

string

例 My Bookmarkウェブリンクの名前。

owned_by

ユーザー (Mini)object

このウェブリンクを所有するユーザー。

parent

フォルダ (Mini)object

ウェブリンクが属する親オブジェクト。

path_collection

object

ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。

表示子属性

entries

フォルダ (Mini)array

この項目の親フォルダ。

total_count

integer(int64)

例 1このリスト内のフォルダの数。

purged_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルが完全に削除される日時。

sequence_id

string

例 3この項目に適用された最新のUser Eventを表す数値の識別子。これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。

shared_link

object

この項目の共有リンクオブジェクト。共有リンクがまだ作成されていない場合は、nullになります。

表示子属性

access

string

例 openこの共有リンクのアクセスレベル

open - このリンクを知っている全員にこの項目へのアクセスを許可します
company - 同じ会社のユーザーにのみこの項目へのアクセスを許可します
collaborators - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します

共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。次の値のいずれか1つ: open,company,collaborators

download_count

integer

例 3この項目がダウンロードされた回数。

download_url

string(url)

例 https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpegファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。フォルダの場合、このプロパティはnullになります。

effective_access

string

例 company共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、accessフィールドの値よりも低いアクセスレベルになることがあります。次の値のいずれか1つ: open,company,collaborators

effective_permission

string

例 can_downloadこの共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。次の値のいずれか1つ: can_edit,can_download,can_preview,no_access

is_password_enabled

boolean

例 true共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。

permissions

object

このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。

表示子属性

can_download

boolean

例 true共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。実際のアクセスレベルがcollaboratorsではなく、openまたはcompanyに設定されている場合は、この値をtrueに設定できます。

can_edit

boolean

例 false共有リンクからの項目の編集を許可するかどうかを定義します。can_downloadがtrueで、項目のタイプがfileの場合のみ、この値もtrueに設定できます。

can_preview

boolean

例 true共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。この値は常にtrueです。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

preview_count

integer

例 3この項目がプレビューされた回数。

unshared_at

string(date-time)

例 2018-04-13T13:53:23-07:00このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。

url

string(url)

例 https://www.box.com/s/vspke7y05sb214wjokpkBox上の項目にアクセスするために使用できるURL。このURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。このURLは、この共有リンクに対してカスタムのvanity_urlが設定されている場合でも動作します。

vanity_name

string

例 my_urlvanity_urlフィールドで使用される、共有リンクのカスタム名。

vanity_url

string(url)

例 https://acme.app.box.com/v/my_url/Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。

trashed_at

string(date-time)

例 2012-12-12T10:53:43-08:00このファイルがごみ箱に移動された日時。

url

string

例 https://www.example.com/example/1234このウェブリンクが指すURL。

{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "description": "Example page",
  "etag": "1",
  "item_status": "active",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "shared_link": {
    "access": "open",
    "download_count": 3,
    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
    "effective_access": "company",
    "effective_permission": "can_download",
    "is_password_enabled": true,
    "permissions": {
      "can_download": true,
      "can_edit": false,
      "can_preview": true
    },
    "preview_count": 3,
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "vanity_name": "my_url",
    "vanity_url": "https://acme.app.box.com/v/my_url/"
  },
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "url": "https://www.example.com/example/1234"
}