出力データ オプション
以下の表に、ValidateAddress が返す情報の種類を制御するオプションの一覧を示します。これらのオプションのうちの一部は、カナダ住所に対してオーバーライドすることができます。詳細については、カナダ住所のオプションを参照してください。
オプション名 |
説明 |
---|---|
OutputRecordType |
出力レコードのタイプ。1 つ以上の場合はリストで提供されます。
|
OutputFieldLevelReturnCodes |
フィールドレベルの結果インジケータを含めるかどうかを指定します。フィールドレベルの結果インジケータは、各住所要素をどのように処理したかを示します。フィールドレベルの結果インジケータは、修飾子 "Result" で返されます。例えば、HouseNumber のフィールドレベルの結果インジケータは HouseNumber.Result に格納されます。結果インジケータの出力フィールドの完全な一覧は、フィールドレベルの結果インジケータを参照してください。
|
OutputFormattedOnFail |
住所の妥当性を確認できない場合に書式を整えた住所を返すかどうかを指定します。住所には、その国の標準住所書式が設定されます。このオプションを選択しない場合、住所の妥当性を確認できないと、出力住所フィールドは空白になります。 注: このオプションは、米国およびカナダの住所のみに適用されます。その他の住所に対して書式を整えたデータは返されません。
OutputRecordType オプションで指定されたフォーマットを使用して、書式を整えた住所が返されます。OutputRecordType=E を指定した場合は、妥当性が確認できた住所に対しては、パース済みで妥当性を確認済みの住所が、パース済み住所要素に含まれることに注意してください。住所の妥当性が確認できなかった場合には、パース済み住所要素には、入力住所がパース済み形式で含まれることになります。ValidateAddress が住所の妥当性を確認できたかどうかにかかわらず、必ず入力住所をパース済み形式で出力したい場合は、OutputRecordType=I を指定します。 Option.OutputRecordType オプションで指定されたフォーマットを使用して、書式を整えた住所が返されます。Option.OutputRecordType=E を指定した場合は、妥当性が確認できた住所に対しては、パース済みで妥当性を確認済みの住所が、パース済み住所要素に含まれることに注意してください。住所の妥当性が確認できなかった場合には、パース済み住所要素には、入力住所がパース済み形式で含まれることになります。ValidateAddress が住所の妥当性を確認できたかどうかにかかわらず、必ず入力住所をパース済み形式で出力したい場合は、Option.OutputRecordType=I を指定します。 [標準住所を含める]、[住所行の要素を含める]、および [郵便情報を含める] の各チェック ボックスで指定されたフォーマットを使用して、書式を整えた住所が返されます。[住所行の要素を含める] を選択した場合は、妥当性が確認できた住所に対しては、パース済みで妥当性を確認済みの住所が、パース済み住所要素に含まれることに注意してください。住所の妥当性が確認できなかった場合には、パース済み住所要素には、入力住所がパース済み形式で含まれることになります。ValidateAddress が住所の妥当性を確認できたかどうかにかかわらず、必ず入力住所をパース済み形式で出力したい場合は、[正規化された入力住所要素を含める] を選択します。 Y を指定する場合は、OutputRecordType に対して "A" と "E" またはそのいずれかを指定する必要があります。 Y を指定する場合は、Option.OutputRecordType に対して "A" と "E" またはそのいずれかを指定する必要があります。 このオプションをオンにする場合は、[標準住所を含める] と [住所行の要素を含める] またはそのいずれかを選択する必要があります。 |
OutputStreetNameAlias |
米国住所に対しては、ストリート名のエイリアスを出力に使用するかどうかを指定します。ストリート名のエイリアスとは、ストリートに対する別名で、通常は、ストリート上の特定の範囲の住所のみに対して使用されます。ストリート名のエイリアスを出力に使用しないと指定した場合は、ストリートにエイリアス名があるかどうかにかかわらず、出力ではストリートの "基本" 名が使用されます。基本名とは、ストリート全体に適用される名称です。
|
OutputStreetNameAlias |
米国住所に対しては、入力に使用されているストリート名のエイリアスの処理方法を指定します。ストリート名のエイリアスとは、ストリートに対する別名で、通常は、ストリート上の特定の範囲の住所のみに対して使用されます。 このオプションを有効にすると、入力に使用されているストリート名のエイリアスが、出力にも使用されます。このオプションを有効にしない場合は、入力に使用されているストリート名のエイリアスが、出力では基本ストリート名に変換されますが、次の例外があります。
これは、ValidateAddress でストリート名のエイリアスを処理する方法を制御する 3 つのオプションのうちの 1 つです。他の 2 つは OutputPreferredAlias と OutputAbbreviatedAlias です。 注: OutputAbbreviatedAlias を有効にした場合は、OutputStreetNameAlias を無効にした場合でも、必ず省略形エイリアスが出力に使用されます。
|
OutputAddressBlocks |
実際の郵便物に印字される、書式を整えた住所を返すかどうかを指定します。住所の各行が、別々の住所ブロック フィールドに入れて返されます。AddressBlock1 から AddressBlock9 まで、最大 9 つの住所ブロック出力フィールドが使用されます。 例えば、以下の住所入力の場合、 AddressLine1: 4200 Parliament Place 以下の住所ブロックが出力されます。 AddressBlock1: 4200 PARLIAMENT PL STE 600 ValidateAddress は、郵便当局の規格に従って、住所の書式を整えて、住所ブロックの形式にします。国名は、万国郵便連合 (UPU) の国名で返されます。OutputCountryFormat オプションは、住所ブロックの国名には影響を与えないことに注意してください。このオプションは、Country 出力フィールドに返される名前のみに影響を与えます。 米国およびカナダ以外の住所に対しては、ValidateAddress で住所の妥当性が確認できなかった場合、住所ブロックは返されません。米国およびカナダの住所に対しては、妥当性が確認できなかった場合も住所ブロックが返されます。
|
OutputAMAS |
実際の郵便物に印字される、書式を整えた住所を返すかどうかを指定します。住所の各行が、別々の住所ブロック フィールドに入れて返されます。AddressBlock1 から AddressBlock9 まで、最大 9 つの住所ブロック出力フィールドが使用されます。 例えば、以下の住所入力の場合、 AddressLine1: 4200 Parliament Place 以下の住所ブロックが出力されます。 AddressBlock1: 4200 PARLIAMENT PL STE 600 ValidateAddress は、郵便当局の規格に従って、住所の書式を整えて、住所ブロックの形式にします。国名は、万国郵便連合 (UPU) の国名で返されます。OutputCountryFormat オプションは、住所ブロックの国名には影響を与えないことに注意してください。このオプションは、Country 出力フィールドに返される名前のみに影響を与えます。 米国およびカナダ以外の住所に対しては、ValidateAddress で住所の妥当性が確認できなかった場合、住所ブロックは返されません。米国およびカナダの住所に対しては、妥当性が確認できなかった場合も住所ブロックが返されます。
|