背景
自動リンクされたパス機能を使用すると、追加のパスを ユーザーに表示されます。また、 ユーザーがメインを保存すると、メインパスにプリリンクがパスされます。 あります。自動的にリンクされたパスは、メインパスと メインパスの上にある、新しいパスが作成されたことをユーザーに知らせるコールアウト リンクされています。メインパスまたはリンクされたパスとしてサポートされているパスタイプは次のとおりです。
- イベント チケット
- 搭乗券
- 交通機関のパス
- 特典
- ギフトカード
- ポイントパス
- 汎用パス
新しいパスが追加されたことを示すコールアウトを含むメインのパス | メインパスにリンクされた新しいパス |
ユースケース
パスを既存のパスにリンクするには、さまざまなユースケースが考えられます。いくつかの例を以下に示します。
- 既存のポイントカードに特典をリンクします。
- 食事クーポンを搭乗券やイベント チケットにリンクします。
- 駐車パスをイベント チケットにリンクします。
自動リンクされたパスを使用する際の考慮事項
- プライマリ オブジェクトとリンクされたオブジェクトは、同じ IssuerId を使用する必要があります。
- プライマリ オブジェクトごとにリンク オブジェクトの上限が 50 個あります。
- リンクされたパスの自動プッシュは保証されておらず、考慮の対象ではありません ベスト エフォートです。ユーザーは自動リンクされたパスの受信を無効にできます。ユースケースが ユーザーがリンクされたパスを受け取る必要がある場合は、 ユーザーが確実にパスを追加できるように、別のチャネルを介して通信する必要があります。
- Google ウォレット AUP の更新 には、準拠する必要がある自動リンクされたパスの使用に関するガイダンスが含まれています。
統合の手順
プライマリ オブジェクトをすでに作成している場合は、ステップ 1 をスキップできます。
- リストにある任意のパスタイプのオブジェクトを作成する 必要があります。これはプライマリ オブジェクトです。
- リストにある任意のパスタイプの別のオブジェクトを作成します。次は linked オブジェクト。
- プライマリ オブジェクトの保存前または保存後に、更新します。 プライマリ オブジェクトは、LinkedObjectIds に含まれるリンク済みオブジェクトの ID に置き換えます。 パラメータを指定します。
プライマリ インスタンスにリンクされたオブジェクト ID を設定するには、最小限のペイロードが必要です。 あります。次の 3 つの必須パラメータがあります。
- ISSUERID.PRIMARY_OBJECT_ID
- ISSUERID.PRIMARY_CLASS_ID
- ISSUERID.LINKED_OBJECT_ID
リンクされたオブジェクトをパス オブジェクトに追加する JSON リクエストの例
… { "id": "ISSUERID.PASS_OBJECTID", "classId": "ISSUERID.PASS_CLASSID", "barcode": { "type": "qrCode", "value": "QR code" }, "linkedObjectIds": {"ISSUERID.LINKED_PASS_OBJECTID"} } …
オブジェクトをパス オブジェクトにリンクした後の JSON レスポンスの例
… "state": "active", "linkedObjectIds": { "ISSUERID.LINKED_PASS_OBJECTID" } …
予想される動作
正常なレスポンスを受信した後、パスを更新したデバイス リンクされたパスを受け取ります。このリンクされたパスは、 あります。右にスワイプすると、リンクされたパスが表示されます。
例外処理
API を誤って使用すると、エラーが発生する可能性があります。
メッセージ | 理由 |
---|---|
プライマリ オブジェクトとリンクされたオブジェクトが同じ発行者を共有していない あります。 | リンクされたオブジェクトを別の発行者のオブジェクトにアタッチすることはできません。 |
プライマリ オブジェクトとリンクされたオブジェクトは同じオブジェクトを参照します。 | linkObject と同じオブジェクトをアタッチすることはできません。 |
リンクされたオブジェクトは存在しません。 | リンクされたオブジェクトはすでにウォレットに挿入されているはずです。 API |
リンクされたオブジェクトには、すでに別のリンクされたオブジェクトがあります。ネストは追加できません 表します。 | リンクされたオブジェクトには、別のリンクされたオブジェクトを設定できません。 |
オブジェクトはすでに別のオブジェクトにリンクされています。ネストされたリンクを追加することはできません 説明します。 | プライマリ オブジェクトを単独でリンクされたオブジェクトにすることはできません。 |
上限を超えているため、リンクされたオブジェクトをこれ以上追加できません。 | メインのリンク済みパスが上限の 50 個に達しました あります。 |