i
マイポケット API リファレンス
第 1.3 版
2016 年 3 月 30 日
ii 改版履歴 日付 版 変更内容 2014/7/10 1.0 初版 2014/12/1 1.1 ・ID 呼称変更に基づく文言変更 MycocoaID⇒ログイン ID ・以下の API の記載を変更 タグ一覧取得 API 人物一覧取得 API ファイル取得 API ファイル・フォルダ一覧検索 API ・以下の API を追加 ファイル移動 API フォルダ変更 API フォルダ移動 API タグ変更 API タグ削除 API ZIP 作成 API ZIP 進捗結果 API 人物登録 API 人物変更 API 人物削除 API 人物グループ一覧取得 API 人物グループ追加 API 人物グループ取得 API 人物グループ変更 API 人物グループ削除 API ・その他 文言修正 2015/5/14 1.2 以下の API の記載を変更 ファイル・フォルダ一覧検索 API 2016/3/30 1.3 以下の API の記載を変更 ファイル取得 API ファイル・フォルダー一覧検索 API タグ一覧取得 API タグ変更 API
iii
目次
1. 認証 ... 4 1.1. WSSE 認証 ... 4 1.2. トークン認証 ... 4 1.2.1. マイポケット認証シーケンス ... 5 2. リクエストについて ... 5 2.1. Content-Type ... 5 2.2. Content-Length ... 5 3. レスポンスについて ... 6 3.1. 正常時 ... 6 3.2. 異常時 ... 7 3.3. その他 ... 8 4. マイポケットについて ... 9 4.1.1. ユーザ領域 ... 9 4.2. 各領域で可能な操作 ... 10 5. マイポケット API ... 11 5.1. トークン払い出し API ... 11 5.2. ファイル登録 API ... 13 5.3. ファイル取得 API ... 17 5.4. ファイルコピーAPI ... 25 5.5. ファイル移動 API ... 27 5.6. ファイル・フォルダ一覧検索 API ... 29 5.7. フォルダ作成 API ... 64 5.8. フォルダ取得 API ... 67 5.9. フォルダ変更 API ... 69 5.10. フォルダ移動 API ... 72 5.11. タグ登録 API ... 74 5.12. タグ一覧取得 API ... 76 5.13. タグ変更 API ... 79 5.14. タグ削除 API ... 83 5.15. シーン分類一覧取得 API ... 83 5.16. ファイルタイプ一覧取得 API ... 86 5.17. ZIP 作成 API ... 88 5.18. ZIP 進捗結果 API ... 90 5.19. 人物一覧取得 API ... 92 5.20. 人物登録 API ... 95 5.21. 人物取得 API ... 98 5.22. 人物変更 API ... 100 5.23. 人物削除 API ... 104 5.24. 人物グループ一覧取得 API ... 105 5.25. 人物グループ追加 API ... 108 5.26. 人物グループ取得 API ... 110 5.27. 人物グループ変更 API ... 112 5.28. 人物グループ削除 API ... 1144
1. 認証
マイポケット API は、WSSE 認証とトークン認証を利用します。
WSSE 認証は、トークン払い出し API のみで利用し、トークン認証は、その他の各 API で利用します。
1.1. WSSE 認証
WSSE 認証を利用する場合は、以下をリクエストヘッダに指定します。
X-WSSE: UsernameToken Username="①", PasswordText="②", AccessKey="③",
UsernameType="④"
※1 「OCN 会員登録証」または「お申込内容のご案内」に記載の 10 桁のお客さま番号またはログイン ID1.2. トークン認証
トークン認証を利用する場合は、以下をリクエストヘッダに指定します。Authorization: Bearer ①
X-Authorization: AccessKey="②"
No 説明 ① マイポケットのログイン ID ※1 ② ①のログイン ID に対応するパスワード ③ Developer Console でアプリケーション登録時に発行されたアクセスキー ④ ①のログイン ID 種別 0：お客さま番号 1：ログイン ID（お客さまが自由に設定することのできる ID） No 説明 ① トークン払い出し API より発行したアクセストークン ② Developer Console のアプリケーション登録時に発行したアクセスキー5
1.2.1. マイポケット認証シーケンス
マイポケット API の利用は以下のシーケンスで行います。 (1) トークン払い出し API（WSSE 認証）リクエスト アプリは、トークン払い出し API （WSSE 認証）を呼び出します。 リクエスト時に、マイポケットのログイン ID、ログイン ID に対応するパスワード、アクセスキーを指定します。 (2) トークン払い出し API レスポンス マイポケットは、トークン払い出し API のレスポンスで、有効期限付きのアクセストークンを払い出します。 (3) 各 API（トークン認証）リクエスト アプリは、必要に応じて各 API（トークン認証）を呼び出します。 リクエスト時に、アクセストークン、アクセスキーを指定します。 (4) 各 API レスポンス マイポケットは、各 API のレスポンスを返却します。 （3）で指定したアクセストークンが有効期限切れの場合、認証エラーを返却します。 その場合は、再度（1）トークン払い出し API を呼び出し、新しいアクセストークンを払い出してください。2. リクエストについて
2.1. Content-Type
リクエストヘッダに Content-Type を付与し、各 API に対応する値を指定してください。指定値は各 API のリ クエストヘッダを参照してください。
2.2. Content-Length
リクエストボディがある場合、リクエストヘッダに Content-Length を付与し、リクエストボディの長さ(byte)を 指定してください。 アプリ マイポケット （1）トークン払い出し API（WSSE 認証）リクエスト （2）トークン払い出し API レスポンス （3）各 API（トークン認証）リクエスト （4）各 API レスポンス6
3. レスポンスについて
3.1. 正常時
正常時は以下のレスポンスコードを返します。 レスポンスパラメータで array 形式の情報を返却する場合、array 形式の情報の件数が 1 件の場合、2 件以 上の場合についてそれぞれ以下の形式でボディを返す。 Array 形式 [files] の情報の件数が 1 件の場合 array 形式 [files] の情報の件数が 2 件以上の場合 No レスポンスコード 説明 1 200 OK GET メソッドでデータ取得に成功したときなど 202 Accepted、204 No Content も 200 OK で返却します。 2 201 Created POST メソッドで新規リソースの作成に成功したときなど { files : { "XXX" : "111", "YYY" : "11111" } } { files : [ { "XXX" : "111", "YYY" : "11111" }, { "XXX" : "222", "YYY" : "22222" } ] }7
3.2. 異常時
異常時は以下のレスポンスコードを返します。 400 Bad Request（エラー1 件）のレスポンスサンプル 400 Bad Request（エラー複数件）のレスポンスサンプル No 説明 ① エラーコード ② エラーメッセージ No レスポンスコード 説明 1 400 Bad Request リクエストパラメータ誤りや既に存在するリソースに POST したなど、リク エストが間違っています。403 Forbidden、405 Method Not Allowed、409 Conflict も 400 Bad Request として返却します。
2 404 Not Found リクエスト先のリソースが存在しません。 3 500 Internal Server Error サーバーで予期せぬエラーが発生しました。
4 503 Service Unavailable サーバーは一時的な過負荷やメンテナンスでレスポンスが返却できませ ん。 HTTP/1.1 400 Bad Request Content-Type: application/json { errors : { "code":"①", "message":"②" } } HTTP/1.1 400 Bad Request Content-Type: application/json { errors : [ {"code":"①", "message":"②"}, {"code":"①", "message":"②"} ] }
8
3.3. その他
正常時、異常時以外の場合は、以下のレスポンスコードを返します。
No レスポンスコード 説明
1 301 Moved Permanently GET メソッドで取得対象となるリソースが恒久的に移動しています。
9
4. マイポケットについて
4.1.1. ユーザ領域
マイポケットでのユーザ領域は、ユーザルートフォルダ内に、ファイル領域、フォト領域、ムービー領域があ り、以下の構造となっております。 ユーザルートフォルダ ├ ファイル領域ルート（ファイル） │├ ストックフォルダ │├ 特殊フォルダ │├ 通常フォルダ ││└ 通常フォルダ │└ 通常フォルダ │ ： ├ フォト領域ルート（フォト） │├ ストックアルバム │├ フォトアルバム │ ： │└ その他アルバム │ └ ムービー領域ルート（ケータイムービー） ├ ストックムービーアルバム ├ ムービーアルバム │ ： └ その他アルバム # 領域 フォルダ 説明 1 ファイル領域 ストックフォルダ デフォルトのフォルダ 通常フォルダ フォルダ作成 API で作成できるフォルダ 特殊フォルダ 特定のアプリケーションによって作成されるフォルダ フォルダによって一部できない操作があり、エラーとなるものがありま す。 2 フォト領域 ストックアルバム デフォルトのフォルダ フォトアルバム フォルダ作成 API で作成できるアルバム その他アルバム デフォルトのフォルダ ファイル領域内のフォト拡張子ファイルを表示します。 3 ムービー領域 ストックムービー アルバム デフォルトのフォルダ ムービーアルバム フォルダ作成 API で作成できるアルバム その他アルバム デフォルトのフォルダ ファイル領域内のムービー拡張子ファイルを表示します。 ファイル領域 フォト領域 ムービー領域10
4.2. 各領域で可能な操作
# 領域 フォルダ 作成 フォルダ内の フォルダ作成 ファイル フォルダ内で扱える 拡張子 アップ ロード ダウン ロード 1 ファイル領域 ストックフォルダ × × 全ての拡張子 ◯ ◯ 通常フォルダ ◯ ◯ ◯ ◯ 特殊フォルダ × △ フォルダによって制限 あり △ △ 2 フォト領域 ストックアルバム × × フォト拡張子のみ jpg,jpeg,jpe,jfif ◯ ◯ フォトアルバム ◯ × ◯ ◯ その他アルバム × × × ◯ 3 ムービー領域 ストックムービー アルバム × × ムービー拡張子のみ avi wmv, asf, avi mp4, m4v, mpg4 3gp, 3g2 mov, moov, qt mpg, mpeg, m2p, m2v ts, m2t, m2ts flv, f4v, f4p, f4a, f4b ◯ ◯ ムービーアルバム ◯ × ◯ ◯ その他アルバム × × × ◯11
5. マイポケット API
5.1. トークン払い出し API
マイポケットの各 API を利用するためのトークン（アクセストークン）を発行します。 発行したトークン（アクセストークン）を利用して、マイポケットの各 API をご利用ください。リクエスト URI
HTTP メソッド：GET 文字コード：UTF-8
https://cocoa.ntt.com/rest/users/v1/token?mode={mode}
No キー 型 必須 説明 サンプル値 1 mode string ◯ 取得するトークンのモード 0：固定 0リクエストヘッダ
No キー 型 必須 説明 サンプル値1 X-WSSE string ◯ 「1.1 WSSE 認証」参照 －
2 Content-Type string ◯ 「application/json」を指定 －
レスポンスヘッダ
No キー 型 必須 説明 サンプル値
1 Content-Type string ◯ コンテンツタイプ application/json
レスポンスボディ
No キー 型 必須 説明 サンプル値
1 1 token string ◯ アクセストークン
86byte、半角英数字、記号(-.)
2 issued string ◯ アクセストークン発行日時 yyyy-MM-dd'T'HH:mm:ss+09:00 (※1) 2005-06-28T01:57: 52+09:00
12
リクエストサンプル
レスポンスサンプル
GET https://cocoa.ntt.com/rest/users/v1/token?mode=0
X-WSSE: UsernameToken Username="1234567890", PasswordText="password", AccessKey="accesskey”, UsernameType="0” Content-Type: application/json HTTP/1.1 200 OK Content-Type: application/json { "token": "accesstoken", "issued": "2005-06-28T01:57:52+09:00" }
13
5.2. ファイル登録 API
登録するフォルダ ID（ファイル・フォルダ一覧検索 API で取得可能）とファイル、ファイルの属性情報を指定 して、ファイルを登録します。 登録するファイルがフォト拡張子の場合、登録時に縮小画像（短辺 150px）、縮小画像（長辺 250px）を作成 します。リクエスト URI
HTTP メソッド：POST 文字コード：UTF-8
https://cocoa.ntt.com/rest/storage/v1/files/{folderId}/upload
No キー 型 必須 説明 サンプル値 1 folderId string ◯ 登録するフォルダ ID ファイル・フォルダ一覧検索 API で取得した フォルダ ID を指定 1~20byte、半角数字 12345670リクエストヘッダ
No キー 型 必須 説明 サンプル値 1 Authorization string ◯ 「1.2 トークン認証」参照 - 2 X-Authorization string ◯ 「1.2 トークン認証」参照 - 3 Content-Type string ◯ 「application/octet-stream」を指定 - 4 Content-length string ◯ リクエストボディの長さ(byte)を指定 102400
5 Slug string ○ 登録するファイル名 (拡張子含む) URL エンコードして指定 URL エンコード前で 1~256byte、全半角文字(半 角カタカナを除く) %e3%82%b5%e3% 83%b3%e3%83%97 %e3%83%ab%2ejp g (URL エンコード前： サンプル.jpg) 6 X-Comment string 登録するファイルのコメント URL エンコードして指定 URL エンコード前で 0~500 文字、全半角文字(半 角カタカナを除く) %e3%82%b3%e3% 83%a1%e3%83%b3 %e3%83%88 (URL エンコード前： コメント)
14 7 X-ShotDate string 登録するファイルの撮影日時 yyyy-MM-dd'T'HH:mm:ss+09:00 形式 (※1) ファイル領域へフォト拡張子ファイル、ムービー 拡張子ファイルを、フォト領域へフォト拡張子フ ァイルアップロートの場合指定可能 キー未指定時、ファイルの Exif 情報を登録 2005-06-28T01:57: 57+09:00 8 X-Latitude string 登録するファイルの撮影場所/更新場所の緯度 半角数字(小数点第 13 位まで) 符号(-),小数点(.) キー未指定時、ファイルの Exif 情報を登録 45.1234567890123 9 X-Longitude string 登録するファイルの撮影場所/更新場所の経度 半角数字(小数点第 13 位まで) 符号(-),小数点(.) キー未指定時、ファイルの Exif 情報を登録 120.123456789012 3 ※1 [ISO-8601]に準拠した日付の形式
リクエストボディ
No キー 型 必須 説明 サンプル値 1 バイナリデータ string ◯ バイナリデータレスポンスヘッダ
No キー 型 必須 説明 サンプル値
1 Content-Type string ◯ コンテンツタイプ application/json
レスポンスボディ
No キー 型 必須 説明 サンプル値 1 fileId string ◯ 登録したファイル ID 1~20byte、半角数字 123456780 2 title string ◯ 登録したファイル名 (※1) 1~256byte、全半角文字(半角カタカナを除く) サンプル.jpg15 3 issued string ◯ 登録したファイルの作成日時 yyyy-MM-dd’T’HH:mm:ss+09:00 形式 (※2) 2014-01-01T01:57: 57+09:00 4 summary string ◯ 登録したファイルのコメント (※1) 0~500 文字、全半角文字(半角カタカナを除 く) コメント 5 shotDate string ◯ 登録したファイルの撮影日時 yyyy-MM-dd’T’HH:mm:ss+09:00 形式 (※2) 2013-12-01T01:57: 57+09:00 6 latitude string ◯ 登録したファイルの撮影場所/更新場所(緯 度) 半角数字(-90~90,整数部 2 桁,小数部 13 桁 0 埋め)、記号(-.) 90.0000000000000 7 longitude string ◯ 登録したファイルの撮影場所/更新場所(経 度) 半角数字(-180~180,整数部 3 桁,小数部 13 桁 0 埋め)、記号(-.) 180.000000000000 0 ※1 バックスラッシュエスケープシーケンスを行う ※
2
[ISO-8601]に準拠した日付の形式16
リクエストサンプル
レスポンスサンプル
POST https://cocoa.ntt.com/rest/storage/v1/files/12345670/upload
Authorization: Bearer accesstoken X-Authorization: AccessKey=”accesskey” Content-Type: application/octet-stream
Slug: %e3%82%b5%e3%83%b3%e3%83%97%e3%83%ab%2ejpg (URL エンコード前：サンプル.jpg) X-Comment: %e3%82%b3%e3%83%a1%e3%83%b3%e3%83%88 (URL エンコード前：コメント) X-ShotDate:2013-08-09T13:27:30+09:00 X-Latitude:45.1234567890123 X-Longitude:120.0123456789123 (binary data ...) HTTP/1.1 201 Created Content-Type:application/json { "fileId":"123456780", "title":"サンプル.jpg", "issued":"2005-06-28T01:57:30+09:00", "summary":"コメント", "shotDate":"2005-06-28T01:57:30+09:00", "latitude":"05.1234567890123", "longitude":"120.0123456789123" }
17
5.3. ファイル取得 API
取得するファイル ID（ファイル・フォルダ一覧検索 API で取得可能）を指定して、ファイルの属性情報、 または縮小画像、またはオリジナルデータを取得します。 Mode=1 (縮小画像(短辺 150px)ダウンロード) で縮小画像のないムービーファイルの取得を行った場合、 縮小画像の作成のみが行われます。縮小画像を取得するためには、再度、取得処理を行ってください。リクエスト URI
HTTP メソッド：GET 文字コード：UTF-8
https://cocoa.ntt.com/rest/storage/v1/files/{fileId}?mode={mode}&expressiveEsti
mationFlg={expressiveEstimationFlg}&reload={reload}
No キー 型 必須 説明 サンプル値 1 fileId string ◯ 取得するファイル ID 1~20byte、半角数字 12345670 2 mode string 取得するファイルのモード 0：属性情報 1：縮小画像(短辺 150px)ダウンロード 2：縮小画像(長辺 800px)ダウンロード 3：オリジナルファイルダウンロード 4：縮小画像(長辺 250px)ダウンロード 5：縮小画像(長辺 2048px)ダウンロード キー未指定時、空値指定時は「0」 mode=2,4,5 はフォト拡張子ファイルのみ指定 可能 0 3 expressiveEstim ationFlg string 表情推定情報取得フラグ on：表情推定情報を取得する off：表情推定情報を取得しない On 4 reload string 最新情報取得フラグ ・off：キャッシュを利用、ない場合は最新情報を 取得 ・on：最新情報を取得 キー未指定時、空値指定時は「off」 On18
リクエストヘッダ
No キー 型 必須 説明 サンプル値
1 Authorization string ◯ 「1.2 トークン認証」参照 2 X-Authorization string ◯ 「1.2 トークン認証」参照 3 Content-Type string ◯ 「application/json」を指定
レスポンスヘッダ
No キー 型 必須 説明 サンプル値
1 Content-Type string ◯ コンテンツタイプ application/json
2 X-Result-code string 縮小画像の状態 サムネイル作成結果 0：未作成 1：作成済（縮小画像をレスポンスボディに指定） 2：作成失敗 3：対象外 キー出力条件 mode=1 指定時のみ 1
レスポンスボディ
No キー 型 必須 説明 サンプル値 1 title string 取得したファイル名 (拡張子含む) 1~256byte、全半角文字(半角カタカナを除く)(※ 1) キー出力条件 mode=0 指定時のみ サンプルファイ ル.txt 2 comment string 取得したファイルのコメント 全半角文字(半角カタカナを除く)(※1) キー出力条件 mode=0 指定時で値がある場合のみ サンプルコメント です。 3 issued string 取得したファイルの作成日時 yyyy-MM-dd’T’HH:mm:ss+09:00 形式(※2) キー出力条件 mode=0 指定時のみ 2013-08-01T00:00: 00+09:00
19 4 shotDate string 取得したファイルの撮影日時 yyyy-MM-dd’T’HH:mm:ss+09:00 形式(※2) キー出力条件 mode=0 指定時のみ 2012-07-07T19:32: 00+09:00 5 modified string 取得したファイルの更新日時 yyyy-MM-dd’T’HH:mm:ss+09:00 形式(※2) キー出力条件 mode=0 指定時のみ 2013-08-03T14:05: 00+09:00 6 latitude string 取得したファイルの撮影場所/更新場所(緯度) 半角数字(-90~90,整数部 2 桁,小数部 13 桁 0 埋め)、記号(-.) キー出力条件 mode=0 指定時のみ 35.6603650000000 7 longitude string 取得したファイルの撮影場所/更新場所(経度) 半角数字(-180~180,整数部 3 桁,小数部 13 桁 0 埋め)、記号(-.) キー出力条件 mode=0 指定時のみ 139.745394000000 0 8 movieTime string 取得したファイルのムービー時間 HHHHHH:MM:SS 形式 HHHHHH：前 0 なし 6 桁まで(0～999999) MM 及び SS：前 0 あり 2 桁固定(00～59) キー出力条件 mode=0 指定時で値がある場合のみ 8:59:00 9 tagId array 取得したファイルに紐づくタグ ID（複数可） 半角数字、格納する型：string キー出力条件 mode=0 指定時のみ 1001,1002 10 updateFlg string 更新可否フラグ 1：更新可 0：更新不可 キー出力条件 mode=0 指定時のみ 0 11 breadcrumbs string 取得したファイルのパンくずリスト キー出力条件 mode=0 指定時のみ ファイル/ストッ クフォルダ
20 12 sceneId array 取得したファイルに紐づくシーン ID（複数可） 1~3byte、半角数字、格納する型：string キー出力条件 mode=0 指定時で値がある場合のみ 301,302,100,200 13 faceId array 取得したファイルに紐づく人物 ID 6byte、半角数字、格納する型：string キー出力条件 mode=0 指定時で値がある場合のみ 100000,100020 14 clockwiseRotate Angle string 正位置までの回転角度（時計回りに何度回転 すると上向きになるかを表した値） 0: 無回転 90: 右 90 度回転で正位置 180: 右 180 度回転で正位置 270: 右 270 度回転で正位置 キー出力条件 mode=0 指定時で値がある場合のみ 90 15 expressiveEstima tionList array 表情推定情報リスト キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 1 expressiveEsti mationId string 表情推定情報 ID 1~32byte、半角数字 キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 1234 2 faceid string 人物 ID 6byte、半角数字 キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 100000,100020 3 faceCoordinat es string 顔位置情報 半角数字およびマイナス記号「-」 顔位置の各 XY 座標を指定 左上 X_左上 Y_右上 X_右上 Y_左下 X_左下 Y_右下 X_右下 Y の順に「_」区切りで記述キ ー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 10_10_10_10_10_ 10_10_10 4 age string 年齢 1~3byte、半角数字 キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 28
21 5 gender string 性別 1byte、半角数字 1: 男 2: 女 キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 1 6 expression string 表情種別フラグと表情タイプごとのパーセント 値「%値(無表情)」「%値(喜)」「%値(驚)」「%値 (怒)」「%値(悲)」「%値(恐)」「%値(嫌)」を区切り 文字「_」で結合した文字列 %値は 0～100 の整数値 表情種別フラグは表情タイプを組み合わせた 半角数字 2byte 【表情種別フラグ】 01(無) 12(無喜) 13(無驚) 14(無怒) 15(無悲) 16(無恐) 17(無嫌) 02(喜) 23(喜驚) 24(喜怒) 25(喜悲) 26(喜恐) 27(喜嫌) 03(驚) 34(驚怒) 35(驚悲) 36(驚恐) 37(驚嫌) 04(怒) 45(怒悲) 46(怒恐) 47(怒嫌) 05(悲) 56(悲恐) 57(悲嫌) 06(恐) 67(恐嫌) 07(嫌) 09(レコメンドなし) 【表情タイプ】 1：無表情 2：喜 3：驚 4：怒 5：悲 6：恐 7：嫌 9：レコメンドなし 0：対象の表情単独であることを示すフラグ キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 2_10_70_20_35_2 0_40_60 7 eyes string 視線種別と上下視線と左右視線の実値を区切 り文字「_」で結合した文字列 実値は -90～90 の整数値 2_-20_70
22 【視線種別】 1：正面 2：その他 キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 8 closeEyes string 目つむり種別と左目つむりと右目つむりの実値 を区切り文字「_」で結合した文字列 実値は 0～1000 の整数値のみ 【目つむり種別】 1：目ひらき 2：目つむり 3：ウィンク 4：レコメンドなし キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 1_700_150 9 smile string 笑顔度 キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 50 10 baby string 赤ちゃん度 キー出力条件 mode=0 かつ expressiveEstimationFlg=on 指定 時のみ 50 16 annoTagId array 取得したファイルに紐づくアノテーションタグ ID （複数可） 半角数字、格納する型：string キー出力条件 mode=0 かつアノテーションタグ ID が設定され ている時のみ 1001,1002 17 １ ６ binary string バイナリ mode の値に対応するバイナリデータ キー出力条件 mode=0 指定時以外のみ ※1 バックスラッシュエスケープシーケンスを行う。 ※2 [ISO-8601]に準拠した日付の形式
23
リクエストサンプル
レスポンスサンプル
GET https://cocoa.ntt.com/rest/storage/v1/files/12345670?mode=0&expressiveEstimationFlg=on& reload=on
Authorization: Bearer accesstoken X-Authorization: AccessKey=”accesskey” Content-Type:application/json HTTP/1.1 200 OK mode=0 (属性情報) 、expressiveEstimationFlg=on 指定時 Content-type : application/json { "title": "サンプルファイル.txt", "comment": "サンプルコメントです。", "issued":"2013-08-01T00:00:00+09:00" "modified": "2013-08-03T14:05:00+09:00", "shotDate": "2012-07-07T19:32:00+09:00", "latitude": "35.6603650000000", "longitude": "139.7453940000000", "tagId": ["1001", "1002"], "updateFlg": "1", "breadcrumbs": "ファイル/ストックフォルダ" "sceneId": ["301", "302", "303", "100"", "200"], "faceId": ["100000","100020"] "clockwiseRotateAngle": "0", "expressiveEstimationList": [ { "expressiveEstimationId": "1234", "faceid": "100000", "faceCoordinates":"10_10_10_10_10_10_10_10", "age": "28", "gender": "1", "expression": "2_10_70_20_35_20_40_60", "eyes": "2_-20_70", "closeEyes": "1_700_150", "smile": "50", "baby": "50" }, { "expressiveEstimationId": "1235", "faceid": "100020",
24 "faceCoordinates":"15_15_15_15_15_15_15_15", "age": "22", "gender": "2", "expression": "3_10_50_80_35_20_40_60", "eyes": "2_-20_70", "closeEyes": "1_700_150", "smile": "50", "baby": "50" } ], "annoTagId": ["1001", "1002"] } mode=1 (縮小画像(短辺 150px)ダウンロード) 指定時で、サムネイル未作成の場合 Content-Type: video/mp4 X-Result-code: 0 mode=1 (縮小画像(短辺 150px)ダウンロード) 指定時で、サムネイル作成済みの場合 Content-Type: image/jpeg X-Result-code: 1 (binary data ...) mode=2,3,4,5 の場合 Content-Type: image/jpeg (binary data ...)
25
5.4. ファイルコピーAPI
コピーするファイル ID とコピー先のフォルダ ID を指定して、ファイルをコピーします。 （ファイル ID、フォルダ ID 共にファイル・フォルダ一覧検索 API で取得可能） コピー先は同じ領域（ファイル領域、フォト領域、ムービー領域）を指定してください。 ただし、フォト拡張子ファイルのみ、ファイル領域からフォト領域、フォト領域からファイル領域へのコピーが 可能です。リクエスト URI
HTTP メソッド：POST 文字コード：UTF-8
https://cocoa.ntt.com/rest/storage/v1/files/copy
リクエストヘッダ
No キー 型 必須 説明 サンプル値 1 Authorization string ◯ 「1.2 トークン認証」参照 2 X-Authorization string ◯ 「1.2 トークン認証」参照 3 Content-Type string ◯ 「application/json」を指定
4 Content-length string ◯ リクエストボディの長さ(byte)を指定 68
リクエストボディ
No キー 型 必須 説明 サンプル値 1 1 fileId array ◯ コピーするファイル ID 1~20byte、半角数字, 格納する型：string 区切り文字(,)で複数指定可 同一のファイル ID を複数指定した場合、コ ピーは 1 回のみ 10000107,1000020 7 2 2 targetFolderId string ○ コピー先のフォルダ ID 1~20byte、半角数字 12345678926
レスポンスヘッダ
No キー 型 必須 説明 サンプル値
1 Content-Type string ◯ コンテンツタイプ application/json
レスポンスボディ
No キー 型 必須 説明 サンプル値 1 copyFileName array ◯ コピーしたファイル名 (拡張子含む) (※1) 1~256byte、全半角文字(半角カタカナを除く) 格納する型：string 複数コピーした場合は、配列で返却 同じファイルを複数指定時は 1 件のみ返却 copyFileName1 ※1 バックスラッシュエスケープシーケンスを行うリクエストサンプル
レスポンスサンプル
POST https://cocoa.ntt.com/rest/storage/v1/files/copy Authorization: Bearer accesstoken
X-Authorization: AccessKey=”accesskey” Content-Type:application/json Content-length:68 { "fileId":["10000107","10000207"], "targetFolderId":"123456789" } HTTP/1.1 201 Created Content-Type:application/json { "copyFileName":["copyFileName1","copyFileName2"] }
27
5.5. ファイル移動 API
移動するファイル ID と移動先のフォルダ ID を指定して、ファイルを移動します。 （ファイル ID、フォルダ ID 共にファイル・フォルダ一覧検索 API で取得可能） 移動先は同じ領域（ファイル領域、フォト領域、ムービー領域）を指定してください。 ただし、フォト拡張子ファイルのみ、ファイル領域からフォト領域、フォト領域からファイル領域への移動が 可能です。リクエスト URI
HTTP メソッド：PUT 文字コード：UTF-8
https://cocoa.ntt.com/rest/storage/v1/files/move
リクエストヘッダ
No キー 型 必須 説明 サンプル値 1 Authorization string ◯ 「1.2 トークン認証」参照 2 X-Authorization string ◯ 「1.2 トークン認証」参照 3 Content-Type string ◯ 「application/json」を指定
4 Content-length string ◯ リクエストボディの長さ(byte)を指定 68
リクエストボディ
No キー 型 必須 説明 サンプル値 1 fileId array ◯ 移動するファイル ID 1~20byte、半角数字, 格納する型：string 区切り文字(,)で複数指定可 同一のファイル ID を複数指定した場合、移動 は 1 回のみ 複数のファイルを移動する場合、同じフォルダ (アルバム)に格納されているファイルのみ指定 できる 10000107,1000020 7 2 targetFolderId string ○ 移動先のフォルダ ID 1~20byte、半角数字 12345678928
レスポンスヘッダ
No キー 型 必須 説明 サンプル値
1 Content-Type string ◯ コンテンツタイプ application/json
レスポンスボディ
No キー 型 必須 説明 サンプル値 1 movedFileName array ◯ 移動したファイル名 (拡張子含む) (※1) 1~256byte、全半角文字(半角カタカナを除く) 格納する型：string 複数移動した場合は、配列で返却 同じファイルを複数指定時は 1 件のみ返却 movedFileName1 ※1 バックスラッシュエスケープシーケンスを行うリクエストサンプル
レスポンスサンプル
POST https://cocoa.ntt.com/rest/storage/v1/files/move Authorization: Bearer accesstoken
X-Authorization: AccessKey=”accesskey” Content-Type:application/json Content-length:63 { "fileId":["10000107","10000207"], "targetFolderId":"123456789" } HTTP/1.1 200 OK Content-Type:application/json { "movedFileName":["movedFileName1","movedFileName2","movedFileName3"] }
29
5.6. ファイル・フォルダ一覧検索 API
ファイル・フォルダの検索方法をクエリパラメータに指定し、取得対象をオプションパラメータに指定して、 該当するファイル・フォルダ一覧（上位フォルダ ID（※）ファイル・フォルダ ID、ファイル・フォルダ名、ファイル・ フォルダ種別、コメント、作成日時、更新日時、撮影日、撮影場所/更新場所、ムービー時間、アルバム内ファ イル数（※）、アルバム最終追加ファイル ID（※）、アルバム最終追加ファイル更新日時（※）、上向きへの回 転角度、オリジナルフォトの縦幅(px)、オリジナルフォト横幅(px)、タグ ID、シーン ID、人物 ID、アノテーションタ グ ID、検索該当件数）を取得します。 ※フォルダ ID 検索 を指定した場合のみ、上位フォルダ ID、アルバム内ファイル数、アルバム最終追加フ ァイル ID 、アルバム最終追加ファイル更新日時）を取得します。 検索方法 1. ファイル・フォルダ・アルバム名検索 2. フォルダ ID 検索 3. タグ ID 検索 4. 撮影日・作成日検索 5. 撮影期間検索 6. 撮影場所・更新場所検索 7. ファイルタイプ ID 検索 8. シーン ID 検索 9. 人物 ID 検索 10. 人物グループ ID 検索 11. 表情推定情報検索 12. 汎用タグ ID 検索 13. アノテーションタグ ID 検索 取得対象 1. ファイルタイプ : ファイル・フォルダ・アルバム,ファイル,フォルダ・アルバム 2. ファイル拡張子: すべての拡張子,フォト拡張子ムービー拡張子, フォト・ムービー拡張子 3. png ファイル: フォト拡張子ファイル取得時に PNG ファイルを取得する, フォト拡張子ファイル取得時に PNG ファイルを取得しない30
リクエスト URI
HTTP メソッド：GET 文字コード：UTF-8
https://cocoa.ntt.com/rest/storage/v1/feed?q={q}&page={page}&showlimit={s
howlimit}&option={option}&sort={sort}&reload={reload}
検索方法、取得対象によって、クエリパラメータ、オプションパラメータの指定値が異なりますので、検索方 法別の指定値を参照してください。1. ファイル・フォルダ・アルバム名検索
ファイル・フォルダ名検索のときに fileType=file+extencion=photo を指定した場合は、フォト領域内(その他 アルバムを除く)のみを取得範囲とします。 No キー 型 必須 説明 サンプル値 1 q 1 string ◯ クエリパラメータを指定 {key}={value}形式 URL エンコードして指定 (value が URL エンコード済みの場合でも二重に URL エンコード) searchName%3d%2 5e3%2582%25b5% 25e3%2583%25b3 %25e3%2583%259 7%25e3%2583%25 ab%252cjpg (URL エンコード前： searchName=%e3% 82%b5%e3%83%b3 %e3%83%97%e3% 83%ab%2cjpg)31 1 searchName string 1 ◯ 検索条件となるファイル名 (拡張子含む)、フォ ルダ名、アルバム名 URL エンコードして指定 URL エンコード前で 256byte、全半角文字(半角 カタカナを除く) オプションパラメータが以下の場合、 区切り文字(,)で複数文字列指定可(指定時は AND 検索) ・fileType=all ・fileType=file+extension=all ・fileType=folder オプションパラメータが以下の場合、 区切り文字(,)で複数文字列指定不可 ・fileType=file+extension=photo %e3%82%b5%e3% 83%b3%e3%83%97 %e3%83%ab%2cjp g (URL エンコード前： サンプル,jpg) 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータ複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2b extension%3dphot o (エンコード前： fileType=file+exten sion=photo) 1 fileType string 取得するファイルタイプを指定 ・all:ファイル・フォルダ・アルバム ・file:ファイル ・folder:フォルダ・アルバム キー未指定時、空値指定時は「all」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・all:すべての拡張子 ・photo:フォト拡張子 ・movie:ムービー拡張子 ・photomovie:フォト・ムービー拡張子 キー未指定時、空値指定時は「all」 photo
32 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) 0 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on
2. フォルダ ID 検索
フォルダ ID 検索では、ファイル・フォルダ名を指定した場合と指定しない場合で取得対象が変わります。 ファイル・フォルダ名を指定した場合は、サブフォルダを含む指定したフォルダ ID 配下のファイル・フォルダ を検索対象とします。 ファイル・フォルダ名を指定しない場合は、指定したフォルダ ID 直下にあるファイル・フォルダのみを検索 対象とします。 No キー 型 必須 説明 サンプル値 1 1 q string ◯ クエリパラメータを指定 {key}={value}形式 クエリパラメータを複数指定時は、 {key}={value}+{key}={value}形式 URL エンコードして指定 (value が URL エンコード済みの場合でも二重に URL エンコード) searchName%3dsa mple%2bsearchFol derId%3d12345670 (エンコード前： searchName=sampl e+searchFolderId=1 2345670) 1 searchName string 検索条件となるファイル名 (拡張子含む)、フォ ルダ名、アルバム名 URL エンコードして指定 URL エンコード前で 256byte、全半角文字(半角 カタカナを除く) フォルダ ID にファイル領域ルートフォルダまた はフォルダの ID を指定した場合、区切り文字(,) で複数文字列指定可(指定時は AND 検索) %e3%82%b5%e3% 83%b3%e3%83%97 %e3%83%ab (エンコード前：サン プル)33 2 searchFolderId string ◯ 検索条件となるフォルダ ID または特別なフォルダを表す指定値 0~20byte、半角英数字 特別なフォルダを表す指定値 空値:ユーザルートフォルダ elsePhotoAlbum：その他アルバム (フォト) elseMovieAlbum：その他アルバム (ムービー) 12345670 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dall (エンコード前： fileType=all) 1 fileType 1 string 取得するファイルタイプを指定 ・all:ファイル・フォルダ・アルバム ・file:ファイル ・folder:フォルダ・アルバム キー未指定時、空値指定時は「all」 file 2 pngFlg 2 string searchFolderId=elsePhotoAlbum 指定時に PNG ファイルを取得するかを指定 ・off:PNG ファイルを含めない ・on:PNG ファイルを含める キー未指定時、空値指定時は「off」 off
34 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) searchFolderId 指定値別ソート順 ・ユーザルートフォルダ(空値)指定時は以下の 順で出力 -ファイル領域ルートフォルダ -フォト領域ルートフォル -ムービー領域ルートフォルダ ・ファイル領域ルートフォルダ ID 指定時は以下 の順で出力 -ストックフォルダ -特殊フォルダ（存在しない場合は出力なし） -ファイル・フォルダ（指定したソート順） ・フォト領域ルートフォルダ ID またはムービー 領域ルートフォルダ ID 指定時は以下の順で出 力 -ストックアルバム -アルバム（指定したソート順） -その他アルバム 0 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on
3. タグ ID 検索
No キー 型 必須 説明 サンプル値 1 q string ◯ クエリパラメータを指定 {key}={value}形式 URL エンコードして指定 searchTagId%3d1 (エンコード前： searchTagId=1)35 1 1 searchTagId string ◯ 検索条件となるタグ ID タグ一覧取得 API で取得したタグ ID を指定 0~36byte、半角数字 空値指定時は、タグ ID なしファイルを取得 1 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2b extension%3dphot o (エンコード前： fileType=file+exten sion=photo) 1 fileType 1 string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension 2 string fileType=file 指定時に取得する拡張子を指定 ・all:すべての拡張子 ・photo:フォト拡張子 ・movie:ムービー拡張子 ・photomovie:フォト・ムービー拡張子 キー未指定時、空値指定時は「all」 photo 3 pngFlg 3 string extension=photo 指定時に PNG ファイルを取 得するかを指定 ・off:PNG ファイルを取得対象に含めない ・on:PNG ファイルを取得対象に含める キー未指定時、空値指定時は「off」 off
36 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) 0 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on
4. 撮影日・作成日検索
ファイルを対象とした検索（fileType=file+extencion=all を指定）のときは、撮影日を基に検索を行い、撮影日が 設定されていないファイルは作成日を基に検索を行う。 フォトやムービーを対象とした検索（fileType=file+extencion=photo or moviel を指定）のときは、撮影日を基に 検索を行い、撮影日が設定されていないファイルは取得対象となりません。 撮影日はマイポケで保存している撮影日、作成日はマイポケットに登録した日となります。 No キー 型 必須 説明 サンプル値 1 1 q string ◯ クエリパラメータを指定 {key}={value}形式 クエリパラメータを複数指定時は、 {key}={value}+{key}={value}形式 URL エンコードして指定 searchStartDate%3 d2013%2d01%2d0 1 (エンコード前： searchStartDate=20 13-01-01) 1 searchStartDate string ◯ 検索条件となる撮影日/作成日 yyyy-MM-dd 形式 (※1) 撮影日/作成日 ・extension=all の場合: 撮影日のないファイルは作成日で検索 ・extension=photo、movie の場合: 撮影日のないファイルは取得対象外 2013-01-0137 2 searchPastYears string 検索条件となる撮影日/作成日の遡り年数 半角数字(1~100) 開始日付を指定せずに遡り取得年を指定した 場合はエラーとする 10 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2b extension%3dphot o (エンコード前： fileType=file+exten sion=photo) 1 fileType 1 string 取得するファイルタイプを指定 ・file:ファイルのみ キー未指定時、空値指定時は「file」 file 2 extension 2 string fileType=file 指定時に取得する拡張子を指定 ・all:すべての拡張子 ・photo:フォト拡張子 ・movie:ムービー拡張子 ・photomovie:フォト・ムービー拡張子 キー未指定時、空値指定時は「all」 photo 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) 0 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on
38 ※1 [ISO-8601]に準拠した日付の形式
5. 撮影期間検索
フォト領域内(その他フォトアルバムを除く)のみを検索対象とします。 No キー 型 必須 説明 サンプル値 1 1 q string ◯ クエリパラメータを指定 {key}={value}形式 クエリパラメータを複数指定時は、 {key}={value}+{key}={value}形式 URL エンコードして指定 (value が URL エンコード済みの場合でも二重に URL エンコード) searchStartDate%3 d2014%2d01%2d0 1%2bsearchEndDat e%3d2014%2d01% 2d31 (エンコード前： searchStartDate=20 14-01-01+searchEn dDate=2014-01-31) 1 searchName string 1 検索するファイル名 (拡張子含む) URL エンコードして指定 URL エンコード前で 256byte、全半角文字(半角 カタカナを除く) %e3%82%b5%e3% 83%b3%e3%83%97 %e3%83%ab (エンコード前： サンプル) 2 searchStartDate 2 string ◯ 検索条件となる撮影日/作成日の開始日付 yyyy-MM-dd 形式 (※1) 2014-01-01 3 searchEndDate 3 string ◯ 検索条件となる撮影日/作成日の終了日付 yyyy-MM-dd 形式 (※1) 2014-01-31 4 searchPastYear s string 検索条件となる撮影日/作成日の遡り年数 半角数字(1~100) 開始日付を指定せずに遡り取得年を指定し た場合はエラーとする 10 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 option 4 string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は fileType%3dfile%2b extension%3dphot o39 {key}={value}+{key}={value}形式 URL エンコードして指定 (エンコード前： fileType=file+exten sion=photo) 1 fileType string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・photo:フォト拡張子 ・movie:ムービー拡張子 ・photomovie:フォト・ムービー拡張子 キー未指定時、空値指定時は「photo」 photo 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) 0 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
6. 撮影場所・更新場所検索
No キー 型 必須 説明 サンプル値 1 1 1 1 q string ◯ クエリパラメータを指定 {key}={value}形式 URL エンコードして指定 searchLocation%3d 10_110_20_120 (エンコード前： searchLocation=10 _110_20_120)40 1 searchLocation string ◯ 検索条件となる撮影場所/更新場所 半角数字(小数点第 13 位まで) 南西緯度,南西経度,北東緯度,北東経度の順 に 4 つ指定 符号(-),小数点(.),区切り文字(_) 緯度: -90 ～ +90、経度: -180 ～ +180 10.1234567890123_ 110.123456789012 3_20.12345678901 23_120.123456789 0123 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2b extension%3dall (エンコード前： fileType=file+exten sion=all) 1 fileType string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・all:すべての拡張子 ・photo:フォト拡張子 ・movie:ムービー拡張子 ・photomovie:フォト・ムービー拡張子 キー未指定時、空値指定時は「all」 all 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) 0
41 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
7. ファイルタイプ ID 検索
No キー 型 必須 説明 サンプル値 1 1 q string ◯ クエリパラメータを指定 {key}={value}形式 クエリパラメータを複数指定時は、 {key}={value}+{key}={value}形式 URL エンコードして指定 (value が URL エンコード済みの場合でも二重に URL エンコード) searchFileType%3d 0002 (エンコード前： searchFileType=000 2) 1 searchName string 検索条件となるファイル名 (拡張子含む) URL エンコードして指定 URL エンコード前で 256byte、全半角文字(半角 カタカナを除く) 区切り文字(,)で複数文字列指定可(指定時は AND 検索) %e3%82%b5%e3% 83%b3%e3%83%97 %e3%83%ab (エンコード前： サンプル) 2 searchFileTyp eId string ◯ 検索条件となるファイルタイプ ID ファイルタイプ一覧取得 API で取得したファ イルタイプ ID を指定 半角数字 4byte(0 埋めした数字列) 0002 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 10042 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2b extension%3dall (エンコード前： fileType=file+exten sion=all) 1 fileType string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・all:すべての拡張子 キー未指定時、空値指定時は「all」 all 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) 0 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
8. シーン ID 検索
No キー 型 必須 説明 サンプル値 1 q 1 string ◯ クエリパラメータを指定 {key}={value}形式 URL エンコードして指定 searchSceneId%3d 100_101 (エンコード前： searchSceneId=100 _101)43 1 searchSceneId string 1 ◯ 検索条件となるシーン ID シーン分類一覧取得 API で取得したシーン ID を指定 半角数字 区切り文字(_)で 2 要素まで指定可(指定時は AND 検索) 100_101 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2be xtension%3dphoto (エンコード前： fileType=file+exten sion=photo) 1 fileType 1 string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension 2 string fileType=file 指定時に取得する拡張子を指定 ・photo:フォト拡張子 キー未指定時、空値指定時は「photo」 photo 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) - 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
44
9. 人物 ID 検索
No キー 型 必須 説明 サンプル値 1 1 q string ◯ クエリパラメータを指定 {key}={value}形式 URL エンコードして指定 searchFaceId%3d10 0000 (エンコード前： searchFaceId=1000 00) 1 searchFaceId string ◯ 検索条件となる人物 ID 人物一覧取得 API で取得した人物 ID を指定 半角英字 100000 2 page 2 string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit 3 string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2b extension%3dphot o (エンコード前： fileType=file+exten sion=photo) 1 fileType string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・photo:フォト拡張子 キー未指定時、空値指定時は「photo」 photo 5 sort 5 string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) -45 6 reload 6 string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
10. 人物グループ ID 検索
No キー 型 必須 説明 サンプル値 1 q string ◯ クエリパラメータを指定 {key}={value}形式 URL エンコードして指定 searchFaceGroupId %3d100000 (エンコード前： searchFaceGroupId =100000) 1 searchFacegro upId string ◯ 検索条件となる人物グループ ID 人物グループ一覧取得 API で取得した人物 ID を指定 半角英字 100000 2 page string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2be xtension%3dphoto (エンコード前： fileType=file+exten sion=photo) 1 fileType string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・photo:フォト拡張子 キー未指定時、空値指定時は「photo」 photo46 5 sort string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) - 6 reload string 最新情報取得フラグ ・off:キャッシュを利用、ない場合は最新情報を 取得 ・on:最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
11. 表情推定情報検索
No キー 型 必須 説明 サンプル値 1 q string ◯ クエリパラメータを指定 {key}={value}形式 クエリパラメータを複数指定時は、 {key}={value}+{key}={value}形式 URL エンコードして指定 searchGender %3d1 (エンコード前： searchGender =1) 1 searchAgeMin string 検索条件となる年齢、または検索条件となる 年齢の下限値 半角数字(0~999) 0 2 searchAgeMax string 検索条件となる年齢の上限値 半角数字(0~999) 100 3 searchGender string 検索条件となる性別 1:男 2:女 147 4 searchExpressi on string 検索条件となる表情タイプと表情%値 [表情タイプ]_[%値を表す整数]形式、または [表情タイプ]のみの形式 表情タイプ：1 桁(1～7) %値を表す整数：前 0 なし 3 桁(0～100) 表情タイプ 1：無表情 2：喜 3：驚 4：怒 5：悲 6：恐 7：嫌 5_40 6 5 searchEyes string 検索条件となる視線 [視線対象]_[視線タイプ]形式 視線対象：半角英字 1 桁(o,a) 視線タイプ：半角数字 1 桁(1～2) 視線対象 o：視線タイプが 1 つ以上存在するフォト a：視線タイプが全て一致しているフォト 視線タイプ 1：正面 2：その他 o_1 o_2 a_1 a_2 6 searchCloseEy es string 検索条件となる目つむり [目つむり対象]_[目つむりタイプ]形式 目つむり対象：半角英字 1 桁(o,a) 目つむりタイプ：半角数字 1 桁(1～3) 目つむり対象 o：目つむりタイプが 1 つ以上存在するフォト a：目つむりタイプが全て一致しているフォト 目つむりタイプ 1：目ひらき 2：目つむり 3：ウィンク o_1 o_2 o_3 a_1 a_2 a_3
48 2 page string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2be xtension%3dphoto (エンコード前： fileType=file+exten sion=photo) 1 fileType string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・photo:フォト拡張子 キー未指定時、空値指定時は「photo」 photo 5 sort string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) - 6 reload string 最新情報取得フラグ ・off：キャッシュを利用、ない場合は最新情報を 取得 ・on：最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
12. 汎用タグ ID 検索
No キー 型 必須 説明 サンプル値49 1 q string ◯ クエリパラメータを指定 {key}={value}形式 URL エンコードして指定 searchUtilityTagId %3d100000 (エンコード前： searchUtilityTagId =100000) 1 searchUtilityTa gId( string OR 検索用汎用 ID 接頭辞(t)：汎用 ID 値をタグ ID として検索 接頭辞(s)：汎用 ID 値をシーン ID として検索 接頭辞(f)：汎用 ID 値を人物 ID として検索 接頭辞(a)：汎用 ID に指定した値をアノテーショ ンタグ ID として検索 各要素は[接頭辞]+[半角数字]形式 10 要素まで指定可、区切り文字(_) t1_t2_s100_s102_f 100001_a1001 2 page string 取得するページ番号 0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」 対象がないページを指定してもエラーとしない 1 3 showlimit string 取得する 1 ページの表示件数 0~3byte、半角数字(1～200) キー未指定時、空値指定時は「100」 100 4 option string オプションパラメータを指定 {key}={value}形式 オプションパラメータを複数指定時は {key}={value}+{key}={value}形式 URL エンコードして指定 fileType%3dfile%2be xtension%3dphoto (エンコード前： fileType=file+exten sion=photo) 1 fileType string 取得するファイルタイプを指定 ・file:ファイル キー未指定時、空値指定時は「file」 file 2 extension string fileType=file 指定時に取得する拡張子を指定 ・photo:フォト拡張子 ・movie:ムービー拡張子 ・photomovie:フォト・ムービー拡張子 キー未指定時、空値指定時は「photo」 photo
50 5 sort string 取得する一覧のソート順を指定 1：名前(昇順)、作成日時(降順) 2：名前(降順)、作成日時(降順) 3：作成日時(昇順)、名前(昇順) 4：作成日時(降順)、名前(昇順) 5：撮影日時(昇順)、名前(昇順) 6：撮影日時(降順)、名前(昇順) 0、指定なし：作成日時(降順)、名前(昇順) - 6 reload string 最新情報取得フラグ ・off：キャッシュを利用、ない場合は最新情報を 取得 ・on：最新情報を取得 キー未指定時、空値指定時は「off」 on ※1 [ISO-8601]に準拠した日付の形式
