2013年3月17日日曜日

共通のリクエストパラメータ


共通のリクエストパラメータ

次の表は、Product Advertising API の全てのオペレーションで使用できるリクエストパラメータを示しています。

パラメータ定義必須AssociateTag

アソシエイトを一意に識別する半角英数字の文字列。この文字列は、Amazon が商品の販売に対する紹介料を加算するアソシエイトを識別するのに使われます。アソシエイトを識別せずにリクエストを実行しても、紹介料は支払われません。AssociateTag を CartCreate リクエストに指定した場合、 CartCreateで返される PurchaseURL に AssociateTag の値が自動的に指定されます。 アソシエイトタグを取得するには、http://affiliate.amazon.co.jpをご参照ください。 詳細については、AssociateTag パラメータをご参照ください。

有効な値: アソシエイトを一意に識別するために Amazon によって割り当てられた半角英数字の文字列。カスタマーが購入した場合に紹介料を受け取れるようにするには、全てのリクエストでこの値を指定します。 いいえ
AWSAccessKeyId リクエストの送信者を一意に識別する半角英数字の文字列。AWSAccessKeyIdを取得するには、http://aws.amazon.com をご参照ください。

有効な値: Amazon によって割り当てられたアクセスキー ID はい
ContentType レスポンスのコンテンツ形式を指定します。通常、ContentTypeは、RES Tリクエストで、Style パラメータを XSLT スタイルシートに設定した場合にだけ変更します。例えば、Product Advertising API のレスポンスを HTML 形式に変換するには、ContentTypeを text/html に設定します。詳細については、Styleをご参照ください。

デフォルト: text/xml有効な値: text/xml, text html いいえ
MerchantId

マーチャントを一意に識別するために Amazon によって割り当てられた半角英数字の文字列。次の値を指定できます。有効な値:



All—レスポンスには、全てのマーチャントが出品している商品が含まれます。


特定のマーチャント—特定のマーチャント ID. Amazon は、マーチャント ID をマーチャントに割り当てます。


Amazon (デフォルト)—Amazon も特定のマーチャント ID を持っています。この ID は、デフォルト値であるため、他のマーチャントとは区別されています。つまり、リクエストでマーチャント ID を指定しない場合、Amazon が出品している商品だけが返されます。リクエストで結果が返されない場合は、MerchantIdの値を "All" に変更してみてください。


FeaturedBuyBoxMerchant—「ショッピングカートに入れる」ボタンに表示されるマーチャント。これは、商品の詳細ページの「ショッピングカートに入れる」ボタンに関連付けられた出品者です。「ショッピングカートに入れる」ボタンには商品の詳細ページのデフォルトの出品者が表示され、カスタマーがこのボタンをクリックすると、この出品者から商品を購入することになります いいえ
Operation 実行する Product Advertising API のオペレーションを指定します。

有効な値: Product Advertising APIのオペレーション。例えば、 ItemLookup はい
Service Product Advertising API のサービスを指定します。Product Advertising API の全てのオペレーションで、値は1つしかありません。

有効な値: AWSECommerceService はい
Style Product Advertising API のレスポンスで返されるデータの形式を制御します。Styleは、REST リクエストだけに関係します。このパラメータに "XML"(デフォルト)を設定すると、純粋な XML レスポンスが生成されます。このパラメータに XSLT スタイルシートの URL を指定すると、 XML レスポンスが変換されます。詳細については、以下をご参照ください。ContentType

デフォルト: XML

有効な値: XSLT スタイルシートの URL。 いいえ
Validate オペレーションを実行しないようにします。実際にリクエストを実行することなくテストを行うには、Validateパラメータを True に設定します。リクエストにValidateを設定する場合、値を True にする必要があります。デフォルト値は Falseです。リクエストを実際に実行しないと(Validate=True)、リクエストに対する一部のエラーしか返されません。これは、リクエストの実行時にしか発生しないエラー(例えばno_exact_matches)があるからです。

デフォルト: False

有効な値: True | False いいえ
Version 使用するProduct Advertising API ソフトウェアと WSDL のバージョンです。デフォルトでは、バージョン 2005-10-05 が使用されます。バージョンを指定する場合は、2009-11-02 などのバージョンを指定します。有効なバージョン番号の一覧については、Product Advertising API のリリースノートを参照してください。最新版の Product Advertising API は、デフォルトでは使われないので注意してください。

デフォルト: 2005-10-05

有効な値: 有効なWSDLバージョンの日付。例えば、2009-11-02 いいえ
XMLEscaping レスポンスをシングルパスとダブルパスのどちらでXMLエンコードするかを指定します。デフォルトでは, XMLEscapingは Single で、Product Advertising API のレスポンスは XML 内で1回だけエンコードされます。例えば、レスポンスデータにアンパサンド文字 (&) が含まれている場合、その文字は通常のXMLエンコード (&) で返されます。もし、XMLEscapingが Double の場合、同じアンパサンド文字が2回 XML エンコードされます(&)。このXMLEscapingの値 Double は、XML 要素内のテキストをデコードしない、PHP などのクライアントで便利です。

デフォルト: Single

有効な値: Single, Double いいえ


AssociateTag

AssociateTagパラメータは Product Advertising API のリクエストにおいては、リモートショッピングカートを作成する場合以外ではオプションとなります。カートにアソシエイトタグを関連付けた場合は、そのショッピングカートに対する他の全てのカートオペレーションでアソシエイトタグを使用する必要があります。アソシエイトタグを使用しない場合、エラーが返されます。

もし CartCreate リクエストにアソシエイトタグを指定しないと、カスタマーがショッピングカート内の商品を購入した場合にアソシエイトとして紹介料を受け取ることができません。リモートショッピングカートを作成したあとにアソシエイトタグを追加する場合は、PurchaseURL の値に手動で追加する必要があります。

AssociateTagは、各国サイトで固有です。つまり、アソシエイトとして紹介料を受け取りたいサイトごとにアソシエイトタグを取得する必要があります。例えば、US サイトのアソシエイトタグを JP サイトで使用しても、アソシエイトの紹介料を得ることはできません。

アソシエイトタグは間違えないように指定してください。値が間違っていてもエラーは返されません。

0 件のコメント: