Help

[重要] 重要

利用率低下により、このオペレーションおよび関連レスポンスグループは2010年07月25日をもってサポート終了となっておりますので、ご利用にならないようご注意ください。

Help オペレーションでは、Product Advertising API のオペレーションとレスポンスグループに関する情報が提供されます。オペレーションに関し、 Help は必須およびオプションのリクエストパラメータと、オペレーションで使用できるデフォルトおよびオプションのレスポンスグループの一覧を表示します。レスポンスグループに関し、 Help はレスポンスグループを使用できるオペレーションと、XMLレスポンスにレスポンスグループで返されるレスポンスタグの一覧を表示します。

Help オペレーションは、カスタマーアプリケーションではあまり使われません。次のように、開発者支援の目的で使用されます。

利用可能なサイト

全ての国のサイト

リクエストパラメータ

次の表では、 Helpのリクエストパラメータについて説明しています。パラメータ名は大文字と小文字が区別されます。

パラメータ定義必須
About

詳細について知りたいオペレーションまたはリクエストグループを指定します。

Product Advertising API の全てのオペレーションとレスポンスグループ

いいえ
HelpType

ヘルプトピックが、オペレーショングループとレスポンスグループのいずれかを指定します。HelpTypeおよびAboutの値は、どちらもオペレーショングループかレスポンスグループのいずれかに属する必要があり、2つを混在させることはできません。

有効な値: Operation, ResponseGroup

いいえ
ResponseGroup

返される値の種類を指定します。1つのリクエストに複数のレスポンスグループをカンマで区切って指定できます。

デフォルト: Request | Help

有効な値: 上記以外になし

いいえ

Help には、全てのオペレーションで使用できるパラメータを指定できます。詳細については、共通のリクエストパラメータをご参照ください。

レスポンスタグ

次の表では、 Help のレスポンスに含まれるデフォルトのレスポンスタグについて説明しています。

Element Tag定義
AvailableParameters オペレーションで使用できるオプションのリクエストパラメータ。詳細については、RequiredParametersをご参照ください。
AvailableResponseGroups オペレーションで使用できるオプションのレスポンスグループ。詳細については、DefaultResponseGroupをご参照ください。
DefaultResponseGroup オペレーションがデフォルトで使用するレスポンスグループ。詳細については、をご参照ください。
Element XMLレスポンスで使われている要素の名前。要素はXパスで表記されるので、WSDLで定義されているXML要素の階層構造がわかります。
Elements 1つまたは複数の Element のコンテナ。
Name Help リクエストにおけるオペレーションの名前。
Operation 指定したレスポンスグループを使用できるProduct Advertising API のオペレーションの名前。
OperationInformation オペレーションがHelpTypeの場合のレスポンスグループ全体のコンテナ。子タグには、Name, RequiredParameters, AvailableParameters, DefaultResponseGroups および AvailableResponseGroups があります。
RequiredParameters オペレーションで必須のリクエストパラメータ。
ValidOperations 1つまたは複数のオペレーションのコンテナ。指定したレスポンスグループを使用できるオペレーションを指定します。

これらのタグの親要素に関する詳細については、レスポンスグループの該当するレスポンスグループを参照してください。

リクエスト例

次のリクエストは、 ItemLookupオペレーションに関する情報を返します。リクエストのHelpTypeには "Operation" を設定する必要があります。これは、Aboutの値がオペレーションであるためです。

http://ecs.amazonaws.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[AWS アクセスキー ID]&
Operation=Help&
HelpType=Operation&
About=ItemLookup

このリクエストに対するレスポンスをレスポンス例に示します。

次のリクエストは、Largeレスポンスグループに関する情報を返します。リクエストのHelpTypeには "ResponseGroup" を設定する必要があります。これは、Aboutの値がレスポンスグループであるためです。

http://ecs.amazonaws.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[AWS アクセスキー ID]&
Operation=Help&
HelpType=ResponseGroup&
About=Large

レスポンス例

次に示すのは、上の例の最初のリクエストで返されるレスポンスの一部です。

<ResponseGroupInformation> 
<Name>Large</Name> 
  <CreationDate>2005-07-26</CreationDate> 
  <ValidOperations> 
  <Operation>ItemLookup</Operation> 
  <Operation>ItemSearch</Operation> 
  <Operation>ListLookup</Operation> 
  <Operation>SimilarityLookup</Operation> 
</ValidOperations>
<Elements> 
  <Element>Accessories/Accessory/ASIN</Element> 
  <Element>Accessories/Accessory/Title</Element> 
  <Element>Arguments/Argument/Name</Element> 
  <Element>Arguments/Argument/Value</Element> 
  <Element>BrowseNode/Ancestors/BrowseNode/BrowseNodeId</Element> 
  <Element>BrowseNode/Ancestors/BrowseNode/Name</Element> 
  <Element>BrowseNode/BrowseNodeId</Element> 
  <Element>BrowseNode/Children/BrowseNode/BrowseNodeId</Element> 
  <Element>BrowseNode/Children/BrowseNode/Name</Element> 
  <Element>BrowseNode/Name</Element> 
  <Element>CustomerReviews/AverageRating</Element> 
  <Element>CustomerReviews/Review/ASIN</Element> 
  <Element>CustomerReviews/Review/Content</Element> 
  <Element>CustomerReviews/Review/CustomerId</Element> 
  <Element>CustomerReviews/Review/Date</Element> 
  <Element>CustomerReviews/Review/HelpfulVotes</Element> 
  <Element>CustomerReviews/Review/Rating</Element> 
  <Element>CustomerReviews/Review/Summary</Element> 
  <Element>CustomerReviews/Review/TotalVotes</Element> 
  <Element>CustomerReviews/TotalReviewPages</Element> 
  <Element>CustomerReviews/TotalReviews</Element> 
  <Element>EditorialReviews/EditorialReview/Content</Element> 
  <Element>EditorialReviews/EditorialReview/Source</Element> 
  <Element>Errors/Error/Code</Element> 
  <Element>Errors/Error/Message</Element> 

Help では、XMLレスポンス要素がXパス形式で表記されることにご注意ください。この表記は、レスポンス要素の階層を理解するのに便利です。

関連オペレーション

なし