Flickr API ドキュメント日本語訳 |
flickr.photos.search
いくつかの条件に合致する写真の一覧を取得します。このメソッドを実行するユーザーが閲覧できる写真のみが取得されます。
非公開写真や準非公開写真を取得するには、メソッド実行者は"読み込み"権限の認証を取得し、その写真の参照権限を持っていなければなりません。
認証なしでメソッドを実行した場合、公開写真のみが取得されます。
認証
このメソッドには認証は必要ありません。
引数
api_key
(Required)- あなたのAPIアプリケーションキー。詳細についてはここを参照してください。
user_id
(Optional)- 写真を検索するユーザーのNSID。このパラメータが設定されていなかった場合、全てのユーザーの公開写真が検索されます。"me"の値を設定すると、メソッドの認証に基づき、メソッド実行者の写真が検索されます
tags
(Optional)- タグをコンマで区切った一覧。設定したタグ一覧の中で、一つ以上のタグが付けられている写真が取得されます。 除外したい文字の前に-を付けて設定することで、それに合致する結果を除外することができます。
tag_mode
(Optional)- 'any'を設定した場合は条件タグのどれかに合致すれば条件をみたし(or条件)、'all'を指定した場合は全ての条件タグに合致した場合に条件をみたします(and条件)。 この値が設定されていない場合、既定では'any'が設定されます。
text
(Optional)- 文字列の自由検索。設定した文字列をタイトル、説明文、タグのいずれかに含んでいる写真を取得します。 除外したい文字列の前に-を付けて設定することで、それに合致する結果を除外することができます。
min_upload_date
(Optional)- アップロード日付の下限指定。これよりも新しいアップロード日付の写真が取得されます。日付はunixタイムスタンプ形式かmysql日付形式でなければなりません。
max_upload_date
(Optional)- アップロード日付の上限指定。これよりも古いアップロード日付の写真が取得されます。日付はunixタイムスタンプ形式かmysql日付形式でなければなりません。
min_taken_date
(Optional)- 写真撮影日の下限指定。これよりも新しい撮影日の写真が取得されます。日付はmysql日付形式かunixタイムスタンプ形式でなければなりません。
max_taken_date
(Optional)- 写真撮影日の上限指定。これよりも古い撮影日の写真が取得されます。日付はmysql日付形式かunixタイムスタンプ形式でなければなりません。
license
(Optional)- 写真のライセンスID (設定可能な値についてはflickr.photos.licenses.getInfo メソッドを参照してください)。複数のライセンスを設定する場合はコンマ区切りで設定してください。
sort
(Optional)- 取得する写真の並び準。既定では date-posted-desc が設定されています(unless you are doing a radial geo query, in which case the default sorting is by ascending distance from the point specified)。設定可能な値は以下の通りです: date-posted-asc, date-posted-desc, date-taken-asc, date-taken-desc, interestingness-desc, interestingness-asc, and relevance.
privacy_filter
(Optional)- 指定した公開レベルに合致する写真のみを取得します。この設定はあなたが所有する写真に対してメソッドが実行された場合にのみ適用されます。 使用できる値は以下の通りです:
- 1 公開写真
- 2 友達は見ることができる非公開写真
- 3 家族は見ることができる非公開写真
- 4 家族と友達は見ることができる非公開写真
- 5 完全な非公開写真
bbox
(Optional)- 検索対象とする地域の境界域を定義するための、コンマで区切った4つの値です。
4つの値は境界域の左下と右上、最低経度・最低緯度・最高経度・最高緯度を表します。
経度は-180から180の値をとり、緯度は-90から90の値をとります。設定されていない場合、 既定では最低経度-180、最低緯度 -90、最高経度 180、最高緯度 90の値が設定されます。
標準の写真クエリとは違い、地形(もしくは境界域)クエリは1ページあたり250の結果のみを返します。
地形クエリでは、データベースの負荷を防ぐためにいくつかの検索絞込み要素が必要です。 これは基本的に、"パラメータを設定せずに検索"するような場合を想定しています。
例えば、ユーザーによって設定される min_date_takenパラメータやmin_date_uploadなどのタグは検索絞込み要素と見なされます。 - 検索絞込み要因が設定されていない場合、最新12時間の間に追加された写真のみを結果として返します。(この12時間という制限は詳細変更されるかもしれませんが)。 accuracy
(Optional)- 保存された位置情報の精度レベル。現時点は 1-16の範囲で設定できます。 :
- 世界レベルは 1
- 国レベルは ~3
- 地域レベルは ~6
- 都市レベルは ~11
- 通りレベルは ~16
safe_search
(Optional)- 安全検索設定:
- 1 は安全(safe)。
- 2 は普通(moderate)。
- 3 は制限付き(restricted)。
content_type
(Optional)- コンテンツタイプ設定:
- 1 は写真のみ。
- 2 はスクリーンショットのみ。
- 3 は'その他' のみ。
- 4 は写真とスクリーンショット。
- 5 はスクリーンショットと'その他'.
- 6 は写真と'その他'.
- 7 は写真とスクリーンショットと'その他' (all).
machine_tags
(Optional)- 完全な形式のマシンタグで値を設定する方法からは一旦離れ、ここでは特定のプロパティーを検索するための特別な構文を説明します:
- 'dc' 名前空間を使っている写真を探す :
"machine_tags" => "dc:"
- 'dc' 名前空間でタイトルを使っている写真を探す :
"machine_tags" => "dc:title="
- 'dc' 名前空間でタイトルを"mr. camera"にしている写真を探す:
"machine_tags" => "dc:title="mr. camera"
- "mr. camera"という値を持っている写真を探す :
"machine_tags" => "*:*="mr. camera""
- 任意の名前空間にタイトルを持っている写真を探す :
"machine_tags" => "*:title="
- 任意の名前空間にタイトルを持っており、タイトルに"mr. camera"を含む写真を探す :
"machine_tags" => "*:title="mr. camera""
- 'dc' 名前空間に"mr. camera"という値を持っている写真を探す :
"machine_tags" => "dc:*="mr. camera""
- 'dc' 名前空間を使っている写真を探す :
machine_tag_mode
(Optional)- 'any'を設定した場合は条件タグのどれかに合致すれば条件をみたし(or条件)、'all'を指定した場合は全ての条件タグに合致した場合に条件をみたします(and条件)。 この値が設定されていない場合、既定では'any'が設定されます。
group_id
(Optional)- 共有写真を検索するグループのID。この値が設定された場合、そのグループの共有写真に登校差レア写真のみが取得されます。
contacts
(Optional)- あなたの知り合いを検索します。'all'もしくは、友達と家族のみを表す'ff'が設定できます。(試験的に)
woe_id
(Optional)- ある一意の地点を表す32ビットの識別子。 (bbox引数が設定されている場合は使用されません).
地形クエリでは、データベースの負荷を防ぐためにいくつかの検索絞込み要素が必要です。 これは基本的に、"パラメータを設定せずに検索"するような場合を想定しています。
例えば、ユーザーによって設定される min_date_takenパラメータやmin_date_uploadなどのタグは検索絞込み要素と見なされます。 - 検索絞込み要因が設定されていない場合、最新12時間の間に追加された写真のみを結果として返します。(この12時間という制限は詳細変更されるかもしれませんが)。 place_id
(Optional)- Flickr 場所 id. (bbox引数が設定されている場合は使用されません).
地形クエリでは、データベースの負荷を防ぐためにいくつかの検索絞込み要素が必要です。 これは基本的に、"パラメータを設定せずに検索"するような場合を想定しています。
例えば、ユーザーによって設定される min_date_takenパラメータやmin_date_uploadなどのタグは検索絞込み要素と見なされます。 - 検索絞込み要因が設定されていない場合、最新12時間の間に追加された写真のみを結果として返します。(この12時間という制限は詳細変更されるかもしれませんが)。 media
(Optional)- メディアの種類を基にして出力結果の絞込みをします。設定できる値は
all
(既定値)かphotos
かvideos
です。 has_geo
(Optional)- ジオタグが付けられている写真を取得する。この値に"0"が設定されている場合はジオタグが付けられていない写真を取得する。
地形クエリでは、データベースの負荷を防ぐためにいくつかの検索絞込み要素が必要です。 これは基本的に、"パラメータを設定せずに検索"するような場合を想定しています。
例えば、ユーザーによって設定される min_date_takenパラメータやmin_date_uploadなどのタグは検索絞込み要素と見なされます。 - 検索絞込み要因が設定されていない場合、最新12時間の間に追加された写真のみを結果として返します。(この12時間という制限は詳細変更されるかもしれませんが)。 geo_context
(Optional)- 地理コンテキスト は経度や緯度とは別の、写真の地理情報を表す数字の値です。。
例えば、"室内"で撮られた写真や"室外"で撮られた写真を検索することができます
現在使用できるコンテキストIDの一覧は以下の通りです。:
- 0, 定義されていません。
- 1, 室内。
- 2, 室外。
地形クエリでは、データベースの負荷を防ぐためにいくつかの検索絞込み要素が必要です。 これは基本的に、"パラメータを設定せずに検索"するような場合を想定しています。
例えば、ユーザーによって設定される min_date_takenパラメータやmin_date_uploadなどのタグは検索絞込み要素と見なされます。 - 検索絞込み要因が設定されていない場合、最新12時間の間に追加された写真のみを結果として返します。(この12時間という制限は詳細変更されるかもしれませんが)。 lat
(Optional)- A valid latitude, in decimal format, for doing radial geo queries.
地形クエリでは、データベースの負荷を防ぐためにいくつかの検索絞込み要素が必要です。 これは基本的に、"パラメータを設定せずに検索"するような場合を想定しています。
例えば、ユーザーによって設定される min_date_takenパラメータやmin_date_uploadなどのタグは検索絞込み要素と見なされます。 - 検索絞込み要因が設定されていない場合、最新12時間の間に追加された写真のみを結果として返します。(この12時間という制限は詳細変更されるかもしれませんが)。 lon
(Optional)- A valid longitude, in decimal format, for doing radial geo queries.
地形クエリでは、データベースの負荷を防ぐためにいくつかの検索絞込み要素が必要です。 これは基本的に、"パラメータを設定せずに検索"するような場合を想定しています。
例えば、ユーザーによって設定される min_date_takenパラメータやmin_date_uploadなどのタグは検索絞込み要素と見なされます。 - 検索絞込み要因が設定されていない場合、最新12時間の間に追加された写真のみを結果として返します。(この12時間という制限は詳細変更されるかもしれませんが)。 radius
(Optional)- A valid radius used for geo queries, greater than zero and less than 20 miles (or 32 kilometers), for use with point-based geo queries.既定の値は 5 (km)です。
radius_units
(Optional)- The unit of measure when doing radial geo queries. Valid options are "mi" (miles) and "km" (kilometers). The default is "km".
is_commons
(Optional)- 検索する範囲をFlickr コモンズプロジェクトの写真のみに限定します。既定ではfalseが設定されています。
in_gallery
(Optional)- 検索する範囲をギャラリー内の写真のみに限定します。既定ではfalseが設定されており、全ての写真が検索されます。
is_getty
(Optional)- 検索する範囲をGettyで販売されている写真のみに限定します。既定ではfalseが設定されています。
extras
(Optional)- 追加で取得したい情報があれば、その情報が保存されているフィールドをコンマ区切りで設定します。現時点では、以下のフィールドをサポートしています:
description
,license
,date_upload
,date_taken
,owner_name
,icon_server
,original_format
,last_update
,geo
,tags
,machine_tags
,o_dims
,views
,media
,path_alias
,url_sq
,url_t
,url_s
,url_q
,url_m
,url_n
,url_z
,url_c
,url_l
,url_o
per_page
(Optional)- 1ページ当たりに出力する写真数。この引数を省略した場合、既定では100が設定されます。設定できる最大値は500です。
page
(Optional)- 出力するページのページ番号。この引数が省略された場合、既定では1が設定されます。
サーバからの応答例
このメソッドでは、標準的なxml形式の写真一覧を戻り値として返します:
<photos page="2" pages="89" perpage="10" total="881"> <photo id="2636" owner="47058503995@N01" secret="a123456" server="2" title="test_04" ispublic="1" isfriend="0" isfamily="0" /> <photo id="2635" owner="47058503995@N01" secret="b123456" server="2" title="test_03" ispublic="0" isfriend="1" isfamily="1" /> <photo id="2633" owner="47058503995@N01" secret="c123456" server="2" title="test_01" ispublic="1" isfriend="0" isfamily="0" /> <photo id="2610" owner="12037949754@N01" secret="d123456" server="2" title="00_tall" ispublic="1" isfriend="0" isfamily="0" /> </photos>
<photo>
エレメントからそのURLを割り出す方法については、 url ドキュメントを参照してください。
検索条件によっては、Flickrから最大4000件の検索結果が返ってくるので注意してください。 これが問題になる場合は、検索条件をさらに絞ってクエリーを送ることをお勧めします。
エラーコード
1: Too many tags in ALL query
- 'all tags' 検索を実行する場合は、タグを20個以上設定しないようにしてください。
2: Unknown user
- 設定されたuser_id引数は有効なFlickrユーザーのものとは合致しません。
3: Parameterless searches have been disabled
- パラメータを設定せずに検索を実行しています (最新の公開写真を取得したいのであれば、代わりにflickr.photos.getRecentを使ってください)。
4: You don't have permission to view this pool
- ログインユーザーはこのグループの共有写真の参照権限を持っていません。(アクセス権が設定されているのであれば)
10: Sorry, the Flickr search API is not currently available.
- Flickr APIの検索データベースが一時的に使用できません。
11: No valid machine tags
- machine_tags引数の構文が有効ではありません。
12: Exceeded maximum allowable machine tags
- 一回のクエリーで使えるマシンタグの体台地を越えています。
17: You can only search within your own contacts
18: Illogical arguments
- リクエスト内に矛盾した引数がありました。
100: Invalid API Key
- 送信されたAPIキーは無効か、既に失効しています。
105: Service currently unavailable
- 要求されたサービスは、一時的に利用できない状態です。
106: Write operation failed
- 要求された操作は、一時的な問題のために失敗しました。
111: Format "xxx" not found
- 要求された応答形式は見つかりませんでした。
112: Method "xxx" not found
- 要求されたメソッドは見つかりませんでした。
114: Invalid SOAP envelope
- リクエスト時に送信されたSOAPエンベロープを解析できませんでした。
115: Invalid XML-RPC Method Call
- リクエスト時に送信されたXML-RPC ドキュメントを解析できませんでした。
116: Bad URL found
- 引数の中に、Flickrに対して有害なURLが含まれています。
API 体験
注意事項 |