giftcardclass

Changed on

Updates the gift card class referenced by the given class ID. This method supports patch semantics.

patch/walletobjects/v1/giftCardClass/{resourceId}

Request

  • Base URL: https://walletobjects.googleapis.com
  • URL: https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass/{resourceId}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/wallet_object.issuer) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/wallet_object.issuer)

Path parameters

resourceIdstring 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 '-'.

Request body

allowBarcodeRedemptionboolean

Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.

allowMultipleUsersPerObjectboolean

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

cardNumberLabelstring

The label to display for the card number, such as "Card Number".

countryCodestring

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.

enableSmartTapboolean

Identifies whether this class supports Smart Tap. The redemptionIssuers and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.

eventNumberLabelstring

The label to display for event number, such as "Target Event #".

hexBackgroundColorstring

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.

idstring

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 '-'.

issuerNamestring

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

kindstring

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

merchantNamestring

Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.

multipleDevicesAndHoldersAllowedStatus'STATUS_UNSPECIFIED' | 'MULTIPLE_HOLDERS' | 'ONE_USER_ALL_DEVICES' | 'ONE_USER_ONE_DEVICE' | 'multipleHolders' | 'oneUserAllDevices' | 'oneUserOneDevice'

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

notifyPreference'NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED' | 'NOTIFY_ON_UPDATE'

Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.

pinLabelstring

The label to display for the PIN, such as "4-digit PIN".

redemptionIssuersstring[]

Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The enableSmartTap and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.

reviewStatus'REVIEW_STATUS_UNSPECIFIED' | 'UNDER_REVIEW' | 'underReview' | 'APPROVED' | 'approved' | 'REJECTED' | 'rejected' | 'DRAFT' | 'draft'

Required. 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.

versionstring int64

Deprecated

viewUnlockRequirement'VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED' | 'UNLOCK_NOT_REQUIRED' | 'UNLOCK_REQUIRED_TO_VIEW'

View Unlock Requirement options for the gift card.

Response

Successful response

Changes

  • a0fe7a8b8267Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status