出力データ オプション

以下の表に、ValidateAddress が返す情報の種類を制御するオプションの一覧を示します。これらのオプションのうちの一部は、カナダ住所に対してオーバーライドすることができます。詳細については、カナダ住所のオプションを参照してください。

表 1. 出力データ オプション

オプション名

説明

OutputRecordType

出力レコードのタイプ。1 つ以上の場合はリストで提供されます。

A
住所データの 1 ~ 4 行に加えて、都市、州、郵便番号、企業名、および都市化名情報を返します。各住所行は、封筒に記載される住所の実際の行に対応しています。詳細については、出力を参照してください。住所の妥当性を確認できた場合は、住所行には正規化済み住所が含まれます。正規化済み住所では、句読文字が取り除かれ、方向指示とストリート接尾語には省略形が使用され、住所要素が修正されています。住所の妥当性を確認できなかった場合は、住所行には入力住所がそのまま含まれます ("パス スルー" データ)。OutputRecordType=A を指定しなかった場合でも、妥当性が確認されなかった住所は必ず、パス スルー データとして住所行フィールドに含まれます。
E
パース済み住所要素。家番号、ストリート名、ストリート接尾語、方向指示などの住所の各要素が、個別のフィールドに返されます。詳細については、パース済み住所要素出力を参照してください。"E" を指定し、OutputFormattedOnFail=Y を指定した場合は、パース済み住所要素に、妥当性が確認できなかった住所の入力住所が含まれることになります。
I
パース済み入力。このオプションでは、住所の妥当性を確認できたかどうかにかかわらず、入力住所をパース済み形式で返します。家番号、ストリート名、ストリート接尾語、方向指示などの入力住所の各要素が、個別のフィールドに返されます。パース済み入力 (値 "I") は、妥当性を確認できなかった入力だけでなく、すべての入力住所をパース済み形式で返す点で、OutputRecordType=EOutputFormattedOnFail=Y の組み合わせとは異なります。詳細については、パース済み入力を参照してください。
P
郵便データ。出力住所には、妥当性が確認された各住所の追加データが含まれます。詳細については、郵便データ出力を参照してください。
空白
住所データまたは郵便データを返しません。

OutputFieldLevelReturnCodes

フィールドレベルの結果インジケータを含めるかどうかを指定します。フィールドレベルの結果インジケータは、各住所要素をどのように処理したかを示します。フィールドレベルの結果インジケータは、修飾子 "Result" で返されます。例えば、HouseNumber のフィールドレベルの結果インジケータは HouseNumber.Result に格納されます。結果インジケータの出力フィールドの完全な一覧は、フィールドレベルの結果インジケータを参照してください。

N
フィールドレベルのリターン コードを出力しません (デフォルト)。
Y
フィールドレベルのリターン コードを出力します。

OutputFormattedOnFail

住所の妥当性を確認できない場合に書式を整えた住所を返すかどうかを指定します。住所には、その国の標準住所書式が設定されます。このオプションを選択しない場合、住所の妥当性を確認できないと、出力住所フィールドは空白になります。

注: このオプションは、米国およびカナダの住所のみに適用されます。その他の住所に対して書式を整えたデータは返されません。
N
失敗した住所の書式を整えません (デフォルト)。
Y
失敗した住所の書式を整えます。

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

米国住所に対しては、ストリート名のエイリアスを出力に使用するかどうかを指定します。ストリート名のエイリアスとは、ストリートに対する別名で、通常は、ストリート上の特定の範囲の住所のみに対して使用されます。ストリート名のエイリアスを出力に使用しないと指定した場合は、ストリートにエイリアス名があるかどうかにかかわらず、出力ではストリートの "基本" 名が使用されます。基本名とは、ストリート全体に適用される名称です。

N
出力において、ストリート名のエイリアスを返しません。
Y
ストリート名のエイリアスが存在する場合は、出力において、ストリート名のエイリアスを返します (デフォルト)。

OutputStreetNameAlias

米国住所に対しては、入力に使用されているストリート名のエイリアスの処理方法を指定します。ストリート名のエイリアスとは、ストリートに対する別名で、通常は、ストリート上の特定の範囲の住所のみに対して使用されます。

このオプションを有効にすると、入力に使用されているストリート名のエイリアスが、出力にも使用されます。このオプションを有効にしない場合は、入力に使用されているストリート名のエイリアスが、出力では基本ストリート名に変換されますが、次の例外があります。

  • 入力において、よく使用されるエイリアスが使用されている場合は、そのエイリアスが必ず出力で使用されます。
  • 入力で使用されている変更名のエイリアスは、出力では必ず基本ストリート名に変換されます。

これは、ValidateAddress でストリート名のエイリアスを処理する方法を制御する 3 つのオプションのうちの 1 つです。他の 2 つは OutputPreferredAliasOutputAbbreviatedAlias です。

注: OutputAbbreviatedAlias を有効にした場合は、OutputStreetNameAlias を無効にした場合でも、必ず省略形エイリアスが出力に使用されます。
N
出力において、ストリート名のエイリアスを返しません。
Y
入力されたストリート名がエイリアスである場合は、出力において、ストリート名のエイリアスを返します (デフォルト)。

OutputAddressBlocks

実際の郵便物に印字される、書式を整えた住所を返すかどうかを指定します。住所の各行が、別々の住所ブロック フィールドに入れて返されます。AddressBlock1 から AddressBlock9 まで、最大 9 つの住所ブロック出力フィールドが使用されます。

例えば、以下の住所入力の場合、

AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706

以下の住所ブロックが出力されます。

AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
AddressBlock3: UNITED STATES OF AMERICA

ValidateAddress は、郵便当局の規格に従って、住所の書式を整えて、住所ブロックの形式にします。国名は、万国郵便連合 (UPU) の国名で返されます。OutputCountryFormat オプションは、住所ブロックの国名には影響を与えないことに注意してください。このオプションは、Country 出力フィールドに返される名前のみに影響を与えます。

米国およびカナダ以外の住所に対しては、ValidateAddress で住所の妥当性が確認できなかった場合、住所ブロックは返されません。米国およびカナダの住所に対しては、妥当性が確認できなかった場合も住所ブロックが返されます。

N
住所ブロックを返しません。こちらがデフォルトです。
Y
住所ブロックを返します。

OutputAMAS

実際の郵便物に印字される、書式を整えた住所を返すかどうかを指定します。住所の各行が、別々の住所ブロック フィールドに入れて返されます。AddressBlock1 から AddressBlock9 まで、最大 9 つの住所ブロック出力フィールドが使用されます。

例えば、以下の住所入力の場合、

AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706

以下の住所ブロックが出力されます。

AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
AddressBlock3: UNITED STATES OF AMERICA

ValidateAddress は、郵便当局の規格に従って、住所の書式を整えて、住所ブロックの形式にします。国名は、万国郵便連合 (UPU) の国名で返されます。OutputCountryFormat オプションは、住所ブロックの国名には影響を与えないことに注意してください。このオプションは、Country 出力フィールドに返される名前のみに影響を与えます。

米国およびカナダ以外の住所に対しては、ValidateAddress で住所の妥当性が確認できなかった場合、住所ブロックは返されません。米国およびカナダの住所に対しては、妥当性が確認できなかった場合も住所ブロックが返されます。

N
住所ブロックを返しません。こちらがデフォルトです。
Y
住所ブロックを返します。