OpenCage Forward GeoCoding

これまでマーケットプレイス (サポートサイト) に掲載されていたOpenCage Forward GeoCodingのプラグインは、今後サポートされません (2023年11月1日をもって終了)。詳細はこちらの記事をご確認ください。これらのコードのレガシーバージョンへのアクセスをご希望の場合は、Yellowfin サポートチームまでお問い合わせください。

概要

こちらのデータトランスフォーメーションステップは、OpenCage forward GeoCiding APIを活用することで、単一のテキストアドレスカラム（列）や、複数のアドレスパートフィールドの組み合わせから、緯度/経度を取得し、ジオポイント値へ変換します。

OpenCage APIについて、より詳細な情報は、こちらを参照してください。https://geocoder.opencagedata.com/

セットアップ

こちらのステップを使用するためには、Yellowfinの環境に、OpenCage GeoCodeのプラグインをインストールしなくてはいけません。

プラグインをインストールします。
Yellowfinのインスタンスへこれをインストールします。プラグインのインストール方法については、こちらを参照してください。

こちらのステップは、2018年2月13日以降にリリースされた、Yellowfin 7.4で機能します。

設定概要

ステップの設定詳細について、簡単に概説します。

インプットオプション

基礎的な設定：アドレス全体が単一のカラム（列）として提供される場合は、こちらの設定を使用します。
Advanced Configuration（高度な設定）：アドレスの個々の部分が指定されている場合は、高度な設定モードに切り替えます。左側が空白のフィールド、またはnull値のフィールドは無視されます。こちらはより具体的な設定のため、full address（フルアドレス）バージョンよりも優れた結果を生成する傾向があります。

計算フィールドステップを使用し、各フィールドにプラス（+）演算子を用いることで、分割アドレスを連結することもできます。
API Key：OpenCageは、ジオコーディングステップを実行するために必須のAPI Keyを提供します。Keyを取得するためには、こちらを参照してください。：https://geocoder.opencagedata.com/
Preview Mode Row Limit（プレビューモードでのロウ（行）制限）：API Keyは価格体系に応じて、APIの使用回数に制限があります。（より詳細な情報は、こちらを参照してください：https://geocoder.opencagedata.com/pricing ）テスト中に使用制限を超過しないために、こちらのフィールドを使用することで、keyをプレビュー実行で使用できる回数を指定することができます。こちらの値を0に設定すると、制限は適用されません。こちらで指定した数字は、データプレビューパネルに表示されるロウ（行）数に影響します。注意：こちらの設定は、フローがすでに発行され、実行されている場合には適用されません。

ステップの出力

APIは、アドレスに提供された詳細のレベルに基づき、可能な緯度/経度の一覧を返します。このステップは、この一覧から最初に一致したものを選択します。APIが何の一致も返さない場合は（不十分なアドレス詳細が提供された場合に発生する可能性があります）、null値が表示されます。

返されるポイントは、APIが作成した一致レベルの中心になります。例えば、住所が提供され、APIがこれを実際の住所と一致することができた場合、ジオポイントは実際のアドレスに配置されます。しかし、市町村区だけが一致した場合は、返されるジオポイントは市の中心地になります。

多くのデータベースはジオメトリーフィールド型を保存することができないため、一致したジオポイントは「POINT（緯度, 経度）」のテキスト文字列として返されます。例：POINT(-112.1234, 45.123)。この値は、データベース機能（SQLサーバ、など）や、Yellowfinのビューレベルのよく知られたテキスト、またはWKTコンバーターを使用したマップ表示のために、ジオメトリーオブジェクトに変換することができます。

ステップ設定手順

ページトップ

データトランスフォーメーションモジュールに移動します。（「作成」ボタン＞「トランスフォーメーションフロー」）
インプットステップ一覧を展開し、フローにデータをインポートするステップを使用します。
ジオポイントに変換するためのアドレス値が、データに含まれていることを確認してください。今回の例では、異なるフィールドに保存されているアドレス値を表示しています。
OpenCage GeoCodeステップを使用する準備が整ったら、トランスフォーメーションステップパネルを表示し、フローにステップをドラッグします。
フロー内の前のステップと接続をします。
ステップをクリックして、トランスフォーメーションフローパネルに設定詳細を表示します。（ステップ設定の詳細概要を確認したい場合は、こちらをクリックしてください）
以下に説明するように、アドレスの設定には2つのオプションがあります。
1. 基礎的な設定：こちらのデフォルトモードでは、単一フィールドに含まれるFull Address（フルアドレス）を含めることができます。Full Address（フルアドレス）ドロップダウンから、こちらのフィールドを選択します。
2. Advanced configuration（高度な設定）：アドレスが様々なフイールドに分割されている場合は、こちらのモードを使用します。
  1. Advanced configuration（高度な設定）トグルを有効にします。追加のオプション設定が表示されます。
  2. 対応するフィールドに、様々なアドレス値を選択します。
OpenCage API Keyを入力します。Yellowfinはこのkeyを、暗号化された値として保存します。
プレビューモードでフローを実行する時に、Keyが使用される回数を制御するための制限を入力します。これは、各ロウ（行）にひとつのリクエストが使用されるため、処理されるロウ（行）数を制御します。
すべての設定が完了したら、「適用」ボタンをクリックします。
設定が適用されると、ステップは、変換されたジオポイントを表示する「LongLat」と呼ばれるカラム（列）が生成します。これは、この出力のデフォルトの名前です。この名前は変更することができます。
さらにステップを追加して、データのトランスフォーメーションを継続するか、アウトプットステップを使用して結果を保存します。