mirror of
https://github.com/google-wallet/rest-samples.git
synced 2026-01-10 05:57:53 -05:00
957f0419c0
* Added examples for the following * Update a class/object * Patch a class/object * Add a message to a class/object * Expire an object * Create a JWT with new classes/objects * Create a JWT with existing classes/objects * Fixed various minor formatting issues * Made function/method names more general (ease of replication across different languages) * Added checks for class/object presence * Clarified some docstrings and comments
926 lines
32 KiB
Python
926 lines
32 KiB
Python
#
|
|
# Copyright 2022 Google Inc. All rights reserved.
|
|
#
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
# use this file except in compliance with the License. You may obtain a copy of
|
|
# the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations under
|
|
# the License.
|
|
#
|
|
|
|
# [START setup]
|
|
# [START imports]
|
|
import json
|
|
import os
|
|
import uuid
|
|
|
|
from google.auth.transport.requests import AuthorizedSession
|
|
from google.oauth2.service_account import Credentials
|
|
from google.auth import jwt, crypt
|
|
# [END imports]
|
|
|
|
|
|
class DemoTransit:
|
|
"""Demo class for creating and managing Transit passes in Google Wallet.
|
|
|
|
Attributes:
|
|
key_file_path: Path to service account key file from Google Cloud
|
|
Console. Environment variable: GOOGLE_APPLICATION_CREDENTIALS.
|
|
base_url: Base URL for Google Wallet API requests.
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.key_file_path = os.environ.get('GOOGLE_APPLICATION_CREDENTIALS',
|
|
'/path/to/key.json')
|
|
self.base_url = 'https://walletobjects.googleapis.com/walletobjects/v1'
|
|
self.batch_url = 'https://walletobjects.googleapis.com/batch'
|
|
self.class_url = f'{self.base_url}/transitClass'
|
|
self.object_url = f'{self.base_url}/transitObject'
|
|
|
|
# Set up authenticated client
|
|
self.auth()
|
|
|
|
# [END setup]
|
|
|
|
# [START auth]
|
|
def auth(self):
|
|
"""Create authenticated HTTP client using a service account file."""
|
|
self.credentials = Credentials.from_service_account_file(
|
|
self.key_file_path,
|
|
scopes=['https://www.googleapis.com/auth/wallet_object.issuer'])
|
|
|
|
self.http_client = AuthorizedSession(self.credentials)
|
|
|
|
# [END auth]
|
|
|
|
# [START createClass]
|
|
def create_class(self, issuer_id: str, class_suffix: str) -> str:
|
|
"""Create a class.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
class_suffix (str): Developer-defined unique ID for this pass class.
|
|
|
|
Returns:
|
|
The pass class ID: f"{issuer_id}.{class_suffix}"
|
|
"""
|
|
|
|
# Check if the class exists
|
|
response = self.http_client.get(
|
|
url=f'{self.class_url}/{issuer_id}.{class_suffix}')
|
|
|
|
if response.status_code == 200:
|
|
print(f'Class {issuer_id}.{class_suffix} already exists!')
|
|
return f'{issuer_id}.{class_suffix}'
|
|
elif response.status_code != 404:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{class_suffix}'
|
|
|
|
# See link below for more information on required properties
|
|
# https://developers.google.com/wallet/tickets/transit-passes/qr-code/rest/v1/transitclass
|
|
new_class = {
|
|
'id': f'{issuer_id}.{class_suffix}',
|
|
'issuerName': 'Issuer name',
|
|
'reviewStatus': 'UNDER_REVIEW',
|
|
'logo': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'https://live.staticflickr.com/65535/48690277162_cd05f03f4d_o.png'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Logo description'
|
|
}
|
|
}
|
|
},
|
|
'transitType': 'BUS'
|
|
}
|
|
|
|
response = self.http_client.post(url=self.class_url, json=new_class)
|
|
|
|
print('Class insert response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END createClass]
|
|
|
|
# [START updateClass]
|
|
def update_class(self, issuer_id: str, class_suffix: str) -> str:
|
|
"""Update a class.
|
|
|
|
**Warning:** This replaces all existing class attributes!
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
class_suffix (str): Developer-defined unique ID for this pass class.
|
|
|
|
Returns:
|
|
The pass class ID: f"{issuer_id}.{class_suffix}"
|
|
"""
|
|
|
|
# Check if the class exists
|
|
response = self.http_client.get(
|
|
url=f'{self.class_url}/{issuer_id}.{class_suffix}')
|
|
|
|
if response.status_code == 404:
|
|
print(f'Class {issuer_id}.{class_suffix} not found!')
|
|
return f'{issuer_id}.{class_suffix}'
|
|
elif response.status_code != 200:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{class_suffix}'
|
|
|
|
# Class exists
|
|
updated_class = response.json()
|
|
|
|
# Update the class by adding a homepage
|
|
updated_class['homepageUri'] = {
|
|
'uri': 'https://developers.google.com/wallet',
|
|
'description': 'Homepage description'
|
|
}
|
|
|
|
# Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
|
|
updated_class['reviewStatus'] = 'UNDER_REVIEW'
|
|
|
|
response = self.http_client.put(
|
|
url=f'{self.class_url}/{issuer_id}.{class_suffix}',
|
|
json=updated_class)
|
|
|
|
print('Class update response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END updateClass]
|
|
|
|
# [START patchClass]
|
|
def patch_class(self, issuer_id: str, class_suffix: str) -> str:
|
|
"""Patch a class.
|
|
|
|
The PATCH method supports patch semantics.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
class_suffix (str): Developer-defined unique ID for this pass class.
|
|
|
|
Returns:
|
|
The pass class ID: f"{issuer_id}.{class_suffix}"
|
|
"""
|
|
|
|
# Check if the class exists
|
|
response = self.http_client.get(
|
|
url=f'{self.class_url}/{issuer_id}.{class_suffix}')
|
|
|
|
if response.status_code == 404:
|
|
print(f'Class {issuer_id}.{class_suffix} not found!')
|
|
return f'{issuer_id}.{class_suffix}'
|
|
elif response.status_code != 200:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{class_suffix}'
|
|
|
|
# Patch the class by adding a homepage
|
|
patch_body = {
|
|
'homepageUri': {
|
|
'uri': 'https://developers.google.com/wallet',
|
|
'description': 'Homepage description'
|
|
},
|
|
|
|
# Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for patches
|
|
'reviewStatus': 'UNDER_REVIEW'
|
|
}
|
|
|
|
response = self.http_client.patch(
|
|
url=f'{self.class_url}/{issuer_id}.{class_suffix}', json=patch_body)
|
|
|
|
print('Class patch response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END patchClass]
|
|
|
|
# [START addMessageClass]
|
|
def add_class_message(self, issuer_id: str, class_suffix: str, header: str,
|
|
body: str) -> str:
|
|
"""Add a message to a pass class.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
class_suffix (str): Developer-defined unique ID for this pass class.
|
|
header (str): The message header.
|
|
body (str): The message body.
|
|
|
|
Returns:
|
|
The pass class ID: f"{issuer_id}.{class_suffix}"
|
|
"""
|
|
|
|
# Check if the class exists
|
|
response = self.http_client.get(
|
|
url=f'{self.class_url}/{issuer_id}.{class_suffix}')
|
|
|
|
if response.status_code == 404:
|
|
print(f'Class {issuer_id}.{class_suffix} not found!')
|
|
return f'{issuer_id}.{class_suffix}'
|
|
elif response.status_code != 200:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{class_suffix}'
|
|
|
|
response = self.http_client.post(
|
|
url=f'{self.class_url}/{issuer_id}.{class_suffix}/addMessage',
|
|
json={'message': {
|
|
'header': header,
|
|
'body': body
|
|
}})
|
|
|
|
print('Class addMessage response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END addMessageClass]
|
|
|
|
# [START createObject]
|
|
def create_object(self, issuer_id: str, class_suffix: str,
|
|
object_suffix: str) -> str:
|
|
"""Create an object.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
class_suffix (str): Developer-defined unique ID for the pass class.
|
|
object_suffix (str): Developer-defined unique ID for the pass object.
|
|
|
|
Returns:
|
|
The pass object ID: f"{issuer_id}.{object_suffix}"
|
|
"""
|
|
|
|
# Check if the object exists
|
|
response = self.http_client.get(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}')
|
|
|
|
if response.status_code == 200:
|
|
print(f'Object {issuer_id}.{object_suffix} already exists!')
|
|
print(response.text)
|
|
return f'{issuer_id}.{object_suffix}'
|
|
elif response.status_code != 404:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{object_suffix}'
|
|
|
|
# See link below for more information on required properties
|
|
# https://developers.google.com/wallet/tickets/transit-passes/qr-code/rest/v1/transitobject
|
|
new_object = {
|
|
'id': f'{issuer_id}.{object_suffix}',
|
|
'classId': f'{issuer_id}.{class_suffix}',
|
|
'state': 'ACTIVE',
|
|
'heroImage': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'https://farm4.staticflickr.com/3723/11177041115_6e6a3b6f49_o.jpg'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Hero image description'
|
|
}
|
|
}
|
|
},
|
|
'textModulesData': [{
|
|
'header': 'Text module header',
|
|
'body': 'Text module body',
|
|
'id': 'TEXT_MODULE_ID'
|
|
}],
|
|
'linksModuleData': {
|
|
'uris': [{
|
|
'uri': 'http://maps.google.com/',
|
|
'description': 'Link module URI description',
|
|
'id': 'LINK_MODULE_URI_ID'
|
|
}, {
|
|
'uri': 'tel:6505555555',
|
|
'description': 'Link module tel description',
|
|
'id': 'LINK_MODULE_TEL_ID'
|
|
}]
|
|
},
|
|
'imageModulesData': [{
|
|
'mainImage': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'http://farm4.staticflickr.com/3738/12440799783_3dc3c20606_b.jpg'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Image module description'
|
|
}
|
|
}
|
|
},
|
|
'id': 'IMAGE_MODULE_ID'
|
|
}],
|
|
'barcode': {
|
|
'type': 'QR_CODE',
|
|
'value': 'QR code'
|
|
},
|
|
'locations': [{
|
|
'latitude': 37.424015499999996,
|
|
'longitude': -122.09259560000001
|
|
}],
|
|
'passengerType': 'SINGLE_PASSENGER',
|
|
'passengerNames': 'Passenger names',
|
|
'tripType': 'ONE_WAY',
|
|
'ticketLeg': {
|
|
'originStationCode': 'LA',
|
|
'originName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Origin name'
|
|
}
|
|
},
|
|
'destinationStationCode': 'SFO',
|
|
'destinationName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Destination name'
|
|
}
|
|
},
|
|
'departureDateTime': '2020-04-12T16:20:50.52Z',
|
|
'arrivalDateTime': '2020-04-12T20:20:50.52Z',
|
|
'fareName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Fare name'
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
# Create the object
|
|
response = self.http_client.post(url=self.object_url, json=new_object)
|
|
|
|
print('Object insert response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END createObject]
|
|
|
|
# [START updateObject]
|
|
def update_object(self, issuer_id: str, object_suffix: str) -> str:
|
|
"""Update an object.
|
|
|
|
**Warning:** This replaces all existing object attributes!
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
object_suffix (str): Developer-defined unique ID for the pass object.
|
|
|
|
Returns:
|
|
The pass object ID: f"{issuer_id}.{object_suffix}"
|
|
"""
|
|
|
|
# Check if the object exists
|
|
response = self.http_client.get(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}')
|
|
|
|
if response.status_code == 404:
|
|
print(f'Object {issuer_id}.{object_suffix} not found!')
|
|
return f'{issuer_id}.{object_suffix}'
|
|
elif response.status_code != 200:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{object_suffix}'
|
|
|
|
# Object exists
|
|
updated_object = response.json()
|
|
|
|
# Update the object by adding a link
|
|
new_link = {
|
|
'uri': 'https://developers.google.com/wallet',
|
|
'description': 'New link description'
|
|
}
|
|
if not updated_object.get('linksModuleData'):
|
|
updated_object['linksModuleData'] = {'uris': []}
|
|
updated_object['linksModuleData']['uris'].append(new_link)
|
|
|
|
response = self.http_client.put(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}',
|
|
json=updated_object)
|
|
|
|
print('Object update response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END updateObject]
|
|
|
|
# [START patchObject]
|
|
def patch_object(self, issuer_id: str, object_suffix: str) -> str:
|
|
"""Patch an object.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
object_suffix (str): Developer-defined unique ID for the pass object.
|
|
|
|
Returns:
|
|
The pass object ID: f"{issuer_id}.{object_suffix}"
|
|
"""
|
|
|
|
# Check if the object exists
|
|
response = self.http_client.get(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}')
|
|
|
|
if response.status_code == 404:
|
|
print(f'Object {issuer_id}.{object_suffix} not found!')
|
|
return f'{issuer_id}.{object_suffix}'
|
|
elif response.status_code != 200:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{object_suffix}'
|
|
|
|
# Object exists
|
|
existing_object = response.json()
|
|
|
|
# Patch the object by adding a link
|
|
patch_body = {}
|
|
new_link = {
|
|
'uri': 'https://developers.google.com/wallet',
|
|
'description': 'New link description'
|
|
}
|
|
|
|
if existing_object.get('linksModuleData'):
|
|
patch_body['linksModuleData'] = existing_object['linksModuleData']
|
|
else:
|
|
patch_body['linksModuleData'] = {'uris': []}
|
|
patch_body['linksModuleData']['uris'].append(new_link)
|
|
|
|
response = self.http_client.patch(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}',
|
|
json=patch_body)
|
|
|
|
print('Object patch response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END patchObject]
|
|
|
|
# [START expireObject]
|
|
def expire_object(self, issuer_id: str, object_suffix: str) -> str:
|
|
"""Expire an object.
|
|
|
|
Sets the object's state to Expired. If the valid time interval is
|
|
already set, the pass will expire automatically up to 24 hours after.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
object_suffix (str): Developer-defined unique ID for the pass object.
|
|
|
|
Returns:
|
|
The pass object ID: f"{issuer_id}.{object_suffix}"
|
|
"""
|
|
|
|
# Check if the object exists
|
|
response = self.http_client.get(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}')
|
|
|
|
if response.status_code == 404:
|
|
print(f'Object {issuer_id}.{object_suffix} not found!')
|
|
return f'{issuer_id}.{object_suffix}'
|
|
elif response.status_code != 200:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{object_suffix}'
|
|
|
|
# Patch the object, setting the pass as expired
|
|
patch_body = {'state': 'EXPIRED'}
|
|
|
|
response = self.http_client.patch(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}',
|
|
json=patch_body)
|
|
|
|
print('Object expiration response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END expireObject]
|
|
|
|
# [START addMessageObject]
|
|
def add_object_message(self, issuer_id: str, object_suffix: str,
|
|
header: str, body: str) -> str:
|
|
"""Add a message to a pass object.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
object_suffix (str): Developer-defined unique ID for this pass object.
|
|
header (str): The message header.
|
|
body (str): The message body.
|
|
|
|
Returns:
|
|
The pass class ID: f"{issuer_id}.{class_suffix}"
|
|
"""
|
|
|
|
# Check if the object exists
|
|
response = self.http_client.get(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}')
|
|
|
|
if response.status_code == 404:
|
|
print(f'Object {issuer_id}.{object_suffix} not found!')
|
|
return f'{issuer_id}.{object_suffix}'
|
|
elif response.status_code != 200:
|
|
# Something else went wrong...
|
|
print(response.text)
|
|
return f'{issuer_id}.{object_suffix}'
|
|
|
|
response = self.http_client.post(
|
|
url=f'{self.object_url}/{issuer_id}.{object_suffix}/addMessage',
|
|
json={'message': {
|
|
'header': header,
|
|
'body': body
|
|
}})
|
|
|
|
print('Object addMessage response')
|
|
print(response.text)
|
|
|
|
return response.json().get('id')
|
|
|
|
# [END addMessageObject]
|
|
|
|
# [START jwtNew]
|
|
def create_jwt_new_objects(self, issuer_id: str, class_suffix: str,
|
|
object_suffix: str) -> str:
|
|
"""Generate a signed JWT that creates a new pass class and object.
|
|
|
|
When the user opens the "Add to Google Wallet" URL and saves the pass to
|
|
their wallet, the pass class and object defined in the JWT are
|
|
created. This allows you to create multiple pass classes and objects in
|
|
one API call when the user saves the pass to their wallet.
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
class_suffix (str): Developer-defined unique ID for the pass class.
|
|
object_suffix (str): Developer-defined unique ID for the pass object.
|
|
|
|
Returns:
|
|
An "Add to Google Wallet" link.
|
|
"""
|
|
|
|
# See link below for more information on required properties
|
|
# https://developers.google.com/wallet/tickets/transit-passes/qr-code/rest/v1/transitclass
|
|
new_class = {
|
|
'id': f'{issuer_id}.{class_suffix}',
|
|
'issuerName': 'Issuer name',
|
|
'reviewStatus': 'UNDER_REVIEW',
|
|
'logo': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'https://live.staticflickr.com/65535/48690277162_cd05f03f4d_o.png'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Logo description'
|
|
}
|
|
}
|
|
},
|
|
'transitType': 'BUS'
|
|
}
|
|
|
|
# See link below for more information on required properties
|
|
# https://developers.google.com/wallet/tickets/transit-passes/qr-code/rest/v1/transitobject
|
|
new_object = {
|
|
'id': f'{issuer_id}.{object_suffix}',
|
|
'classId': f'{issuer_id}.{class_suffix}',
|
|
'state': 'ACTIVE',
|
|
'heroImage': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'https://farm4.staticflickr.com/3723/11177041115_6e6a3b6f49_o.jpg'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Hero image description'
|
|
}
|
|
}
|
|
},
|
|
'textModulesData': [{
|
|
'header': 'Text module header',
|
|
'body': 'Text module body',
|
|
'id': 'TEXT_MODULE_ID'
|
|
}],
|
|
'linksModuleData': {
|
|
'uris': [{
|
|
'uri': 'http://maps.google.com/',
|
|
'description': 'Link module URI description',
|
|
'id': 'LINK_MODULE_URI_ID'
|
|
}, {
|
|
'uri': 'tel:6505555555',
|
|
'description': 'Link module tel description',
|
|
'id': 'LINK_MODULE_TEL_ID'
|
|
}]
|
|
},
|
|
'imageModulesData': [{
|
|
'mainImage': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'http://farm4.staticflickr.com/3738/12440799783_3dc3c20606_b.jpg'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Image module description'
|
|
}
|
|
}
|
|
},
|
|
'id': 'IMAGE_MODULE_ID'
|
|
}],
|
|
'barcode': {
|
|
'type': 'QR_CODE',
|
|
'value': 'QR code'
|
|
},
|
|
'locations': [{
|
|
'latitude': 37.424015499999996,
|
|
'longitude': -122.09259560000001
|
|
}],
|
|
'passengerType': 'SINGLE_PASSENGER',
|
|
'passengerNames': 'Passenger names',
|
|
'tripType': 'ONE_WAY',
|
|
'ticketLeg': {
|
|
'originStationCode': 'LA',
|
|
'originName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Origin name'
|
|
}
|
|
},
|
|
'destinationStationCode': 'SFO',
|
|
'destinationName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Destination name'
|
|
}
|
|
},
|
|
'departureDateTime': '2020-04-12T16:20:50.52Z',
|
|
'arrivalDateTime': '2020-04-12T20:20:50.52Z',
|
|
'fareName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Fare name'
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
# Create the JWT claims
|
|
claims = {
|
|
'iss': self.credentials.service_account_email,
|
|
'aud': 'google',
|
|
'origins': ['www.example.com'],
|
|
'typ': 'savetowallet',
|
|
'payload': {
|
|
# The listed classes and objects will be created
|
|
'transitClasses': [new_class],
|
|
'transitObjects': [new_object]
|
|
},
|
|
}
|
|
|
|
# The service account credentials are used to sign the JWT
|
|
signer = crypt.RSASigner.from_service_account_file(self.key_file_path)
|
|
token = jwt.encode(signer, claims).decode('utf-8')
|
|
|
|
print('Add to Google Wallet link')
|
|
print(f'https://pay.google.com/gp/v/save/{token}')
|
|
|
|
return f'https://pay.google.com/gp/v/save/{token}'
|
|
|
|
# [END jwtNew]
|
|
|
|
# [START jwtExisting]
|
|
def create_jwt_existing_objects(self, issuer_id: str) -> str:
|
|
"""Generate a signed JWT that references an existing pass object.
|
|
|
|
When the user opens the "Add to Google Wallet" URL and saves the pass to
|
|
their wallet, the pass objects defined in the JWT are added to the
|
|
user's Google Wallet app. This allows the user to save multiple pass
|
|
objects in one API call.
|
|
|
|
The objects to add must follow the below format:
|
|
|
|
{
|
|
'id': 'ISSUER_ID.OBJECT_SUFFIX',
|
|
'classId': 'ISSUER_ID.CLASS_SUFFIX'
|
|
}
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
|
|
Returns:
|
|
An "Add to Google Wallet" link
|
|
"""
|
|
|
|
# Multiple pass types can be added at the same time
|
|
# At least one type must be specified in the JWT claims
|
|
# Note: Make sure to replace the placeholder class and object suffixes
|
|
objects_to_add = {
|
|
# Event tickets
|
|
'eventTicketObjects': [{
|
|
'id': f'{issuer_id}.EVENT_OBJECT_SUFFIX',
|
|
'classId': f'{issuer_id}.EVENT_CLASS_SUFFIX'
|
|
}],
|
|
|
|
# Boarding passes
|
|
'flightObjects': [{
|
|
'id': f'{issuer_id}.FLIGHT_OBJECT_SUFFIX',
|
|
'classId': f'{issuer_id}.FLIGHT_CLASS_SUFFIX'
|
|
}],
|
|
|
|
# Generic passes
|
|
'genericObjects': [{
|
|
'id': f'{issuer_id}.GENERIC_OBJECT_SUFFIX',
|
|
'classId': f'{issuer_id}.GENERIC_CLASS_SUFFIX'
|
|
}],
|
|
|
|
# Gift cards
|
|
'giftCardObjects': [{
|
|
'id': f'{issuer_id}.GIFT_CARD_OBJECT_SUFFIX',
|
|
'classId': f'{issuer_id}.GIFT_CARD_CLASS_SUFFIX'
|
|
}],
|
|
|
|
# Loyalty cards
|
|
'loyaltyObjects': [{
|
|
'id': f'{issuer_id}.LOYALTY_OBJECT_SUFFIX',
|
|
'classId': f'{issuer_id}.LOYALTY_CLASS_SUFFIX'
|
|
}],
|
|
|
|
# Offers
|
|
'offerObjects': [{
|
|
'id': f'{issuer_id}.OFFER_OBJECT_SUFFIX',
|
|
'classId': f'{issuer_id}.OFFER_CLASS_SUFFIX'
|
|
}],
|
|
|
|
# Transit passes
|
|
'transitObjects': [{
|
|
'id': f'{issuer_id}.TRANSIT_OBJECT_SUFFIX',
|
|
'classId': f'{issuer_id}.TRANSIT_CLASS_SUFFIX'
|
|
}]
|
|
}
|
|
|
|
# Create the JWT claims
|
|
claims = {
|
|
'iss': self.credentials.service_account_email,
|
|
'aud': 'google',
|
|
'origins': ['www.example.com'],
|
|
'typ': 'savetowallet',
|
|
'payload': objects_to_add
|
|
}
|
|
|
|
# The service account credentials are used to sign the JWT
|
|
signer = crypt.RSASigner.from_service_account_file(self.key_file_path)
|
|
token = jwt.encode(signer, claims).decode('utf-8')
|
|
|
|
print('Add to Google Wallet link')
|
|
print(f'https://pay.google.com/gp/v/save/{token}')
|
|
|
|
return f'https://pay.google.com/gp/v/save/{token}'
|
|
|
|
# [END jwtExisting]
|
|
|
|
# [START batch]
|
|
def batch_create_objects(self, issuer_id: str, class_suffix: str):
|
|
"""Batch create Google Wallet objects from an existing class.
|
|
|
|
The request body will be a multiline string. See below for information.
|
|
|
|
https://cloud.google.com/compute/docs/api/how-tos/batch#example
|
|
|
|
Args:
|
|
issuer_id (str): The issuer ID being used for this request.
|
|
class_suffix (str): Developer-defined unique ID for this pass class.
|
|
"""
|
|
data = ''
|
|
|
|
# Example: Generate three new pass objects
|
|
for _ in range(3):
|
|
# Generate a random object suffix
|
|
object_suffix = str(uuid.uuid4()).replace('[^\\w.-]', '_')
|
|
|
|
# See link below for more information on required properties
|
|
# https://developers.google.com/wallet/tickets/transit-passes/qr-code/rest/v1/transitobject
|
|
batch_object = {
|
|
'id': f'{issuer_id}.{object_suffix}',
|
|
'classId': f'{issuer_id}.{class_suffix}',
|
|
'state': 'ACTIVE',
|
|
'heroImage': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'https://farm4.staticflickr.com/3723/11177041115_6e6a3b6f49_o.jpg'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Hero image description'
|
|
}
|
|
}
|
|
},
|
|
'textModulesData': [{
|
|
'header': 'Text module header',
|
|
'body': 'Text module body',
|
|
'id': 'TEXT_MODULE_ID'
|
|
}],
|
|
'linksModuleData': {
|
|
'uris': [{
|
|
'uri': 'http://maps.google.com/',
|
|
'description': 'Link module URI description',
|
|
'id': 'LINK_MODULE_URI_ID'
|
|
}, {
|
|
'uri': 'tel:6505555555',
|
|
'description': 'Link module tel description',
|
|
'id': 'LINK_MODULE_TEL_ID'
|
|
}]
|
|
},
|
|
'imageModulesData': [{
|
|
'mainImage': {
|
|
'sourceUri': {
|
|
'uri':
|
|
'http://farm4.staticflickr.com/3738/12440799783_3dc3c20606_b.jpg'
|
|
},
|
|
'contentDescription': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Image module description'
|
|
}
|
|
}
|
|
},
|
|
'id': 'IMAGE_MODULE_ID'
|
|
}],
|
|
'barcode': {
|
|
'type': 'QR_CODE',
|
|
'value': 'QR code'
|
|
},
|
|
'locations': [{
|
|
'latitude': 37.424015499999996,
|
|
'longitude': -122.09259560000001
|
|
}],
|
|
'passengerType': 'SINGLE_PASSENGER',
|
|
'passengerNames': 'Passenger names',
|
|
'tripType': 'ONE_WAY',
|
|
'ticketLeg': {
|
|
'originStationCode': 'LA',
|
|
'originName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Origin name'
|
|
}
|
|
},
|
|
'destinationStationCode': 'SFO',
|
|
'destinationName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Destination name'
|
|
}
|
|
},
|
|
'departureDateTime': '2020-04-12T16:20:50.52Z',
|
|
'arrivalDateTime': '2020-04-12T20:20:50.52Z',
|
|
'fareName': {
|
|
'defaultValue': {
|
|
'language': 'en-US',
|
|
'value': 'Fare name'
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
data += '--batch_createobjectbatch\n'
|
|
data += 'Content-Type: application/json\n\n'
|
|
data += 'POST /walletobjects/v1/transitObject/\n\n'
|
|
|
|
data += json.dumps(batch_object) + '\n\n'
|
|
|
|
data += '--batch_createobjectbatch--'
|
|
|
|
# Invoke the batch API calls
|
|
response = self.http_client.post(
|
|
url='https://walletobjects.googleapis.com/batch',
|
|
data=data,
|
|
headers={
|
|
# `boundary` is the delimiter between API calls in the batch request
|
|
'Content-Type':
|
|
'multipart/mixed; boundary=batch_createobjectbatch'
|
|
})
|
|
|
|
print('Batch insert response')
|
|
print(response.content.decode('UTF-8'))
|
|
|
|
# [END batch]
|