ListSearch

[重要] 重要

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

説明

カスタマー名またはEメールアドレスを ListSearch オペレーションで指定すると、関連付けられているリストIDが返されます (リスト商品は返されません) 。リスト商品を検索するには、 ListSearch で返されたリストIDを ListLookup で使用します。

リクエストで、フルネーム、名前だけまたは姓だけを指定すると、さまざまな人が所有する複数のリストが返されます。ID情報としてEメールを使用すると、さらに結果を絞り込めます。

[注]注意

Eメールアドレスの@記号は、必ず %40 にURLエンコードしてください。これをしないと、リクエストは失敗します。

利用可能なサイト

全ての国のサイト

リクエストパラメータ

Wishlists と WeddingRegistry のリストタイプの場合、次のパラメータを1つまたは複数指定する必要があります。

  • e-mail

  • FirstName

  • LastName

  • Name

BabyRegistry リストタイプの場合、次のパラメータを1つまたは複数指定する必要があります。

  • FirstName

  • LastName

例えば、e-mail address または Name を指定してベビーレジストリを取得することはできません。

名前説明必須
City

リストの作成者が住んでいる都市。

タイプ: 文字列. スペースを使用する場合は、URLエンコード (%20) してください

タイプ: 文字列

デフォルト値: なし

いいえ
ContentType

取り出すリストの種類を指定します。

タイプ: 文字列

デフォルト値: なし

有効な値: BabyRegistry | WeddingRegistry | Wishlist

いいえ
e-mail

リスト作成者のEメールアドレス。このパラメータは、BabyRegistry ではサポートされていません。

タイプ: 文字列

デフォルト値: なし

有効な値: 有効な E メールアドレス@記号は%40にURLエンコードしてください。

いいえ
FirstName

リストの作成者のファーストネーム (名)。ListSearch は、指定した FirstName を名に含む全てのリストオーナーを返します。例えば、 "John" を指定した場合、 "John"、"Johnny"、"Johnson" の名前が返されます。

タイプ: 文字列。スペースを使用する場合は、URLエンコード (%20) してください。

タイプ: 文字列

デフォルト値: なし

いいえ
LastName

リストの作成者のラストネーム (姓)。ListSearch は、指定した LastName を姓に含む全てのリストオーナーを返します。例えば、"Ender" を指定した場合、"Ender"、"Enders"、"Enderson" の姓が返されます。

タイプ: 文字列。スペースを使用する場合は、URLエンコード (%20) してください。

タイプ: 文字列

デフォルト値: なし

いいえ
ListPage

リストIDの特定のページを取得します。各ページに10個のリストIDが表示されます。合計ページ数は TotalPages レスポンスタグで返されます。デフォルトでは最初のページが返されます。

タイプ: 文字列

デフォルト: なし

有効な値: 1~20までの整数.

いいえ
Name

リストの作成者の氏名。このパラメータは、BabyRegistry ではサポートされていません。

タイプ: 文字列。スペースを使用する場合は、URLエンコード (%20) してください。

タイプ: 文字列

デフォルト値: なし

いいえ
State

リストの作成者が住んでいる都道府県または州。

タイプ: 文字列。スペースを使用する場合は、URLエンコード (%20) してください。

タイプ: 文字列

デフォルト値: なし

いいえ
ResponseGroup

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

タイプ: 文字列

デフォルト: ListInfo

有効な値: ListMinimum

いいえ

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

レスポンス

名前説明
CustomerName リスト作成者の名前。
DateCreated リストの作成日。
List CustomerName、DateCreated、ListId、ListType、ListURL、TotalItems、TotalPages を含む、リストタグのコンテナ。
ListId リストを一意に識別する半角英数字の文字列。
Lists 1つまたは複数のリストのコンテナ。
ListType リストの種類: BabyRegistry、WeddingRegistry、またはWishlist。
ListURL リストのURL。
TotalItems リスト上の商品数。
TotalPages リストのページ数。各ページに最大10件のリストが表示されます。
TotalResults 見つかったリストの数。

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

次のリクエストは、John Smith のほしい物リストIDを返しています。

http://ecs.amazonaws.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[アクセスキー ID]&
Operation=ListSearch&
ListType=WishList&
Name=John20Smith

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

次のリクエストは、JohnSmith@ISP.com のほしい物リストIDを返しています。

http://ecs.amazonaws.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[アクセスキー ID]&
Operation=ListSearch&
ListType=WishList&
e-mail=JohnSmith40ISP.com

レスポンス例

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

<TotalResults>2</TotalResults> 
<TotalPages>1</TotalPages>
<List>
  <List>
    <ListId>BR4444442H77</ListId> 
    <ListURL>http://www.amazon.com/gp/registry/BR4444442H77</ListURL> 
    <ListType>WishList</ListType> 
    <TotalItems>70</TotalItems> 
    <TotalPages>7</TotalPages> 
    <DateCreated>1999-10-06</DateCreated> 
    <CustomerName>John Smith</CustomerName> 
  </List>
  <List>
    <ListId>BR6666662H77</ListId> 
    <ListURL>http://www.amazon.com/gp/registry/BR6666662H77</ListURL> 
    <ListType>WishList</ListType> 
    <TotalItems>51</TotalItems> 
    <TotalPages>6</TotalPages> 
    <DateCreated>2002-10-02</DateCreated> 
    <CustomerName>John Smith</CustomerName> 
  </List>
</Lists>  

デフォルトのレスポンスは、見つかったリストに関する要約情報を返します。この例は、John Smith が2つのほしい物リストをもっていることを示しています。最初のListIdが BR4444442H77 のリストには、70個の商品が含まれています。2番目のListIdが BR6666662H77 のリストには、51個の商品が含まれています。ほしい物リストの商品を返すには、これらのリストIDを使用して ListLookup オペレーションを実行します。

レスポンスから、ListIdがわかっていれば、URL: http://www.amazon.com/gp/registry/ListId を使用して直接リストを参照することもできます。上の例で、最初のListId は BR4444442H77 です。

[注]注意

ListLookup では、BabyRegistry 内の商品にアクセスできません。現時点では、BabyRegistry 内の商品を表示する方法はありません。

関連オペレーション