ArcGIS Earth Automation API の使用

ArcGIS Earth Automation API の有効化

ArcGIS Earth Automation API を有効にして ArcGIS Earth と通信するには、[高度な設定] アプリケーション設定で [Automation API の有効化] をオンにします。 有効にすると、ArcGIS Earth Automation API のサンプル ページとヘルプ ページのリンクが使用できるようになり、以下がリストされます。

構成

settings.json 構成ファイルを使用して、ArcGIS Earth Automation API を構成することができます。 settings.json 構成ファイルは通常 C:\Program Files\ArcGIS\Earth\bin\automation フォルダーに配置され、ArcGIS Earth が開始されると、自動的にユーザーの Documents/ArcGISEarth/automation フォルダーにコピーされます。 これにより、ユーザーは settings.json 構成ファイルを使用して ArcGIS Earth Automation API を構成することができます。

ArcGIS Earth の開始時に、autoStart 関数が自動的に ArcGIS Earth Automation API を有効にします。 デフォルトは、false です。 autoStart=true の場合は、ArcGIS Earth で .NET Generic Host が作成され、HTTP サーバーが実装された Web サービスが起動時にローカル コンピューター上で開始されます。 [高度な設定] アプリケーション設定から ArcGIS Earth Automation API のステータスを確認します。

初めて使用する場合は、インポートした構成ファイルの autoStart パラメーターを使用して、[高度な設定] アプリケーション設定の API スイッチをコントロールできます。

注意:

  • ArcGIS Earth Automation API では、最初にユーザーのディレクトリ内にある settings.json 構成ファイルが使用されます。
  • 構成ファイルの autoStart パラメーターは、1 つ目の ArcGIS Earth インストールでのみ機能します。

構成可能な Automation API パラメーター

ArcGIS Earth Automation API は、特別な構成を必要としないため、すぐに使用することができます。 ただし、デフォルト値を変更する場合は、それぞれの構成パラメーターを把握しておく必要があります。

パラメーター説明
autoStart

ArcGIS Earth が開始された時点で ArcGIS Earth Automation API を有効にします。 デフォルトは false です。

baseUrl

ArcGIS Earth Automation API が聴取する URL を設定します。 デフォルトは、http://localhost:8000 です。

ヒント:
  • HTTP プロトコル タイプのみサポートされています。
  • baseUrl のデフォルト ホストは localhost です。 ArcGIS Earth Automation API に別のオリジンからアクセスできるようにする場合は、ローカル IP アドレスまたはホスト名を使用することもできます。
  • ArcGIS Earth Automation API では、HTTP スキームを含むすべてのオリジンからのクロスオリジン リソース シェアリング (CORS) リクエストと、HTTP メソッドが許可されています。 許可されたオリジンの設定と許可された HTTP メソッドの設定にはまだ対応していません。 詳細については、「ASP.NET Core での CORS ポリシー オプション」をご参照ください。

webRoot

ArcGIS Earth Automation API で使用されている Web ルート ディレクトリを指定します。 これはオプションです。 デフォルトの Web ルート ディレクトリは、ユーザーの Documents/ArcGISEarth/automation フォルダーに格納されています。

ヒント:
  • Web ルートによって、アプリの静的アセットへの相対パスが決まります。 このパスが存在しないと、no-op ファイル プロバイダーが使用されます。 詳細については、「WebRoot」をご参照ください。

ArcGIS Earth への接続

ArcGIS Earth Automation API が開始されたら、クライアント アプリは RESTful Automation API を介して ArcGIS Earth と通信できるようになります。

ArcGIS Earth Automation API を操作するには、URL の構築方法とレスポンスの解釈方法を把握しておく必要があります。 ArcGIS Earth Automation API で公開されているすべての操作には、エンドポイントの階層からアクセスできます。

ArcGIS Earth Automation API を使用するには、リクエストを送信するための特定のエンドポイント アドレスが必要です。 デフォルトのエンドポイントは、http://localhost:8000/arcgisearth/<controller> です。 たとえば、ArcGIS Earth のカメラ情報を取得する場合の URL は次のとおりです。

http://localhost/arcgisearth/camera

[高度な設定] アプリケーション設定から ArcGIS Earth Automation API のステータスを確認し、お使いのブラウザーのサンプル ページを使用するか、ArcGIS Earth Automation API GitHub にアクセスして詳細を確認してください。