交通機関のパスのテンプレート

交通機関のパスはテンプレート レンダリングをサポートしています。テンプレートが定義されていない場合は、デフォルトのテンプレートが使用されます。

テンプレート定義

パス テンプレートはクラスレベルで定義され、クラスに関連付けられているオブジェクトを表示するために使用されます。テンプレートは、パスのさまざまなセクションに表示するフィールドを定義します。

テンプレートは次のセクションで構成されています。

Android

パス テンプレートのレイアウト セクションと位置の概要

ウェブ

パス テンプレートのレイアウト セクションと位置の概要

カードタイトル

Android

カードタイトルのレイアウト要素とフィールドの位置 デフォルトのカードタイトル
  1. class.logo
  2. class.localizedIssuerName
    または class.issuerName
  3. object.ticketLeg.originName
  4. object.ticketLeg.destinationName
  5. object.ticketLeg.originStationCode
  6. object.ticketLeg.destinationStationCode
  7. object.tripType
  8. object.hexBackgroundColor
    または class.hexBackgroundColor

ワイドロゴカードのタイトル
  1. class.wideLogo
  2. object.ticketLeg.originName
  3. object.ticketLeg.destinationName
  4. object.ticketLeg.originStationCode
  5. object.ticketLeg.destinationStationCode
  6. object.tripType
  7. object.hexBackgroundColor
    または class.hexBackgroundColor

ウェブ

カードタイトルのレイアウト要素とフィールドの位置 デフォルトのカードタイトル
  1. class.logo
  2. class.localizedIssuerName
    または class.issuerName
  3. object.ticketLeg.originName
  4. object.ticketLeg.destinationName
  5. object.ticketLeg.originStationCode
  6. object.ticketLeg.destinationStationCode
  7. object.tripType
  8. object.hexBackgroundColor
    または class.hexBackgroundColor

ワイドロゴカードのタイトル
  1. class.wideLogo
  2. object.ticketLeg.originName
  3. object.ticketLeg.destinationName
  4. object.ticketLeg.originStationCode
  5. object.ticketLeg.destinationStationCode
  6. object.tripType
  7. object.hexBackgroundColor
    または class.hexBackgroundColor

カードタイトル セクションには、交通事業者のロゴと名前、乗車の概要が表示されます。これら 3 つの要素はすべて必須であり、それらを入力するために使用されるフィールド参照も、それらの位置も変更できません。

ただし、レンダリング ロジックにより、最上行にはある程度の柔軟性が認められています。乗車券の一番上の行は、乗車概要を表します。これは、1 区間の乗車の場合、TransitObject の次のフィールドによって制御されます。

  • object.tripType
  • object.ticketLeg.originName
  • object.ticketLeg.destinationName
  • object.ticketLeg.originStationCode
  • object.ticketLeg.destinationStationCode

パスのレンダリング方法は、空でないフィールドによって異なります。次の方法でレンダリングできます。

  • 出発地名のみ: 出発地名のみが表示されます。これは、特定のルートではなく、エリアをカバーするチケットに特に役立ちます。
  • 出発地と目的地: 出発地は左側、目的地は右側にあります。2 つの間の記号は、旅行の種類によって異なります。出発地と目的地は、次のいずれかとして表示されます。
    • 名前と駅コード: 駅コードは、名前の上に小さいテキストで表示されます。
    • 名前のみ: 名前が表示されます。
    • 駅コードのみ: 駅コードが表示されます。

複数区間の TransitObject オブジェクトも同様に機能します。この場合、object.ticketLeg は使用しないでください。代わりに、object.ticketLegs[] リストを使用する必要があります。出発地と目的地の両方を定義する必要があります。名前または駅コード、あるいはその両方を、各区間で一貫して使用する必要があります。表示される出発地は配列の最初の要素の出発地で、表示される目的地は配列の最後の要素の目的地です。

パスの背景色は必須フィールドではなく、クラスレベルとオブジェクト レベルの両方で定義できます。オブジェクト フィールドは優先度が高く、クラス フィールドをオーバーライドするために使用できます。

ワイドロゴ フィールドが設定されている場合、モバイル デバイスでは、ロゴとカード発行者名を含むデフォルトのテンプレート ヘッダーがワイドロゴに置き換えられます。

パスに画像を最適に表示するには、ワイドロゴ画像のガイドラインに沿ってワイドヘッダー ロゴを作成してください。

カード テンプレート

Android

カード テンプレートの行レイアウト要素とフィールド位置

ウェブ

カード テンプレートの行レイアウト要素とフィールド位置

カード テンプレート セクションは、追加行を表示するために使用します。これらの行には、テキストベースの構造化データ フィールドやテキスト モジュール フィールドを含めることができます。

行数を指定して class.classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[] リスト内のオブジェクト数を定義できます。このリストには要素を少なくとも 1 つ指定する必要があります。指定する要素は 2 つ以下にすることをおすすめします。各要素は、次のいずれかのタイプにする必要があります。

  • oneItem は、次の 1 つのアイテムを受け取ります。
    • item
  • twoItems は、次の 2 つのアイテムを受け取ります。
    • startItem
    • endItem
  • threeItems は、次の 3 つのアイテムを受け取ります。
    • startItem
    • middleItem
    • endItem

各アイテムは、単一のフィールド セレクタ(.firstValue)、2 つのフィールド セレクタ(.firstValue と .secondValue)、事前定義されたアイテム(.predefinedItem)として定義できます。選択したフィールドの値とそれぞれのラベルが両方とも表示されます。2 つのフィールド セレクタを定義した場合は、選択したフィールドの値がセパレータ「/」で区切られて表示されます。選択したフィールドのラベルについても同様です。さらに複雑なレンダリングを定義するには、事前定義されたアイテムを使用します。

次のコードサンプルは、カード テンプレートのカード行セクションをオーバーライドして、2 つの行を指定する方法を示しています。各行のそれぞれ 3 つのアイテムが 6 つのクラスレベルの textModuleData カスタム フィールドとそれぞれのヘッダー(ラベル)を参照するように指定しています。

Python

 {
   ... //Rest of class
   "textModulesData": [
        {
            "header": "Label 1",
            "body": "Some info 1",
            "id": "myfield1"
        },
        {
            "header": "Label 2",
            "body": "Some info 2",
            "id": "myfield2"
        },
        {
            "header": "Label 3",
            "body": "Some info 3",
            "id": "myfield3"
        },
        {
            "header": "Label 4",
            "body": "Some info 4",
            "id": "myfield4"
        },
        {
            "header": "Label 5",
            "body": "Some info 5",
            "id": "myfield5"
        },
        {
            "header": "Label 6",
            "body": "Some info 6",
            "id": "myfield6"
        }
    ],
   "classTemplateInfo": {
        "cardTemplateOverride": {
            "cardRowTemplateInfos": [{
                "threeItems": {
                    "startItem": {
                        "firstValue": {
                            "fields": [{
                                "fieldPath": "class.textModulesData['myfield1']"
                            }]
                        }
                    },
                    "middleItem": {
                        "firstValue": {
                            "fields": [{
                                "fieldPath": "class.textModulesData['myfield2']"
                            }]
                        }
                    },
                    "endItem": {
                        "firstValue": {
                            "fields": [{
                                "fieldPath": "class.textModulesData['myfield3']"
                            }]
                        }
                    },
                }
            },{
                "threeItems": {
                    "startItem": {
                        "firstValue": {
                            "fields": [{
                                "fieldPath": "class.textModulesData['myfield4']"
                            }]
                        }
                    },
                    "middleItem": {
                        "firstValue": {
                            "fields": [{
                                "fieldPath": "class.textModulesData['myfield5']"
                            }]
                        }
                    },
                    "endItem": {
                        "firstValue": {
                            "fields": [{
                                "fieldPath": "class.textModulesData['myfield6']"
                            }]
                        }
                    },
                }
            }]
        }
    }
}
    

Java

// Rest of class
  .setTextModulesData((new ArrayList<TextModuleData>() {
    {
      add((new TextModuleData()).setHeader("Label 1")
        .setBody("Some info 1")
        .setId("myfield1"));
      add((new TextModuleData()).setHeader("Label 2")
        .setBody("Some info 1")
        .setId("myfield2"));
      add((new TextModuleData()).setHeader("Label 3")
        .setBody("Some info 3")
        .setId("myfield3"));
      add((new TextModuleData()).setHeader("Label 4")
        .setBody("Some info 4")
        .setId("myfield4"));
      add((new TextModuleData()).setHeader("Label 5")
        .setBody("Some info 5")
        .setId("myfield5"));
      add((new TextModuleData()).setHeader("Label 6")
        .setBody("Some info 5")
        .setId("myfield6"));
    }
  }))
  .setClassTemplateInfo((new ClassTemplateInfo())
    .setCardTemplateOverride((new CardTemplateOverride())
      .setCardRowTemplateInfos(new ArrayList<CardRowTemplateInfo>() {
        {
          add((new CardRowTemplateInfo()).setThreeItems((new CardRowThreeItems())
            .setStartItem((new TemplateItem()).setFirstValue((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
              {
                add((new FieldReference()).setFieldPath("class.textModulesData['myfield1']"));
              }
            })))
            .setMiddleItem((new TemplateItem()).setFirstValue((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
              {
                add((new FieldReference()).setFieldPath("class.textModulesData['myfield2']"));
              }
            })))
            .setEndItem((new TemplateItem()).setFirstValue((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
              {
                add((new FieldReference()).setFieldPath("class.textModulesData['myfield3']"));
              }
            })))
          ));
          add((new CardRowTemplateInfo()).setThreeItems((new CardRowThreeItems())
            .setStartItem((new TemplateItem()).setFirstValue((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
              {
                add((new FieldReference()).setFieldPath("class.textModulesData['myfield4']"));
              }
            })))
            .setMiddleItem((new TemplateItem()).setFirstValue((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
              {
                add((new FieldReference()).setFieldPath("class.textModulesData['myfield5']"));
              }
            })))
            .setEndItem((new TemplateItem()).setFirstValue((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
              {
                add((new FieldReference()).setFieldPath("class.textModulesData['myfield6']"));
              }
            })))
          ));
          }
  })))
    

PHP

// Rest of class
    $textModulesData1 = new Google_Service_Walletobjects_TextModuleData();
    $textModulesData1->setBody("Some info 1");
    $textModulesData1->setHeader("Label 1");
    $textModulesData1->setId("myfield1");

    $textModulesData2 = new Google_Service_Walletobjects_TextModuleData();
    $textModulesData2->setBody("Some info 2");
    $textModulesData2->setHeader("Label 2");
    $textModulesData2->setId("myfield2");

    $textModulesData3 = new Google_Service_Walletobjects_TextModuleData();
    $textModulesData3->setBody("Some info 3");
    $textModulesData3->setHeader("Label 3");
    $textModulesData3->setId("myfield3");

    $textModulesData4 = new Google_Service_Walletobjects_TextModuleData();
    $textModulesData4->setBody("Some info 4");
    $textModulesData4->setHeader("Label 4");
    $textModulesData4->setId("myfield4");

    $textModulesData5 = new Google_Service_Walletobjects_TextModuleData();
    $textModulesData5->setBody("Some info 5");
    $textModulesData5->setHeader("Label 5");
    $textModulesData5->setId("myfield5");

    $textModulesData6 = new Google_Service_Walletobjects_TextModuleData();
    $textModulesData6->setBody("Some info 6");
    $textModulesData6->setHeader("Label 6");
    $textModulesData6->setId("myfield6");

    $textModulesDatas = array($textModulesData1, $textModulesData2, $textModulesData3,
                  $textModulesData4, $textModulesData5, $textModulesData6);

    $startItemField = new Google_Service_Walletobjects_FieldReference();
    $startItemField->setFieldPath("class.textModulesData['myfield1']");

    $startItemFirstValue = new Google_Service_Walletobjects_FieldSelector();
    $startItemFirstValue->setFields(array($startItemField));

    $startItem = new Google_Service_Walletobjects_TemplateItem();
    $startItem->setFirstValue($startItemFirstValue);

    $middleItemField = new Google_Service_Walletobjects_FieldReference();
    $middleItemField->setFieldPath("class.textModulesData['myfield2']");

    $middleItemFirstValue = new Google_Service_Walletobjects_FieldSelector();
    $middleItemFirstValue->setFields(array($middleItemField));

    $middleItem = new Google_Service_Walletobjects_TemplateItem();
    $middleItem->setFirstValue($middleItemFirstValue);

    $endItemField = new Google_Service_Walletobjects_FieldReference();
    $endItemField->setFieldPath("class.textModulesData['myfield3']");

    $endItemFirstValue = new Google_Service_Walletobjects_FieldSelector();
    $endItemFirstValue->setFields(array($endItemField));

    $endItem = new Google_Service_Walletobjects_TemplateItem();
    $endItem->setFirstValue($endItemFirstValue);

    $cardRowTemplate = new Google_Service_Walletobjects_CardRowThreeItems();
    $cardRowTemplate->setStartItem($startItem);
    $cardRowTemplate->setMiddleItem($middleItem);
    $cardRowTemplate->setEndItem($endItem);

    $cardRowTemplateInfo1 = new Google_Service_Walletobjects_CardRowTemplateInfo();
    $cardRowTemplateInfo1->setThreeItems($cardRowTemplate);

    $startItemField2 = new Google_Service_Walletobjects_FieldReference();
    $startItemField2->setFieldPath("class.textModulesData['myfield4']");

    $startItemFirstValue2 = new Google_Service_Walletobjects_FieldSelector();
    $startItemFirstValue2->setFields(array($startItemField2));

    $startItem2 = new Google_Service_Walletobjects_TemplateItem();
    $startItem2->setFirstValue($startItemFirstValue2);

    $middleItemField2 = new Google_Service_Walletobjects_FieldReference();
    $middleItemField2->setFieldPath("class.textModulesData['myfield5']");

    $middleItemFirstValue2 = new Google_Service_Walletobjects_FieldSelector();
    $middleItemFirstValue2->setFields(array($middleItemField2));

    $middleItem2 = new Google_Service_Walletobjects_TemplateItem();
    $middleItem2->setFirstValue($middleItemFirstValue2);

    $endItemField2 = new Google_Service_Walletobjects_FieldReference();
    $endItemField2->setFieldPath("class.textModulesData['myfield6']");

    $endItemFirstValue2 = new Google_Service_Walletobjects_FieldSelector();
    $endItemFirstValue2->setFields(array($endItemField2));

    $endItem2 = new Google_Service_Walletobjects_TemplateItem();
    $endItem2->setFirstValue($endItemFirstValue2);

    $cardRowTemplate2 = new Google_Service_Walletobjects_CardRowThreeItems();
    $cardRowTemplate2->setStartItem($startItem2);
    $cardRowTemplate2->setMiddleItem($middleItem2);
    $cardRowTemplate2->setEndItem($endItem2);

    $cardRowTemplateInfo2 = new Google_Service_Walletobjects_CardRowTemplateInfo();
    $cardRowTemplateInfo2->setThreeItems($cardRowTemplate2);

    $cardTemplateOverride = new Google_Service_Walletobjects_CardTemplateOverride();
    $cardTemplateOverride->setCardRowTemplateInfos(array($cardRowTemplateInfo1,
                  $cardRowTemplateInfo2));

    $classTemplateInfo = new Google_Service_Walletobjects_ClassTemplateInfo();
    $classTemplateInfo->setCardTemplateOverride($cardTemplateOverride);

    $payload->setTextModulesData($textModulesDatas);
    $payload->setClassTemplateInfo($classTemplateInfo);
    

コードは、次のコード テンプレート セクション形式でパスを作成します。

ラベルのオーバーライドの例。

アイテムが空の場合、そのアイテムは表示されません。詳細については、フィールド参照をご覧ください。行内のすべてのアイテムが空の場合、その行は表示されません。行内のすべてのアイテムではなく、一部のアイテムが空の場合は、空でないアイテムが再配置され、1 行に表示されるアイテム数が少なくなります。

カード テンプレートをオーバーライドしない場合は、デフォルトの行数、デフォルトのアイテム数、デフォルトのフィールド参照が使用されます。詳細については、デフォルト テンプレートをご覧ください。

ヒーロー画像を定義すると、cardRowTemplateInfos リストに複数の行がある場合は最初の行の後に、行が 1 つのみの場合はその行の上に表示されます。

カード バーコード

Android

カード バーコードのレイアウト要素と位置
  1. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstTopDetail
  2. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .secondTopDetail
  3. object.barcode.type と object.barcode.value
    または object.ticketNumber
  4. object.barcode.alternateText
  5. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstBottomDetail

ウェブ

カード バーコードのレイアウト要素と位置
  1. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstTopDetail
  2. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .secondTopDetail
  3. object.barcode.type と object.barcode.value
    または object.ticketNumber
  4. object.barcode.alternateText
  5. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstBottomDetail

カード バーコード セクションは、バーコードの前後にテキストや画像を追加して表示するために使用します。このセクションのフィールドはすべて必須ではありません。

バーコードの前に 2 つのフィールドを並べて定義し、バーコードの後に 1 つのフィールドを定義するために使用できるフィールド セレクタが 3 つあります。これらのフィールドはラベルなしで表示され、テキストベースの構造化データ フィールド、テキスト モジュール フィールド、画像モジュール フィールドのいずれかを選択できます。画像を使用する場合は、ブランド ガイドラインに従う必要があります。

バーコードはタイプと値で定義されます。サポートされているバーコードの種類の一覧については、リファレンスをご覧ください。また、テキストをバーコードの真下に表示できます。このテキストは、バーコードのスキャンを促すなどの目的に使用できます。

次のコードサンプルは、パスのバーコード セクションをオーバーライドして、バーコードの上に画像を表示する方法を示しています。

Python

#... rest of class
    "imageModulesData": [
        {
            "mainImage": {
                "sourceUri": {
                    "uri":  "http://farm4.staticflickr.com/3738/12440799783_3dc3c20606_b.jpg",
                    "description": "Coffee"
                }
            },
            "id": "myimage"
        }
    ],
    "classTemplateInfo": {
        "cardBarcodeSectionDetails": {
            "firstTopDetail": {
                "fieldSelector": {
                    "fields": [
                        {
                        "fieldPath": "class.imageModulesData['myimage'].mainImage"
                        }
                    ]
                }
            }
        }
    }
}
    

Java

//... rest of class
  .setImageModulesData((new ArrayList<ImageModuleData>() {
    {
      add((new ImageModuleData())
        .setId("myimage")
        .setMainImage((new Image()).setSourceUri((new ImageUri()).setDescription("Coffee beans")
          .setUri("http://farm4.staticflickr.com/3738/12440799783_3dc3c20606_b.jpg"))));
        }
      }))
      .setClassTemplateInfo((new ClassTemplateInfo())
        .setCardBarcodeSectionDetails((new CardBarcodeSectionDetails())
          .setFirstTopDetail((new BarcodeSectionDetail())
            .setFieldSelector((new FieldSelector())
              .setFields((new ArrayList<FieldReference>(){
                {
                  add((new FieldReference()).setFieldPath("class.imageModulesData['myimage'].mainImage"));
                }
            })))))
      }
    

PHP

//... rest of class
    $imageUri = new Google_Service_Walletobjects_ImageUri();
    $imageUri->setUri("https://farm8.staticflickr.com/7340/11177041185_a61a7f2139_o.jpg");
    $imageUri->setDescription("Baconrista flights image");
    $image = new Google_Service_Walletobjects_Image();
    $image->setSourceUri($imageUri);
    $imageModulesData = new Google_Service_Walletobjects_ImageModuleData();
    $imageModulesData->setMainImage($image);
            $imageModulesData->setId("myimage");

    $cardBarcodeFieldReference = new Google_Service_Walletobjects_FieldReference();
    $cardBarcodeFieldReference->setFieldPath("class.imageModulesData['myimage'].mainImage");

    $cardBarcodeFieldSelector = new Google_Service_Walletobjects_FieldSelector();
    $cardBarcodeFieldSelector->setFields(array($cardBarcodeFieldReference));

    $cardBarcodeDetail = new Google_Service_Walletobjects_BarcodeSectionDetail();
    $cardBarcodeDetail->setFieldSelector($cardBarcodeFieldSelector);

    $cardBarcodeSectionDetails = new Google_Service_Walletobjects_CardBarcodeSectionDetails();
    $cardBarcodeSectionDetails->setFirstTopDetail($cardBarcodeDetail);

    $classTemplateInfo = new Google_Service_Walletobjects_ClassTemplateInfo();
    $classTemplateInfo->setCardBarcodeSectionDetails($cardBarcodeSectionDetails);

    $payload->setClassTemplateInfo($classTemplateInfo);
            $payload->setImageModuleData($imageModulesData);
    

コードは、次のバーコード セクション形式でパスを作成します。

カードのバーコード オーバーライドの例。

バーコード セクションをオーバーライドしない場合は、デフォルトのバーコード フィールドが使用されます。詳細については、デフォルト テンプレートをご覧ください。

下部セクション

Android

詳細テンプレートの下部セクションとアイテム
  • 複数の区間を含む旅程
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[0].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[1].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[2].item
  • ...

ウェブ

詳細テンプレートの下部セクションとアイテム
  • 複数の区間を含む旅程
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[0].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[1].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[2].item
  • ...

下部のセクションはアイテム class.classTemplateInfo.detailsTemplateOverride.detailsItemInfos[] のリストです。アイテムには、任意の種類の構造化データ フィールド、テキスト モジュール フィールド、リンク モジュール フィールド、画像モジュール フィールド、メッセージを含めることができます。

各アイテムは、単一のフィールド セレクタ(.firstValue)、2 つのフィールド セレクタ(.firstValue と .secondValue)、事前定義されたアイテム(.predefinedItem)として定義できます。選択したフィールドの値とそれぞれのラベルが両方とも表示されます。2 つのフィールド セレクタを定義した場合は、選択したフィールドの値がセパレータ「/」で区切られて表示されます。選択したフィールドのラベルについても同様です。さらに複雑なレンダリングを定義するには、事前定義されたアイテムを使用します。画像モジュールのフィールドは、ラベルなしで全幅でレンダリングされます。

次のコードサンプルは、パスの下部セクションをオーバーライドして、ラベル付きの単一の linksModuleData フィールドを表示する方法を示しています。

Python

//... rest of class
   "linksModuleData": {
        "uris": [
            {
                "uri": "http://maps.google.com/",
                "description": "Nearby Locations",
                "id":"mylink"
            }
        ]
    },
   "classTemplateInfo": {
        "detailsTemplateOverride": {
            "detailsItemInfos": [
                {
                    "item":{
                        "firstValue": {
                            "fields": [{
                                "fieldPath": "class.linksModuleData.uris['mylink']"
                            }]
                        }
                    }
                }
            ]
        }
     }
//... rest of class
    

Java

 //... rest of class
  .setLinksModuleData((new ArrayList<LinksModuleData>() {
    {
      add((new LinksModuleData()).setDescription("Nearby Locations")
        .setUri("http://maps.google.com/")
        .setId("mylink"));
      }))
      .setClassTemplateInfo((new ClassTemplateInfo())
        .setDetailsTemplateOverride((new DetailsTemplateOverride())
          .setDetailsItemInfos(new ArrayList<DetailsItemInfo>(){
            {
              add((new DetailsItemInfo())
                .setItem((new TemplateItem()).setFirstValue((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
                  {
                    add((new FieldReference()).setFieldPath("class.linksModuleData.uris['mylink']"));
                  }
                }))));
              }
            }))
//... rest of class
    

PHP

    //... rest of class building
    $locationUri = new Google_Service_Walletobjects_Uri();
    $locationUri->setUri("http://maps.google.com/");
    $locationUri->setDescription("Nearby Locations");
    $locationUri->setId("mylink");

    $linksModuleData = new Google_Service_Walletobjects_LinksModuleData();
    $linksModuleData->setUris(array($locationUri));

    $detailItemFieldReference = new Google_Service_Walletobjects_FieldReference();
    $detailItemFieldReference->setFieldPath("class.linksModuleData.uris['mylink']");
    $detailItemFieldSelector = new Google_Service_Walletobjects_FieldSelector();
    $detailItemFieldSelector->setFields(array($detailItemFieldReference));

    $detailItem = new Google_Service_Walletobjects_TemplateItem();
    $detailItem->setFirstValue($detailItemFieldSelector);

    $detailsItemInfo = new Google_Service_Walletobjects_DetailsItemInfo();
    $detailsItemInfo->setItem($detailItem);

    $cardDetailsTemplateOverride = new Google_Service_Walletobjects_DetailsTemplateOverride();
    $cardDetailsTemplateOverride->setDetailsItemInfos(array($detailsItemInfo));

    $classTemplateInfo = new Google_Service_Walletobjects_ClassTemplateInfo();
    $classTemplateInfo->setDetailsTemplateOverride($cardDetailsTemplateOverride);

    $payload->setClassTemplateInfo($classTemplateInfo);
    $payload->setLinksModuleData($linksModuleData);
    //... rest of class
    

コードは、次の下部セクション形式でパスを作成します。

下部セクションのオーバーライドの例。

アイテムが空の場合、そのアイテムは表示されません。詳細については、フィールド参照をご覧ください。

下部セクションをオーバーライドしない場合は、デフォルトの参照フィールドのリストがデフォルトの順序で表示されます。詳細については、デフォルト テンプレートをご覧ください。

乗車区間が複数ある場合は、セクションの一番上に略式の乗車経路が表示されます。この乗車経路の表示を移動することはできません。乗車区間が 1 つのみの場合は、class.enableSingleLegItinerary を設定することで略式の乗車経路を表示できます。

複数区間の旅程
  1. class.tranistType
  2. object.ticketLegs[i].originName
    または object.ticketLegs[i].originStationCode
  3. object.ticketLegs[i].departureDateTime(時刻のみ)
  4. object.ticketLegs[i].transitOperatorName
  5. 普通客車または class.customCoachLabel
  6. object.ticketLegs[i].ticketSeat.coach
    または object.ticketLegs[i].ticketSeats[*].coach
  7. 座席または class.customSeatLabel
  8. object.ticketLegs[i].ticketSeat.seat
    または object.ticketLegs[i].ticketSeat.seatAssignment
    または object.ticketLegs[i].ticketSeats[*].seat
    または object.ticketLegs[i].ticketSeats[*].seatAssignment
    または座席情報なし
  9. object.hexBackgroundColor
    または class.hexBackgroundColor
  10. object.ticketLegs[i].destinationName
    または object.ticketLegs[i].destinationStationCode
  11. object.ticketLegs[i].arrivalDateTime(時刻のみ)
  12. 乗り換え先: プラットフォーム
    または乗り換え先: class.customPlatformLabel
    または乗り換え(プラットフォームが定義されていない場合)
  13. object.ticketLegs[i+1].platform

リスト テンプレート

リスト テンプレートの要素
  1. class.classTemplateInfo.listTemplateOverride
      .firstRowOption.fieldOption.fields[]
  2. object.ticketLeg.departureDateTime(グループ化)
    または class.classTemplateInfo.listTemplateOverride
    .secondRowOption.fields[]
  3. class.logo
  4. object.hexBackgroundColor
    または class.hexBackgroundColor
  5. <# 個のパス>(グループ化)

リスト テンプレート セクションは、Google ウォレット アプリの「パス」ビューに表示するフィールドを選択するために使用します。パスは、ロゴ、背景色、3 つの行を含むリストで表示されます。

次のコードサンプルは、パスのリスト テンプレートをオーバーライドして、ひとつのパスのオブジェクト有効期限フィールドをリスト テンプレートの最初の行に表示する方法を示しています。

Python

#... rest of class definition
   "classTemplateInfo": {
        "listTemplateOverride":{
            "firstRowOption": {
                "fieldOption":{
                    "fields": [{
                        "fieldPath": "object.validTimeInterval.end"
                    }]
                }
            }
        }
   }
}
    

Java

//... rest of class
  .setClassTemplateInfo((new ClassTemplateInfo())
    .setListTemplateOverride((new ListTemplateOverride())
      .setFirstRowOption((new FirstRowOption())
        .setFieldOption((new FieldSelector()).setFields(new ArrayList<FieldReference>(){
          {
            add((new FieldReference()).setFieldPath("object.validTimeInterval.end"));
          }
        }))))
//... rest of class
    

PHP

    //... rest of class
    $fieldReference = new Google_Service_Walletobjects_FieldReference();
    $fieldReference->setFieldPath("object.validTimeInterval.end");

    $fieldOption = new Google_Service_Walletobjects_FieldSelector();
    $fieldOption->setFields(array($fieldReference));

    $firstRowOption = new Google_Service_Walletobjects_FirstRowOption();
    $firstRowOption->setFieldOption($fieldOption);

    $listTemplateOverride = new Google_Service_Walletobjects_ListTemplateOverride();
    $listTemplateOverride->setFirstRowOption($firstRowOption);

    $classTemplateInfo = new Google_Service_Walletobjects_ClassTemplateInfo();
    $classTemplateInfo->setListTemplateOverride($listTemplateOverride);

    $payload->setClassTemplateInfo($classTemplateInfo);
    //... rest of class
    

コードは、次のリスト テンプレート レンダリングでパスを作成します。

リストのオーバーライドの例。

最初の行は、フィールド セレクタで定義することも、ジャーニーの概要を表示することもできます。要約の形式は次のいずれかです。

  • originAndDestinationCodes
  • originAndDestinationNames
  • originName

2 行目と 3 行目は、フィールド セレクタでのみ定義できます。フィールドはラベルなしで表示されます。 グループ化されたパスの場合、2 行目には常に出発日が表示され、3 行目には常にグループ化されたパスの数が表示されます。

ラベル

すべての構造化データ フィールドには、Google が提供するラベルが付いています。Google は、これらの各ラベルをサポートされているすべての言語に翻訳する作業を担当します。

これらのラベルの一部は、class.custom<name_of_the_field>Label フィールドのいずれかを使用してカスタマイズできます。ユーザーがラベルをカスタマイズする場合、そのラベルをサポートするすべての言語に翻訳する作業は、ユーザー側で行う必要があります。

フィールド参照

フィールド参照は、テンプレートのさまざまな部分で class.classTemplateInfo.*.fields[] 形式で使用されます。フィールド参照には、構造化データ フィールド、テキスト モジュール フィールド、リンク モジュール フィールド、画像モジュール フィールド、またはメッセージへのパスのリストが含まれます。

すべてのフィールド参照ですべてのタイプのパスが許可されているわけではありません。たとえば、一部のフィールド参照では、テキストベースの構造化データ フィールドまたはテキスト モジュール フィールドへのパスのみが許可されます。テキストベースの構造化フィールドは、文字列、ローカライズされた文字列、日付、金額のいずれかのタイプの構造化データ フィールドです。

このリストは、フォールバック ロジックの実装に使用できます。つまり、リストの最初のパスが空のフィールドに解決されると、次のパスが評価されます。フォールバック ロジックは、主にテキストベースの構造化データ フィールドまたはテキスト モジュール フィールドを対象としています。同じリストに異なるタイプのフィールドを混在させないでください。フォールバック ロジックは、一部のオブジェクトに存在するが他のオブジェクトには存在しないフィールドの一貫したパターンが想定される特定の状況でのみ、慎重に使用してください。ほとんどの場合、ユースケースごとに個別のクラスを作成する方が簡単です。

フィールド参照リスト内のすべてのパスが空のフィールドに解決される場合、フィールド参照を使用するアイテムは表示されません。フィールド参照を使用するアイテムを常に存在させる場合は、少なくとも 1 つのパスが空でないことを確認してください。一部のフィールドではスペースのみの文字列が許可されますが、null 値を表すには、フィールドを「-」などの特殊文字に設定することをおすすめします。

リストに含まれるフィールドを参照するには、リスト内のフィールドのインデックスを使用するか、ほとんどの場合は参照 ID を使用します。ID で参照できるリストのアイテムには .id フィールドがあります。可能な限り、リスト内でのフィールドのインデックスではなく、参照 ID を使用することをおすすめします。

以下は、リストに含まれるフィールドを参照する方法の例です。

  • object.imageModulesData[0].id = my-first-id
  • object.imageModulesData[1].id = my-second-id
  • class.detailsTemplateOverride.detailsItemInfos[0].item.firstValue.fields[0].fieldPath = object.imageModulesData[‘my-second-id’]
  • class.detailsTemplateOverride.detailsItemInfos[1].item.firstValue.fields[0].fieldPath = object.imageModulesData[0]

この場合、パスの詳細セクションの最初のアイテムは、オブジェクトで宣言された 2 番目の画像になります。パスの詳細セクションの 2 番目のアイテムは、オブジェクトで宣言された最初の画像です。

デフォルト テンプレート

Android

デフォルトのパス テンプレートのレイアウト要素と位置
  1. class.logo
  2. class.localizedIssuerName
    または class.issuerName
  3. カードタイトルを表示
  4. 出発時刻または有効開始
  5. object.ticketLeg.departureDateTime(日時)
    または object.validTimeInterval.start.date
  6. 到着時刻または有効期限
  7. object.ticketLeg.arrivalDateTime(時刻のみ)
    または object.validTimeInterval.end.date
  8. 乗客名
  9. object.passengerNames
  10. 車両または class.customCarriageLabel
  11. object.ticketLeg.carriage
  12. 普通客車または class.customCoachLabel
  13. object.ticketLeg.ticketSeat.coach
  14. 座席または class.customSeatLabel
  15. object.ticketLeg.ticketSeat.seat
    または object.ticketLeg.ticketSeat.seatAssignment
  16. object.barcode.type と object.barcode.value
    または object.ticketNumber
  17. object.barcode.alternateText
  18. object.hexBackgroundColor
    または class.hexBackgroundColor
  19. 複数の区間を含む旅程
  20. チケット番号または class.customTicketNumberLabel
  21. object.ticketNumber
  22. チケットのステータス
  23. object.ticketStatus または object.customTicketStatus
  24. 出発
  25. object.ticketLeg.departureDateTime
  26. 到着時刻
  27. object.ticketLeg.arrivalDateTime
  28. 運賃種別または class.customFareNameLabel
  29. object.ticketLeg.fareName
  30. プラットフォームまたは class.customPlatformLabel
  31. object.ticketLeg.platform
  32. ゾーンまたは class.customZoneLabel
  33. object.ticketLeg.zone
  34. 運賃クラスまたは class.customFareClassLabel
  35. object.ticketLeg.ticketSeat.fareClass
    または object.ticketLeg.ticketSeat.customFareClass
  36. 割引カテゴリ
    または class.customConcessionCategoryLabel
  37. object.concessionCategory
    または object.customConcessionCategory
  38. 利用ルート制限
    または class.customRouteRestrictionsLabel
  39. object.ticketRestrictions.routeRestrictions
  40. 利用ルート制限の詳細
    または class.customRouteRestrictionsDetailsLabel
  41. object.ticketRestrictions.routeRestrictionsDetails
  42. 時間制限
    または class.customTimeRestrictionsLabel
  43. object.ticketRestrictions.timeRestrictions
  44. その他の制限
    または class.customOtherRestrictionsLabel
  45. object.ticketRestrictions.otherRestrictions
  46. 領収書番号
    または class.customPurchaseReceiptNumberLabel
  47. object.purchaseDetails.purchaseReceiptNumber
  48. 購入日
  49. object.purchaseDetails.purchaseDateTime
  50. アカウント ID
  51. object.purchaseDetails.accountId
  52. 確認コード
    または class.customConfirmationCodeLabel
  53. object.purchaseDetails.confirmationCode
  54. 額面金額または class.customPurchaseFaceValueLabel
  55. object.purchaseDetails.ticketCost.faceValue
  56. 価格または class.customPurchasePriceLabel
  57. object.purchaseDetails.ticketCost.purchasePrice
  58. 割引メッセージ
    または class.customDiscountMessageLabel
  59. object.purchaseDetails.ticketCost.discountMessage
  60. class.imageModulesData[0].mainImage
  61. object.imageModulesData[0].mainImage
  62. class.messages[].header
  63. class.messages[].body
  64. object.messages[].header
  65. object.messages[].body
  66. class.textModulesData[0..9].header
  67. class.textModulesData[0..9].body
  68. object.textModulesData[0..9].header
  69. object.textModulesData[0..9].body
  70. class.linksModuleData.uris[].description
  71. object.linksModuleData.uris[].description

ウェブ

デフォルトのパス テンプレートのレイアウト要素と位置
  1. class.logo
  2. class.localizedIssuerName
    または class.issuerName
  3. カードタイトルを表示
  4. 出発時刻または有効開始
  5. object.ticketLeg.departureDateTime(日時)
    または object.validTimeInterval.start.date
  6. 到着時刻または有効期限
  7. object.ticketLeg.arrivalDateTime(時刻のみ)
    または object.validTimeInterval.end.date
  8. 乗客名
  9. object.passengerNames
  10. 車両または class.customCarriageLabel
  11. object.ticketLeg.carriage
  12. 普通客車または class.customCoachLabel
  13. object.ticketLeg.ticketSeat.coach
  14. 座席または class.customSeatLabel
  15. object.ticketLeg.ticketSeat.seat
    または object.ticketLeg.ticketSeat.seatAssignment
  16. object.barcode.type と object.barcode.value
    または object.ticketNumber
  17. object.barcode.alternateText
  18. object.hexBackgroundColor
    または class.hexBackgroundColor
  19. 複数の区間を含む旅程
  20. チケット番号または class.customTicketNumberLabel
  21. object.ticketNumber
  22. チケットのステータス
  23. object.ticketStatus または object.customTicketStatus
  24. 出発
  25. object.ticketLeg.departureDateTime
  26. 到着時刻
  27. object.ticketLeg.arrivalDateTime
  28. 運賃種別または class.customFareNameLabel
  29. object.ticketLeg.fareName
  30. プラットフォームまたは class.customPlatformLabel
  31. object.ticketLeg.platform
  32. ゾーンまたは class.customZoneLabel
  33. object.ticketLeg.zone
  34. 運賃クラスまたは class.customFareClassLabel
  35. object.ticketLeg.ticketSeat.fareClass
    または object.ticketLeg.ticketSeat.customFareClass
  36. 割引カテゴリ
    または class.customConcessionCategoryLabel
  37. object.concessionCategory
    または object.customConcessionCategory
  38. 利用ルート制限
    または class.customRouteRestrictionsLabel
  39. object.ticketRestrictions.routeRestrictions
  40. 利用ルート制限の詳細
    または class.customRouteRestrictionsDetailsLabel
  41. object.ticketRestrictions.routeRestrictionsDetails
  42. 時間制限
    または class.customTimeRestrictionsLabel
  43. object.ticketRestrictions.timeRestrictions
  44. その他の制限
    または class.customOtherRestrictionsLabel
  45. object.ticketRestrictions.otherRestrictions
  46. 領収書番号
    または class.customPurchaseReceiptNumberLabel
  47. object.purchaseDetails.purchaseReceiptNumber
  48. 購入日
  49. object.purchaseDetails.purchaseDateTime
  50. アカウント ID
  51. object.purchaseDetails.accountId
  52. 確認コード
    または class.customConfirmationCodeLabel
  53. object.purchaseDetails.confirmationCode
  54. 額面金額または class.customPurchaseFaceValueLabel
  55. object.purchaseDetails.ticketCost.faceValue
  56. 価格または class.customPurchasePriceLabel
  57. object.purchaseDetails.ticketCost.purchasePrice
  58. 割引メッセージ
    または class.customDiscountMessageLabel
  59. object.purchaseDetails.ticketCost.discountMessage
  60. class.imageModulesData[0].mainImage
  61. object.imageModulesData[0].mainImage
  62. class.messages[].header
  63. class.messages[].body
  64. object.messages[].header
  65. object.messages[].body
  66. class.textModulesData[0..9].header
  67. class.textModulesData[0..9].body
  68. object.textModulesData[0..9].header
  69. object.textModulesData[0..9].body
  70. class.linksModuleData.uris[].description
  71. object.linksModuleData.uris[].description

画像モジュール フィールドについては、クラスから 1 つ、オブジェクトから 1 つのみが表示されます。いずれかのレベルで複数の画像モジュール フィールドが必要な場合は、デフォルト テンプレートをオーバーライドします。

テキスト モジュール フィールドについては、クラスから最大 20 個、オブジェクトから最大 20 個のみが表示されます。これらのフィールドは、配列で定義されているのと同じ順序で表示されます。いずれかのレベルで 20 個を超えるテキスト モジュール フィールドが必要な場合は、デフォルト テンプレートをオーバーライドします。

メッセージについては、クラスから最大 20 個、オブジェクトから最大 20 個のみが表示されます。メッセージの順序は保証されません。いずれかのレベルで 20 個を超えるメッセージが必要な場合や、順序を保証したい場合は、デフォルト テンプレートをオーバーライドします。

リンク モジュール フィールドでは、定義できる URI の数に制限はありません。URI は各レベル(クラスまたはオブジェクト)に対して次の順序でグループ化されて表示されます。

  1. 地図上の座標
  2. 電話番号
  3. メール アドレス
  4. ウェブページ

グループごとに、URI は配列で定義されているのと同じ順序で表示されます。順序を変更する必要がある場合は、デフォルト テンプレートをオーバーライドします。

デフォルトのリスト テンプレートのレイアウト要素と位置
  1. (object.ticketLeg.originName
    と object.ticketLeg.destinationName)
    (object.ticketLeg.originStationCode
    と object.ticketLeg.destinationStationCode)
    または object.ticketLeg.originName
  2. object.ticketLeg.departureDateTime
    または object.validTimeInterval.end.date
  3. class.logo
  4. object.hexBackgroundColor
    または class.hexBackgroundColor
  5. <# 個のパス>(グループ化)