入力
フィールド名 パラメータ |
書式 |
説明 |
---|---|---|
Action |
String |
実行するアクションを指定します。次のいずれかです。
|
AlternativeContext |
String |
commit アクションにおいて、[Alternatives.InContext] フィールドと [Alternatives.OutContext] フィールドのどちらからの値を選択したかを表します。このフィールドは、他のアクションでは無視されます。次のいずれかです。
|
AlternativeIndex |
文字列 |
commit アクションにおいて、作成中の住所で使用する値を指定します。例えば、都市を検索し、BuildGlobalAddress が 3 つの都市を返した場合に、インデックス値を指定することによって、どの都市を選択したかを表します。BuildGlobalAddress が提示する選択肢のインデックス値は 0 から開始します。つまり、最初の選択肢のインデックス値は 0、2 つめの選択肢のインデックス値は 1 で、以後同様に続きます。 この入力フィールドは、commit 以外のアクションでは無視されます。 |
Country |
文字列 |
init アクションにおいて、作成する住所が所在する国を指定します。入力した国フォーマット (英語名、2 文字の ISO 3116-1 Alpha-2 コード、または 3 文字の ISO 3116-1 Alpha-3 コード) を使用して、国を指定します。ISO コードの一覧は、ISO 国コードとモジュール サポートを参照してください。 この入力フィールドは、init 以外のアクションでは無視されます。 |
FieldIndex |
文字列 |
search アクションに対しては、検索する住所要素を指定します。clear アクションに対しては、確定を取り消す住所要素を指定します。次のいずれかです。
この入力フィールドは、search と clear 以外のアクションでは無視されます。 |
SearchValue |
文字列 |
search アクションにおいて、検索する値を指定します。この値は、[FieldIndex] で指定したフィールドに対して適切な値である必要があります。例えば、[FieldIndex] で ZIP Code フィールドを指定した場合は、このフィールドに ZIP Code または ZIP Code の一部を入力します。同様に、[FieldIndex] で City フィールドを選択した場合は、このフィールドに都市名または都市名の一部を指定します。このフィールドを空白のままにすると、search はインコンテキストのすべての値を返します。インコンテキストおよびアウトオブコンテキストの値については、コンテキストとはを参照してください。 この入力フィールドは、search 以外のアクションでは無視されます。 |
SessionId |
文字列 |
この呼び出しで使用するセッション ID を指定します。セッション ID を取得するには、init アクションを使用します。動作のない状態が 5 分間続くと、セッションの有効期限が切れ、新しい init 呼び出しを実行して、新しいセッションを開始する必要が生じます。 このフィールドは、init 以外のすべてのアクションで必須です。 |