Plantilla de tarjeta de regalo

Las tarjetas de regalo admiten la renderización de plantillas. Si no se define ninguna plantilla, se usa la predeterminada.

Definición de la plantilla

Una plantilla de pase se define a nivel de la clase y se usa para mostrar cualquier objeto asociado con ella. La plantilla define qué campos se mostrarán en las diferentes secciones del pase.

La plantilla se divide en las siguientes secciones:

Android

Descripción general de la plantilla

Web

Descripción general de la plantilla

Título de la tarjeta

Android

Elementos del título de la tarjeta Título de la tarjeta predeterminado
  1. class.programLogo
  2. class.localizedMerchantName
    o class.merchantName
    o class.localizedIssuerName
    o class.issuerName
  3. object.balance
  4. class.hexBackgroundColor

Título de la tarjeta con logotipo ancho
  1. class.wideProgramLogo
  2. object.balance
  3. class.hexBackgroundColor

Web

Elementos del título de la tarjeta Título de la tarjeta predeterminado
  1. class.programLogo
  2. class.localizedMerchantName
    o class.merchantName
    o class.localizedIssuerName
    o class.issuerName
  3. object.balance
  4. class.hexBackgroundColor

Título de la tarjeta con logotipo ancho
  1. class.wideProgramLogo
  2. object.balance
  3. class.hexBackgroundColor

En la sección del título de la tarjeta, se muestra el logotipo, el nombre del comercio y el saldo. No se pueden cambiar las referencias de campo que se usan para propagarlos ni su posición.

Cuando se configura el campo de logotipo ancho, en los dispositivos Android, el encabezado de plantilla predeterminado con el logotipo y el nombre del emisor se reemplaza por el logotipo ancho.

Sigue los lineamientos de imagen de logotipo ancho cuando crees el logotipo del encabezado ancho para mostrar tu imagen de forma óptima en tus pases.

Plantilla de tarjeta

Android

Descripción general de la plantilla

Web

Descripción general de la plantilla

La sección de plantilla de tarjeta se usa para mostrar filas adicionales. Estas filas pueden contener campos de datos estructurados basados en texto o campos de módulo de texto.

Puedes especificar la cantidad de filas que definen la cantidad de objetos en la lista class.classTemplateInfo.cardTemplateOverride.cardRowTemplateInfos[]. La lista requiere al menos un elemento y te recomendamos que uses como máximo dos elementos. Cada elemento debe ser de uno de los siguientes tipos:

  • oneItem, que acepta un elemento:
    • item
  • twoItems, que acepta dos elementos:
    • startItem
    • endItem
  • threeItems, que acepta tres elementos:
    • startItem
    • middleItem
    • endItem

Cada elemento se puede definir como un selector de campo único (.firstValue), dos selectores de campo (.firstValue y .secondValue) o un elemento predefinido (.predefinedItem). Se muestran los valores del campo seleccionado y sus etiquetas correspondientes. Cuando defines dos selectores de campo, los valores de los campos seleccionados se muestran con un separador “/”. Lo mismo ocurre con las etiquetas de los campos seleccionados. Los elementos predefinidos se usan para definir una renderización más compleja.

En la siguiente muestra de código, se muestra cómo anular las secciones de fila de la plantilla de tarjeta para especificar dos filas. Cada fila incluye tres elementos que hacen referencia a seis campos personalizados textModuleData a nivel de la clase y sus encabezados como etiquetas:

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

El código crea un pase con el siguiente formato de sección de plantilla de código:

Ejemplo de una anulación de etiqueta.

Si un elemento está vacío, no se mostrará. Para obtener más detalles, consulta Referencias de campos. Si todos los elementos de una fila están vacíos, esta no se mostrará. Si algunos, pero no todos, los elementos de una fila están vacíos, los elementos que no están vacíos se reorganizan y se muestran como una fila con menos elementos.

Si no anulas la plantilla de tarjeta, se usarán la cantidad predeterminada de filas, la cantidad predeterminada de elementos y las referencias de campo predeterminadas. Para obtener más detalles, consulta Plantilla predeterminada.

Después de definir una Imagen Hero, puede aparecer después de la primera fila, si hay varias filas en la lista cardRowTemplateInfos, o sobre la fila, si solo hay una.

Código de barras de la tarjeta

Android

Elementos del código de barras de la tarjeta
  1. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstTopDetail
  2. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .secondTopDetail
  3. object.barcode.type y object.barcode.value
    o object.cardNumber (CODE_128)
  4. object.cardNumber
    o object.barcode.alternateText
  5. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstBottomDetail
  6. object.heroImage
    o class.heroImage

Web

Elementos del código de barras de la tarjeta
  1. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstTopDetail
  2. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .secondTopDetail
  3. object.barcode.type y object.barcode.value
    o object.cardNumber (CODE_128)
  4. object.cardNumber
    o object.barcode.alternateText
  5. class.classTemplateInfo
      .cardBarcodeSectionDetails
      .firstBottomDetail

La sección del código de barras de la tarjeta se usa para mostrar texto o imágenes adicionales sobre y debajo del código de barras. Ninguno de los campos de esta sección es obligatorio.

Hay tres selectores de campo que se pueden usar para definir dos campos en paralelo, uno sobre el código de barras y otro debajo. Se muestran sin etiqueta y pueden ser campos de datos estructurados basados en texto, campos de módulos de texto o campos de módulos de imágenes. Si usas imágenes, estas deben cumplir con los lineamientos de desarrollo de la marca.

El código de barras se define mediante un tipo y un valor. Para obtener una lista de los tipos de códigos de barras compatibles, consulta Referencia. Además, se puede mostrar un texto debajo del código de barras. Este texto puede facilitar la lectura de códigos de barras, entre otros usos.

En la siguiente muestra de código, se muestra cómo anular la sección de código de barras de un pase para mostrar una imagen sobre él:

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

El código crea un pase con el siguiente formato de sección de código de barras:

Ejemplo de una anulación de código de barras de la tarjeta

Si no anulas la sección de códigos de barras, se usarán los campos de códigos de barras predeterminados. Para obtener más información, consulta Plantilla predeterminada.

Plantilla de detalles

Android

Secciones de la plantilla de detalles
  • 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

Secciones de la plantilla de detalles
  • 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 sección de la plantilla de detalles es una lista de elementos class.classTemplateInfo.detailsTemplateOverride.detailsItemInfos[]. Los elementos pueden contener cualquier tipo de campo de datos estructurados, campos de módulo de texto, campos de módulo de vínculo, campos de módulo de imagen o mensajes.

Cada elemento se puede definir como un selector de campo único (.firstValue), dos selectores de campo (.firstValue y .secondValue) o un elemento predefinido (.predefinedItem). Se muestran los valores del campo seleccionado y sus etiquetas correspondientes. Cuando defines dos selectores de campo, los valores de los campos seleccionados se muestran con un separador “/”. Lo mismo ocurre con las etiquetas de los campos seleccionados. Los elementos predefinidos se usan para definir una renderización más compleja. Los campos del módulo de imagen se renderizan en ancho completo sin una etiqueta.

En el siguiente ejemplo de código, se muestra cómo anular la sección de detalles del pase para mostrar un solo campo linksModuleData con su etiqueta:

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
    

El código crea un pase con el siguiente formato de sección de detalles:

Ejemplo de una anulación de detalle.

Si un elemento está vacío, no se mostrará. Para obtener más detalles, consulta Referencias de campos.

Si no anulas la plantilla de detalles, se mostrará la lista predeterminada de campos de referencia en el orden predeterminado. Para obtener más información, consulta Plantilla predeterminada.

Plantilla de lista

Elementos de la plantilla de lista
  1. class.classTemplateInfo.listTemplateOverride
      .firstRowOption.fieldOption.fields[]
  2. class.classTemplateInfo.listTemplateOverride
      .secondRowOption.fields[]
  3. class.programLogo
  4. class.hexBackgroundColor

La sección de plantilla de lista se usa para seleccionar qué campo mostrar en la vista "Pasos" de la app de la Billetera de Google. El pase se representa en la lista con el logotipo, el color de fondo y tres filas.

En la siguiente muestra de código, se muestra cómo anular la plantilla de lista de un pase para mostrar un campo de fecha de vencimiento de objeto de pase único en la primera fila de la plantilla de lista:

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
    

El código crea un pase con la siguiente renderización de plantilla de lista:

Ejemplo de una anulación de lista.

Las tres filas se pueden definir con un selector de campo. Los campos se muestran sin etiqueta.

Etiquetas

Todos los campos de datos estructurados tienen una etiqueta proporcionada por Google. Google es responsable de proporcionar una traducción para cada una de estas etiquetas en todos los idiomas admitidos.

Puedes personalizar algunas de estas etiquetas con uno de los campos class.custom<name_of_the_field>Label. Cuando personalizas una etiqueta, te conviertes en responsable de proporcionar traducciones para esa etiqueta específica en todos los idiomas que desees admitir.

Referencias de campos

Las referencias de campo se usan en diferentes partes de la plantilla con la forma class.classTemplateInfo.*.fields[]. Una referencia de campo contiene una lista de instrucciones de acceso a campos de datos estructurados, campos de módulos de texto, campos de módulos de vínculos, campos de módulos de imágenes o mensajes.

No todos los tipos de rutas de acceso están permitidos en cada referencia de campo. Por ejemplo, algunas referencias de campo solo permiten rutas de acceso a campos de datos estructurados basados en texto o campos de módulo de texto. Los campos estructurados basados en texto son campos de datos estructurados de tipo cadena, cadena localizada, fecha o dinero.

La lista se puede usar para implementar una lógica de resguardo. Esto significa que, si la primera ruta de la lista se resuelve en un campo vacío, se evalúa la siguiente ruta. La lógica de resguardo se orienta principalmente a los campos de datos estructurados basados en texto o a los campos de módulos de texto. No mezcles diferentes tipos de campos en la misma lista. Usa la lógica de resguardo con precaución y solo en situaciones específicas cuando esperes un patrón coherente de campos que existen en algunos objetos, pero no en otros. La mayoría de las veces, es más fácil crear clases separadas para casos de uso independientes.

Si todas las rutas de acceso de una lista de referencias de campo se resuelven en campos vacíos, no se muestra el elemento que usa la referencia de campo. Si deseas que el elemento que usa la referencia de campo siempre esté presente, asegúrate de que al menos una ruta no esté vacía. Te recomendamos que configures un campo con un carácter especial, como “-”, para representar un valor nulo, incluso si algunos campos permiten cadenas con solo un espacio.

Para hacer referencia a un campo contenido en una lista, puedes usar el índice del campo en la lista o, en la mayoría de los casos, puedes usar un ID de referencia. Los elementos de una lista a los que se puede hacer referencia por ID tienen un campo .id. Te recomendamos que uses un ID de referencia en lugar del índice del campo en la lista cuando esté disponible.

Este es un ejemplo de cómo hacer referencia a campos contenidos en una lista.

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

En este caso, el primer elemento de la sección de detalles del pase es la segunda imagen declarada en el objeto. Mientras tanto, el segundo elemento de la sección de detalles del pase es la primera imagen declarada en el objeto.

Plantilla predeterminada

Android

Elementos de plantilla predeterminados
  1. class.programLogo
  2. class.localizedMerchantName
    o class.merchantName
    o class.localizedIssuerName
    o class.issuerName
  3. TARJETA DE REGALO: object.balance
  4. object.barcode.type y object.barcode.value
    o object.cardNumber (CODE_128)
  5. object.cardNumber
    o object.barcode.alternateText
  6. object.heroImage
    o class.heroImage
  7. class.hexBackgroundColor
  8. ACTUALIZADA
  9. object.balanceUpdateTime
  10. PIN
    o class.localizedPinLabel
    o class.pinLabel
  11. object.pin
  12. NÚMERO DE EVENTO
    o class.localizedEventNumberLabel
    o class.eventNumberLabel
  13. object.eventNumber
  14. class.imageModulesData[0].mainImage
  15. object.imageModulesData[0].mainImage
  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

Web

Elementos de plantilla predeterminados
  1. class.programLogo
  2. class.localizedMerchantName
    o class.merchantName
    o class.localizedIssuerName
    o class.issuerName
  3. TARJETA DE REGALO: object.balance
  4. object.barcode.type y object.barcode.value
    o object.cardNumber (CODE_128)
  5. object.cardNumber
    o object.barcode.alternateText
  6. object.heroImage
    o class.heroImage
  7. class.hexBackgroundColor
  8. ACTUALIZADA
  9. object.balanceUpdateTime
  10. PIN
    o class.localizedPinLabel
    o class.pinLabel
  11. object.pin
  12. NÚMERO DE EVENTO
    o class.localizedEventNumberLabel
    o class.eventNumberLabel
  13. object.eventNumber
  14. class.imageModulesData[0].mainImage
  15. object.imageModulesData[0].mainImage
  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

En el caso de los campos de módulo de imagen, mostramos uno y solo un campo de módulo de imagen de la clase y uno y solo un campo de módulo de imagen del objeto. Si necesitas más de un campo de módulo de imagen en cualquiera de los niveles, anula la plantilla predeterminada.

En el caso de los campos de módulo de texto, solo mostramos un máximo de 20 campos de módulo de texto de la clase y 20 campos de módulo de texto del objeto. Los campos se muestran en el mismo orden en que se definen en el array. Si necesitas más de 20 campos de módulo de texto en cualquiera de los niveles, anula la plantilla predeterminada.

En el caso de los mensajes, solo mostramos un máximo de 20 mensajes de la clase y 20 mensajes del objeto. No garantizamos el orden de los mensajes. Si necesitas más de 20 mensajes en cualquiera de los niveles o una garantía para cualquier pedido, anula la plantilla predeterminada.

En el campo del módulo de vínculos, no hay límite para la cantidad de URIs que puedes definir. Los URIs se muestran agrupados en el siguiente orden para cada nivel (clase u objeto):

  1. Coordenadas del mapa
  2. Números de teléfono
  3. Direcciones de correo electrónico
  4. Páginas web

Para cada grupo, los URIs se muestran en el mismo orden en que se definen en el array. Si necesitas un orden diferente, anula la plantilla predeterminada.

Elementos predeterminados de la plantilla de lista
  1. class.localizedMerchantName
    o class.merchantName
    o class.localizedIssuerName
    o class.issuerName
  2. TARJETA DE REGALO: object.balance
  3. class.programLogo
  4. class.hexBackgroundColor