/walletobjects/v1/offerClass

GET

offerclass

Returns a list of all offer classes for a given issuer ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://walletobjects.googleapis.com//walletobjects/v1/offerClass'

Response Example

{
  "pagination": {
    "kind": "string",
    "nextPageToken": "string",
    "resultsPerPage": 0
  },
  "resources": [
    {
      "allowMultipleUsersPerObject": true,
      "callbackOptions": {
        "updateRequestUrl": "string",
        "url": "string"
      },
      "classTemplateInfo": {
        "cardBarcodeSectionDetails": {
          "firstBottomDetail": {
            "fieldSelector": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            }
          },
          "firstTopDetail": {
            "fieldSelector": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            }
          },
          "secondTopDetail": {
            "fieldSelector": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            }
          }
        },
        "cardTemplateOverride": {
          "cardRowTemplateInfos": [
            {
              "oneItem": {
                "item": {
                  "firstValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  },
                  "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                  "secondValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  }
                }
              },
              "threeItems": {
                "endItem": {
                  "firstValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  },
                  "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                  "secondValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  }
                },
                "middleItem": {
                  "firstValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  },
                  "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                  "secondValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  }
                },
                "startItem": {
                  "firstValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  },
                  "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                  "secondValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  }
                }
              },
              "twoItems": {
                "endItem": {
                  "firstValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  },
                  "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                  "secondValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  }
                },
                "startItem": {
                  "firstValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  },
                  "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                  "secondValue": {
                    "fields": [
                      {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                      }
                    ]
                  }
                }
              }
            }
          ]
        },
        "detailsTemplateOverride": {
          "detailsItemInfos": [
            {
              "item": {
                "firstValue": {
                  "fields": [
                    {
                      "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                      "fieldPath": "string"
                    }
                  ]
                },
                "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                "secondValue": {
                  "fields": [
                    {
                      "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                      "fieldPath": "string"
                    }
                  ]
                }
              }
            }
          ]
        },
        "listTemplateOverride": {
          "firstRowOption": {
            "fieldOption": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            },
            "transitOption": "TRANSIT_OPTION_UNSPECIFIED"
          },
          "secondRowOption": {
            "fields": [
              {
                "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                "fieldPath": "string"
              }
            ]
          },
          "thirdRowOption": {
            "fields": [
              {
                "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                "fieldPath": "string"
              }
            ]
          }
        }
      },
      "countryCode": "string",
      "details": "string",
      "enableSmartTap": true,
      "finePrint": "string",
      "helpUri": {
        "description": "string",
        "id": "string",
        "kind": "string",
        "localizedDescription": {
          "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
          },
          "kind": "string",
          "translatedValues": [
            {
              "kind": "string",
              "language": "string",
              "value": "string"
            }
          ]
        },
        "uri": "string"
      },
      "heroImage": {
        "kind": "string",
        "sourceUri": {
          "description": "string",
          "localizedDescription": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "uri": "string"
        }
      },
      "hexBackgroundColor": "string",
      "homepageUri": {
        "description": "string",
        "id": "string",
        "kind": "string",
        "localizedDescription": {
          "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
          },
          "kind": "string",
          "translatedValues": [
            {
              "kind": "string",
              "language": "string",
              "value": "string"
            }
          ]
        },
        "uri": "string"
      },
      "id": "string",
      "imageModulesData": [
        {
          "id": "string",
          "mainImage": {
            "kind": "string",
            "sourceUri": {
              "description": "string",
              "localizedDescription": {
                "defaultValue": {
                  "kind": "string",
                  "language": "string",
                  "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                  {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                  }
                ]
              },
              "uri": "string"
            }
          }
        }
      ],
      "infoModuleData": {
        "labelValueRows": [
          {
            "columns": [
              {
                "label": "string",
                "localizedLabel": {
                  "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                  },
                  "kind": "string",
                  "translatedValues": [
                    {
                      "kind": "string",
                      "language": "string",
                      "value": "string"
                    }
                  ]
                },
                "localizedValue": {
                  "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                  },
                  "kind": "string",
                  "translatedValues": [
                    {
                      "kind": "string",
                      "language": "string",
                      "value": "string"
                    }
                  ]
                },
                "value": "string"
              }
            ]
          }
        ],
        "showLastUpdateTime": true
      },
      "issuerName": "string",
      "kind": "string",
      "linksModuleData": {
        "uris": [
          {
            "description": "string",
            "id": "string",
            "kind": "string",
            "localizedDescription": {
              "defaultValue": {
                "kind": "string",
                "language": "string",
                "value": "string"
              },
              "kind": "string",
              "translatedValues": [
                {
                  "kind": "string",
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "uri": "string"
          }
        ]
      },
      "localizedDetails": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedFinePrint": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedIssuerName": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedProvider": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedShortTitle": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedTitle": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "locations": [
        {
          "kind": "string",
          "latitude": 0,
          "longitude": 0
        }
      ],
      "messages": [
        {
          "body": "string",
          "displayInterval": {
            "end": {
              "date": "string"
            },
            "kind": "string",
            "start": {
              "date": "string"
            }
          },
          "header": "string",
          "id": "string",
          "kind": "string",
          "localizedBody": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "localizedHeader": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "messageType": "MESSAGE_TYPE_UNSPECIFIED"
        }
      ],
      "multipleDevicesAndHoldersAllowedStatus": "STATUS_UNSPECIFIED",
      "provider": "string",
      "redemptionChannel": "REDEMPTION_CHANNEL_UNSPECIFIED",
      "redemptionIssuers": [
        "string"
      ],
      "review": {
        "comments": "string"
      },
      "reviewStatus": "REVIEW_STATUS_UNSPECIFIED",
      "shortTitle": "string",
      "textModulesData": [
        {
          "body": "string",
          "header": "string",
          "id": "string",
          "localizedBody": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "localizedHeader": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          }
        }
      ],
      "title": "string",
      "titleImage": {
        "kind": "string",
        "sourceUri": {
          "description": "string",
          "localizedDescription": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "uri": "string"
        }
      },
      "version": "string",
      "wordMark": {
        "kind": "string",
        "sourceUri": {
          "description": "string",
          "localizedDescription": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "uri": "string"
        }
      }
    }
  ]
}

Request

Query Params

issuerId

string

optional

The ID of the issuer authorized to list classes.

maxResults

integer

optional

Identifies the max number of results returned by a list. All results are returned if maxResults isn't defined.

token

string

optional

Used to get the next set of results if maxResults is specified, but more than maxResults classes are available in a list. For example, if you have a list of 200 classes and you call list with maxResults set to 20, list will return the first 20 classes and a token. Call list again with maxResults set to 20 and the token to get the next 20 classes.

Responses

🟢200Successful response

application/json

Body

pagination

object (Pagination)

optional

Pagination of the response.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#pagination".

nextPageToken

string

optional

Page token to send to fetch the next page.

resultsPerPage

integer <int32>

optional

Number of results returned in this page.

resources

array[object (OfferClass) {37}]

optional

Resources corresponding to the list request.

allowMultipleUsersPerObject

boolean

optional

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

callbackOptions

object (CallbackOptions)

optional

Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.

classTemplateInfo

object (ClassTemplateInfo)

optional

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.

countryCode

string

optional

Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.

details

string

optional

The details of the offer.

enableSmartTap

boolean

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

finePrint

string

optional

The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel."

helpUri

object (Uri)

optional

The help link for the offer, such as http://myownpersonaldomain.com/help

heroImage

object (Image)

optional

Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.

hexBackgroundColor

string

optional

The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0.

homepageUri

object (Uri)

optional

The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).

string

optional

Required. The unique identifier for a class. This ID must be unique across all classes 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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

issuerName

string

optional

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#offerClass".

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the object, both will be displayed.

localizedDetails

object (LocalizedString)

optional

Translated strings for the details.

localizedFinePrint

object (LocalizedString)

optional

Translated strings for the fine_print.

localizedIssuerName

object (LocalizedString)

optional

Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

localizedProvider

object (LocalizedString)

optional

Translated strings for the provider. Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.

localizedShortTitle

object (LocalizedString)

optional

Translated strings for the short title. Recommended maximum length is 20 characters.

localizedTitle

object (LocalizedString)

optional

Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.

locations

array[object (LatLongPoint) {3}]

optional

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.

messages

array[object (Message) {8}]

optional

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.

multipleDevicesAndHoldersAllowedStatus

enum<string>

optional

Identifies whether multiple users and devices will save the same object referencing this class.

Allowed values:

STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice

provider

string

optional

Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.

redemptionChannel

enum<string>

optional

Required. The redemption channels applicable to this offer.

Allowed values:

REDEMPTION_CHANNEL_UNSPECIFIEDINSTOREinstoreONLINEonlineBOTHbothTEMPORARY_PRICE_REDUCTIONtemporaryPriceReduction

redemptionIssuers

array[string <int64>]

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

review

object (Review)

optional

The review comments set by the platform when a class is marked approved or rejected.

reviewStatus

enum<string>

optional

Required. The status of the class. This field can be set to draft or The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft. You should keep this field to draft when the class is under development. A draft class cannot be used to create any object. You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects. When updating an already approved class you should keep setting this field to underReview.

Allowed values:

REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft

shortTitle

string

optional

A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.

textModulesData

array[object (TextModuleData) {5}]

optional

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.

title

string

optional

Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.

titleImage

object (Image)

optional

The title image of the offer. This image is displayed in both the details and list views of the app.

version

string <int64>

optional

Deprecated

wordMark

object (Image)

optional

Deprecated.

/walletobjects/v1/loyaltyObject/{resourceId}/modifyLinkedOfferObjects

/walletobjects/v1/offerClass