オプション

表 1. GetCandidateAddresses オプション

optionName

説明

PerformUSProcessing

米国住所を処理するかどうかを指定します。米国住所処理を有効にすると、GetCandidateAddresses は、米国住所の候補となる住所の取得を試みます。米国住所処理を無効にすると、米国住所は失敗します。つまり、Status 出力フィールドに "F" が設定されて返されます。出力フィールド Status.Code は、"DisabledCoder" となります。米国住所処理のライセンスを取得していない場合は、ジョブに米国住所が含まれるか否かにかかわらず、米国住所処理を無効にしなければ、ジョブを正常に実行することはできません。

注: 米国住所を正常に処理するには、米国住所処理の有効なライセンスを取得する必要があります。米国住所処理のライセンスを取得していないか、ライセンスの期限が切れているにもかかわらず、米国住所処理を有効にすると、エラーとなります。
Y
はい、米国住所を処理します (デフォルト)。
N
いいえ、米国住所を処理しません。

Database.US

米国住所処理に使用するデータベースを指定します。Management Console の [米国データベース リソース] パネルで定義されたデータベースのみが使用可能です。

PerformCanadianProcessing

カナダ住所を処理するかどうかを指定します。カナダ住所処理を有効にすると、GetCandidateAddresses は、カナダ住所の候補となる住所の取得を試みます。カナダ住所処理を無効にした場合、Status フィールドに "F" が設定されカナダ住所は失敗します。出力フィールド Status.Code は、"DisabledCoder" となります。カナダ住所処理のライセンスを取得していない場合は、ジョブにカナダ住所が含まれるか否かにかかわらず、カナダ住所処理を無効にしなければ、ジョブを正常に実行することはできません。

注: カナダ住所を正常に処理するには、カナダ住所処理の有効なライセンスを取得する必要があります。カナダ住所処理のライセンスを取得していないか、ライセンスの期限が切れているにもかかわらず、カナダ住所処理を有効にすると、エラーとなります。
Y
カナダ住所を処理します (デフォルト)。
N
カナダ住所を処理しません。

Database.Canada

カナダ住所処理に使用するデータベースを指定します。Management Console の [カナダ データベース リソース] パネルで定義されたデータベースのみが使用可能です。

PerformInternationalProcessing

国際住所 (米国およびカナダ以外の住所) を処理するかどうかを指定します。国際住所処理を有効にすると、GetCandidateAddresses は、国際住所の候補となる住所の取得を試みます。国際住所処理を無効にした場合、Status フィールドに "F" が設定され国際住所は失敗します。出力フィールド Status.Code は、"DisabledCoder" となります。国際住所処理のライセンスを取得していない場合は、ジョブに国際住所が含まれるか否かにかかわらず、国際住所処理を無効にしなければ、ジョブを正常に実行することはできません。

注: 国際住所を正常に処理するには、国際住所処理の有効なライセンスを取得する必要があります。国際住所処理のライセンスを取得していないか、ライセンスの期限が切れているにもかかわらず、国際住所処理を有効にすると、エラーとなります。
Y
国際住所を処理します (デフォルト)。
N
国際住所を処理しません。

Database.International

国際的な住所の検証に使用するデータベースを指定します。Management Console の [国際データベース リソース] パネルで定義されたデータベースのみが使用可能です。

OutputCasing

出力データの大文字と小文字の区別を指定します。次のいずれかです。

M
出力に大文字と小文字を混在させます (デフォルト)。例:

123 Main St
Mytown FL 12345

U
出力に大文字を使用します。例:

123 MAIN ST
MYTOWN FL 12345

MaximumResults

GetCandidateAddresses が返す候補住所の最大数。デフォルトは 10 です。最大数は 10 になります。

OutputShortCityName

米国住所に対しては、USPS® が承認する都市の略称がある場合に、それを返すかどうかを指定します。USPS® は、14 文字以上の都市名に対し、略称を定めています。都市の略称は 13 文字以下で、宛名ラベルのサイズが限られている場合に使用できます。短い都市名が存在しない都市に対しては、正式な都市名が返されます。

Y
短い都市名を返します。
N
短い都市名を返しません。

DualAddressLogic

(米国住所のみ)。通り情報と PO Box/地方配送路/幹線請負契約情報の両方が住所に含まれる場合に、GetCandidateAddresses が、通り一致を返すか、または PO Box/地方配送路/幹線請負契約一致を返すかを制御します。詳細については、二重住所ロジックについてを参照してください。

N
(デフォルト) USPS®CASS™ の規則では、以下の優先順位に基づいて、返す住所を決定します。
  1. PO Box
  2. Firm
  3. Highrise
  4. Street
  5. Rural Route
  6. General Delivery
S
住所行に関係なく、通り一致を返します。
P
住所行に関係なく、PO Box 一致を返します。

StreetMatchingStrictness

通り名のマッチングの精度 (米国住所のみ)。

E
入力された通り名は、データベースに完全に一致する必要があります。
T
マッチング アルゴリズムは "厳格" です。
M
マッチング アルゴリズムは "中" です (デフォルト)。
L
マッチング アルゴリズムは "あいまい" です。

FirmMatchingStrictness

企業名マッチングの精度 (米国住所のみ)。

E
入力された企業名は、データベースに完全に一致する必要があります。
T
マッチング アルゴリズムは "厳格" です。
M
マッチング アルゴリズムは "中" です (デフォルト)。
L
マッチング アルゴリズムは "あいまい" です。

DirectionalMatchingStrictness

道順マッチングの精度。

E
入力された道順は、データベースに完全に一致する必要があります。
T
マッチング アルゴリズムは "厳格" です。
M
マッチング アルゴリズムは "中" です (デフォルト)。
L
マッチング アルゴリズムは "あいまい" です。

PerformESM

Enhanced Street Matching (ESM) を実行するかどうかを指定します。ESM は、通常の住所検証プロセスでマッチしなかった任意の入力住所に対して、追加データによる別のマッチング ロジックを適用します。ESM は、米国住所にのみ適用されます。

Y
ESM 処理を実行します。
N
ESM 処理を実行しません (デフォルト)。

AddressLineSearchOnFail

ValidateAddress において、住所行で都市、州/省、郵便番号の検索を行うかどうかを指定します。

このオプションにより、ValidateAddress において、City、StateProvince、および PostalCode の各入力フィールドの値を使用して住所にマッチする結果が得られなかった場合に、AddressLine 入力フィールドで都市、州/省、郵便番号、および国を検索することができます。

入力住所において、AddressLine フィールドに都市、州/省、および郵便番号の情報が存在する場合は、このオプションを有効にすることを検討してください。

入力住所において、City、State/Province、および PostalCode フィールドが使用されている場合は、このオプションを無効にしてください。このオプションを有効にしてこれらのフィールドを使用すると、ValidateAddress がこれらのフィールド値の修正 (例えば、スペルミスのある都市名など) に失敗する可能性が高くなります。

Y
住所行フィールドを検索します (デフォルト)。
N
いいえ、AddressLine フィールドを検索しません。