前提条件
先に進む前に、必ず次の手順を完了してください。
スマートタップを有効にするアカウントを確認する
手順を進める前に、クーポン発行者アカウントとして指定するアカウントを特定する必要があります。これを判定する方法は 2 つあります。
新しい発行者アカウントを作成する
新しいアカウントの連絡先情報には、販売者の情報が含まれている必要があります。Google Pay & ウォレット コンソールでこれを行う方法については、こちらのサポート記事をご覧ください。次のコードサンプルは、Google Wallet API を使用して発行者アカウントを作成する方法を示しています。
Java
/**
* Create a new Google Wallet Issuer account.
*
* @param issuerName The Issuer's name.
* @param issuerEmail The Issuer's email address.
* @throws IOException
*/
public void CreateIssuerAccount(String issuerName, String issuerEmail) throws IOException {
// New Issuer information
Issuer issuer =
new Issuer()
.setName(issuerName)
.setContactInfo(new IssuerContactInfo().setEmail(issuerEmail));
Issuer response = service.issuer().insert(issuer).execute();
System.out.println("Issuer insert response");
System.out.println(response.toPrettyString());
}
PHP
/**
* Create a new Google Wallet issuer account.
*
* @param string $issuerName The Issuer's name.
* @param string $issuerEmail The Issuer's email address.
*/
public function createIssuerAccount(string $issuerName, string $issuerEmail)
{
// New Issuer information
$issuer = new Google_Service_Walletobjects_Issuer([
'name' => $issuerName,
'contactInfo' => new Google_Service_Walletobjects_IssuerContactInfo([
'email' => $issuerEmail,
]),
]);
$response = $this->service->issuer->insert($issuer);
print "Issuer insert response\n";
print_r($response);
}
Python
def create_issuer_account(self, issuer_name: str, issuer_email: str):
"""Create a new Google Wallet Issuer account.
Args:
issuer_name (str): The Issuer's name.
issuer_email (str): The Issuer's email address.
"""
# New Issuer information
issuer = {'name': issuer_name, 'contactInfo': {'email': issuer_email}}
# Make the POST request
response = self.http_client.post(url=self.issuer_url, json=issuer)
print('Issuer insert response')
print(response.text)
C#
/// <summary>
/// Create a new Google Wallet Issuer account.
/// </summary>
/// <param name="issuerName">The Issuer's name.</param>
/// <param name="issuerEmail">The Issuer's email address.</param>
public void CreateIssuerAccount(string issuerName, string issuerEmail)
{
// New issuer information
Issuer issuer = new Issuer()
{
ContactInfo = new IssuerContactInfo()
{
Email = issuerEmail
},
Name = issuerName,
};
Stream responseStream = service.Issuer
.Insert(issuer)
.ExecuteAsStream();
StreamReader responseReader = new StreamReader(responseStream);
JObject jsonResponse = JObject.Parse(responseReader.ReadToEnd());
Console.WriteLine("Issuer insert response");
Console.WriteLine(jsonResponse.ToString());
}
Node.js
/**
* Create a new Google Wallet Issuer account.
*
* @param {string} issuerName The Issuer's name.
* @param {string} issuerEmail The Issuer's email address.
*/
async createIssuerAccount(issuerName, issuerEmail) {
// New Issuer information
let issuer = {
name: issuerName,
contactInfo: {
email: issuerEmail
}
};
let response = await this.httpClient.request({
url: this.issuerUrl,
method: 'POST',
data: issuer
});
console.log('Issuer insert response');
console.log(response);
}
最初は、発行者アカウントを作成したプリンシパル（サービス アカウントまたはユーザー）のみがアクセスできます。パスを管理できる追加のユーザーまたはサービス アカウントが含まれるように、発行者アカウントの権限を更新する必要があります。次のコードサンプルは、発行者アカウントの権限を更新する方法を示しています。
Java
/**
* Update permissions for an existing Google Wallet Issuer account.
*
* <p><strong>Warning:</strong> This operation overwrites all existing permissions!
*
* <p>Example permissions list argument below. Copy the add entry as needed for each email address
* that will need access. Supported values for role are: 'READER', 'WRITER', and 'OWNER'
*
* <pre><code>
* ArrayList<Permission> permissions = new ArrayList<Permission>();
* permissions.add(new Permission().setEmailAddress("emailAddress").setRole("OWNER"));
* </code></pre>
*
* @param issuerId The Issuer ID being used for this request.
* @param permissions The list of email addresses and roles to assign.
* @throws IOException
*/
public void UpdateIssuerAccountPermissions(String issuerId, ArrayList<Permission> permissions)
throws IOException {
Permissions response =
service
.permissions()
.update(
Long.parseLong(issuerId),
new Permissions().setIssuerId(Long.parseLong(issuerId)).setPermissions(permissions))
.execute();
System.out.println("Issuer permissions update response");
System.out.println(response.toPrettyString());
}
PHP
/**
* Update permissions for an existing Google Wallet Issuer account.
*
* **Warning:** This operation overwrites all existing permissions!
*
* Example permissions list argument below. Copy the entry as
* needed for each email address that will need access. Supported
* values for role are: 'READER', 'WRITER', and 'OWNER'
*
* $permissions = array(
* new Google_Service_Walletobjects_Permission([
* 'emailAddress' => 'email-address',
* 'role' => 'OWNER',
* ]),
* );
*
* @param string $issuerId The Issuer ID being used for this request.
* @param array $permissions The list of email addresses and roles to assign.
*/
public function updateIssuerAccountPermissions(string $issuerId, array $permissions)
{
// Make the PUT request
$response = $this->service->permissions->update(
$issuerId,
new Google_Service_Walletobjects_Permissions([
'issuerId' => $issuerId,
'permissions' => $permissions,
])
);
print "Permissions update response\n";
print_r($response);
}
Python
def update_issuer_account_permissions(self, issuer_id: str,
permissions: List):
"""Update permissions for an existing Google Wallet Issuer account.
**Warning:** This operation overwrites all existing permissions!
Example permissions list argument below. Copy the dict entry as
needed for each email address that will need access. Supported
values for role are: 'READER', 'WRITER', and 'OWNER'
permissions = [
{
'emailAddress': 'email-address',
'role': 'OWNER'
}
]
Args:
issuer_id (str): The Issuer ID being used for this request.
permissions (List): The list of email addresses and roles to assign.
"""
response = self.http_client.put(url=f'{self.permissions_url}/{issuer_id}',
json={
'issuerId': issuer_id,
'permissions': permissions
})
print('Permissions update response')
print(response.text)
C#
/// <summary>
/// Update permissions for an existing Google Wallet Issuer account.
/// <para />
/// <strong>Warning:</strong> This operation overwrites all existing permissions!
/// <para />
/// Example permissions list argument below. Copy the add entry as needed for each email
/// address that will need access.Supported values for role are: 'READER', 'WRITER', and 'OWNER'
/// <para />
/// <![CDATA[List<Permission> permissions = new List<Permission>();]]>
/// <para />
/// permissions.Add(new Permission { EmailAddress = "emailAddress", Role = "OWNER"});
/// </summary>
/// <param name="issuerId">The issuer ID being used for this request.</param>
/// <param name="permissions">The list of email addresses and roles to assign.</param>
public void UpdateIssuerAccountPermissions(string issuerId, List<Permission> permissions)
{
Stream responseStream = service.Permissions
.Update(new Permissions
{
IssuerId = long.Parse(issuerId),
PermissionsValue = permissions
},
long.Parse(issuerId))
.ExecuteAsStream();
StreamReader responseReader = new StreamReader(responseStream);
JObject jsonResponse = JObject.Parse(responseReader.ReadToEnd());
Console.WriteLine("Issuer permissions update response");
Console.WriteLine(jsonResponse.ToString());
}
Node.js
/**
* Update permissions for an existing Google Wallet Issuer account.
*
* **Warning:** This operation overwrites all existing permissions!
*
* Example permissions list argument below. Copy the dict entry as
* needed for each email address that will need access. Supported
* values for role are: 'READER', 'WRITER', and 'OWNER'
*
* let permissions = [
* {
* 'emailAddress': 'email-address',
* 'role': 'OWNER',
* },
* ];
*
* @param {string} issuerId The Issuer ID being used for this request.
* @param {Array} permissions The list of email addresses and roles to assign.
*/
async updateIssuerPermissions(issuerId, permissions) {
let response = await this.httpClient.request({
url: `${this.permissionsUrl}/${issuerId}`,
method: 'PUT',
data: {
issuerId: issuerId,
permissions: permissions
}
});
console.log('Permissions update response');
console.log(response);
}
既存のアカウントを使用する
既存のパスクラスを含む発行者アカウントを使用できるかどうかを判断するには、次の基準を使用する必要があります。
- パス開発用の発行者アカウントに他の販売者のクラスが含まれている場合は、販売者の代わりに新しいアカウントを設定する必要があります。
- パス開発用の発行者アカウントに特定の販売者のクラスのみが含まれている場合は、そのアカウントを使用できます。
アカウントがこれらの条件を満たしている場合は、アカウント名で販売者を識別できるように、ビジネス プロフィールの連絡先情報を販売者の情報で更新する必要があります。このアカウントへの API アクセスを他のユーザーに許可しないでください。 追加のパスのデベロッパーは、独自の発行者アカウントを作成する必要があります。
クーポン発行者アカウントの構成
Google Pay & ウォレット コンソールを使用する
クーポン発行者アカウントでは、以下の手順を行います。
- [Google Wallet API] セクションに移動します
- [その他の機能] を選択します。
- [認証キーを追加] を選択します。
- 公開鍵（
.pemファイル）をアップロードして鍵バージョンを指定する - [認証キーを作成] を選択します。
認証キーが正常にアップロードされると、コレクタ ID が提供されます。
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEchyXj869zfmKhRi9xP7f2AK07kEo
4lE7ZlWTN14jh4YBTny+hRGRXcUzevV9zSSPJlPHpqqu5pEwlv1xyFvE1w==
-----END PUBLIC KEY-----
Google Wallet API を使用する
公開鍵をアップロードする
Google Wallet API を使用して公開鍵と鍵バージョンを割り当てるには、発行者エンドポイントに PATCH リクエストを行う必要があります。
PATCH https://walletobjects.googleapis.com/walletobjects/v1/issuer/{issuerId}
PATCH リクエストの本文は次のようになります。
{
"smartTapMerchantData": {
"authenticationKeys": [
{
"id": 1,
"publicKeyPem": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"
},
{
"id": 2,
"publicKeyPem": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"
}
]
}
}
次のコードサンプルは、前述のデモ用の公開鍵を含めるように発行者アカウントを更新する方法を示しています。
Java
/**
* Add a new public key to an Issuer account.
*
* @param issuerId The issuer ID being used for this request.
* @throws IOException
*/
public void AddSmartTapKey(Long issuerId) throws IOException {
// New smart tap key information
Issuer patchBody =
new Issuer()
.setSmartTapMerchantData(
new SmartTapMerchantData()
.setAuthenticationKeys(
Arrays.asList(
new AuthenticationKey()
.setId(1)
.setPublicKeyPem(
"-----BEGIN PUBLIC KEY-----\n"
+ "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEchyXj869zfmKhRi9xP7f2AK07kEo\n"
+ "4lE7ZlWTN14jh4YBTny+hRGRXcUzevV9zSSPJlPHpqqu5pEwlv1xyFvE1w==\n"
+ "-----END PUBLIC KEY-----"))));
Issuer response = service.issuer().patch(issuerId, patchBody).execute();
System.out.println("Issuer patch response");
System.out.println(response.toPrettyString());
}
PHP
/**
* Add a new public key to an Issuer account.
*
* @param string $issuerId The issuer ID being used for this request.
*/
public function addSmartTapKey(string $issuerId)
{
// New smart tap key information
$patchBody = new Google_Service_Walletobjects_Issuer([
'smartTapMerchantData' => new Google_Service_Walletobjects_SmartTapMerchantData([
'authenticationKeys' => [
new Google_Service_Walletobjects_AuthenticationKey([
'id' => 1,
'publicKeyPem' => "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEchyXj869zfmKhRi9xP7f2AK07kEo\n4lE7ZlWTN14jh4YBTny+hRGRXcUzevV9zSSPJlPHpqqu5pEwlv1xyFvE1w==\n-----END PUBLIC KEY-----"
])
]
])
]);
$response = $this->service->issuer->patch($issuerId, $patchBody);
print "Issuer patch response\n";
print_r($response);
}
Python
def add_smart_tap_key(self, issuer_id: str) -> str:
"""Add a new public key to an Issuer account.
Args:
issuer_id (str): The issuer ID being used for this request.
"""
# New smart tap key information
patch_body = {
'smartTapMerchantData': {
'authenticationKeys': [{
'id':
1,
'publicKeyPem':
'-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEchyXj869zfmKhRi9xP7f2AK07kEo\n4lE7ZlWTN14jh4YBTny+hRGRXcUzevV9zSSPJlPHpqqu5pEwlv1xyFvE1w==\n-----END PUBLIC KEY-----'
}]
}
}
# Make the PATCH request
response = self.http_client.patch(url=f'{self.issuer_url}/{issuer_id}', json=patch_body)
print('Issuer patch response')
print(response.text)
return response.json()['smartTapMerchantData']['smartTapMerchantId']
C#
/// <summary>
/// Add a new public key to an Issuer account.
/// </summary>
/// <param name="issuerId">The issuer ID being used for this request.</param>
public void AddSmartTapKey(long issuerId)
{
// New smart tap key information
Issuer patchBody = new Issuer()
{
SmartTapMerchantData = new SmartTapMerchantData
{
AuthenticationKeys = new List<AuthenticationKey>
{
new AuthenticationKey
{
Id = 1,
PublicKeyPem = "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEchyXj869zfmKhRi9xP7f2AK07kEo\n4lE7ZlWTN14jh4YBTny+hRGRXcUzevV9zSSPJlPHpqqu5pEwlv1xyFvE1w==\n-----END PUBLIC KEY-----"
}
}
}
};
Stream responseStream = service.Issuer
.Patch(patchBody, issuerId)
.ExecuteAsStream();
StreamReader responseReader = new StreamReader(responseStream);
JObject jsonResponse = JObject.Parse(responseReader.ReadToEnd());
Console.WriteLine("Issuer patch response");
Console.WriteLine(jsonResponse.ToString());
}
Node.js
/**
* Add a new public key to an Issuer account.
*
* @param {string} issuerId The issuer ID being used for this request.
*/
async addSmartTapKey(issuerId) {
// New smart tap key information
let patchBody = {
smartTapMerchantData: {
authenticationKeys: [
{
id: 1,
publicKeyPem: '-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEchyXj869zfmKhRi9xP7f2AK07kEo\n4lE7ZlWTN14jh4YBTny+hRGRXcUzevV9zSSPJlPHpqqu5pEwlv1xyFvE1w==\n-----END PUBLIC KEY-----'
}
]
}
};
let response = await this.httpClient.request({
url: `${this.issuerUrl}/${issuerId}`,
method: 'PATCH',
data: patchBody
});
console.log('Issuer patch response');
console.log(response);
}
レスポンスには、送信した本文と追加の smartTapMerchantData.smartTapMerchantId フィールドが含まれます。これは、クーポン発行者アカウントのコレクタ ID です。
コレクタ ID を取得する
鍵と鍵バージョンを追加したら、Google Wallet API を使用して発行者エンドポイントに GET リクエストを行い、コレクタ ID を取得できます。
GET https://walletobjects.googleapis.com/walletobjects/v1/issuer/{issuerId}
Java
/**
* Get the Collector ID for an Issuer account.
*
* @param issuerId The issuer ID being used for this request.
* @return The Collector ID
* @throws IOException
*/
public Long GetCollectorId(Long issuerId) throws IOException {
Issuer response = service.issuer().get(issuerId).execute();
System.out.println("Issuer patch response");
System.out.println(response.toPrettyString());
return response.getSmartTapMerchantData().getSmartTapMerchantId();
}
PHP
/**
* Get the Collector ID for an Issuer account.
*
* @param string $issuerId The issuer ID being used for this request.
* @return string The Collector ID.
*/
public function getCollectorId(string $issuerId)
{
$response = $this->service->issuer->get($issuerId);
print "Issuer get response\n";
print_r($response);
return $response['smartTapMerchantData']['smartTapMerchantId'];
}
Python
def get_collector_id(self, issuer_id: str) -> str:
"""Get the Collector ID for an Issuer account.
Args:
issuer_id (str): The issuer ID being used for this request.
"""
# Make the GET request
response = self.http_client.get(url=f'{self.issuer_url}/{issuer_id}')
print('Issuer get response')
print(response.text)
return response.json()['smartTapMerchantData']['smartTapMerchantId']
C#
/// <summary>
/// Get the Collector ID for an Issuer account.
/// </summary>
/// <param name="issuerId">The issuer ID being used for this request.</param>
/// <returns>The Collector ID</returns>
public string GetCollectorId(long issuerId)
{
Stream responseStream = service.Issuer
.Get(issuerId)
.ExecuteAsStream();
StreamReader responseReader = new StreamReader(responseStream);
JObject jsonResponse = JObject.Parse(responseReader.ReadToEnd());
Console.WriteLine("Issuer get response");
Console.WriteLine(jsonResponse.ToString());
return jsonResponse["smartTapMerchantData"]["smartTapMerchantId"].Value<string>();
}
Node.js
/**
* Get the Collector ID for an Issuer account.
*
* @param {string} issuerId The issuer ID being used for this request.
*
* @returns {string} The Collector ID
*/
async getCollectorId(issuerId) {
let response = await this.httpClient.request({
url: `${this.issuerUrl}/${issuerId}`,
method: 'GET'
});
console.log('Issuer patch response');
console.log(response);
return response.data.smartTapMerchantData.smartTapMerchantId;
}
レスポンスには smartTapMerchantData.smartTapMerchantId フィールドが含まれます。これは、クーポン発行者アカウントのコレクタ ID です。
発行者アカウントの管理
パスの構成
複数の販売者のパスクラスとパス オブジェクトを管理する一般的な方法には、次の 2 つがあります。
- すべての販売者に 1 つの発行者アカウントを作成する
- 販売者ごとに新しい発行者アカウントを作成する
たとえば、Foo-Loyalty では、ILuvCoffee と TeaLuv という 2 つの販売者のポイント プログラムを管理しています。それらのパスクラスは、次のいずれかの方法で管理できます。
| アプローチ | 説明 |
|---|---|
| 単一の発行者アカウント | 1 つの発行者アカウント「Foo-Loyalty」にすべてのポイントクラスを含める。パスが利用可能な場所をクラスレベルで追跡する場合は、この方法をおすすめします。この発行者アカウントに販売者の API へのアクセスを許可しない場合にも適しています。 |
| 個別の発行者アカウント | 「iLuvCoffee via Foo-Loyalty」と「teaLuv via Foo-Loyalty」という 2 つのアカウントを作成する。特定の発行者アカウントのすべてのクラスを販売者レベルで利用可能にする場合や、発行者アカウントに販売者の API へのアクセス権を付与する予定の場合は、このオプションをおすすめします。 |
クーポン発行者アカウント
使用する正しいクーポン発行者アカウントを決定する際は、2 つのシナリオを考慮します。
シナリオ 1: 販売者がすでにスマートタップを使用している
販売者が端末で Google ウォレットからすでに特典を利用できること（販売者がすでにクーポン発行者として設定されている）を確認した場合は、次の手順を行います。
- 販売者のクーポン発行者 ID をリクエストする
- パスクラスの
redemptionIssuersプロパティに販売者のクーポン発行者 ID を追加します
シナリオ 2: 販売者がスマートタップを初めて使用する
このシナリオでは、販売者はスマートタップ対応の端末を所有していますが、この機能をまだ利用していません。販売者の端末でスマートタップを有効にするには、販売者、端末プロバイダ、またはパスのデベロッパーが 1 回限りの設定を行う必要があります。
詳細については、販売者の構成をご覧ください。