Azure Maps 用の Azure Event Grid イベント スキーマAzure Event Grid event schema for Azure Maps

この記事では、Azure Maps のイベントのプロパティとスキーマについて説明します。This article provides the properties and schema for Azure Maps events. イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。For an introduction to event schemas, see Azure Event Grid event schema.

使用可能なイベントの種類Available event types

Azure Maps アカウントから出力されるイベントの種類は次のとおりです。An Azure Maps account emits the following event types:

イベントの種類Event type 説明Description
Microsoft.Maps.GeofenceEnteredMicrosoft.Maps.GeofenceEntered 受信した座標が指定されたジオフェンスの外部から内部に移動したときに発生しますRaised when coordinates received have moved from outside of a given geofence to within
Microsoft.Maps.GeofenceExitedMicrosoft.Maps.GeofenceExited 受信した座標が指定されたジオフェンスの内部から外部に移動したときに発生しますRaised when coordinates received have moved from within a given geofence to outside
Microsoft.Maps.GeofenceResultMicrosoft.Maps.GeofenceResult 状態に関係なく、ジオフェンシング クエリから結果が返されるたびに発生しますRaised every time a geofencing query returns a result, regardless of the state

イベントの例Event examples

次の例では、GeofenceEntered イベントのスキーマを示しますThe following example shows the schema of a GeofenceEntered event

{   
   "id":"7f8446e2-1ac7-4234-8425-303726ea3981", 
   "topic":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Maps/accounts/{accountName}", 
   "subject":"/spatial/geofence/udid/{udid}/id/{eventId}", 
   "data":{   
      "geometries":[   
         {   
            "deviceId":"device_1", 
            "udId":"1a13b444-4acf-32ab-ce4e-9ca4af20b169", 
            "geometryId":"2", 
            "distance":-999.0, 
            "nearestLat":47.618786, 
            "nearestLon":-122.132151 
         } 
      ], 
      "expiredGeofenceGeometryId":[   
      ], 
      "invalidPeriodGeofenceGeometryId":[   
      ] 
   }, 
   "eventType":"Microsoft.Maps.GeofenceEntered", 
   "eventTime":"2018-11-08T00:54:17.6408601Z", 
   "metadataVersion":"1", 
   "dataVersion":"1.0" 
}

次の例では、GeofenceResult のスキーマを示しますThe following example show schema for GeofenceResult

{   
   "id":"451675de-a67d-4929-876c-5c2bf0b2c000", 
   "topic":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Maps/accounts/{accountName}", 
   "subject":"/spatial/geofence/udid/{udid}/id/{eventId}", 
   "data":{   
      "geometries":[   
         {   
            "deviceId":"device_1", 
            "udId":"1a13b444-4acf-32ab-ce4e-9ca4af20b169", 
            "geometryId":"1", 
            "distance":999.0, 
            "nearestLat":47.609833, 
            "nearestLon":-122.148274 
         }, 
         {   
            "deviceId":"device_1", 
            "udId":"1a13b444-4acf-32ab-ce4e-9ca4af20b169", 
            "geometryId":"2", 
            "distance":999.0, 
            "nearestLat":47.621954, 
            "nearestLon":-122.131841 
         } 
      ], 
      "expiredGeofenceGeometryId":[   
      ], 
      "invalidPeriodGeofenceGeometryId":[   
      ] 
   }, 
   "eventType":"Microsoft.Maps.GeofenceResult", 
   "eventTime":"2018-11-08T00:52:08.0954283Z", 
   "metadataVersion":"1", 
   "dataVersion":"1.0" 
}

イベントのプロパティEvent properties

イベントのトップレベルのデータを次に示します。An event has the following top-level data:

プロパティProperty TypeType 説明Description
topictopic stringstring イベント ソースの完全なリソース パス。Full resource path to the event source. このフィールドは書き込み可能ではありません。This field is not writeable. この値は Event Grid によって指定されます。Event Grid provides this value.
subjectsubject stringstring 発行元が定義したイベントの対象のパス。Publisher-defined path to the event subject.
eventTypeeventType stringstring このイベント ソース用に登録されたイベントの種類のいずれか。One of the registered event types for this event source.
eventTimeeventTime stringstring プロバイダーの UTC 時刻に基づくイベントの生成時刻。The time the event is generated based on the provider's UTC time.
idid stringstring イベントの一意識別子。Unique identifier for the event.
datadata objectobject ジオフェンシングのイベント データ。Geofencing event data.
dataVersiondataVersion stringstring データ オブジェクトのスキーマ バージョン。The schema version of the data object. スキーマ バージョンは発行元によって定義されます。The publisher defines the schema version.
metadataVersionmetadataVersion stringstring イベント メタデータのスキーマ バージョン。The schema version of the event metadata. 最上位プロパティのスキーマは Event Grid によって定義されます。Event Grid defines the schema of the top-level properties. この値は Event Grid によって指定されます。Event Grid provides this value.

データ オブジェクトには、次のプロパティがあります。The data object has the following properties:

プロパティProperty TypeType 説明Description
apiCategoryapiCategory stringstring イベントの API カテゴリ。API category of the event.
apiNameapiName stringstring イベントの API 名。API name of the event.
issuesissues objectobject 処理中に発生した問題の一覧を示します。Lists issues encountered during processing. 何らかの問題が返された場合、応答ではジオメトリが返されません。If any issues are returned, then there will be no geometries returned with the response.
responseCoderesponseCode numbernumber HTTP 応答コードHTTP response code
geometriesgeometries objectobject 座標が含まれるフェンス ジオメトリ、または位置の周りに searchBuffer が重なっているフェンス ジオメトリの一覧を示します。Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position.

Maps API でエラーが発生すると、エラー オブジェクトが返されます。The error object is returned when an error occurs in the Maps API. エラー オブジェクトには、次のプロパティがあります。The error object has the following properties:

プロパティProperty TypeType 説明Description
errorerror ErrorDetailsErrorDetails Maps API でエラーが発生すると、このオブジェクトが返されますThis object is returned when an error occurs in the Maps API

Maps API でエラーが発生すると、ErrorDetails オブジェクトが返されます。The ErrorDetails object is returned when an error occurs in the Maps API. ErrorDetails オブジェクトには、次のプロパティがあります。The ErrorDetails or object has the following properties:

プロパティProperty TypeType 説明Description
codecode stringstring HTTP 状態コード。The HTTP status code.
messagemessage stringstring ある場合、人間が判読できるエラーの説明。If available, a human readable description of the error.
innererrorinnererror InnerErrorInnerError ある場合、エラーに関するサービス固有の情報が含まれるオブジェクト。If available, an object containing service-specific information about the error.

InnerError は、エラーに関するサービス固有の情報が含まれるオブジェクトです。The InnerError is an object containing service-specific information about the error. InnerError オブジェクトには、次のプロパティがあります。The InnerError object has the following properties:

プロパティProperty TypeType 説明Description
codecode stringstring エラー メッセージ。The error message.

geometries オブジェクト。要求のユーザー時刻を基準にして有効期限が切れているジオフェンスのジオメトリ ID の一覧です。The geometries object, lists geometry IDs of the geofences that have expired relative to the user time in the request. geometries オブジェクトには、次のプロパティを含むジオメトリ項目があります。The geometries object has geometry items with the following properties:

プロパティProperty TypeType 説明Description
deviceiddeviceid stringstring デバイスの ID。ID of device.
distancedistance stringstring

座標からジオフェンスの最も近い境界までの距離。Distance from the coordinate to the closest border of the geofence. 正の値は、座標がジオフェンスの外部にあることを意味します。Positive means the coordinate is outside of the geofence. 座標がジオフェンスの外部にあっても、最も近いジオフェンスの境界から searchBuffer の値より大きく離れている場合、値は 999 になります。If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. 負の値は、座標がジオフェンスの内部にあることを意味します。Negative means the coordinate is inside of the geofence. 座標がポリゴンの内部にあっても、最も近いジオフェンスの境界から searchBuffer の値より大きく離れている場合、値は -999 になります。If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. 値 999 は、座標がジオフェンスの外部にあることが十分に確実であることを意味します。A value of 999 means that there is great confidence the coordinate is well outside the geofence. 値 -999 は、座標がジオフェンスの内部にあることが十分に確実であることを意味します。A value of -999 means that there is great confidence the coordinate is well within the geofence.

geometryidgeometryid stringstring ジオフェンスのジオメトリを示す一意 ID。The unique id identifies the geofence geometry.
nearestlatnearestlat numbernumber ジオメトリの最も近いポイントの緯度。Latitude of the nearest point of the geometry.
nearestlonnearestlon numbernumber ジオメトリの最も近いポイントの経度。Longitude of the nearest point of the geometry.
udIdudId stringstring ジオフェンスをアップロードしたときに、ユーザーのアップロード サービスから返される一意 ID。The unique id returned from user upload service when uploading a geofence. Geofencing POST API には含まれません。Will not be included in geofencing post API.

データ オブジェクトには、次のプロパティがあります。The data object has the following properties:

プロパティProperty TypeType 説明Description
expiredGeofenceGeometryIdexpiredGeofenceGeometryId string[]string[] 要求でのユーザー時刻を基準にして期限切れになっているジオフェンスのジオメトリ ID の一覧。Lists of the geometry ID of the geofence that is expired relative to the user time in the request.
geometriesgeometries geometries[]geometries[] 座標が含まれるフェンス ジオメトリ、または位置の周りに searchBuffer が重なっているフェンス ジオメトリの一覧を示します。Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position.
invalidPeriodGeofenceGeometryIdinvalidPeriodGeofenceGeometryId string[]string[] 要求でのユーザー時刻を基準にして無効期間内になっているジオフェンスのジオメトリ ID の一覧。Lists of the geometry ID of the geofence that is in invalid period relative to the user time in the request.
isEventPublishedisEventPublished ブール値boolean Azure Maps イベント サブスクライバーに対して少なくとも 1 つのイベントが発行されている場合は true、Azure Maps イベント サブスクライバーに対してイベントが発行されていない場合は false。True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.

次の手順Next steps