Class rakutenApi_CDSearch

Description
Description | Methods (details)

楽天CD検索APIインターフェイス

rakutenApi::connect("CDSearch")
 で使用できます。
 (実際にrakutenApi::connectをコールする際には、オブジェクトからコールする必要があります)

Located in /CDSearch.php (line 86) 

rakutenApi_Common
   |
   --rakutenApi_CDSearch
Method Summary
Description | Methods (details)
void rakutenApi_CDSearch ([mixed $developer_id = RAC_DEFAULT_API_BASE_DEVELOPER_ID], [mixed $affiliate_id = NULL])
string getCarrier ()
string getCount ()
string getFirst ()
string getHits ()
array getItem ()
string getLast ()
string getPage ()
string getPageCount ()
void setAvailability (string $setter)
void setCarrier (string $setter)
void setCatalogCode (string $setter)
void setField (string $setter)
void setGenreId (string $setter)
void setHits (string $setter)
void setImageFlag (string $setter)
void setKeyword (string $setter)
void setMaxPrice (string $setter)
void setMinPrice (string $setter)
void setNGKeyword (string $setter)
void setPage (string $setter)
void setSearchmode (string $setter)
void setShopCode (string $setter)
void setSort (string $setter)
Methods
Description | Methods (details)
Constructor rakutenApi_CDSearch (line 115)

Constructor

void rakutenApi_CDSearch ([mixed $developer_id = RAC_DEFAULT_API_BASE_DEVELOPER_ID], [mixed $affiliate_id = NULL])
getCarrier (line 388)

キャリア情報を取得

string getCarrier ()
getCount (line 338)

検索結果の総商品数を取得

string getCount ()
getFirst (line 358)

検索結果の何件目からかを取得

string getFirst ()
getHits (line 378)

1度に取得する商品数を取得

string getHits ()
getItem (line 408)

商品情報・店舗情報・ジャンル情報をまとめて取得

array getItem ()
getLast (line 368)

検索結果の何件目までかを取得

string getLast ()
getPage (line 348)

現在のページ番号を取得

string getPage ()
getPageCount (line 398)

総ページ数を取得

string getPageCount ()
setAvailability (line 255)

販売可能商品のみ取得するか

無効:RAC_CD_SEARCH_AVAILABILITY_OFF 有効:RAC_CD_SEARCH_AVAILABILITY_ON

void setAvailability (string $setter)
  • string $setter
setCarrier (line 284)

キャリアを設定する

ＰＣ:RAC_CD_SEARCH_CARRIER_PC 携帯:RAC_CD_SEARCH_CARRIER_MOBILE

void setCarrier (string $setter)
  • string $setter
setCatalogCode (line 195)

カタログコードを設定する

void setCatalogCode (string $setter)
  • string $setter: カタログコード
setField (line 269)

検索フィールドを設定する

狭く:RAC_CD_SEARCH_FIELD_NARROW 広く:RAC_CD_SEARCH_FIELD_WIDE

void setField (string $setter)
  • string $setter: 検索フィールド
setGenreId (line 183)

ジャンルIDを設定する

void setGenreId (string $setter)
  • string $setter: ジャンルID
setHits (line 207)

1ページあたりの取得件数を設定する

void setHits (string $setter)
  • string $setter: 1ページあたりの取得件数
setImageFlag (line 299)

商品画像があるものだけを取得するか

無効:RAC_CD_SEARCH_IMAGE_OFF 有効:RAC_CD_SEARCH_IMAGE_ON

void setImageFlag (string $setter)
  • string $setter: 商品画像有無フラグ
setKeyword (line 131)

検索キーワードを設定する

検索キーワード、ジャンルID、カタログコードのいずれかが指定されていることが必須です。 ただし、カタログコードが指定された場合、検索キーワード、ジャンルIDの指定は無効になります。

void setKeyword (string $setter)
  • string $setter: 検索キーワード
setMaxPrice (line 240)

最大価格を設定する

void setMaxPrice (string $setter)
  • string $setter: 最大価格
setMinPrice (line 229)

最小価格を設定する

void setMinPrice (string $setter)
  • string $setter: 最小価格
setNGKeyword (line 326)

除外キーワードを設定する

void setNGKeyword (string $setter)
  • string $setter: 除外キーワード
setPage (line 218)

取得ページを設定する

void setPage (string $setter)
  • string $setter: 取得ページ
setSearchmode (line 315)

検索モードを指定する

RAC_CD_SEARCH_MODE_AND => AND検索 RAC_CD_SEARCH_MODE_OR => OR 検索 デフォルトは、AND検索

void setSearchmode (string $setter)
  • string $setter: 検索モード
setShopCode (line 172)

ショップコードを設定する

void setShopCode (string $setter)
  • string $setter: ショップコード
setSort (line 161)

ソートを設定する

RAC_CD_SEARCH_SORT_AFFILIATERATE_ASC： アフィリエイト料率順(昇順) RAC_CD_SEARCH_SORT_AFFILIATERATE_DESC： アフィリエイト料率順(降順) RAC_CD_SEARCH_SORT_REVIEWCOUNT_ASC： レビュー件数順(昇順) RAC_CD_SEARCH_SORT_REVIEWCOUNT_DESC： レビュー件数順(降順) RAC_CD_SEARCH_SORT_ITEMPRICE_ASC： 価格順(昇順) RAC_CD_SEARCH_SORT_ITEMPRICE_DESC： 価格順(降順) RAC_CD_SEARCH_SORT_UPDATETIMESTAMP_ASC： 商品更新日時順(昇順) RAC_CD_SEARCH_SORT_UPDATETIMESTAMP_DESC： 商品更新日時順(降順) RAC_CD_SEARCH_SORT_RANDOM： ランダム順

void setSort (string $setter)
  • string $setter: ソート

Inherited Methods

Inherited From rakutenApi_Common

rakutenApi_Common::execute()
rakutenApi_Common::free()
rakutenApi_Common::getAll()
rakutenApi_Common::getArg()
rakutenApi_Common::getErrorCode()
rakutenApi_Common::getErrorMessage()
rakutenApi_Common::getStatus()
rakutenApi_Common::getStatusMsg()
rakutenApi_Common::getXMLContents()
rakutenApi_Common::isSuccess()
rakutenApi_Common::setAffiliateId()
rakutenApi_Common::setDeveloperId()

Documentation generated on Sun, 07 Oct 2007 13:10:55 +0900 by phpDocumentor 1.2.3