パスを期限切れとして設定すると、期限切れのパスが Google ウォレット アプリの [パス] タブで論理的にグループ化されます。Google ウォレット アプリの [期限切れのパス] セクションには、アーカイブされたパスや無効なパスがすべて含まれています。
次の条件の少なくとも 1 つに該当する場合、そのパスは [期限切れのパス] セクションに移動されます。
- object.validTimeInterval.end.date に達した場合。この日付になると、パスは 24 時間以内に [期限切れのパス] に移動されます。
- オブジェクトの
object.stateフィールドの状態がExpired、Inactive、Completedのいずれかとしてマークされている場合。
次のコードサンプルは、Google Wallet API を使用してパス オブジェクトを期限切れにする方法を示しています。
Java
/**
* Expire an object.
*
* <p>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.
*
* @param issuerId The issuer ID being used for this request.
* @param objectSuffix Developer-defined unique ID for this pass object.
* @return The pass object ID: "{issuerId}.{objectSuffix}"
*/
public String expireObject(String issuerId, String objectSuffix) throws IOException {
// Check if the object exists
try {
service.offerobject().get(String.format("%s.%s", issuerId, objectSuffix)).execute();
} catch (GoogleJsonResponseException ex) {
if (ex.getStatusCode() == 404) {
// Object does not exist
System.out.printf("Object %s.%s not found!%n", issuerId, objectSuffix);
return String.format("%s.%s", issuerId, objectSuffix);
} else {
// Something else went wrong...
ex.printStackTrace();
return String.format("%s.%s", issuerId, objectSuffix);
}
}
// Patch the object, setting the pass as expired
OfferObject patchBody = new OfferObject().setState("EXPIRED");
OfferObject response =
service
.offerobject()
.patch(String.format("%s.%s", issuerId, objectSuffix), patchBody)
.execute();
System.out.println("Object expiration response");
System.out.println(response.toPrettyString());
return response.getId();
}
PHP
/**
* 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.
*
* @param string $issuerId The issuer ID being used for this request.
* @param string $objectSuffix Developer-defined unique ID for this pass object.
*
* @return string The pass object ID: "{$issuerId}.{$objectSuffix}"
*/
public function expireObject(string $issuerId, string $objectSuffix)
{
// Check if the object exists
try {
$this->service->offerobject->get("{$issuerId}.{$objectSuffix}");
} catch (Google\Service\Exception $ex) {
if (!empty($ex->getErrors()) && $ex->getErrors()[0]['reason'] == 'resourceNotFound') {
print("Object {$issuerId}.{$objectSuffix} not found!");
return "{$issuerId}.{$objectSuffix}";
} else {
// Something else went wrong...
print_r($ex);
return "{$issuerId}.{$objectSuffix}";
}
}
// Patch the object, setting the pass as expired
$patchBody = new Google_Service_Walletobjects_OfferObject([
'state' => 'EXPIRED'
]);
$response = $this->service->offerobject->patch("{$issuerId}.{$objectSuffix}", $patchBody);
print "Object expiration response\n";
print_r($response);
return $response->id;
}
Python
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')
C#
/// <summary>
/// Expire an object.
/// <para />
/// 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.
/// </summary>
/// <param name="issuerId">The issuer ID being used for this request.</param>
/// <param name="objectSuffix">Developer-defined unique ID for this pass object.</param>
/// <returns>The pass object ID: "{issuerId}.{objectSuffix}"</returns>
public string ExpireObject(string issuerId, string objectSuffix)
{
// Check if the object exists
Stream responseStream = service.Offerobject
.Get($"{issuerId}.{objectSuffix}")
.ExecuteAsStream();
StreamReader responseReader = new StreamReader(responseStream);
JObject jsonResponse = JObject.Parse(responseReader.ReadToEnd());
if (jsonResponse.ContainsKey("error"))
{
if (jsonResponse["error"].Value<int>("code") == 404)
{
// Object does not exist
Console.WriteLine($"Object {issuerId}.{objectSuffix} not found!");
return $"{issuerId}.{objectSuffix}";
}
else
{
// Something else went wrong...
Console.WriteLine(jsonResponse.ToString());
return $"{issuerId}.{objectSuffix}";
}
}
// Patch the object, setting the pass as expired
OfferObject patchBody = new OfferObject
{
State = "EXPIRED"
};
responseStream = service.Offerobject
.Patch(patchBody, $"{issuerId}.{objectSuffix}")
.ExecuteAsStream();
responseReader = new StreamReader(responseStream);
jsonResponse = JObject.Parse(responseReader.ReadToEnd());
Console.WriteLine("Object expiration response");
Console.WriteLine(jsonResponse.ToString());
return $"{issuerId}.{objectSuffix}";
}
Node.js
/**
* 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.
*
* @param {string} issuerId The issuer ID being used for this request.
* @param {string} objectSuffix Developer-defined unique ID for the pass object.
*
* @returns {string} The pass object ID: `${issuerId}.${objectSuffix}`
*/
async expireObject(issuerId, objectSuffix) {
let response;
// Check if the object exists
try {
response = await this.httpClient.request({
url: `${this.objectUrl}/${issuerId}.${objectSuffix}`,
method: 'GET'
});
} catch (err) {
if (err.response && err.response.status === 404) {
console.log(`Object ${issuerId}.${objectSuffix} not found!`);
return `${issuerId}.${objectSuffix}`;
} else {
// Something else went wrong...
console.log(err);
return `${issuerId}.${objectSuffix}`;
}
}
// Patch the object, setting the pass as expired
let patchBody = {
'state': 'EXPIRED'
};
response = await this.httpClient.request({
url: `${this.objectUrl}/${issuerId}.${objectSuffix}`,
method: 'PATCH',
data: patchBody
});
console.log('Object expiration response');
console.log(response);
return `${issuerId}.${objectSuffix}`;
}