ファイルのジオコーディング (Geocode File) (ジオコーティング)

サマリー

住所または場所の大きなローカル テーブルをフィーチャクラスのポイントに変換するか、CSV または XLS テーブルとして変換します。 このツールは、ArcGIS Enterprise ポータルでホストされているロケーターを使用します。

注意:

このツールは、ArcGIS Enterprise 10.7 以降のポータルと組み合わせた ArcGIS Pro 2.4 以降で動作します。

使用法

  • このツールは入力として次のテーブル形式をサポートします。

    • カンマ区切り値のファイル (.csv)
    • ファイル ジオデータベース テーブル
    • Microsoft Excel ワークシート (.xls および .xlsx ファイル)

    入力 CSV テーブルの場合、入力ファイルの最初の行は、ロケーターから追加されるフィールドとともに、出力テーブルのフィールド名として使用されます。 フィールド名には、空白文字または特殊文字 ($ や * など) は使用できません。

    ArcGIS Pro での Microsoft Excel ファイルの操作の詳細

    注意:

    ファイル ジオデータベース形式の入力テーブルでジオコード結果を返す最も簡単な方法は、ファイル ジオデータベースの内容を制限するか、テーブルを 1 つ含むファイル ジオデータベースを指定することです。

  • 単一のフィールドに格納されている住所、複数のフィールドに分割されている住所、または単一のフィールドと国フィールドに格納されている住所をジオコーディングすることができます。 単一の入力フィールドには、完全な住所が格納されています。たとえば、303 Peachtree St NE, Atlanta, GA 30308 のようになります。 入力住所が、米国の一般的な住所に使用される AddressCityStateZIP などの複数のフィールドに分割されている場合、複数のフィールドがサポートされます。 完全な住所 (例: 303 Peachtree St NE, Atlanta, GA 30308) を格納する単一入力フィールド、および住所に関連付けられている国 (例: USA) を格納するフィールドもサポートされています。

  • 一部のロケーターは、複数の入力住所フィールド (AddressAddress2Address3 など) をサポートしています。 この場合、住所コンポーネントは複数のフィールドに分割可能で、これらの住所フィールドはジオコーディング時に連結されます。 たとえば、3 つのフィールドに 100、Main St、Apt 140 がある場合や、2 つのフィールドに 100 Main St と Apt 140 がある場合、ジオコーディングのときは、どちらも 100 Main St Apt 140 になります。

  • このツールを使用するには、ArcGIS Enterprise 10.7 以降のポータルが必要です。

  • ユーティリティ サービスとしてポータルで使用できないポータル ロケーターがある場合は、その「ロケーターをポータル ユーティリティ サービスとして追加」し、「バッチ ジオコーディングに対応できる構成にする」ようポータル管理者に依頼します。

  • 複数のスレッドを使用するように構成」された ArcGIS Enterprise ポータルでロケーターを使用すると、ジオコーディングのパフォーマンスが向上します。

  • ジオコーディング結果はロケーターと同じ空間参照内に保存されます。 出力の空間参照を変更するには、このツールの「環境設定」で異なる「出力座標系」を設定します。

  • ジオコーディング結果には、スコア、ステータス、各レコードの一致した住所など、関連するすべてのジオコーディング情報だけでなく、元の入力テーブル内の値も含まれます。 このツールで生成されるジオコーディングの結果には、元の入力テーブルの静的なスナップショットが含まれるため、元のテーブルで値の追加や更新を行っても、その結果は出力ファイルに反映されません。 ツールを再実行して、これらの変更を含む新しい出力ファイルを作成します。

  • ジオコーディング結果がフィーチャクラスとして返された場合に、住所の再照合を行うには、「住所の再照合」ツールを使用するか、または [住所の再照合] ウィンドウを開く [住所の再照合] オプションを使用します。

    注意:

    バッチ ジオコーディングに複数のスレッドを使用する ArcGIS Enterprise 10.8 ポータルのロケーターを使用して、テーブルをジオコーディングする必要があります。

    ジオコーディング結果の再照合の詳細

  • Z 対応データで構築された入力ロケーターを使用する場合、ツールは Z 対応でない出力を返します。 このツールでは、2D 出力のみがサポートされています。

  • ArcGIS Pro 3.2 で作成されたロケーター ビュー」の構成を [ロケーター] パラメーター値として使用した場合、ツールはその構成を適用しません。

パラメーター

ラベル説明データ タイプ
入力テーブル

ジオコーディングする住所または場所を含む CSV、XLS、XLSX 形式の入力テーブル、またはファイル ジオデータベース テーブル。

Record Set
ロケーター

テーブルのジオコーディングに使用されるポータル ロケーター。

自動入力されたリストからアクティブなポータル上のロケーターを選択するか、アクティブなポータルを参照して他の使用可能なロケーターを選択します。 アクティブなポータルでユーティリティ サービスとして設定されたロケーターをデフォルトで使用できます。

注意:

このツールでは、ArcGIS World Geocoding Service は無効化されています。 ArcGIS World Geocoding Service を使用する場合は、「住所のジオコーディング」ツールを使用します。

Address Locator
住所フィールドのマッピング

ロケーターで使用される住所フィールドを、住所の入力テーブルのフィールドに割り当てます。 完全な住所 (303 Peachtree St NE, Atlanta, GA 30308 など) が入力テーブルの 1 つのフィールドに格納されている場合は、[単一フィールド] を指定します。 入力住所が、米国の一般的な住所に使用される複数のフィールド (AddressCityStateZIP など) に分割されている場合、[複数フィールド] を指定します。 完全な住所 (例: 303 Peachtree St NE, Atlanta, GA 30308) と国 (例: USA) が別々のフィールド (AddressCountry など) に分かれている場合、[単一のフィールドと国フィールド] を指定します。

一部のロケーターは、複数の入力住所フィールド (AddressAddress2Address3 など) をサポートしています。 この場合、住所コンポーネントは複数のフィールドに分割可能で、これらの住所フィールドはジオコーディング時に連結されます。 たとえば、3 つのフィールドに 100、Main st、Apt 140 がある場合や、2 つのフィールドに 100 Main st と Apt 140 がある場合、ジオコーディングのときは、どちらも 100 Main st Apt 140 になります。

ロケーターで使用されるオプションの入力住所フィールドを住所の入力テーブル内のフィールドにマッピングしない場合、フィールド名の代わりに [<なし>] を使用して、マッピングしないことを示します。

Field Info
出力タイプ

ジオコード結果が書き込まれるファイル タイプを指定します。

  • CSV.csv ファイルが返されます。
  • フィーチャクラスファイル ジオデータベース内のフィーチャクラスが返されます。
  • XLS.xls ファイルが返されます。
String
出力場所

出力ジオコーディング結果が書き込まれるフォルダー。

出力が .csv または .xls ファイルの場合、出力ファイルは指定されたフォルダーに配置されます。

出力がフィーチャクラスの場合、出力ファイル ジオデータベースが作成され、指定されたフォルダーに配置されます。新しいファイル ジオデータベースには、ジオコーディングされたフィーチャクラスが含まれます。 出力ファイル ジオデータベースとファイル ジオデータベース内のフィーチャクラスの名前は同じです。

Workspace
出力名

ジオコーディングされた出力結果の名前。

String
(オプション)

ジオコーディングされた住所を検索する 1 つまたは複数の国。

これは国パラメーターに対応したロケーターを対象とするもので、ジオコーディングを指定した国々に制限する働きがあります。 国を指定すれば、多くの場合、ジオコーディングの精度が向上します。 [住所フィールドのマッピング] パラメーターで [単一のフィールドと国フィールド] を選択し、[入力テーブル] パラメーター値で国を表すフィールドを [住所フィールドのマッピング] パラメーターの Country フィールドにマッピングした場合、[入力テーブル] パラメーターの国の値の方が、[国] パラメーターよりも優先されます。

これは、指定した国またはエリアに制限されます。 国を指定しないと、ロケーターでサポートされているすべての国に対してジオコーディングが実行されます。

すべてのロケーターが [国] パラメーターに対応しているわけではありません。

String
優先位置タイプ
(オプション)

[ポイント住所] の照合で返される優先出力ジオメトリを指定します。 このパラメーターのオプションは、ルート検索に使用できるストリートの片側の位置を表す [ルート検索位置] または屋上や住所の区画の重心を表す [住所の位置] です。 優先位置がデータに存在しない場合、デフォルト位置が返されます。 Addr_type=PointAddress のジオコード結果の場合、x および y 属性値はストリートに沿った住所の座標を記述し、DisplayX および DisplayY の値は屋上または建物の重心の座標を記述します。

すべてのロケーターがこのパラメーターに対応しているわけではありません。

  • 住所の位置屋根の位置、区画の重心、玄関などの住所位置を表すジオコード結果のジオメトリが返されます。
  • ルート検索の位置車両のルート検索に使用できるストリートの片側に近い位置を表すジオコード結果のジオメトリを返します。 これがデフォルトです。
String
カテゴリ
(オプション)

ロケーターが検索する場所のタイプを制限します。これにより、誤判定の一致が除外されるため、検索処理の速度が上がる可能性があります。 カテゴリを指定しないと、サポートされているすべてのカテゴリに対してジオコーディングが実行されます。 すべての位置および国に対して、すべてのカテゴリ値がサポートされているわけではありません。 通常、このパラメーターは次の目的に使用できます。

  • 一致を特定の場所タイプまたは住所レベルに制限します
  • 不要な住所レベルの代替一致を回避します
  • 座標検索のあいまいさを解消します

すべてのロケーターがこのパラメーターに対応しているわけではありません。

String
出力フィールド
(オプション)

ジオコード結果で返されるロケーター出力フィールドを指定します。

  • すべて使用可能なすべてのロケーター出力フィールドがジオコード結果に含まれます。 これがデフォルトです。
  • 位置のみジオコード結果がフィーチャクラスの場合、Shape フィールドが格納されます。 結果が .csv または .xls ファイルの場合、Shape X および Shape Y フィールドが格納されます。 [入力テーブル] パラメーターの元のフィールド名は、元のフィールド名を使用して維持されます。
  • 最小場所とその場所がジオコード結果のロケーター内の情報にどれだけ一致しているかが記述されたフィールド (ShapeStatusScoreMatch_typeMatch_addr、および Addr_type) が追加されます。 [入力テーブル] パラメーター値から取得された元のフィールド名が維持されます。
  • 最小およびユーザー フィールドジオコード結果のユーザー定義のカスタム出力フィールドとともに、場所とその場所がロケーターの情報にどれだけ一致しているかを記述したフィールド (ShapeStatusScoreMatch_typeMatch_addr、および Addr_type) が追加されます。 [入力テーブル] パラメーター値から取得された元のフィールド名が維持されます。
注意:

このパラメーターは、Enterprise 10.9 以降に公開されている [ロケーターの作成 (Create Locator)] または [フィーチャ ロケーターの作成 (Create Feature Locator)] ツールによって作成された入力ロケーターと共に使用できます。 [住所ロケーターの作成 (Create Address Locator)] ツールを使用して作成されたロケーターが 1 つ以上含まれているコンポジット ロケーターでは、このパラメーターを使用できません。

String

派生した出力

ラベル説明データ タイプ
出力フィーチャクラス

出力フィーチャクラス。

Feature Class
出力テーブル

CSV または XLS 形式の出力テーブルです (選択した [出力タイプ] の値によって異なります)。

Table

arcpy.geocoding.GeocodeFile(in_table, locator, address_fields, output_type, output_location, output_name, {country}, {location_type}, {category}, {output_fields})
名前説明データ タイプ
in_table

ジオコーディングする住所または場所を含む CSV、XLS、XLSX 形式の入力テーブル、またはファイル ジオデータベース テーブル。

Record Set
locator

テーブルのジオコーディングに使用されるポータル ロケーター。

自動入力されたリストからアクティブなポータル上のロケーターを選択するか、アクティブなポータルを参照して他の使用可能なロケーターを選択します。 アクティブなポータルでユーティリティ サービスとして設定されたロケーターをデフォルトで使用できます。

注意:

このツールでは、ArcGIS World Geocoding Service は無効化されています。 ArcGIS World Geocoding Service を使用する場合は、「住所のジオコーディング」ツールを使用します。

Address Locator
address_fields

このパラメーターでマッピングしている各フィールドの形式は input_locator_field, table_field_name です。ここで、input_locator_field はロケーターで指定された入力住所フィールドの名前であり、table_field_name はジオコーディングする住所テーブル内の対応するフィールドの名前です。

完全な住所を格納する単一の入力フィールドを指定できます (たとえば、303 Peachtree St NE, Atlanta, GA 30308)。 また、入力住所が、米国の一般的な住所に使用される AddressCityStateZIP などの複数のフィールドに分割されている場合は、複数のフィールドを指定することもできます。 完全な住所 (例: 303 Peachtree St NE, Atlanta, GA 30308) を格納する単一入力フィールド、および住所に関連付けられている国 (例: USA) を格納するフィールドも指定できます。

一部のロケーターは、複数の入力住所フィールド (AddressAddress2Address3 など) をサポートしています。 この場合、住所コンポーネントは複数のフィールドに分割可能で、これらの住所フィールドはジオコーディング時に連結されます。 たとえば、3 つのフィールドに 100、Main st、Apt 140 がある場合や、2 つのフィールドに 100 Main st と Apt 140 がある場合、ジオコーディングのときは、どちらも 100 Main st Apt 140 になります。

ロケーターで使用されるオプションの入力住所フィールドを住所の入力テーブル内のフィールドにマッピングしない場合、フィールド名の代わりに <None> を使用して、マッピングしないことを示します。

Field Info
output_type

ジオコード結果が書き込まれるファイル タイプを指定します。

  • CSV.csv ファイルが返されます。
  • FEATURE_CLASSファイル ジオデータベース内のフィーチャクラスが返されます。
  • XLS.xls ファイルが返されます。
String
output_location

出力ジオコーディング結果が書き込まれるフォルダー。

出力が .csv または .xls ファイルの場合、出力ファイルは指定されたフォルダーに配置されます。

出力がフィーチャクラスの場合、出力ファイル ジオデータベースが作成され、指定されたフォルダーに配置されます。新しいファイル ジオデータベースには、ジオコーディングされたフィーチャクラスが含まれます。 出力ファイル ジオデータベースとファイル ジオデータベース内のフィーチャクラスの名前は同じです。

Workspace
output_name

ジオコーディングされた出力結果の名前。

String
country
[country,...]
(オプション)

ジオコーディングされた住所を検索する 1 つまたは複数の国。

これは国パラメーターに対応したロケーターを対象とするもので、ジオコーディングを指定した国々に制限する働きがあります。 国を指定すれば、多くの場合、ジオコーディングの精度が向上します。 in_table パラメーターで国を表すフィールドが、address_fieldsCountry フィールドにマッピングされる場合、in_table パラメーターの国の値の方が、country パラメーターよりも優先されます。

これは、指定した国またはエリアに制限されます。 国を指定しないと、ロケーターでサポートされているすべての国に対してジオコーディングが実行されます。

2 文字または 3 文字の国コードとして値をカンマ区切りリストに指定します。 使用する入力値については、「サポートされている国コード列」をご参照ください。

すべてのロケーターが country パラメーターに対応しているわけではありません。

String
location_type
(オプション)

POINT_ADDRESS の一致で返される優先出力ジオメトリを指定します。 このパラメーターのオプションは、ルート検索に使用できるストリートの片側の位置を表す ROUTING_LOCATION または屋上、住所の区画の重心、玄関を表す ADDRESS_LOCATION です。 優先位置がデータに存在しない場合、ROUTING_LOCATION のデフォルト位置が返されます。 Addr_type=PointAddress のジオコード結果の場合、x および y 属性値はストリートに沿った住所の座標を記述し、DisplayX および DisplayY の値は屋上または建物の重心の座標を記述します。 「geocodeAddresseslocationType パラメーター」の詳細については、ArcGIS REST API Web ヘルプをご参照ください。

すべてのロケーターがこのパラメーターに対応しているわけではありません。

  • ADDRESS_LOCATION屋根の位置、区画の重心、玄関などの住所位置を表すジオコード結果のジオメトリが返されます。
  • ROUTING_LOCATION車両のルート検索に使用できるストリートの片側に近い位置を表すジオコード結果のジオメトリを返します。 これがデフォルトです。
String
category
[category,...]
(オプション)

ロケーターが検索する場所のタイプを制限します。これにより、誤判定の一致が除外されるため、検索処理の速度が上がる可能性があります。 カテゴリを指定しないと、サポートされているすべてのカテゴリに対してジオコーディングが実行されます。 すべての位置および国に対して、すべてのカテゴリ値がサポートされているわけではありません。 通常、このパラメーターは次の目的に使用できます。

  • 一致を特定の場所タイプまたは住所レベルに制限します
  • 不要な住所レベルの代替一致を回避します
  • 座標検索のあいまいさを解消します

すべてのロケーターがこのパラメーターに対応しているわけではありません。

カテゴリ フィルター」の詳細については、ArcGIS REST API Web ヘルプをご参照ください。

String
output_fields
(オプション)

ジオコード結果で返されるロケーター出力フィールドを指定します。

注意:

このパラメーターは、Enterprise 10.9 以降に公開されている [ロケーターの作成 (Create Locator)] または [フィーチャ ロケーターの作成 (Create Feature Locator)] ツールによって作成された入力ロケーターと共に使用できます。 [住所ロケーターの作成 (Create Address Locator)] ツールを使用して作成されたロケーターが 1 つ以上含まれているコンポジット ロケーターでは、このパラメーターを使用できません。

  • ALL使用可能なすべてのロケーター出力フィールドがジオコード結果に含まれます。 これがデフォルトです。
  • LOCATION_ONLYジオコード結果がフィーチャクラスの場合、Shape フィールドが格納されます。 結果が .csv または .xls ファイルの場合、Shape X および Shape Y フィールドが格納されます。 in_table パラメーターの元のフィールド名は、元のフィールド名を使用して維持されます。
  • MINIMAL場所とその場所がジオコード結果のロケーター内の情報にどれだけ一致しているかが記述されたフィールド (ShapeStatusScoreMatch_typeMatch_addr、および Addr_type) が追加されます。 in_table パラメーター値の元のフィールド名が維持されます。
  • MINIMAL_AND_USERユーザー定義のカスタム出力フィールドとともに、場所とその場所がジオコード結果のロケーターの情報にどれだけ一致しているかを記述したフィールド (ShapeStatusScoreMatch_typeMatch_addr、および Addr_type) が追加されます。 in_table パラメーター値の元のフィールド名が維持されます。
String

派生した出力

名前説明データ タイプ
out_feature_class

出力フィーチャクラス。

Feature Class
out_table

CSV または XLS 形式の出力テーブルです (選択した [出力タイプ] の値によって異なります)。

Table

コードのサンプル

GeocodeFile の例 (スタンドアロン スクリプト)

次の Python スクリプトは、スタンドアロン スクリプトで GeocodeFile 関数を使用する方法を示しています。

注意:
お使いのポータルにあるロケーターを操作する場合は、サイン インしていること、およびそのポータルを ArcGIS Pro でアクティブなポータルとして設定していることを確認してください。 アクティブなポータル以外のポータルにあるロケーターにアクセスするには、SignInToPortal 関数を使用して認証できます。

import arcpy

# Input is a local table
input_table = r"C:\data\customers.csv"

# This tool works with locators on a portal
in_locator = "https://<machine_name>/server/rest/services/<service_name>/GeocodeServer/<service_name>"

# The best way to generate a field mapping is to run the tool in ArcGIS 
# Pro, right-click the green success ribbon, and click "Copy Python command"

field_mapping = "'Address or Place' Address VISIBLE NONE;Address2 <None> VISIBLE NONE;Address3 <None> VISIBLE NONE;Neighborhood <None> VISIBLE NONE;
City <None> VISIBLE NONE;County <None> VISIBLE NONE;State <None> VISIBLE NONE;ZIP ZIP VISIBLE NONE;ZIP4 <None> VISIBLE NONE;Country <None> VISIBLE NONE"
output_type = "FEATURE_CLASS"

# Output folder for the output CSV, Excel, or GDB table. If you select 
# FEATURE_CLASS output_type, a new GDB will be created in the 
# output_folder with the geocoding results
output_folder = r"C:\data\outputs"
output_name = "Geocoding_output"

# Optional geocoding parameters. Only some are supported depending on the 
# in_locator that you use.
country = None
location_type = "ROUTING_LOCATION"
category = "'Street Address'"

arcpy.geocoding.GeocodeFile(input_table, in_locator, field_mapping, output_type, 
                            output_folder, output_name, country, location_type, 
                            category)

ライセンス情報

  • Basic: 次のものが必要 ArcGIS Enterprise のアカウントで [解析の実行] 権限を設定
  • Standard: 次のものが必要 ArcGIS Enterprise のアカウントで [解析の実行] 権限を設定
  • Advanced: 次のものが必要 ArcGIS Enterprise のアカウントで [解析の実行] 権限を設定

関連トピック