アフィリエイトWEBサービス・ツールで使用するパラメーターの一覧です。
call.php?key=キーワード&asp=am&imagesize=l
のように指定して使います。
赤文字は設定が必須です。緑文字は少なくとも一つが必要です。
現在の共通モジュール(call.php data.php)のバージョンはそれぞれVer. 3.3、3.04です。
★付きのモジュールは、PHPVer5の文字コード変換エラーに対応したものです。付いていないモジュールはPHPVer5の場合、カタカナの「ソ」を入れた検索で問題が起きます。
モジュールの数が増え、パラメーター表が見にくくなったので、分割しました。(1/2/3)
| パラメーター | ★LinkShare クロスオーバーサーチ Ver. 1.4 |
★LinkShare マーチャンダイザー Ver. 1.3 |
★ValueCommerce Mylink Ver. 1.5 |
★Excel XML Ver. 2.3 |
★Amazon Product Advertising API Ver. 2.5 |
★楽天ブックス総合検索 Ver. 2.0 |
★楽天商品 検索API Ver. 4.1 |
★楽天トラベル キーワード 検索API Ver.2.2 |
|---|---|---|---|---|---|---|---|---|
| asp | ls |
md |
vm |
xm |
am |
rb |
rk |
rt |
| dummy | 「ture」にすると、結果を出力しない。PHPなどで変数だけ得たいときに使用。デフォルトは「false」。エラー情報は$statusに出力。 | |||||||
| showstatus | 「0」にすると、該当する商品がなかった場合のメッセージを表示しない。 | |||||||
| productid | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 |
| key | 検索キーワード 半角スペースで区切り 複数設定可 |
検索キーワード 複数指定不可 |
優先順位1 検索キーワード 複数指定不可 |
優先順位1 検索キーワード 複数指定不可 |
検索キーワード 半角スペースで区切り 複数設定可 |
検索キーワード 半角スペースで区切り 複数設定可 |
検索キーワード 半角スペースで区切り 複数設定可 |
検索キーワード 半角スペースで区切り 複数設定可 あるいは 施設番号 コンマで 区切り 複数設定可 |
| kwck | 有料オプションの検索キーワード取得コンポーネントで使用。 | |||||||
| original | ファイルを指定すると、テンプレートを読み込む前に実行します。独自の変数などを定義するのに利用できます。 | |||||||
| region | ||||||||
| pref | ||||||||
| l_area | ||||||||
| s_area | ||||||||
| o_area_id | ||||||||
| o_id | ||||||||
| x,y,range | ||||||||
| and_or | 無効 | 無効 | 無効 | 無効 | 1: or検索 2: and検索 無指定はand |
1: or検索 2: and検索 無指定はand |
無効 | |
| type | 適切な表示タイプのテンプレートを選択。改良・自作も可 | |||||||
| code | WEBページの文字コード 無指定だとSJIS |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| pagecode | 特定のページでキーワードに
使用している文字コード sitecodeの指定より優先する |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| datacode | 無効 | データファイルの 文字コード 無指定だとUTF-8 |
無効 SJISに固定 |
無効 UTF-8に固定 |
無効 | 無効 | 無効 | 無効 |
| filename | 無効 | データファイル名 | データファイル名 | データファイル名 .xml |
無効 | 無効 | 無効 | 無効 |
| separator | 無効 | データファイル のセパレータ 無指定だと 縦棒(|) タブは「tab」 と指定 |
常に「,」 | 無効 | 無効 | 無効 | 無効 | 無効 |
| page | 表示するページ番号 | 無効 | 優先順位3 表示する ページ番号 検索結果ではなく データファイル内 全商品が対象 |
優先順位3 表示する ページ番号 検索結果ではなく データファイル内 全商品が対象 |
表示するページ番号 最大400 |
表示するページ番号 最大100 |
表示するページ番号 最大100 |
無効 |
| no | 優先順位2 表示する商品の データファイル内の 位置 noを指定すると 一商品だけ表示 |
優先順位2 表示する商品の データファイル内の 位置 noを指定すると 一商品だけ表示 |
||||||
| max | 1回にASPのシステムが 返す最大アイテム数 最大100 指定しないと10 |
無効 | 1ページに表示する 商品数 指定しないと10 |
検索対象にする 商品数 ファイルのトップから数える。 ファイル全体を対象とする場合は、十分大きな数値を設定。 指定しないと10 |
無効 10に固定 |
1回にASPのシステムが 返す最大アイテム数 最大30 指定しないと10 |
1回にASPのシステムが 返す最大アイテム数 最大30 指定しないと10 |
1回にASPのシステムが 返す最大アイテム数 最大30 指定しないと10 施設番号で 検索する場合は1 |
| hits | 表示するアイテム数 max以下 |
表示するアイテム数 | 表示するアイテム数 | 表示するアイテム数 | 表示するアイテム数 10以下 |
表示するアイテム数 max以下 |
表示するアイテム数 max以下 |
表示するアイテム数 max以下 |
| genre | 無効 | 検索対象 一つのみ指定可 省略するとtitle。 リンクID:id 商品名:title 商品コード:sku 主カテゴリ:category サブカテゴリ:subcategory 商品概要:explain 商品詳細:detail キーワード:keyword |
keyを設定する場合 検索対象とする 列の番号一つのみ 左端は0 無指定は0 |
keyを設定する場合 検索対象とする 列の番号一つのみ 左端は0 無指定は0 |
Books、など。 こちらのページにある SearchInexを使用 |
楽天ブックスの ジャンルID 指定しないと 001 書籍 |
商品ジャンルのID 省略すると全部 |
無効 |
| identicalcheck | 前と同じデータを 飛ばす時に使用 飛ばすために チェックする列の 番号を指定 左端は0 |
|||||||
| options | ||||||||
| imagesize | 無効 とんでもなく大きな画像が 登録されていることがある テンプレートでwidthを指定 するのがお勧め |
無効 とんでもなく大きな画像が 登録されていることがある テンプレートでwidthを指定 するのがお勧め |
無効 | 無効 | sw(サムネイル)、s、m、l のいずれか。 省略すると m |
s、m、l のいずれか。 |
s、mのいずれか。 省略すると m |
無効 とんでもなく大きな画像が 登録されていることがある テンプレートでwidthを指定 するのがお勧め |
| shopid | 検索対象にする ショップのID 省略すると全ショップ |
無効 | 無効 | 無効 | 無効 | 無効 | 検索対象にする ショップのID 省略すると全ショップ |
無効 |
| subshopid | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 |
| ngshop | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 | 無効 |
| sort | 無効 常にランダム |
無効 データファイル の中での 並び順 |
無効 データファイル の中での 並び順 |
無効 データファイル の中での 並び順 |
商品カテゴリー (genreの指定) によって異なる こちらを参照 |
1:販売順 3:レビュー件数順(昇順) 4:レビュー件数順(降順) 5:価格順(昇順) 6:価格順(降順) 7:発売日(古い順) 8:発売日(新しい順) 9:楽天標準ソート順 省略時は9 |
1:アフィリエイト料率順(昇順) 2:アフィリエイト料率順(降順) 3:レビュー件数順(昇順) 4:レビュー件数順(降順) 5:価格順(昇順) 6:価格順(降順) 7:商品更新日時順(昇順) 8:商品更新日時順(降順) 9:ランダム順 省略時は8 |
無効 |
| minPrice | 無効 | 無効 | 無効 | 無効 | 1以上 未指定は1 中古価格も対象 |
1以上 未指定は1 |
1以上 未指定は1 |
無効 |
| maxPrice | 無効 | 無効 | 無効 | 無効 | minPriceより大きい数字 未指定は999999999 中古価格も対象 |
minPriceより大きい数字 未指定は999999999 |
minPriceより大きい数字 未指定は999999999 |
無効 |
| field | 無効 | 無効 | 無効 | 無効 | 無効 | 0:検索範囲が広い |
0:検索範囲が広い |
無効 |
| carrier | 無効 | 無効 | 無効 | 無効 | 無効 | 0:PC |
0:PC |
0:PC 1:携帯 未指定だと0 |
| NGKeyword | 無効 | 無効 | 無効 | 無効 | 無効 | 未対応 | 未対応 | 無効 |
| width | $widthで指定する 画像などの幅 |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| height | $heightで指定する 画像などの幅 |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| elength | 説明$explainと$longの文字数 10以上。無指定はそのまま |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| tlength | 商品名$nameの文字数 10以上。無指定はそのまま |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| name_no | 無効 | 無効 | 商品名の 列の番号 左端は0 |
商品名の 列の番号 左端は0 |
無効 | 無効 | 無効 | 無効 |
| url_no | 無効 | 無効 | 商品リンクの 列の番号 左端は0 |
商品リンクの 列の番号 左端は0 |
無効 | 無効 | 無効 | 無効 |
| image_no | 無効 | 無効 | 画像URLの 列の番号 左端は0 |
画像URLの 列の番号 左端は0 |
無効 | 無効 | 無効 | 無効 |
| explain_no | 無効 | 無効 | 説明文の 列の番号 左端は0 |
説明文の 列の番号 左端は0 |
無効 | 無効 | 無効 | 無効 |
| price_no | 無効 | 無効 | 値段の 列の番号 左端は0 |
値段の 列の番号 左端は0 |
無効 | 無効 | 無効 | 無効 |
| item_no | 無効 | 無効 | 商品IDの 列の番号 左端は0 |
商品IDの 列の番号 左端は0 |
無効 | 無効 | 無効 | 無効 |
| sid | 無効 | 無効 | マイリンクのsid set.phpで 設定も可 |
ValueCommerce マイリンク使用時 マイリンクのsid set.phpで 設定も可 |
無効 | 無効 | 無効 | 無効 |
| pid | 無効 | 無効 | マイリンクのpid | ValueCommerce マイリンク使用時 マイリンクのpid |
無効 | 無効 | 無効 | 無効 |
テンプレートの中で用いることのできる検索結果の戻り値一覧です。PHPプログラムから呼び出す場合、変数として使用も可能です。
テンプレートは必ずUTF-8でエンコードしてください。
| 戻り値 | LinkShare クロスオーバーサーチ Ver. 1.4 |
LinkShare マーチャンダイザー Ver. 1.3 |
ValueCommerce Mylink Ver. 1.5 |
Excel XML Ver. 2.3 |
Amazon Product Advertising API Ver. 2.5 |
★楽天ブックス総合検索 Ver. 2.0 |
楽天商品 検索API Ver. 4.0 |
楽天トラベル キーワード検索API Ver.2.2 |
|---|---|---|---|---|---|---|---|---|
| $referer | call.php を呼び出したホームページのURL(場合によっては取得できない場合もあり)。 | |||||||
| $attribution | なし | なし | なし | なし | Amazon.co.jp アソシエイト (サイト上の どこかに必要) |
規約上不可欠 こちらを参照 |
規約上不可欠 こちらを参照 |
規約上不可欠 こちらを参照 |
| $pvimg | なし | なし | 規約上不可欠 こちらを参照 |
ValueCommerce マイリンクの場合 規約上不可欠 こちらを参照 |
なし | なし | なし | なし |
| $name | 商品名 | 商品名 | 商品名 | 商品名 | 商品名 | 商品名 | 商品名 | 宿泊施設名 |
| $kana | なし | なし | ||||||
| $namewithlink | アフィリエイトリンク付 商品名 |
アフィリエイトリンク付 商品名 |
アフィリエイトリンク付 商品名 |
ValueCommerce MyLinkを指定すると アフィリエイトリンク付 商品名 |
アフィリエイトリンク付 商品名 |
アフィリエイトリンク付 商品名 |
アフィリエイトリンク付 商品名 |
アフィリエイトリンク付 宿泊施設名 |
| $price | 参考価格 | 参考価格 | 参考価格 | 参考価格 | 参考価格 (販売価格設定がある 場合は販売価格) |
販売価格 | 販売価格 | なし |
| $listprice | $priceから「,」などフォーマットを取ったもの。数値データとして利用可。 | |||||||
| $offerprice | 販売価格(設定がない商品もあり) | |||||||
| $lowestnewprice | なし | なし | なし | なし | 最低新品価格 | なし | なし | なし |
| $lowestusedprice | なし | なし | なし | なし | 最低中古価格 | なし | なし | なし |
| $autoprice | 参考価格 (「円」表示付) |
参考価格 (「円」表示付) |
参考価格 (「円」表示付) |
参考価格 (「円」表示付) |
アマゾン販売価格、 最低新品価格、 最低中古価格を 自動表示 |
販売価格 (「円」表示付) |
販売価格 (「円」表示付) |
なし |
| $explain | 短い説明 | 短い説明 | 短い説明 | 短い説明 | なし | 説明 (ないものもある) |
説明 | 説明 |
| $long | 長い説明 | 長い説明 | なし | なし | なし | なし | なし | 地域名 施設番号で 検索するとなし |
| $imageurl | 商品画像のURL | 商品画像のURL | 商品画像のURL | 商品画像のURL | 商品画像のURL | 商品画像のURL | 商品画像のURL | 施設画像のURL |
| $imagewithlink | アフィリエイトリンク付 画像 |
アフィリエイトリンク付 画像 |
アフィリエイトリンク付 画像 |
ValueCommerce MyLinkを指定すると アフィリエイトリンク付 画像 |
アフィリエイトリンク付 画像 |
アフィリエイトリンク付 画像 |
アフィリエイトリンク付 画像 |
アフィリエイトリンク付 画像 |
| $url | アフィリエイトリンク | アフィリエイトリンク | アフィリエイトリンク | ValueCommerce MyLinkを指定すると アフィリエイトリンク |
アフィリエイトリンク | アフィリエイトリンク | アフィリエイトリンク | アフィリエイトリンク |
| $itemurl | なし | なし | 商品ページの アフィリエイト なしリンク |
商品ページの アフィリエイト なしリンク |
なし | 商品ページの アフィリエイト なしリンク |
商品ページの アフィリエイト なしリンク |
施設ページの アフィリエイト なし リンク |
| $encodeditemurl | なし | なし | エンコードした |
エンコードした |
なし | エンコードした |
エンコードした |
エンコードした $itemurl |
| $jan | JANコード 商品によってはない |
JANコード 商品によってはない |
なし | なし | JANコード 商品によってはない |
書籍の場合13桁ISBNコード | なし | なし |
| $artist | なし | なし | なし | なし | ミュージシャンなど 商品によってはない |
ミュージシャンなど 商品によってはない |
なし | なし |
| $author | なし | なし | なし | なし | 筆者など 商品によってはない |
筆者など 商品によってはない |
なし | なし |
| $asin/$itemid | 商品コード等 | 商品コード等 | item_noの指定が ある場合のみ有効 |
item_noの指定が ある場合のみ有効 |
アマゾン固有の 商品ID(ASIN番号) |
書籍の場合 10桁のISBNコード |
楽天市場の商品コード | 施設番号 |
| $isbn10 | アマゾン固有の 商品ID(ASIN番号) |
書籍の場合 10桁のISBNコード |
||||||
| $productid | なし | なし | ||||||
| $offerid | offeridの中の 商品コード部分。 マーチャンダイザーの 商品コードと互換。 ショップによって $itemidと同じ 場合も異なっている 場合もある |
$itemidと同じ | なし | なし | なし | なし | なし | |
| $availability | なし | なし | なし | 発送予定 | 在庫状況など | なし | なし | |
| $manufacturer | なし | なし | なし | 商品製造者、出版社 商品による |
商品製造者、出版社 | なし | なし | |
| $shop | 販売するショップ名 | 販売するショップ名 | なし | Amazon.co.jp | 楽天ブックス | 販売するショップ名 | 楽天トラベル | |
| $substore | なし | なし | なし | なし | なし | なし | なし | |
| $shopid | 商品を販売する ショップのID |
商品を販売する ショップのID |
なし | なし | なし | 商品を販売する ショップのID |
なし | |
| $substoreid | なし | |||||||
| $shoplink | なし | なし | なし | なし | なし | ショップページへの アフィリエイトURL |
ショップページへの アフィリエイトURL |
楽天トラベル への アフィリエイト URL |
| $shopwithlink | ショップ名 | ショップ名 | なし | なし | Amazon.co.jp | アフィリエイトリンク付 ショップ名 |
アフィリエイトリンク付 ショップ名 |
アフィリエイトリンク付 ショップ名 |
| $shopimage | ||||||||
| $totalmatches | 検索にヒットした総数 最大5000 |
検索にヒットした総数 テンプレートの $header、 $footerの 中でのみ有効 |
検索にヒットした総数 テンプレートの $header、 $footerの 中でのみ有効 |
検索にヒットした総数 テンプレートの $header、 $footerの 中でのみ有効 |
検索にヒットした総数 | 検索にヒットした総数 | 検索にヒットした総数 | 検索にヒットした総数 |
| $totalgoods | ファイルの中の 総商品数 |
|||||||
| $totalpages | 総ページ数 | なし | ファイルの中の 総ページ数 |
総ページ数 | 総ページ数 最大100 |
総ページ数 最大100 |
なし | |
| $page | 表示されている |
なし |
表示されている ページの番号 |
表示されている ページの番号 |
表示されている ページの番号 |
表示されている ページの番号 |
なし | |
| $from | $totalmatches の内、 表示されている 最初の商品の番号 |
無効 | 無効 | 無効 | $totalmatches の内、 表示されている 最初の商品の番号 |
$totalmatches の内、 表示されている 最初の商品の番号 |
$totalmatches の内、 表示されている 最初の商品の番号 |
$totalmatches の内、 表示されている 最初の商品の番号 |
| $to | $totalmatches の内、 表示されている 最後の商品の番号 |
無効 | 無効 | 無効 | $totalmatches の内、 表示されている 最後の商品の番号 |
$totalmatches の内、 表示されている 最後の商品の番号 |
$totalmatches の内、 表示されている 最後の商品の番号 |
$totalmatches の内、 表示されている 最後の商品の番号 |
| $counter | 表示されている |
表示されている |
表示されている ページの中での 商品の連番 |
表示されている ページの中での 商品の連番 |
同左 | 同左 | 同左 | 同左 |
| $resultnum | 表示された商品数 テンプレートの
$header、
$footerの中でのみ正確 |
|||||||
| $totalcounter | ファイルの中での 商品の連番 |
ファイルの中での 商品の連番 |
||||||
| $genreid | なし | なし | なし | なし | Product Group | 商品の 楽天ブックス ジャンルID |
商品のジャンルID | なし |
| $genrename | ||||||||
| $keyword | 検索に使用した キーワード |
検索に使用した キーワード |
検索に使用した キーワード |
検索に使用した キーワード |
同左 | 同左 | 同左 | 同左 |
| $encodedkeyword | 検索に使用した キーワードを UTF-8でURLENCODE |
検索に使用した キーワードを UTF-8でURLENCODE |
検索に使用した キーワードを UTF-8でURLENCODE |
検索に使用した キーワードを UTF-8でURLENCODE |
同左 | 同左 | 同左 | 同左 |
| $width | widthで指定する 画像の幅 |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| $height | heightで指定する 画像の幅 |
同左 | 同左 | 同左 | 同左 | 同左 | 同左 | 同左 |
| $postage | なし | なし | なし | なし | なし | 送料の区分 | 「送料込」 あるいは 「送料別」 |
なし |
| $creditcard | なし | なし | なし | なし | 「カード可」 | カード可 | 「カード可」 あるいは 「カード不可」 |
なし |
| $bids | ||||||||
| $initprice | ||||||||
| $starttime | ||||||||
| $endtime | ||||||||
| $timeleft | ||||||||
| $reviewaverage | レビューの 平均点 施設番号で 検索するとなし |
|||||||
| $reviewcount | レビューの数 施設番号で 検索するとなし |
|||||||
| $checkinTime | チェックイン時刻 | |||||||
| $checkoutTime | チェックアウト時刻 | |||||||
| $latitude | 緯度 日本測地系 (ミリ秒) |
|||||||
| $longitude | 経度 日本測地系 (ミリ秒) |
|||||||
| $latitude2 | 緯度 世界測地系 (度) |
|||||||
| $longitude2 | 経度 世界測地系 (度) |
|||||||
| $postalCode | 郵便番号 | |||||||
| $completeAddress | 都道府県を 含む住所 |
|||||||
| $prefecture | 都道府県 | |||||||
| $address | 都道府県を 含まない住所 |
|||||||
| $largeArea | なし | |||||||
| $smallArea | なし | |||||||
| $pref | ||||||||
| $l_area | ||||||||
| $s_area | ||||||||
| $telephoneNo | 電話番号 | |||||||
| $faxNo | FAX番号 | |||||||
| $access | 施設へのアクセス | |||||||
| $nearestStationName | 最寄の駅名 | |||||||
| $parkingInformation | 駐車場 | |||||||
| $hotelClassCode | ホテル種別コード | |||||||
| $roomname | ||||||||
| $facility | ||||||||
| $meal | ||||||||
| $ratetype | ||||||||
| $cell0〜$cell9 | 最大10個分の セルに入った情報を 文字コード変換して そのまま出力 |
|||||||
| $encodedcell0〜$encodedcell9 | 最大10個分の セルに入った情報を UTF-8のまま URLENCODEして 出力 |
|||||||