コンテンツを検索

get
https://api.box.com/2.0
/search/

ユーザーのコンテンツまたは会社全体でファイル、フォルダ、ウェブリンク、および共有ファイルを検索します。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

stringクエリ内省略可能
file

このタイプの項目に検索結果を絞り込みます。このパラメータが受け取る値は1つだけです。デフォルトでは、このAPIによって、以下のいずれかのタイプと一致する項目が返されます。

  • file - 検索結果をファイルに絞り込みます。
  • folder - 検索結果をフォルダに絞り込みます。
  • web_link - 検索結果をウェブリンク (ブックマークとも呼ばれます) に絞り込みます。

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

string arrayクエリ内省略可能
4535234,234123235,2654345

フォルダIDのカンマ区切りリストとして定義された、指定したフォルダリスト内の項目のみに検索結果を絞り込みます。

検索結果には、これらの先祖フォルダのサブフォルダ内の項目も含まれます。

フォルダは現在認証されているユーザーによって所有または共有されている必要もあることに注意してください。このユーザーがフォルダにアクセスできない場合、またはフォルダがない場合は、代わりにHTTP 404エラーコードが返されます。

会社全体で検索するには、サポートチームにリクエスト可能なenterprise_contentスコープパラメータを使用することをお勧めします。

string arrayクエリ内省略可能
name,description

ファイルの説明など、ファイルの特定の部分に対する検索クエリと一致する項目のみに検索結果を絞り込みます。

コンテンツタイプの定義には、Boxで認識されるコンテンツタイプのカンマ区切りリストを使用します。許可されるコンテンツタイプは以下のとおりです。

  • name - nameフィールドで定義されている、項目の名前。
  • description - descriptionフィールドで定義されている、項目の説明。
  • file_content - ファイルの実際のコンテンツ。
  • comments - ファイルまたはフォルダに対するコメントのコンテンツ。
  • tag - tagフィールドで定義されている、項目に適用されるタグ。
string arrayクエリ内省略可能
2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00

指定した日付範囲内に作成されたすべての項目に検索結果を絞り込みます。

日付範囲はカンマ区切りのRFC3339タイムスタンプとして定義されます。

開始日が省略されている場合 (,2014-05-17T13:35:01-07:00)、終了日より前に作成された項目がすべて返されます。

終了日が省略されている場合 (2014-05-15T13:35:01-07:00,)、代わりに現在の日付が終了日として使用されます。

stringクエリ内省略可能
ASC"DESC"

検索結果の並べ替えの方向を定義します。このパラメータが明示的に指定されていない限り、このAPIはデフォルトで、降順 (DESC) で項目を返します。

結果がrelevanceを基準にして並べ替えられると、関連性の降順で項目が返されるよう並べ替えはロックされ、このパラメータは無視されます。

次の値のいずれか1つ: DESC,ASC

string arrayクエリ内省略可能
id,type,name

応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

string arrayクエリ内省略可能
pdf,png,gif

指定したファイル拡張子のいずれかと一致するファイルのみに検索結果を絞り込みます。このリストは、ドットなしのファイル拡張子のカンマ区切りリストです。

integer / int64クエリ内省略可能
10030200

結果ページの一部として返す項目の最大数を定義します。

メタデータフィルタ arrayクエリ内省略可能
[{"scope":"enterprise","templateKey":"contract","filters":{"category":"online"}}]

検索結果のフィルタに使用するメタデータテンプレートのリスト。

queryパラメータが定義されていない場合は必須です。

integer / int64クエリ内省略可能
10000

応答が開始される項目のオフセット。

string arrayクエリ内省略可能
123422,23532,3241212

指定した所有者リスト (ユーザーIDのカンマ区切りリストとして定義) によって所有される項目のみに検索結果を絞り込みます。

検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要もあることに注意してください。いずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。

会社全体で検索するには、サポートチームにリクエスト可能なenterprise_contentスコープパラメータを使用することをお勧めします。

stringクエリ内省略可能
sales

検索する文字列。このクエリは、項目名、説明、ファイルのテキストコンテンツなど、さまざまな項目タイプのフィールドと照合されます。

このパラメータでは、返された結果をさらに絞り込むためのさまざまな演算子がサポートされます。

  • "" - クエリを二重引用符で囲むと、APIによって完全一致のみが返されます。完全一致検索では、特定の文字の並びに基づいた検索結果は返されません。代わりに、フレーズ (つまり、単語の並び) に基づいた一致が返されます。たとえば、"Blue-Box"を検索すると、"blue.box""Blue Box""Blue-Box"などの並びを含む、検索結果が返されます。つまり、BlueおよびBoxという単語が指定した順序で連続して含まれている項目です。
  • AND - 両方の検索用語を含む項目が返されます。たとえば、marketing AND BoxWorksを検索すると、marketingBoxWorksの両方が任意の順番でテキストに含まれている項目が返されます。テキストにBoxWorksのみが含まれる結果は返されません。
  • OR - 検索用語のいずれかを含む項目が返されます。たとえば、marketing OR BoxWorksを検索すると、marketingBoxWorksのいずれかがテキストに含まれている結果が返されます。サポートされている別のブール条件が使用されている場合を除き、複数語のクエリは暗黙的にORとして解釈されるため、この演算子の使用は必須ではありません。
  • NOT - 指定された検索用語が含まれていない項目が返されます。たとえば、marketing AND NOT BoxWorksを検索すると、テキストにmarketingのみが含まれている結果が返され、BoxWorksが含まれる結果は省略されます。

小文字の演算子 (andornot) および大文字と小文字を組み合わせた演算子 (AndOrおよびNot) はサポートされていないことに注意してください。

このフィールドは、mdfiltersパラメータが定義されていない場合に必須です。

stringクエリ内省略可能
user_content"user_content"

ユーザーがアクセスできるファイルまたは会社全体で利用可能なファイルに検索結果を絞り込みます。

スコープは、デフォルトでuser_contentに設定されます。これにより、検索結果は、現在認証されているユーザーが使用できるコンテンツに絞り込まれます。

enterprise_contentは、管理者がサポートチャネルを通じてリクエストできます。このスコープがユーザーに対して有効になっていると、そのユーザーは、アクセスできるコンテンツだけでなく、会社全体のコンテンツに対してクエリを実行できます。

次の値のいずれか1つ: user_content,enterprise_content

integer arrayクエリ内省略可能
1000000,5000000

特定のファイルサイズ範囲内のサイズの項目に検索結果を絞り込みます。これはファイルとフォルダに適用されます。

サイズ範囲は、バイトサイズの下限と上限 (下限と上限も含む) のカンマ区切りリストとして定義します。

上限または下限を省略すると、上限または下限のないサイズ範囲を指定できます。

stringクエリ内省略可能
modified_at"relevance"

結果が返される順序を定義します。このパラメータが明示的に指定されていない限り、このAPIはデフォルトで、関連性を基準として項目を返します。

  • relevance (デフォルト) を指定すると、クエリの検索語との関連性を基準として並べ替えられた結果が返されます。関連性は、項目の名前、説明、コンテンツ、およびその他のプロパティでの検索語の出現回数に基づきます。
  • modified_atを指定すると、項目が最後に変更された日付を基準にして降順で並べ替えられた結果が返されます。

次の値のいずれか1つ: modified_at,relevance

stringクエリ内省略可能
non_trashed_only"non_trashed_only"

検索時にごみ箱で項目を探すかどうかを決定します。

デフォルトでは、このAPIで返されるのは、現在ごみ箱にない項目の検索結果のみです (non_trashed_only)。

  • trashed_only - 現在ごみ箱にある項目のみを検索します。
  • non_trashed_only - 現在ごみ箱にない項目のみを検索します。

次の値のいずれか1つ: non_trashed_only,trashed_only

string arrayクエリ内省略可能
2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00

指定した日付範囲内に更新された項目に検索結果を絞り込みます。

日付範囲はカンマ区切りのRFC3339タイムスタンプとして定義されます。

開始日が省略されている場合 (,2014-05-17T13:35:01-07:00)、終了日より前に更新された項目が返されます。

終了日が省略されている場合 (2014-05-15T13:35:01-07:00,)、代わりに現在の日付が終了日として使用されます。

レスポンス

検索結果のコレクションを返します。一致する検索結果がない場合、entries配列は空になります。

リクエストが無効だった場合にエラーを返します。これには、複数の理由があり、context_infoオブジェクトによって詳細が示されます。

  • missing_parameter - 検索で少なくともqueryまたはmdfiltersクエリパラメータを指定してください。
  • invalid_parameter - いずれかのフィールドの形式に誤りがある可能性があります。たとえば、RFC3339日付のいずれかが正しくないか、整数が想定されている場所に文字列が指定されることを意味します。

このAPI呼び出しを行う権限がユーザーにない場合にエラーを返します。

  • 開発者は、scopeとしてenterprise_contentを指定しましたが、Boxのサポートチャネルを通じて、このスコープをユーザーに対して有効にするようリクエストしませんでした。

ユーザーが、リクエストで取り上げられた項目にアクセスできない場合にエラーを返します。

  • 開発者は、存在しないフォルダIDまたはユーザーがアクセスできないフォルダIDをancestor_folder_idsで指定しました。

予期しないクライアントエラー。

get
コンテンツを検索
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/search?query=sales" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
// Search for PDF or Word documents matching "Meeting Notes"
BoxCollection<BoxItem> results = await client.SearchManager
    .QueryAsync("Meeting Notes", fileExtensions: new { "pdf", "docx" });
Java
// Find the first 10 files matching "taxes"
long offsetValue = 0;
long limitValue = 10;
BoxSearch boxSearch = new BoxSearch(api);
BoxSearchParameters searchParams = new BoxSearchParameters();
searchParams.setQuery("taxes");
searchParams.setType("file");
PartialCollection<BoxItem.Info> searchResults = boxSearch.searchRange(offsetValue, limitValue, searchParams);
Python
items = client.search().query(query='TEST QUERY', limit=100, file_extensions=['pdf', 'doc'])
for item in items:
    print('The item ID is {0} and the item name is {1}'.format(item.id, item.name))
Node
// Search for PDF or Word documents matching "Mobile"
client.search.query(
	'Mobile',
	{
		fields: 'name,modified_at,size,extension,permissions,sync_state',
		file_extensions: 'pdf,doc',
		limit: 200,
		offset: 0
	})
	.then(results => {
		/* results -> {
			total_count: 1,
			entries: 
			[ { type: 'file',
				id: '11111',
				sequence_id: '1',
				etag: '1',
				sha1: 'f89d97c5eea0a68e2cec911s932eca34a52355d2',
				name: 'Box for Sales - Empowering Your Mobile Worker White paper 2pg (External).pdf',
				description: '',
				size: 408979,
				path_collection: 
					{ total_count: 2,
					entries: 
					[ { type: 'folder',
						id: '0',
						sequence_id: null,
						etag: null,
						name: 'All Files' },
						{ type: 'folder',
						id: '22222',
						sequence_id: '1',
						etag: '1',
						name: 'Marketing Active Work' } ] },
				created_at: '2014-05-17T12:59:45-07:00',
				modified_at: '2014-05-17T13:00:20-07:00',
				trashed_at: null,
				purged_at: null,
				content_created_at: '2014-05-17T12:58:58-07:00',
				content_modified_at: '2014-05-17T12:58:58-07:00',
				created_by: 
					{ type: 'user',
					id: '33333',
					name: 'Example User',
					login: 'user@example.com' },
				modified_by: 
					{ type: 'user',
					id: '33333',
					name: 'Example User',
					login: 'user@example.com' },
				owned_by: 
					{ type: 'user',
					id: '33333',
					name: 'Example User',
					login: 'user@example.com' },
				shared_link: null,
				parent: 
					{ type: 'folder',
					id: '22222',
					sequence_id: '1',
					etag: '1',
					name: 'Marketing Active Work' },
				item_status: 'active' } ],
			limit: 200,
			offset: 0 }
		*/
	});
iOS
client.search.query(query: "Quarterly Business Review") { results in
    switch results {
    case let .success(iterator):
        for i in 1 ... 10 {
            iterator.next { result in
                switch result {
                case let .success(item):
                    switch item {
                    case let .file(file):
                        print("- File \(file.name) (ID: \(file.id))")
                    case let .folder(folder):
                        print("- Folder \(file.name) (ID: \(file.id))")
                    case let .webLink(webLink):
                        print("- Web Link \(file.name) (ID: \(file.id))")
                    }
                case let .failure(error):
                    print(error)
                }
            }
        }
    case let .failure(error):
        print(error)
    }
}

レスポンスの例

{
  "entries": [
    {
      "id": 12345,
      "etag": 1,
      "type": "file",
      "sequence_id": 3,
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": 12345,
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "description": "Contract for Q1 renewal",
      "size": 629644,
      "path_collection": {
        "total_count": 1,
        "entries": [
          {
            "id": 12345,
            "etag": 1,
            "type": "folder",
            "sequence_id": 3,
            "name": "Contracts"
          }
        ]
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "trashed_at": "2012-12-12T10:53:43-08:00",
      "purged_at": "2012-12-12T10:53:43-08:00",
      "content_created_at": "2012-12-12T10:53:43-08:00",
      "content_modified_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "modified_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "owned_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "shared_link": {
        "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
        "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
        "vanity_url": "https://acme.app.box.com/v/my_url/",
        "vanity_name": "my_url",
        "access": "open",
        "effective_access": "company",
        "effective_permission": "can_download",
        "unshared_at": "2018-04-13T13:53:23-07:00",
        "is_password_enabled": true,
        "permissions": {
          "can_download": true,
          "can_preview": true
        },
        "download_count": 3,
        "preview_count": 3
      },
      "parent": {
        "id": 12345,
        "etag": 1,
        "type": "folder",
        "sequence_id": 3,
        "name": "Contracts"
      },
      "item_status": "active"
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "total_count": 5000
}