Google Classes Admin
Lists the tenant's Google Wallet classes of one family, for the current environment.
The Google Wallet class family to read; each family is a separate collection at Google:
Loyalty (loyalty cards), GiftCard, Offer (coupons), EventTicket, Generic.
The classes; empty when the issuer has none of that family.
A Google Wallet class registered under the tenant's issuer.
Full Google class id, {issuerId}.{suffix}.
Google's review status of the class, passed through as Google reports it (for example UNDER_REVIEW, APPROVED, REJECTED, DRAFT); null when Google sends none.
The type query parameter is missing or unknown.
The caller is not authenticated.
The caller lacks the tenant.walletConfig:read scope.
Google Wallet is not configured for the tenant.
Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.
GET /api/{tenantId}/admin/wallet/google/classes HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "text",
"reviewStatus": null
}
]Reads one loyalty class and its discoverable program.
The class is returned even when it publishes no discoverable program; the program fields are then null. Any class of the issuer can be read, whatever its environment.
Full Google class id.
The class and its discoverable program.
A loyalty class and the discoverable program it publishes in the Google Wallet app.
Full Google class id, {issuerId}.{suffix}.
ISO 3166-1 alpha-2 country the program is offered in. Empty when Google has none on the class.
Program name in the class's default language; empty when unset.
Public URL of the program logo; null when the class has none.
Issuer name keyed by language code. A class with only a plain, unlocalized name returns it under en; null when there is no name at all.
Program name keyed by language code, with the same fallback to en as issuerName.
Page where an existing member signs in to link their account; null when not set.
Page where a new holder joins the program; null when not set.
Holder data Google shares with the sign-up page, as upper snake case Google shared data types (for example FIRST_NAME, EMAIL_OR_PHONE); null when none.
Publication state of the program (trusted testers only, live, or disabled), set by Google and passed through as Google reports it; null when Google has not set one.
The caller is not authenticated.
The caller lacks the tenant.walletConfig:read scope.
Google Wallet is not configured for the tenant, or Google has no loyalty class with this id.
Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.
GET /api/{tenantId}/admin/wallet/google/classes/loyalty/discoverable-program HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"classId": "text",
"countryCode": "text",
"programName": "text",
"programLogo": null,
"issuerName": null,
"localizedProgramName": null,
"signinUrl": null,
"signupUrl": null,
"signupSharedDatas": [
"text"
],
"state": null
}Creates the loyalty class carrying a discoverable program, or replaces the program on an existing one.
On an existing class, the fields this endpoint does not manage (colors, labels, tiers) are kept, except the class template, security animation, unlock requirement, notification preference and value-added modules, which are reset; the program's publication state is kept. A new class starts in the state Google assigns, trusted testers only; going live is done at Google, not here. Every call resubmits the class for Google's review (UNDER_REVIEW).
The discoverable program to publish on a loyalty class.
Full Google class id to create or update. Omitted, the class {issuerId}.loyalty-{countryCode}-discoveryprogram is used, with an environment suffix outside production.
ISO 3166-1 alpha-2 country the program is offered in. Required; an unknown code is refused with 400.
Program name, used only when localizedProgramName is empty.
Public URL of the program logo, fetched by Google. Required.
Program name keyed by language code; the first entry becomes the default language and the plain program name.
Page where an existing member signs in to link their account. Omitted, sign-in is removed from the program.
Page where a new holder joins the program. Omitted together with signupSharedDatas, sign-up is removed from the program.
Holder data Google shares with the sign-up page, as Google shared data types. Any casing is accepted (firstName, first-name and FIRST_NAME are equivalent); blanks, duplicates and SHARED_DATA_TYPE_UNSPECIFIED are dropped.
The class as Google stored it.
A loyalty class and the discoverable program it publishes in the Google Wallet app.
Full Google class id, {issuerId}.{suffix}.
ISO 3166-1 alpha-2 country the program is offered in. Empty when Google has none on the class.
Program name in the class's default language; empty when unset.
Public URL of the program logo; null when the class has none.
Issuer name keyed by language code. A class with only a plain, unlocalized name returns it under en; null when there is no name at all.
Program name keyed by language code, with the same fallback to en as issuerName.
Page where an existing member signs in to link their account; null when not set.
Page where a new holder joins the program; null when not set.
Holder data Google shares with the sign-up page, as upper snake case Google shared data types (for example FIRST_NAME, EMAIL_OR_PHONE); null when none.
Publication state of the program (trusted testers only, live, or disabled), set by Google and passed through as Google reports it; null when Google has not set one.
A required field is missing, or Google Wallet refuses a value (for example the country code or the logo URL).
The caller is not authenticated.
The caller lacks the tenant.walletConfig:write scope.
Google Wallet is not configured for the tenant.
Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.
PUT /api/{tenantId}/admin/wallet/google/classes/loyalty/discoverable-program HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 216
{
"classId": null,
"countryCode": "text",
"programName": null,
"programLogo": "text",
"issuerName": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"localizedProgramName": null,
"signinUrl": null,
"signupUrl": null,
"signupSharedDatas": [
"text"
]
}{
"classId": "text",
"countryCode": "text",
"programName": "text",
"programLogo": null,
"issuerName": null,
"localizedProgramName": null,
"signinUrl": null,
"signupUrl": null,
"signupSharedDatas": [
"text"
],
"state": null
}Lists the loyalty classes of the current environment that publish a discoverable program.
The discoverable programs; empty when none is configured.
A loyalty class and the discoverable program it publishes in the Google Wallet app.
Full Google class id, {issuerId}.{suffix}.
ISO 3166-1 alpha-2 country the program is offered in. Empty when Google has none on the class.
Program name in the class's default language; empty when unset.
Public URL of the program logo; null when the class has none.
Issuer name keyed by language code. A class with only a plain, unlocalized name returns it under en; null when there is no name at all.
Program name keyed by language code, with the same fallback to en as issuerName.
Page where an existing member signs in to link their account; null when not set.
Page where a new holder joins the program; null when not set.
Holder data Google shares with the sign-up page, as upper snake case Google shared data types (for example FIRST_NAME, EMAIL_OR_PHONE); null when none.
Publication state of the program (trusted testers only, live, or disabled), set by Google and passed through as Google reports it; null when Google has not set one.
The caller is not authenticated.
The caller lacks the tenant.walletConfig:read scope.
Google Wallet is not configured for the tenant.
Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.
GET /api/{tenantId}/admin/wallet/google/classes/loyalty/discoverable-programs HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"classId": "text",
"countryCode": "text",
"programName": "text",
"programLogo": null,
"issuerName": null,
"localizedProgramName": null,
"signinUrl": null,
"signupUrl": null,
"signupSharedDatas": [
"text"
],
"state": null
}
]Counts the Google Wallet passes (objects) issued on a class.
Counts every object on the class, saved by a holder or not; slow on large classes. The count can lag recent changes by a few minutes.
Full Google class id, as returned by the list endpoint.
The Google Wallet class family to read; each family is a separate collection at Google:
Loyalty (loyalty cards), GiftCard, Offer (coupons), EventTicket, Generic.
The number of objects on the class.
The type query parameter is missing or unknown.
The caller is not authenticated.
The caller lacks the tenant.walletConfig:read scope.
Google Wallet is not configured for the tenant.
Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after Retry-After.
GET /api/{tenantId}/admin/wallet/google/classes/pass-count HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
1Last updated