ガイドAPIリファレンス変更履歴
ガイド
  1. HERE Geocoding and Search API v7開発者ガイド
  2. HERE Geocoding and Search API v7エンドポイント

Signals

/signalsエンドポイントにより、開発者はエンドポイントから返されたAPIレスポンス項目に対するエンドユーザーの操作を共有し、HERE Geocoding and Searchレスポンス品質の継続的な向上に貢献できます。

現在、エンドユーザーからのフィードバックが特に重要となるエンドポイントは次のとおりです。

  • /discoverエンドポイント
  • /autosuggestエンドポイント

Requests

/signalsエンドポイントの呼び出しは、検索レスポンス内の特定のランクの項目に対して、特定の時刻にユーザーが実行したアクションに関する情報を共有します。

/signalsエンドポイントへの各リクエストには次のフィールドを含める必要があります。

  • action：ユーザーが実行するアクション。
  • timestamp：アクションが発生した時刻。
  • correlationId：関連付けられたAPIレスポンスの識別子。
  • resourceId：操作が行われた特定の項目の識別子。
  • rank：レスポンス内の項目の位置。

Request Format

/signalsエンドポイントの呼び出しは次のベースURLに対するHTTP 1.1 POSTリクエストです。

https://signals.search.hereapi.com

リクエストボディには、x-www-form-urlencodedの形式を使用する必要があります。

version=1&timetamp=<timestamp>&resourceId=<resourceId>&correlationId=<correlationId>&rank=<rank>&action=<action>

例：

version=1&timestamp=1675403788324&resourceId=here:pds:place:250u09tu-4561b8da952f4fd79c4e1998c3fcf032&correlationId=22457435-efcf-46b9-8c87-62912f3f2f0&rank=0&action=here:gs:action:navigate-to

Field Details

version

各 /signals 呼び出しボディには version フィールドを含める必要があります。現在、version=1 のみがサポートされています。

action

/signalsエンドポイントへの各リクエストにはactionフィールドを含める必要があります。

サポートされているアクションは次のとおりです。

actionエンド ユーザーが次のアクションを実行した場合に送信
here:gs:action:call結果の電話番号を使用
here:gs:action:email結果のメールアドレスを使用
here:gs:action:navigate-to結果項目__への__ナビゲーションを開始
here:gs:action:navigate-from結果項目__からの__ナビゲーションを開始
here:gs:action:pin結果をブックマークまたは結果をコレクションに追加
here:gs:action:tap地図に表示されている結果をタップ
here:gs:action:viewリストで結果を選択
here:gs:action:share結果を別のユーザーにまたはメール/PMとして共有/sends
here:gs:action:visit結果のWebサイトにアクセス
📘

注：

2つの検索結果間のナビゲーションを提供するアプリケーションは、次の2つの信号を送信する必要があります。

  • 目的地(here:gs:action:navigate-to)
  • 出発地(here:gs:action:navigate-from)
  • 出発地がユーザーの現在地である場合、またはHERE Geocoding and Search APIの検索結果から発生していない場合、navigate-from信号は必要ありません。

correlationIdとresourceId

各APIレスポンスにはヘッダーX-Correlation-IDが含まれます。 この値はcorrelationIdフィールドに使用します。

各レスポンス項目にはidフィールドを含めます。この値はresourceIdフィールドに使用します。

timestamp

timestampフィールドには、ユーザーがアクションを実行したときのUnixエポック時刻(ミリ秒)を指定する必要があります。

rank

rankフィールドはレスポンスのitems配列内の項目のインデックスを表します。

  • 最初の項目のインデックスは0です。
  • /lookupレスポンス(単一の項目を含み、items配列がない)の場合、rank=0を設定します。
📘

注

/signalsエンドポイントはRESTRICTEDとしてリリースされています。詳細については、機能の成熟度トピックの「特権」セクションを参照してください。

詳細については、「APIリファレンス」を参照してください。

4 日前の更新