ホーム API/ツール API フォトコレクション

フォトコレクション

    フォトコレクションAPIを利用すると、クラウドへ写真・動画をアップロードしたり、クラウドから写真・動画の取得ができます。

    API
    基本情報
    提供 : REST
    • 審査 : アプリ審査
    ご利用いただくためには「アカウント登録(無料)」が必要です。

    リファレンスを参照するAPI機能名を選択してください

    コンテンツIDリスト取得

    コンテンツのメタデータを検索し返却します。

    テクニカルガイドライン

    • 各(フィルタ条件)項目は、全てAND条件として検索に適用されます。
    • 省略可能な(フィルタ条件)項目の指定を省略すると、当該フィルタは適用されません(ただし省略時値が定義されている場合は省略時値が適用されます)。

    リクエストURL

    https://xlb.photocolle-docomo.com/file_a2/2.0/ext/file_search/get_list

    メソッド : POST
    文字コード : UTF-8

    リクエストヘッダ

    キー 必須 説明
    Content-Type 送信データのMIMEタイプは、下記を指定。
    application/json
    Authorization OAuth認証スキーム。
    「Bearer + スペース + <access_token>」の形式でアクセストークンを指定する。
    詳細はAPI共通リファレンス 2.3を参照。

    ※OAuth を利用するためのAndroid™、iOSおよびJava SDKを提供しております。 こちらを参照ください。

    リクエストボディ(JSON形式)

    キー 必須 説明
    projection 返却データ項目セットの範囲は、下記を指定。
    3 : 詳細情報(タグ情報無)
    file_type_cd
    (フィルタ条件)
    フィルタ条件 : コンテンツのメディア種別
    下記のいずれかを指定
    1 : 静止画
    2 : 動画
    3 : スライドムービー
    dustbox_condition
    (フィルタ条件)
    - フィルタ条件 : コンテンツがゴミ箱内にあるか否か
    下記のいずれかを指定。
    1 : ごみ箱以外のコンテンツ
    2 : ごみ箱内のコンテンツ
    min_date_upload
    (フィルタ条件)
    - フィルタ条件 : コンテンツのアップロード日時が本項目値以上のもの
    タイムゾーンは任意に設定してよい。
    RFC 3339 の date-time フォーマットで 秒の1の位まで指定する。
    サンプル値) yyyy-mm-ddThh:mi:ss+09:00 (JSTの例)
    yyyy-mm-ddThh:mi:ssZ (UTCの例)
    ※「更新日時(最小値)」と同時に指定することは認めない。
    min_date_modified
    (フィルタ条件)
    - フィルタ条件 : コンテンツの更新日時が本項目値以上のもの
    タイムゾーンは任意に設定してよい。
    RFC 3339 の date-time フォーマットで秒の1の位まで指定する。
    サンプル値) yyyy-mm-ddThh:mi:ss+09:00 (JSTの例)
    yyyy-mm-ddThh:mi:ssZ (UTCの例)
    ※「アップロード日時(最小値)」と同時に指定することは認めない
    max_results
    (ページング条件)
    - ページング条件 : 検索結果全体のうち、レスポンスとして返却する最大件数(ページサイズ)
    最小値:1
    最大値:100
    省略時:100
    ※内部的には上限値と省略時値は、それぞれプロパティで定義する可変値とする。
    start
    (ページング条件)
    - ページング条件 : 検索結果全体のうち、レスポンスとして返却するレコードの開始番号
    最小値:1
    省略時:1
    ※検索結果の総件数を上回る値が指定された場合は、「コンテンツ数=0」で正常応答する。
    sort_type
    (ページング条件)
    ページング条件 : 検索結果(コンテンツリスト)のソート条件
    下記のいずれかを指定。
    1 : 撮影日の降順
    2 : 撮影日の昇順
    3 : 更新日時の降順
    4 : 更新日時の昇順
    5 : アップロード日時の昇順
    6 : アップロード日時の降順

    レスポンスヘッダ

    キー 必須 説明
    Content-Type 受信データのMIMEタイプは、下記を返却。
    application/json

    レスポンスボディ(処理成功)(JSON形式)

    キー 必須 説明
    result 処理結果は、下記を返却。
    0 : 成功
    content_cnt 本レスポンスの返却コンテンツ数(コンテンツリストの要素数)。
    start 検索結果全体のうち、レスポンスとして返却するレコードの開始番号。
    リクエストの開始番号と同じ値を返却。
    next_page 次ページ開始番号。
    ・次ページありの場合 : 開始番号 + コンテンツ数
    ・次ページなしの場合 : 0
    content_list 検索条件を満たすコンテンツのリスト。
    ※検索結果の「コンテンツ情報」件数=0の場合は、空(要素数=0)の array とする。
       content_info - コンテンツ情報。
       content_guid コンテンツID。
    content_name コンテンツファイル名。
    file_type_cd コンテンツのメディア種別は、下記のいずれかを返却。
    1:静止画
    2:動画
    3:スライドムービー
    exif_camera_day EXIFから取得した撮影日。ない場合はファイル作成日。
    RFC 3339 の date-time フォーマットで秒の1の位まで指定する。
    サンプル値) yyyy-mm-ddThh:mi:ss+09:00
    mdate コンテンツ情報の最終更新日時。アップロード後に画像回転等の操作を行うと更新される。ゴミ箱内のコンテンツの場合は削除日時である。
    RFC 3339 の date-time フォーマットで秒の1の位まで指定する。
    サンプル値) yyyy-mm-ddThh:mi:ss+09:00
    upload_datetime アップロード日時。
    ・画像種別コード=1,2の場合 : フォトコレクションにコンテンツをアップロード後、分析が完了した日時
    ・画像種別コード=3の場合 : スライドムービーの作成日時
    RFC 3339 の date-time フォーマットで秒の1の位まで指定する。
    サンプル値) yyyy-mm-ddThh:mi:ss+09:00
    file_data_size 原本のファイルサイズ(単位はbyte)。
    ※最大サイズは30MB
    resize_ng_flg リサイズNGフラグは、下記のいずれかを返却。
    0:リサイズOK
    1:リサイズNG

    レスポンスボディ(処理失敗)(JSON形式)

    キー 必須 説明
    result 処理結果は、下記を返却。
    1 : 失敗
    err_cd エラーの詳細内容を表すコード。詳細は 仕様書「業務エラーコード一覧」参照。
    設定値については 仕様書「業務エラーマッピング」参照。
    param_name - エラー発生箇所をリクエスト項目で特定できる場合に、その物理項目名がセットされる。
    param_value - エラー発生箇所をリクエスト項目で特定できる場合に、エラーの発生した「エラー項目」の値がセットされる。
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。