IT-TOP.BIZはPHP/CGI/AJAXベースのWEBサイト・システム製作に助力致します。

トップ 新着 ソフトウェア サポート&サービス 更新履歴 2010/02/09
WWWフロンティア〜IT-TOP.BIZ

Yahoo API の使い方

 Yahoo Web APIは、パラメータを指定したURLを実行する事で使えます。
 PHPのサンプルは、レスポンスとしてXMLを受け取ります。

3.Yahoo API / PHPサンプル.1を動かす

サンプル1.ではxmldomを使います。「xmldom」が使えるかどうかは、phpinfo()関数を呼び出すと分かります。
前述したようにサンプル1には「common.php」「YJSearchExample.php」が含まれます。

3.1.「common.php」の内容

「common.php」は共通ライブラリファイルです。以下、注意点を解説します。
<?php
// common.php
// Yahoo! JAPAN Search Services PHP Example Code Ver.1(2005/11/30)
// 

$appid = '[ここにアプリケーションIDを記述]';
/*※アプリケーションIDを定義します。例えば、アプリケーションIDが"TOKYO_JAPAN"であれば、
$appid = '[TOKYO_JAPAN]';
となります。*/


$service = array('web'=>'http://api.search.yahoo.co.jp/WebSearchService/V1/webSearch',
                 'image'=>'http://api.search.yahoo.co.jp/ImageSearchService/V1/imageSearch',
                 'video'=>'http://api.search.yahoo.co.jp/VideoSearchService/V1/videoSearch');
/*※APIの呼び出し先の定義です。
対象が、WEB検索、画像検索、動画検索のいずれかにより、呼び出し先URLが変わります。*/
/*※APIの呼び出し先URLの定義を参照して下さい。

header('Content-Type: text/html; charset=UTF-8');
?>
<html>
<head><title>PHP Yahoo! JAPAN Web Service Example Code</title></head>
<body>
<form action="YJSearchExample.php" method="post">
Search Keywords: <input type="text" name="query" /><br />
<input type="submit" value=" Search " />
<select name="type">
<?php foreach($service as $name => $val) {
    if(!empty($_REQUEST['type']) && $name == $_REQUEST['type'])
      echo "<option SELECTED>$name</option>\n";
    else echo "<option>$name</option>\n";
} ?>
</select>
</form>
<?php

function done() {

  echo '<br>Web Services by <a href="http://developer.yahoo.co.jp/">Yahoo! JAPAN</a></body></html>';
  exit;
}

function build_query() {
  global $appid, $service;
  if(empty($_REQUEST['query']) || !in_array($_REQUEST['type'],array_keys($service))) done();


  $q = '?query='.rawurlencode($_REQUEST['query']);
  if(!empty($_REQUEST['start'])) $q.="&start=".$_REQUEST['start'];
  $q .= "&appid=$appid";
  return $q;
}
/*※呼び出しパラメータを3つ指定しています。それぞれ、
query:問合せキーワード
start:検索結果を取得する先頭順位(1が先頭)
apiid:アプリケーションID
このパラメータは「WEB検索」「画像検索」「動画検索」のいずれでも有効なパラメータです。*/
/*※また、問合せキーワードをrawurlencodeでURLエンコード(※1)してます。*/
/*※指定パラメータの定義を参照して下さい。

// Create Previous/Next Page links
function next_prev($res, $start, $last) {
  if($start > 1)

    echo '<a href="'.$_SERVER['PHP_SELF'].
                   '?query='.rawurlencode($_REQUEST['query']).
                   '&type='.rawurlencode($_REQUEST['type']).
                   '&start='.($start-10).'"><-Previous Page</a>   ';
  if($last < $res['totalResultsAvailable'])
    echo '<a href="'.$_SERVER['PHP_SELF'].
                   '?query='.rawurlencode($_REQUEST['query']).
                   '&type='.rawurlencode($_REQUEST['type']).
                   '&start='.($last+1).'">Next Page-></a>';
} 
?>

(※1)「URLエンコード」:
スペース(空白)文字などは、URLの文字列の一部として記述する事ができません。
  例えば、「http://www.hogehoge.com/hoge hoge/」のように途中にスペースを含む事ができません。
  そのため、空白文字をURLとして送信可能な文字に変換してから送信する必要があるのです。
  これを通称、URLエンコード、といいます。
  URLエンコードされた文字を受け取った側では、そのままでは使えませんから、使える文字に戻します。
  これをURLでコードといいます。

3.2.「YJSearchExample.php」の内容

<?php
// Yahoo! JAPAN Search Services PHP Example Code Ver.1(2005/11/30)
// 

require './common.php';

$q=build_query();
// Then send it to the appropriate service
$xml = file_get_contents($service[$_REQUEST['type']].$q);
/*呼び出しクエリーを作成し、APIを呼び出します。
呼び出した結果をそのまま文字列として受け取ります。*/

// Parse the XML and check it for errors

if (!$dom = domxml_open_mem($xml,DOMXML_LOAD_PARSING,$error)) {
  echo "XML parse error\n";
  foreach ($error as $errorline) {
  /* For production use this should obviously be logged to a file instead */
    echo $errorline['errormessage']."<br />\n";
    echo " Node  : " . $errorline['nodename'] . "<br />\n";
    echo " Line  : " . $errorline['line'] . "<br />\n";
    echo " Column : " . $errorline['col'] . "<br />\n";
  }
  done();
}
/*domxml_open_memを使って、APIの戻り値として受け取ったXMLを
解析し、XMLオブジェクトを作成します。*/

// Now traverse the DOM with this function
// It is basically a generic parser that turns limited XML into a PHP array
// with only a couple of hardcoded tags which are common across all the
// result xml from the web services
function xml_to_result($dom) {
    /*XMLの内容から、文字列配列を取得する関数です*/
  $root = $dom->document_element();
    /*document_element()メソッド*/でルートエレメントを取得
  $res['totalResultsAvailable'] = $root->get_attribute('totalResultsAvailable');/*マッチしたデータ数*/
  $res['totalResultsReturned'] = $root->get_attribute('totalResultsReturned');/*実際に戻ってきたデータ数*/
  $res['firstResultPosition'] = $root->get_attribute('firstResultPosition');/*全検索結果の先頭位置*/
    /*get_attribute()メソッドでルートの属性値を取得する*/
  $node = $root->first_child();
    /*first_child()メソッドで、ルート「ResultSet」の子ノード「Result」にアクセスする*/
  $i = 0;
  while($node) {
    switch($node->tagname) {
      case 'Result':/*XMLタグがResult(検索結果)の場合*/
        /* Resultタグの子ノード「Title」「Summary」「Url」「ClickUrl」
        「ModificationDate」「MimeType」「Cache」にアクセスする*/
        $subnode = $node->first_child();
        while($subnode) {
          $subnodes = $subnode->child_nodes();
          if(!empty($subnodes)) foreach($subnodes as $k=>$n) {
            if(empty($n->tagname)) $res[$i][$subnode->tagname] = trim($n->get_content());
            /*タグ名をキーとする配列に値を格納する*/
            else $res[$i][$subnode->tagname][$n->tagname]=trim($n->get_content());
            /*Cacheタグは子ノード「URL」を持つので、URLを取得*/
            /*get_content()メソッドにてノードの値を取得*/
          }
          $subnode = $subnode->next_sibling();
          /*next_sibling()メソッドで次の兄弟ノードへ*/
        }
        break;
      default:
        $res[$node->tagname] = trim($node->get_content());
        $i--;
        break;
    }
    $i++;
    $node = $node->next_sibling();
  }  
  return $res;
}

$res = xml_to_result($dom); /*上記の実行*/

// Ok, now that we have the results in an easy to use format,
// display them.  It's quite ugly because I am using a single
// display loop to display every type.
$first = $res['firstResultPosition'];
$last = $first + $res['totalResultsReturned']-1;
echo "<p>Matched ${res[totalResultsAvailable]}, showing $first to $last</p>\n";
if(!empty($res['ResultSetMapUrl'])) {
  echo "<p>Result Set Map: <a href=\"${res[ResultSetMapUrl]}\">${res[ResultSetMapUrl]}</a></p>\n";
}
for($i=0; $i<$res['totalResultsReturned']; $i++) {
  foreach($res[$i] as $key=>$value) {
    switch($key) {
      case 'Thumbnail':/*サムネイル画像をIMGタグで表示*/
        echo "<img src=\"${value[Url]}\" height=\"${value[Height]}\" width=\"${value[Width]}\" />\n";
        break;
      case 'Cache':/*サーバーキャッシュのURLを表示*/
        echo "Cache: <a href=\"${value[Url]}\">${value[Url]}</a> [${value[Size]}]<br />\n";
        break;
      case 'PublishDate':/*最終更新日*/
      case 'ModificationDate':
        echo "<b>$key:</b> ".strftime('%X %x',$value)."<br />\n";
        break;
      default:/*タイトル、URLなど*/
        if(stristr($key,'url')) echo "<a href=\"$value\">$value</a><br />\n";
        else echo "<b>$key:</b> $value<br />";
        break;
    }
  }
  echo "<hr />\n";
}

next_prev($res, $first, $last);
done();
?>
(※)「DOM XML」:PHPのアドインです。
  このサンプルでは「domxml_open_mem()関数」を使ってDOMオブジェクトを作成しています。

3.3.サンプルを動かしてみよう

ローカルのサーバーの適当なディレクトリに上記の2つのファイルをアップロードし、「YJSearchExample.php」にアクセスします。
YahooAPI PHPサンプル1のようになります。
<前へ 次へ>
目次
1.Yahoo APIでできる事 
2.Yahoo API サンプルを取得する 
3.Yahoo API PHPサンプル1 を動かしてみる
4.Yahoo API PHPサンプル2 を動かしてみる 
5.Yahoo API PHPサンプル3 を動かしてみる 
6.Yahoo API PHPサンプル4 を動かしてみる 
7.Yahoo API PHPサンプル5 を動かしてみる 
サイトマップ お問い合わせ 相互リンク 免責事項
Copyright© 2005 IT-TOP.BIZCopyright© 2005 IT-TOP.BIZ