クチコミ検索API

リクエストURL

XML
https://map.yahooapis.jp/olp/v1/review/{uid}
JSONP
https://map.yahooapis.jp/olp/v1/review/{uid}

目次

概要

  • クチコミ検索APIでは、Yahoo!ロコで投稿された、店舗のクチコミを検索できます。
  • 店舗IDを指定して、その店舗に投稿されたクチコミを取得できます。
  • クチコミは新しい投稿順に取得できます。

URIパラメーター一覧

「RESTリクエストの構築（GET）」をご参照ください。

パラメーター 値 説明
uid（必須） string 店舗ID。

リクエストパラメーター一覧

パラメーター 値 説明
appid（必須） string アプリケーションID。詳細はこちらをご覧ください。
results int 取得件数を指定します（最大100）。
start int 取得開始位置を指定します（最大9999）。
output string 出力形式：
  • xml - XML形式（デフォルト）
  • json - JSON形式
callback string
 JSONPとして出力する際のコールバック関数名を入力するためのパラメーター。UTF-8でエンコードした文字列を入力します。

API使用上の注意

URLの最大の長さは2048バイトです。
URLをエンコードして指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。

レスポンスフィールド

フィールド 説明
YDF クエリーレスポンスのすべてを含みます。
ResultInfo レスポンスのまとめ情報です。
Count レスポンスに含まれるクチコミのデータ件数です。
Total 出力されているクチコミ以外も含めた全データ件数です。
Start レスポンスに含まれるクチコミの、全データからの取得開始位置です。
Status リクエスト元に処理結果を伝えるためのコードです。正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。
Latency レスポンスを生成するのに要した時間です。
Feature 検索結果1件分のデータ群です。
Id 内部識別用のIDです。
※後述のクチコミIDと同一ではありません。
Property 各種データを格納します。
Uid リクエスト時にURIパラメーターに指定した店舗IDです。
Comment クチコミの本体情報を格納します。
Id クチコミのIDです。
Subject クチコミのタイトル文です。
Body クチコミの本文です。
Guid クチコミ投稿者の識別IDです。
Author クチコミ投稿者の表示名称です。
Rating 店舗に対する評価情報です。1.0から5.0までの値となります。
VisitDate 店舗を訪問した日付です。
Scene シーン番号：
  • 1 - 昼
  • 2 - 夜
  • 3 - 終日
  • 4 - その他
UsefulCount クチコミを支持する人数です。
CreateDate クチコミが投稿された日付です。
UpdateDate クチコミが更新された日付です。

サンプルレスポンス

以下は、店舗ID:27bac2879a69b786816d77f8351105fac2eb2708のクチコミのリクエストとレスポンスです。

http://api.olp.yahooapis.jp/v1/review/27bac2879a69b786816d77f8351105fac2eb2708?appid=＜あなたのアプリケーションID＞

結果を以下に示します。

<?xml version="1.0" encoding="UTF-8"?>
  <YDF totalResultsAvailable="8" totalResultsReturned="8" firstResultPosition="1">
    <ResultInfo>
      <Count>8</Count>
      <Total>8</Total>
      <Start>1</Start>
      <Status>200</Status>
      <Latency>0.122</Latency>
      <Description />
      <Copyright>Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved.</Copyright>
    </ResultInfo>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>bc15d71e1badcb5de2148029f51dc048f47d75e6</Id>
            <Body>昼に行った
  すごい高くて東京が一望できる。。</Body>
            <Subject>良い</Subject>
            <Guid>FMRM4VSLOIUJZKGHTIAT2B44DI</Guid>
            <Author>bre*****</Author>
            <Rating>4.5</Rating>
            <VisitDate />
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2015-07-11T14:05:26+09:00</CreateDate>
          <UpdateDate>2015-07-11T14:05:26+09:00</UpdateDate>
        </Property>
      </Feature>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>8b519ae083e0f7f640d5ff9c14fac9fb0f082604</Id>
            <Body>東京スカイツリー公式オンラインショップは欠品商品が堂々と掲載されています。
  行く前にお土産類はオンラインショップで注文しました。
  ２泊現地に泊まって，帰ってきても発送しましたのメールも来ない？
  次の日，欠品なので待てのメールだけ。発送するときにまたメールするとのことでした。
  そこで，ふと，公式オンラインショップを見たら，欠品はまだ堂々と掲載中で，カートにいれられる状態で放置。
  ちなみに，商品は＜上野風月堂＞ソラカラちゃん東京カラメリゼ</Body>
            <Subject>公式オンラインショップは？？？</Subject>
            <Guid>AUTEEX4WRM3QLZ6Q7W5PQZKBGQ</Guid>
            <Author>kaz*ma_*chi*o</Author>
            <Rating>1</Rating>
            <VisitDate />
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2015-01-09T01:41:47+09:00</CreateDate>
          <UpdateDate>2015-02-20T11:41:21+09:00</UpdateDate>
        </Property>
      </Feature>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>8e9a7fe9971b591b4772336f0934cb2027466874</Id>
            <Body>サービス性がね...もっとよくなって欲しい。</Body>
            <Subject>サービスが行き届いてなかった</Subject>
            <Guid>MNYJRMWURYP33XJPEB7PD5LTIU</Guid>
            <Author>tsuyoshi</Author>
            <Rating>1</Rating>
            <VisitDate />
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2012-10-04T22:22:08+09:00</CreateDate>
          <UpdateDate>2015-02-20T08:18:54+09:00</UpdateDate>
        </Property>
      </Feature>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>14211ece0549646243c188b97ebce8a4f6850d4f</Id>
            <Body>２２日の午後に３５０ｍの展望台の昇ったら、西側の場所で無線機のスイッチをＯＮ。

  「ＣＱ、ＣＱ、ＣＱ　こちらＪ〇４〇〇〇」、
  　　　　中略
  「東京スカイツリー展望台よりオンエア」、
  「入感局ありましたら、ＱＳＯお願いします」　</Body>
            <Subject>２２日の開業日が待ち遠しい♪</Subject>
            <Guid>E2X7Z7PBDTNRLPRYWIIQ2NYKAE</Guid>
            <Author>『恋するスケッチブック』</Author>
            <Rating>5</Rating>
            <VisitDate>2012-05-01T00:00:00+09:00</VisitDate>
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2012-05-04T04:47:14+09:00</CreateDate>
          <UpdateDate>2015-02-20T04:43:34+09:00</UpdateDate>
        </Property>
      </Feature>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>f715474d4c1545b85cda77be5e03708be23d311b</Id>
            <Body>工事中のスカイツリーもうじき完成してオープン間近ですね。
  楽しみだな。</Body>
            <Subject>でっかいよ</Subject>
            <Guid>D74OROEISL64D2AQYYKJFHZ3NU</Guid>
            <Author>china</Author>
            <Rating>3</Rating>
            <VisitDate />
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2012-04-24T00:05:19+09:00</CreateDate>
          <UpdateDate>2015-02-20T09:19:04+09:00</UpdateDate>
        </Property>
      </Feature>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>2cf08f0417f3d17a29dc372b14c47863209fcf6b</Id>
            <Body>できたら、晴天の日に訪れるのが一番だと思います。青空をバックにそびえ立つツリーの姿は感動的！美しいです。植物の葉脈を思わせる独特の外観が、どこか有機的というか、親しみやすさを感じさせてくれます。</Body>
            <Subject>ツリーの勇姿は、必見です。励まされます！</Subject>
            <Guid>JMWFYTKTEA2GM22MXTC6UXWDEY</Guid>
            <Author>洋ちゃん</Author>
            <Rating>3</Rating>
            <VisitDate>2012-03-01T00:00:00+09:00</VisitDate>
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2012-04-21T12:29:53+09:00</CreateDate>
          <UpdateDate>2015-02-19T21:17:43+09:00</UpdateDate>
        </Property>
      </Feature>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>1a0eae7e8a5b05de70c142c930c47b7617a5aae6</Id>
            <Body>初めてスカイツリーを見に行って来ました
  凄く興奮してしまいました</Body>
            <Subject>スカイツリー</Subject>
            <Guid>3IYMWGHFX75BRDMN7PTSC36ZAU</Guid>
            <Author>－</Author>
            <Rating>3</Rating>
            <VisitDate />
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2012-04-07T18:33:14+09:00</CreateDate>
          <UpdateDate>2015-02-20T06:39:24+09:00</UpdateDate>
        </Property>
      </Feature>
      <Feature>
        <Id />
        <Property>
          <Uid>27bac2879a69b786816d77f8351105fac2eb2708</Uid>
          <Comment>
            <Id>6f67b23b2dac37bb02e5ef97b10f8733ec230199</Id>
            <Body>東京スカイツリータワー、期待していた通りです。
  あのタワーの色、輝き、きれいです。みていて、気持ちがいいです。
  とうきょうたわーも、大好きでした、でも、スカイツリーの方が、もっともっと好きです(^-^)//</Body>
            <Subject>かっこいい、スカイツリータワー！</Subject>
            <Guid>B2VUTWYEYHBEBHCGOA7YCZRWO4</Guid>
            <Author>Bonnie</Author>
            <Rating>4.5</Rating>
            <VisitDate />
            <Scene />
            <UsefulCount>0</UsefulCount>
            <LinkUrl />
          </Comment>
          <CreateDate>2012-04-06T16:14:32+09:00</CreateDate>
          <UpdateDate>2015-02-19T23:50:27+09:00</UpdateDate>
        </Property>
      </Feature>
  </YDF>

エラー

コード 説明
400 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。
403 リソースへのアクセスを許されていないか、利用制限を超えている場合に適用されます。
405 リソースに対して要求したメソッドが許可されていない場合に返されます。
503 内部的な問題によってデータを返すことができない場合に返されます。

以下は、リクエストに対するエラーレスポンスです。

<?xml version="1.0" encoding="UTF-8"?>
  <Error>
    <Code>400</Code>
    <Message>Bad Request</Message>
  </Error>

利用制限

クチコミ検索APIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。

アプリケーションの管理

目次

開発のヒント