explore.searchTags

explore.searchTags

オリジナル: http://wiki.lingr.com/dev/show/ExploreSearchTags

翻訳日: 2007/04/13

原文リビジョン: 3


指定した検索条件にヒットするルームの一覧を取得します。ヒットするルームは与えられた検索語の全てにヒットした物で、検索対象はそのルームに付けられたタグです。1分に1回以上ポーリングしてはいけません。

HTTPメソッド

GET

パラメータ

api_key(必須)

あなたのAPIキー

q(必須)

検索語。複数の場合はコンマ区切りで渡します。

format(オプション)

希望の応答フォーマット。指定する場合はxmljsonを指定します。デフォルトxmlです。

callback(オプション)

応答フォーマットjsonを指定した場合、コールバック関数名を指定します。


認証

このメソッドは認証を必要としません。

応答の例

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <rooms>
    <room>
      <id>gcnZ3vAcZDA</id>
      <name>My awesome room</name>
      <description>A really GREAT room</description>
      <url>http://www.lingr.com/room/myawesomeroom</url>
      <icon_url>http://images.lingr.com/room/gcnZ3vAcZDA/16x16.gif</icon_url>
      <counter>356</counter>
      <max_user_message_id>346</max_user_message_id>
      <tags>
        <tag>
          <name>sanfrancisco</name>
          <display_name>San Francisco</display_name>
          <url>http://www.lingr.com/tag/sanfrancisco</url>
        </tag>
      </tags>
    </room>
  </rooms>
</response>

応答の詳細

成功したメソッド呼び出しの応答は以下のような要素を持ちます。

rooms

hot roomsの一覧を格納した配列です。それぞれの要素のデータ構造はこちらを参照してください。→Room

エラーコード

100: 不正HTTPメソッド

HTTPメソッドが間違っています。

101: 無効なAPIキー

指定されたAPIキーが不正です。

104: 不正な応答フォーマット

要求された応答フォーマットサポートされていません。

112: 回数制限に達した

ポーリングの頻度が制限以上です。

119: 検索語が与えられていない

"q"パラメータが与えられていません。