Box開発者向けドキュメントポータル
ログイン

ウェブリンク

ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。

ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。

基本
簡易
標準

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、標準バリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

string
1

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

string
11446498

このオブジェクトの一意の識別子

string
web_link

web_link

次の値のいずれか1つ: file,folder,web_link,web_link

string
My Bookmark

ウェブリンクの名前

string
3

この項目に適用された最新のユーザーイベントを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるユーザーイベントを除外できます。

たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するユーザーイベントの発生を監視する場合などがこれに該当します。ユーザーイベントのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなユーザーイベントをすべて無視します。

string
https://www.example.com/example/1234

このウェブリンクが指すURL

string / date-time
2012-12-12T10:53:43-08:00

このファイルがBoxのサーバー上に作成された日時。

User (Mini) object

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

string
Example page

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

string
active

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

次の値のいずれか1つ: active,trashed,deleted

string / date-time
2012-12-12T10:53:43-08:00

このファイルがBoxサーバー上で最後に更新された日時。

User (Mini) object

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

User (Mini) object

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

Folder (Mini) object

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

Folder (Mini) array

ルートを起点にした、このリンクまでのフォルダのパス

string / date-time
2012-12-12T10:53:43-08:00

このファイルが完全に削除される日時。

object

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

string
open

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

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

共有リンクの作成時にこのフィールドを省略した場合は、 エンタープライズ管理者によって指定されたデフォルトのアクセスレベルに設定されます。

次の値のいずれか1つ: open,company,collaborators

integer
3

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

string / url
https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg

ファイルをダウンロードするために使用できるURL。 このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。

フォルダの場合、このプロパティはnullになります。

string
company

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

次の値のいずれか1つ: open,company,collaborators

string
can_download

この共有リンクの実際の権限。

次の値のいずれか1つ: can_download,can_preview

boolean
true

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

object

このリンクを通じてユーザーが項目のプレビューとダウンロードを行うことを許可するかどうかを定義します。

boolean
true

共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。 フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

実際のアクセスレベルがcollaboratorsではなく、openまたはcompanyに設定されている場合は、 この値をtrueに設定できます。

boolean
true

共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。

この値は常にtrueです。フォルダの共有リンクの場合、 この設定はフォルダ内のすべての項目にも適用されます。

integer
3

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

string / date-time
2018-04-13T13:53:23-07:00

このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。

string / url
https://www.box.com/s/vspke7y05sb214wjokpk

Box上の項目にアクセスするために使用できるURL。

このURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。

このURLは、この共有リンクに対してカスタムのvanity_urlが 設定されている場合でも動作します。

string / url
https://acme.app.box.com/v/my_url/

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

string / date-time
2012-12-12T10:53:43-08:00

このファイルが最後にごみ箱に移動された日時。

詳細

レスポンスの例

{
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "description": "Example page",
  "etag": 1,
  "id": 11446498,
  "item_status": "active",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "parent": {
    "etag": 1,
    "id": 12345,
    "name": "Contracts",
    "sequence_id": 3,
    "type": "folder"
  },
  "path_collection": [
    {
      "id": 12345,
      "etag": 1,
      "type": "folder",
      "sequence_id": 3,
      "name": "Contracts"
    }
  ],
  "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_preview": true
    },
    "preview_count": 3,
    "unshared_at": "2018-04-13T13:53:23-07:00",
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "vanity_url": "https://acme.app.box.com/v/my_url/"
  },
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "type": "web_link",
  "url": "https://www.example.com/example/1234"
}