入力

実行するアクションを指定します。次のいずれかです。

init

初期化。このアクションは、セッションを開始し、他のすべてのアクションで必要となるセッション ID を返します。init アクションでは、[Country] 入力フィールドが必須です。

search

特定の住所要素に対する値を検索し、選択肢となる値のリストを返します。search アクションでは、次の入力フィールドが必須です。

• FieldIndex
• SearchValue
• SessionId

commit

search アクションで返された値のうちの 1 つをフィールドに代入します。commit アクションでは、次の入力フィールドが必須です。

• AlternativeIndex
• AlternativeContext
• SessionId

clear

[FieldIndex] フィールドに指定されたフィールドの確定を取り消します。clear アクションでは、次の入力フィールドが必須です。

• FieldIndex
• SessionID

close

セッションを終了します。close アクションでは、[SessionId] 入力フィールドが必須です。

commit アクションにおいて、[Alternatives.InContext] フィールドと [Alternatives.OutContext] フィールドのどちらからの値を選択したかを表します。このフィールドは、他のアクションでは無視されます。次のいずれかです。

in

[Alternatives.InContext] フィールドからの値を確定しています。つまり、[AlternativeIndex] 入力フィールドで指定した値は、[Alternatives.InContext] 出力フィールドの値に対応します。

out

[Alternatives.OutContext] フィールドからの値を確定しています。つまり、[AlternativeIndex] 入力フィールドで指定した値は、[Alternatives.OutContext] 出力フィールドの値に対応します。

commit アクションにおいて、作成中の住所で使用する値を指定します。例えば、都市を検索し、BuildGlobalAddress が 3 つの都市を返した場合に、インデックス値を指定することによって、どの都市を選択したかを表します。BuildGlobalAddress が提示する選択肢のインデックス値は 0 から開始します。つまり、最初の選択肢のインデックス値は 0、2 つめの選択肢のインデックス値は 1 で、以後同様に続きます。

この入力フィールドは、commit 以外のアクションでは無視されます。

init アクションにおいて、作成する住所が所在する国を指定します。入力した国フォーマット (英語名、2 文字の ISO 3116-1 Alpha-2 コード、または 3 文字の ISO 3116-1 Alpha-3 コード) を使用して、国を指定します。ISO コードの一覧は、ISO 国コードとモジュール サポートを参照してください。

この入力フィールドは、init 以外のアクションでは無視されます。

search アクションに対しては、検索する住所要素を指定します。clear アクションに対しては、確定を取り消す住所要素を指定します。次のいずれかです。

all

すべての住所要素に対して、"clear" アクションを実行します。このオプションは、"clear" アクションのみに適用されます。

<インデックス番号>

特定の住所要素に対して、アクションを実行します。住所要素のインデックスを調べるには、[Field.n.Name] フィールドを参照して、必要なフィールドを探します。値 n は、フィールドのインデックスを表します。例えば、米国住所の ZIP Code のインデックスを調べる場合を考えます。init 呼び出しの後、[Field.0.Name] が "Zip" となるため、ZIP Code のフィールド インデックスが "0" であることがわかります。

この入力フィールドは、search と clear 以外のアクションでは無視されます。

search アクションにおいて、検索する値を指定します。この値は、[FieldIndex] で指定したフィールドに対して適切な値である必要があります。例えば、[FieldIndex] で ZIP Code フィールドを指定した場合は、このフィールドに ZIP Code または ZIP Code の一部を入力します。同様に、[FieldIndex] で City フィールドを選択した場合は、このフィールドに都市名または都市名の一部を指定します。このフィールドを空白のままにすると、search はインコンテキストのすべての値を返します。インコンテキストおよびアウトオブコンテキストの値については、コンテキストとはを参照してください。

この入力フィールドは、search 以外のアクションでは無視されます。