Modèle d'offre

Les cartes d'offre sont compatibles avec le rendu de modèle. Si aucun modèle n'est défini, le modèle par défaut est utilisé.

Définition du modèle

Un modèle de carte est défini au niveau de la classe et permet d'afficher tout objet associé à la classe. Le modèle définit les champs à afficher dans les différentes sections de la carte.

Le modèle comprend les sections suivantes :

Android

Présentation des sections et des positions de la mise en page du modèle de pass

Web

Présentation des sections et des positions de la mise en page du modèle de pass

Titre de la fiche

Android

Éléments de mise en page du titre de la carte et positions des champs Titre de carte par défaut
  1. class.titleImage
  2. class.localizedIssuerName
    ou class.issuerName
  3. class.localizedTitle
    ou class.title
  4. class.hexBackgroundColor

Titre de la carte avec logo large
  1. class.wideTitleImage
  2. class.localizedTitle
    ou class.title
  3. class.hexBackgroundColor

Web

Éléments de mise en page du titre de la carte et positions des champs Titre de carte par défaut
  1. class.titleImage
  2. class.localizedIssuerName
    ou class.issuerName
  3. class.localizedTitle
    ou class.title
  4. class.hexBackgroundColor

Titre de la carte avec logo large
  1. class.wideTitleImage
  2. class.localizedTitle
    ou class.title
  3. class.hexBackgroundColor

La section du titre de la carte affiche le logo, le nom de l'émetteur et le titre de l'offre. Ni les références de champ utilisées pour les renseigner, ni leur position ne peuvent être modifiées.

Lorsque le champ du logo large est défini, l'en-tête du modèle par défaut avec le logo et le nom de l'émetteur est remplacé par le logo large sur les appareils Android.

Suivez les instructions liées à l'image du grand logo lorsque vous créez votre grand logo d'en-tête pour afficher votre image de manière optimale sur vos pass.

Modèle de carte

Android

Éléments de mise en page et positions des champs des lignes du modèle de carte

Web

Éléments de mise en page et positions des champs des lignes du modèle de carte

La section du modèle de carte permet d'afficher des lignes supplémentaires. Ces lignes peuvent contenir des champs de données structurées textuelles ou des champs de module de texte.

Vous pouvez spécifier le nombre de lignes qui définissent le nombre d'objets dans la liste class.classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[]. La liste doit contenir au moins un élément, et nous recommandons d'en utiliser deux au maximum. Chaque élément doit être de l'un des types suivants :

  • oneItem, qui accepte un élément :
    • item
  • twoItems, qui accepte deux éléments :
    • startItem
    • endItem
  • threeItems, qui accepte trois éléments :
    • startItem
    • middleItem
    • endItem

Chaque élément peut être défini comme un sélecteur de champ unique (.firstValue), deux sélecteurs de champ (.firstValue et .secondValue) ou un élément prédéfini (.predefinedItem). Les valeurs du champ sélectionné et leurs libellés respectifs s'affichent. Si vous définissez deux sélecteurs de champ, les valeurs des champs sélectionnés sont affichées avec un séparateur "/". Il en va de même pour les libellés des champs sélectionnés. Les éléments prédéfinis sont utilisés pour définir un rendu plus complexe.

L'exemple de code suivant montre comment remplacer les sections de ligne de la carte du modèle de carte pour spécifier deux lignes. Chaque ligne comprend trois éléments qui référencent chacun six champs textModuleData personnalisés au niveau de la classe et leurs en-têtes en tant que libellés :

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);
    

Le code crée une carte dont la section de modèle de code a le format suivant :

Exemple de remplacement de libellé.

Si un élément est vide, il n'est pas affiché. Pour en savoir plus, consultez Références de champ. Si tous les éléments d'une ligne sont vides, la ligne n'est pas affichée. Si certains éléments d'une ligne sont vides (mais pas tous), les éléments non vides sont réorganisés et affichés sous la forme d'une ligne comportant moins d'éléments.

Si vous ne remplacez pas le modèle de carte, les nombres de lignes et d'éléments et les références de champ par défaut sont utilisés. Pour en savoir plus, consultez Modèle par défaut.

Une fois que vous avez défini une image héros, celle-ci peut s'afficher après la première ligne (s'il y a plusieurs lignes dans la liste cardRowTemplateInfos) ou au-dessus de la ligne (s'il n'y en a qu'une seule).

Code-barres de la carte

Android

Éléments et positions de la mise en page du code-barres de la carte
  1. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstTopDetail
  2. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .secondTopDetail
  3. object.barcode.type et
    object.barcode.value
  4. object.barcode.alternateText
    ou object.barcode.value
  5. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstBottomDetail
  6. object.heroImage
    ou class.heroImage

Web

Éléments et positions de la mise en page du code-barres de la carte
  1. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstTopDetail
  2. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .secondTopDetail
  3. object.barcode.type et
    object.barcode.value
  4. object.barcode.alternateText
    ou object.barcode.value
  5. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstBottomDetail

La section du code-barres de la carte permet d'afficher du texte ou des images supplémentaires avant et après le code-barres. Aucun des champs de cette section n'est obligatoire.

Trois sélecteurs de champ peuvent être utilisés pour définir deux champs côte à côte avant le code-barres et un après. Ceux-ci sont affichés sans libellé, et peuvent être des champs de données structurées textuelles, des champs de module de texte ou des champs de module d'image. Si vous utilisez des images, elles doivent respecter les consignes relatives à la marque.

Le code-barres est défini par un type et une valeur. Pour obtenir la liste des types de codes-barres acceptés, consultez la documentation de référence. De plus, du texte peut s'afficher directement sous le code-barres. Ce texte peut, entre autres, faciliter la lecture des codes-barres.

L'exemple de code suivant montre comment remplacer la section du code-barres d'une carte pour afficher une image au-dessus du code-barres :

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);
    

Le code crée une carte dont la section de code-barres a le format suivant :

Exemple de remplacement de code-barres d'une carte.

Si vous ne remplacez pas la section du code-barres, les champs de code-barres par défaut sont utilisés. Pour en savoir plus, consultez Modèle par défaut.

Section inférieure

Android

Sections et éléments inférieurs du modèle des détails
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[0].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[1].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[2].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[3].item

Web

Sections et éléments inférieurs du modèle des détails
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[0].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[1].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[2].item
  • class.classTemplateInfo.detailsTemplateOverride
      .detailsItemInfos[3].item

La section inférieure est une liste d'éléments class.classTemplateInfo.detailsTemplateOverride.detailsItemInfos[]. Ces éléments peuvent contenir tout type de champs de données structurées, de champs de module de texte, de champs de module de lien, de champs de module d'image ou de messages.

Chaque élément peut être défini comme un sélecteur de champ unique (.firstValue), deux sélecteurs de champ (.firstValue et .secondValue) ou un élément prédéfini (.predefinedItem). Les valeurs du champ sélectionné et leurs libellés respectifs s'affichent. Si vous définissez deux sélecteurs de champ, les valeurs des champs sélectionnés sont affichées avec un séparateur "/". Il en va de même pour les libellés des champs sélectionnés. Les éléments prédéfinis sont utilisés pour définir un rendu plus complexe. Les champs de module d'image sont affichés en pleine largeur, sans libellé.

L'exemple de code suivant montre comment remplacer la section inférieure de la carte pour afficher un champ linksModuleData unique avec son libellé :

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
    

Le code crée une carte dont la section inférieure a le format suivant :

Exemple de remplacement de la section inférieure.

Si un élément est vide, il n'est pas affiché. Pour en savoir plus, consultez Références de champ.

Si vous ne remplacez pas la section inférieure, la liste par défaut des champs de référence est affichée dans l'ordre par défaut. Pour en savoir plus, consultez Modèle par défaut.

Modèle de liste

Éléments du modèle de liste
  1. class.classTemplateInfo.listTemplateOverride
      .firstRowOption.fieldOption.fields[]
  2. class.classTemplateInfo.listTemplateOverride
      .secondRowOption.fields[]
  3. class.titleImage
  4. class.hexBackgroundColor

La section du modèle de liste permet de sélectionner les champs à afficher dans la vue "Cartes" de l'application Google Wallet. La carte est représentée dans la liste avec le logo, la couleur d'arrière-plan et trois lignes.

L'exemple de code suivant montre comment remplacer le modèle de liste d'une carte pour afficher dans la première ligne du modèle de liste un champ de date d'expiration de l'objet correspondant à une carte donnée :

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
    

Le code crée une carte avec le rendu de modèle de liste suivant :

Exemple de remplacement de liste.

Les trois lignes peuvent être définies avec un sélecteur de champ. Les champs s'affichent sans libellé.

Étiquettes

Tous les champs de données structurées possèdent un libellé fourni par Google. Google est chargé de fournir une traduction pour chacun de ces libellés, dans toutes les langues acceptées.

Vous pouvez personnaliser certains de ces libellés à l'aide de l'un des champs class.custom<name_of_the_field>Label. Lorsque vous personnalisez un libellé, il vous incombe de fournir les traductions pour ce libellé spécifique dans toutes les langues que vous souhaitez prendre en charge.

Références de champ

Les références de champ sont utilisées dans différentes parties du modèle sous la forme class.classTemplateInfo.*.fields[]. Une référence de champ contient une liste de chemins d'accès à des champs de données structurées, des champs de module de texte, des champs de module de lien, des champs de module d'image ou des messages.

Tous les types de chemins d'accès ne sont pas autorisés dans chaque référence de champ. Par exemple, certaines références de champ n'autorisent que les chemins d'accès à des champs de données structurées textuelles ou à des champs de module de texte. Les champs de données structurées textuelles sont des champs de données structurées de type chaîne, chaîne localisée, date ou valeur monétaire.

La liste peut être utilisée pour implémenter une logique de remplacement. Cela signifie que, si le premier chemin d'accès de la liste correspond à un champ vide, le chemin suivant est évalué. La logique de remplacement cible principalement les champs de données structurées textuelles ou les champs de module de texte. Ne mélangez pas différents types de champs dans la même liste. Utilisez la logique de remplacement avec prudence et uniquement dans des cas spécifiques où vous attendez un schéma cohérent de champs qui existent dans certains objets, mais pas dans d'autres. La plupart du temps, il est plus simple de créer des classes distinctes pour chaque cas d'utilisation.

Si tous les chemins d'accès d'une liste de références de champ correspondent à des champs vides, l'élément utilisant la référence de champ ne s'affiche pas. Si vous souhaitez que l'item utilisant la référence de champ soit toujours présent, assurez-vous qu'au moins un chemin d'accès n'est pas vide. Nous vous recommandons de définir un champ sur un caractère spécial, par exemple "-", afin de représenter une valeur nulle, même si certains champs autorisent des chaînes contenant uniquement un espace.

Pour référencer un champ contenu dans une liste, vous pouvez utiliser son index dans la liste ou, dans la plupart des cas, un identifiant de référence. Les éléments d'une liste pouvant être référencés à l'aide d'un identifiant comportent un champ .id. Nous vous recommandons d'utiliser un identifiant de référence plutôt que l'index du champ dans la liste, lorsque cela est possible.

Voici un exemple montrant comment référencer des champs contenus dans une liste.

  • 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]

Dans ce cas, le premier élément de la section des détails de la carte est la deuxième image déclarée dans l'objet. tandis que le deuxième élément de la section des détails de la carte est la première image déclarée dans l'objet.

Modèle par défaut

Android

Éléments et positions de la mise en page du modèle de carte par défaut
  1. class.titleImage
  2. class.localizedIssuerName
    ou class.issuerName
  3. class.localizedTitle
    ou class.title
  4. object.barcode.type et
    object.barcode.value
  5. object.barcode.alternateText
    ou object.barcode.value
  6. DATE D'EXPIRATION
  7. object.validTimeInterval.end
  8. class.hexBackgroundColor
  9. object.heroImage
    ou class.heroImage
  10. FROM
  11. class.localizedProvider
    ou class.provider
  12. DÉTAILS
  13. class.localizedDetails
    ou class.details
  14. CLAUSE DE NON-RESPONSABILITÉ
  15. class.localizedFinePrint
    ou class.finePrint
  16. class.messages[].header
  17. class.messages[].body
  18. object.messages[].header
  19. object.messages[].body
  20. class.textModulesData[0..9].header
  21. class.textModulesData[0..9].body
  22. object.textModulesData[0..9].header
  23. object.textModulesData[0..9].body
  24. class.linksModuleData.uris[].description
  25. object.linksModuleData.uris[].description
  26. class.homepageUri
  27. class.helpUri

Web

Éléments et positions de la mise en page du modèle de carte par défaut
  1. class.titleImage
  2. class.localizedIssuerName
    ou class.issuerName
  3. class.localizedTitle
    ou class.title
  4. object.barcode.type et
    object.barcode.value
  5. object.barcode.alternateText
    ou object.barcode.value
  6. DATE D'EXPIRATION
  7. object.validTimeInterval.end
  8. class.hexBackgroundColor
  9. object.heroImage
    ou class.heroImage
  10. FROM
  11. class.localizedProvider
    ou class.provider
  12. DÉTAILS
  13. class.localizedDetails
    ou class.details
  14. CLAUSE DE NON-RESPONSABILITÉ
  15. class.localizedFinePrint
    ou class.finePrint
  16. class.messages[].header
  17. class.messages[].body
  18. object.messages[].header
  19. object.messages[].body
  20. class.textModulesData[0..9].header
  21. class.textModulesData[0..9].body
  22. object.textModulesData[0..9].header
  23. object.textModulesData[0..9].body
  24. class.linksModuleData.uris[].description
  25. object.linksModuleData.uris[].description
  26. class.homepageUri
  27. class.helpUri

Pour les champs de module d'image, nous n'affichons qu'un seul champ de module d'image de la classe et qu'un seul champ de module d'image de l'objet. Si vous avez besoin de davantage de champs de module d'image au niveau de la classe ou de l'objet, remplacez le modèle par défaut.

Pour les champs de module de texte, nous affichons uniquement un maximum de 20 champs de module de texte de la classe et 20 champs de module de texte de l'objet. Les champs s'affichent dans l'ordre dans lequel ils sont définis dans le tableau. Si vous avez besoin de plus de 20 champs de module de texte au niveau de la classe ou de l'objet, remplacez le modèle par défaut.

Pour les messages, nous affichons uniquement un maximum de 20 messages de la classe et 20 messages de l'objet. Nous ne garantissons pas l'ordre des messages. Si vous avez besoin de plus de 20 messages au niveau de la classe ou de l'objet, ou d'une garantie concernant leur ordre, remplacez le modèle par défaut.

Pour le champ de module de lien, le nombre d'URI que vous pouvez définir n'est pas limité. Les URI sont affichés de manière groupée dans l'ordre suivant pour chaque niveau (classe ou objet) :

  1. Coordonnées géographiques
  2. Numéros de téléphone
  3. Adresses e-mail
  4. Pages Web

Pour chaque groupe, les URI s'affichent dans l'ordre dans lequel ils sont définis dans le tableau. Si vous avez besoin d'un ordre différent, remplacez le modèle par défaut.

Éléments et positions de la mise en page du modèle de liste par défaut
  1. class.localizedIssuerName
    ou class.issuerName
  2. class.localizedShortTitle
    ou class.shortTitle
    ou class.localizedTitle
    ou class.title
  3. class.titleImage
  4. class.hexBackgroundColor