ガイドAPIリファレンス
ガイド

外部位置イベントの使用方法

ジオフェンスイベントが設定されていない場合でも、お客様はトラッカーが特定の場所に出入りしたことを示す補助的な情報源を持っている場合があります。このような場合、お客様は外部位置情報イベントをプロジェクトの入力ストリームに送信できます。これらのイベントにより、出荷の自動状態遷移がアクティブになります。 トラッキングサービスは、ジオフェンスイベントおよび外部位置情報イベントに基づいて、出荷状態を自動遷移させます。出荷の状態遷移は、ジオフェンスイベント、外部位置情報イベント、またはその両方を使用することで実行できます。使用するイベントは出荷の場所でどのイベントが使用できるかによって決まります。 外部位置情報イベントは、出荷、位置情報、搬入・搬出状況、搬入・搬出時刻を特定します。さらに、イベントには、必要に応じてセグメント識別子とメタデータオブジェクトを含めることができます。セグメント識別子を使用すると、出荷の複数のセグメントで同じ場所を使用する場合に位置を識別できます。メタデータオブジェクトを使用すると、お客様固有のイベントデータを保存できます。 より正確なイベント定義については、入力ストリームの取り込みスキーマをダウンロードしてください。定義はinputStreamLocationEventプロパティに記載されています。

ジオフェンスイベントと外部位置情報イベント

ジオフェンスイベントと外部位置情報イベントが出荷状態に与える影響には、いくつかの違いがあります。 ジオフェンスイベントの場合、出荷に定義されている順序で出荷場所を通過する必要があります。出荷の進行中のセグメントに影響を与える場所のジオフェンスイベントのみ、または進行中のセグメントがない場合は、最初の保留中のセグメントが考慮されます。 外部位置情報イベントは出荷場所のグラウンドトゥルースとして扱われ、出荷がすでに特定の場所に到達していることをこのイベントが示した場合、その場所の前に保留中のセグメントがあったとしても、セグメントの状態はそれに応じてその場所に変更されます。ただし、すでに完了しているセグメントの状態は後から変更されることはありません。 出荷で同じ場所が複数回使用される場合は、イベントでオプションのセグメント識別子を使用すれば、イベントが対象とする場所を特定できます。位置情報イベントでセグメントを識別せずに同じ場所を複数回使用する場合は、次に起こり得る状態に変更されます。位置情報イベントでセグメントを識別する場合、次のいずれかを指定する必要があります。

  • 退出イベントの場合、出発地を離れるセグメント
  • 進入イベントの場合、目的地に進入するセグメント

イベントの例

以下に入力ストリームに送信される外部位置情報イベントの例を示します。

{
  requestId: '5d4d0797-5946-48a7-b1af-9e4913284364',
  type: 'event',
  version: '1.0',
  data: [
    {
      timestamp: '2025-08-08T06:00:26.445Z',
      eventSource: 'location',
      eventType: 'exit',
      shipment: { extId: 'example-shipment' },
      segment: { extId: 'example-segment-1' },
      location: { extId: 'example-location-1' }
    }
  ]
}

以下はイベント出力ストリームからの出力例です。

{
  type: 'events',
  version: '1.0',
  events: [
    {
      trackingId: 'SHP-828770a4-0701-41b7-b86e-ccc76b453d81',
      timestamp: 1754632826445,
      ruleId: '00000000-0000-4000-8000-000000000002',
      eventSource: 'location',
      eventType: 'exit',
      initialState: false,
      trigger: 'external',
      extOrderId: 'example-shipment',
      extSegmentId: 'example-segment-1',
      segmentId: 'SEG-4b2a5d73-bf26-441f-824a-f81fb357bc10',
      segmentIndex: 1,
      extLocationId: 'example-location-1',
      locationId: 'LOC-245dfbda-ae1e-4baa-8f20-fea94584ab86'
    }
  ],
  correlationId: '5d4d0797-5946-48a7-b1af-9e4913284364'
}