Loyaltyobject

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "walletobjects#loyaltyObject",
  "id": string,
  "classId": string,
  "version": long,
  "state": string,
  "barcode": {
    "kind": "walletobjects#barcode",
    "type": string,
    "value": string,
    "alternateText": string
  },
  "messages": [
    {
      "kind": "walletobjects#walletObjectMessage",
      "header": string,
      "localizedHeader": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "body": string,
      "localizedBody": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "displayInterval": {
        "kind": "walletobjects#timeInterval",
        "start": {
          "date": string
        },
        "end": {
          "date": string
        }
      },
      "id": string,
      "messageType": string
    }
  ],
  "validTimeInterval": {
    "kind": "walletobjects#timeInterval",
    "start": {
      "date": string
    },
    "end": {
      "date": string
    }
  },
  "locations": [
    {
      "kind": "walletobjects#latLongPoint",
      "latitude": double,
      "longitude": double
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    "labelValueRows": [
      {
        "columns": [
          {
            "label": string,
            "localizedLabel": {
              "kind": "walletobjects#localizedString",
              "translatedValues": [
                {
                  "kind": "walletobjects#translatedString",
                  "language": string,
                  "value": string
                }
              ],
              "defaultValue": {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            },
            "value": string,
            "localizedValue": {
              "kind": "walletobjects#localizedString",
              "translatedValues": [
                {
                  "kind": "walletobjects#translatedString",
                  "language": string,
                  "value": string
                }
              ],
              "defaultValue": {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            }
          }
        ]
      }
    ],
    "showLastUpdateTime": boolean
  },
  "imageModulesData": [
    {
      "mainImage": {
        "kind": "walletobjects#image",
        "sourceUri": {
          "kind": "walletobjects#uri",
          "uri": string,
          "description": string,
          "localizedDescription": {
            "kind": "walletobjects#localizedString",
            "translatedValues": [
              {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            ],
            "defaultValue": {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          },
          "id": string
        }
      },
      "id": string
    }
  ],
  "textModulesData": [
    {
      "header": string,
      "body": string,
      "localizedHeader": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "localizedBody": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  ],
  "linksModuleData": {
    "uris": [
      {
        "kind": "walletobjects#uri",
        "uri": string,
        "description": string,
        "localizedDescription": {
          "kind": "walletobjects#localizedString",
          "translatedValues": [
            {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          ],
          "defaultValue": {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        },
        "id": string
      }
    ]
  },
  "classReference": loyaltyclass Resource,
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    "label": string,
    "localizedLabel": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "balance": {
      "string": string,
      "int": integer,
      "double": double,
      "money": {
        "kind": "walletobjects#money",
        "micros": long,
        "currencyCode": string
      }
    }
  },
  "secondaryLoyaltyPoints": {
    "label": string,
    "localizedLabel": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "balance": {
      "string": string,
      "int": integer,
      "double": double,
      "money": {
        "kind": "walletobjects#money",
        "micros": long,
        "currencyCode": string
      }
    }
  },
  "linkedOfferIds": [
    string
  ]
}
Property name Value Description Notes
accountId string The loyalty account identifier. Recommended maximum length is 20 characters. writable
accountName string The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
barcode nested object The barcode type and value. writable
barcode.alternateText string An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned. writable
barcode.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".
barcode.type string The type of barcode.

Acceptable values are:
  • "aztec"
  • "codabar"
  • "code128"
  • "code39"
  • "dataMatrix"
  • "ean13"
  • "ean8"
  • "itf14"
  • "pdf417"
  • "qrCode"
  • "textOnly"
  • "upcA"
  • "upcE"
writable
barcode.value string The value encoded in the barcode. writable
classId string The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved.

Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
writable
classReference nested object A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
disableExpirationNotification boolean Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false.

Currently, this can only be set for offers.
writable
hasLinkedDevice boolean Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
hasUsers boolean Indicates if the object has users. This field is set by the platform.
id string The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
imageModulesData[] list Image module data. If image modules data is also defined on the class, those will be merged with the image data defined on the object. The maximum number of these fields (combined with the class) is 1. writable
imageModulesData[].id string The ID associated with an image module. This field is here to enable ease of management of image modules.
imageModulesData[].mainImage nested object A 100% width image. writable
imageModulesData[].mainImage.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
imageModulesData[].mainImage.sourceUri nested object The URI for the image. writable
imageModulesData[].mainImage.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
imageModulesData[].mainImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
imageModulesData[].mainImage.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
imageModulesData[].mainImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
infoModuleData nested object Deprecated. Use textModulesData instead. writable
infoModuleData.labelValueRows[] list A list of collections of labels and values. These will be displayed one after the other in a singular column. writable
infoModuleData.labelValueRows[].columns[] list A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name. writable
infoModuleData.labelValueRows[].columns[].label string The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedLabel nested object Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.

writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue nested object Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].value string The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.showLastUpdateTime boolean Deprecated writable
kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyObject".
linkedOfferIds[] list A list of offer objects linked to this loyalty card. The offer objects must already exist.

Offer object IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
writable
linksModuleData nested object Links module data. If links module data is also defined on the class, both will be displayed. The maximum number of these fields (combined with the class) is 10. writable
linksModuleData.uris[] list The list of URIs. writable
linksModuleData.uris[].description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
linksModuleData.uris[].id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
linksModuleData.uris[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
linksModuleData.uris[].localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
linksModuleData.uris[].localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
linksModuleData.uris[].localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
linksModuleData.uris[].localizedDescription.translatedValues[] list Contains the translations for the string. writable
linksModuleData.uris[].localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
linksModuleData.uris[].localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
locations[] list The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID. writable
locations[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
locations[].latitude double The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected. writable
locations[].longitude double The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected. writable
loyaltyPoints nested object The loyalty reward points label, balance, and type. writable
loyaltyPoints.balance nested object The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of loyaltyPoints and secondaryLoyaltyPoints. writable
loyaltyPoints.balance.double double The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
loyaltyPoints.balance.int integer The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
loyaltyPoints.balance.money nested object The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
loyaltyPoints.balance.money.currencyCode string The currency code, such as "USD" or "EUR." writable
loyaltyPoints.balance.money.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#money".
loyaltyPoints.balance.money.micros long The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros. writable
loyaltyPoints.balance.string string The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
loyaltyPoints.label string The loyalty points label, such as "Points". Recommended maximum length is 9 characters. writable
loyaltyPoints.localizedLabel nested object Translated strings for the label. Recommended maximum length is 9 characters. writable
loyaltyPoints.localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
loyaltyPoints.localizedLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
loyaltyPoints.localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
loyaltyPoints.localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
loyaltyPoints.localizedLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
loyaltyPoints.localizedLabel.translatedValues[] list Contains the translations for the string. writable
loyaltyPoints.localizedLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
loyaltyPoints.localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
loyaltyPoints.localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[] list An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. writable
messages[].body string The message body. writable
messages[].displayInterval nested object The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided. writable
messages[].displayInterval.end nested object End time of the interval.

Offset is not required. If an offset is provided and start time is set, start must also include an offset.
writable
messages[].displayInterval.end.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].displayInterval.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#timeInterval".
messages[].displayInterval.start nested object Start time of the interval.

Offset is not required. If an offset is provided and end time is set, end must also include an offset.
writable
messages[].displayInterval.start.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].header string The message header. writable
messages[].id string The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. writable
messages[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
messages[].localizedBody nested object Translated strings for the message body. writable
messages[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedBody.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
messages[].localizedBody.translatedValues[] list Contains the translations for the string. writable
messages[].localizedBody.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader nested object Translated strings for the message header. writable
messages[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedHeader.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
messages[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
messages[].localizedHeader.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].messageType string The type of the message. Currently, this can only be set for offers.

Acceptable values are:
  • "expirationNotification": Notification to display for an offer expiration. The displayInterval.start.date sets the time the notification will appear. It can be set up to 30 days prior to the expiration date. If a time span greater than this is specified, then the notification will trigger at the 30 day mark.
  • "text": Renders the message as text on the card details screen. This is the default message type.
writable
secondaryLoyaltyPoints nested object The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. writable
secondaryLoyaltyPoints.balance nested object The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of loyaltyPoints and secondaryLoyaltyPoints. writable
secondaryLoyaltyPoints.balance.double double The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
secondaryLoyaltyPoints.balance.int integer The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
secondaryLoyaltyPoints.balance.money nested object The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
secondaryLoyaltyPoints.balance.money.currencyCode string The currency code, such as "USD" or "EUR." writable
secondaryLoyaltyPoints.balance.money.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#money".
secondaryLoyaltyPoints.balance.money.micros long The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros. writable
secondaryLoyaltyPoints.balance.string string The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated. writable
secondaryLoyaltyPoints.label string The loyalty points label, such as "Points". Recommended maximum length is 9 characters. writable
secondaryLoyaltyPoints.localizedLabel nested object Translated strings for the label. Recommended maximum length is 9 characters. writable
secondaryLoyaltyPoints.localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
secondaryLoyaltyPoints.localizedLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
secondaryLoyaltyPoints.localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
secondaryLoyaltyPoints.localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
secondaryLoyaltyPoints.localizedLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
secondaryLoyaltyPoints.localizedLabel.translatedValues[] list Contains the translations for the string. writable
secondaryLoyaltyPoints.localizedLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
secondaryLoyaltyPoints.localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
secondaryLoyaltyPoints.localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
smartTapRedemptionValue string Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
state string The state of the object. This field is used to determine how an object is displayed in the app.

Acceptable values are:
  • "active": Object is active and displayed to with other active objects.
  • "completed"
  • "expired": Object is no longer valid (validTimeInterval passed)
  • "inactive"
writable
textModulesData[] list Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields (combined with the class) is 10. writable
textModulesData[].body string The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].header string The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].id string The ID associated with a text module. This field is here to enable ease of management of text modules.
textModulesData[].localizedBody nested object Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedBody.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
textModulesData[].localizedBody.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedBody.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader nested object Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedHeader.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
textModulesData[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedHeader.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
validTimeInterval nested object The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed. writable
validTimeInterval.end nested object End time of the interval.

Offset is not required. If an offset is provided and start time is set, start must also include an offset.
writable
validTimeInterval.end.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
validTimeInterval.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#timeInterval".
validTimeInterval.start nested object Start time of the interval.

Offset is not required. If an offset is provided and end time is set, end must also include an offset.
writable
validTimeInterval.start.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
version long Deprecated

Methods

addmessage
Adds a message to the loyalty object referenced by the given object ID.
get
Returns the loyalty object with the given object ID.
insert
Inserts a loyalty object with the given ID and properties.
list
Returns a list of all loyalty objects for a given class ID.
modifylinkedofferobjects
Add (and remove) linked offer objects, specified by ID, to the loyalty object referenced by the resource ID.
patch
Updates the loyalty object referenced by the given object ID. This method supports patch semantics.
update
Updates the loyalty object referenced by the given object ID.

Envoyer des commentaires concernant…

Google Pay for Passes