ヘルプ

フォト蔵API

photo_album APIメソッド

JSON: https://api.art19.photozou.jp/rest/photo_album.json
 XML: https://api.art19.photozou.jp/rest/photo_album.xml

概要

アルバムの一覧を取得します。

認証

このメソッドは、認証が必要です。

サポートされているHTTPメソッド

HTTP GETメソッドのみをサポートしています。

パラメータ

なし

JSONレスポンス

{
  info": {
    "album": [
      {
        "album_id": ###,
        "user_id": ###,
        "name": "アルバム名",
        "description": "アルバムの説明",
        "perm_type": "allow/deny",
        "perm_type2": "net/everyone/all/user_group",
        "order_type": "upload/date/comment/file_name",
        "copyright_type": "normal/creativecommons",
        "copyright_commercial": "yes/no",
        "copyright_modifications": "yes/no/share",
        "photo_num": ###,
        "perm_msg": "公開範囲の説明",
        "cover_photo_id": ###,
        "cover_image_url": "URL",
        "cover_original_image_url": "URL",
        "cover_thumbnail_image_url": "URL",
        "upload_email": "EMAIL",
        "created_time": "YYYY-MM-DDThh:mm:ss+09:00",
        "updated_time": "YYYY-MM-DDThh:mm:ss+09:00"
      },
      ...
    }
  }
}

XMLレスポンス

<info>
  <album>
    <album_id>###</album_id>
    <user_id>###</user_id>
    <name>アルバム名</name>
    <description>アルバムの説明</description>
    <perm_type>allow/deny</perm_type>
    <perm_type2>net/everyone/all/user_group</perm_type2>
    <order_type>upload/date/comment/file_name</order_type>
    <copyright_type>normal/creativecommons</copyright_type>
    <copyright_commercial>yes/no</copyright_commercial>
    <copyright_modifications>yes/no/share</copyright_modifications>
    <photo_num>###</photo_num>
    <perm_msg>公開範囲の説明</perm_msg>
    <cover_image_url>URL</cover_image_url>
    <cover_original_image_url>URL</cover_original_image_url>
    <cover_thumbnail_image_url>URL</cover_thumbnail_image_url>
    <upload_email>EMAIL</upload_email>
    <created_time>YYYY-MM-DDThh:mm:ss+09:00</created_time>
    <updated_time>YYYY-MM-DDThh:mm:ss+09:00</updated_time>
  </album>
  ...
</info>

レスポンスの説明

album_id
アルバムID
user_id
ユーザーID
name
アルバム名
description
アルバムの説明
perm_type
写真の公開権限を指定です。
'allow', 'deny'の2種類があります。
'allow'の場合はアクセスを許可し、'deny'の場合はアクセスを拒否します。
perm_type2
写真の公開権限の範囲です。
'net', 'everyone', 'all', 'user_group'の4種類あります。
それぞれ次を意味します。
'net': インターネット
'everyone': フォト蔵会員だけ
'all': 友達全員
'user_group': 選んだ友達
order_type
写真の並び順です。次の値があります。
'upload': アップロード順
'date': 撮影日順
'comment': コメント順
'file_name': ファイル名順
値の後に'2'がつくと(例: upload2)逆順になります。
copyright_type
ライセンスの型(normal: ライセンスなし、または creativecommons: クリエイティブ・コモンズ)
copyright_commercial
クリエイティブ・コモンズによる著作権、営利目的での利用を指定します。
'yes'(デフォルト), 'no'の2種類を指定できます。
'yes'の場合は利用を許可、'no'の場合は利用を許可しません。
copyright_modifications
クリエイティブ・コモンズによる著作権、改変の許可を指定します。 ('copyright'パラメータに'creativecommons'を指定したときのみ有効)
'yes'(デフォルト), 'no', 'share'の3種類を指定できます。
'yes'の場合は改変を許可、'no'の場合は改変を許可しません。
'share'の場合は他の人が同一条件化で配付する場合のみ変更を許可します。
photo_num
登録されている写真の総数
perm_msg
公開権限に関する説明メッセージです。
cover_image_url
アルバムの表紙画像のURL
cover_original_image_url
アルバムの表紙画像のオリジナルURL
cover_thumbnail_image_url
アルバムの表紙画像のサムネイルURL
upload_email
メールに写真を添付してこのアドレス宛にメールを送るとアップロードすることができます。
created_time
アルバムが作成された日時（ISO 8601の日時表記形式）
updated_time
アルバムが更新された日時（更新は該当のアルバムに写真がアップロードされた場合を含む、ISO 8601の日時表記形式）