更新票證類別和票證物件

隨時更新票證是與客戶互動的重要方式, 打造正面體驗

有兩個可更新的資源:GiftCardClassGiftCardObject

最佳做法

下列清單包含實用資訊,可在更新 禮物卡類別和物件:

  • 如要更新整個類別或物件,請傳送 update 要求。 如要更新類別或物件的少量欄位,請將 patch 要求。
  • 發出 update 要求時,整個物件或類別都會更新。 這表示系統會清除要求中未包含的所有欄位。 傳送 update 要求前,建議您將 GET 要求傳送至 請確認您的問題為最新版本 欄位。
  • 提出 patch 要求時,只有修補過的欄位 已更新。傳送 patch 要求之前,建議您視需要傳送 GET 要求,比較您的變更與最新版本。
  • 提出 patch 要求來更新陣列時,原始陣列會是 替換成要求主體中的 1。您無法修改 單一陣列中的各個元素。
  • 在某些情況下,您可能不知道變更何時發生,或是何時觸發 更新。請考慮定期為以下執行個體排程 updatepatch 要求: 所有類別和物件

更新票證類別

使用 Google 錢包商家主控台

票證類別 (非物件) 可直接在 Google Pay 和錢包主控台

  1. 前往控制台
  2. 選取「Google Wallet API」
  3. 選取要修改的課程
  4. 選取 [編輯]
  5. 更新類別屬性
  6. 選取 [儲存]

儲存變更後,系統就會自動為任何 禮物卡持有人。

使用 Google Wallet API

更新 GiftCardClass 會影響所有已佈建的使用者 禮物卡。例如,假設您要將 您的禮物卡,請將 updatepatch 要求提交至 Google Wallet APIresourceId 的值就是類別 ID (ISSUER_ID.CLASS_SUFFIX)。

# Update
PUT https://walletobjects.googleapis.com/walletobjects/v1/giftcardclass/{resourceId}

# Patch
PATCH https://walletobjects.googleapis.com/walletobjects/v1/giftcardclass/{resourceId}

詳情請參閱 API 參考資料

Java

如要開始在 Java 中整合,請參閱我們提供的完整 查看程式碼範例

/**
 * Update a class.
 *
 * <p><strong>Warning:</strong> This replaces all existing class attributes!
 *
 * @param issuerId The issuer ID being used for this request.
 * @param classSuffix Developer-defined unique ID for this pass class.
 * @return The pass class ID: "{issuerId}.{classSuffix}"
 */
public String updateClass(String issuerId, String classSuffix) throws IOException {
  GiftCardClass updatedClass;

  // Check if the class exists
  try {
    updatedClass =
        service.giftcardclass().get(String.format("%s.%s", issuerId, classSuffix)).execute();
  } catch (GoogleJsonResponseException ex) {
    if (ex.getStatusCode() == 404) {
      // Class does not exist
      System.out.printf("Class %s.%s not found!%n", issuerId, classSuffix);
      return String.format("%s.%s", issuerId, classSuffix);
    } else {
      // Something else went wrong...
      ex.printStackTrace();
      return String.format("%s.%s", issuerId, classSuffix);
    }
  }

  // Class exists
  // Update the class by adding a homepage
  updatedClass.setHomepageUri(
      new Uri()
          .setUri("https://developers.google.com/wallet")
          .setDescription("Homepage description"));

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  updatedClass.setReviewStatus("UNDER_REVIEW");

  GiftCardClass response =
      service
          .giftcardclass()
          .update(String.format("%s.%s", issuerId, classSuffix), updatedClass)
          .execute();

  System.out.println("Class update response");
  System.out.println(response.toPrettyString());

  return response.getId();
}

PHP

如要在 PHP 中開始整合,請參閱我們提供的完整 查看程式碼範例

/**
 * Update a class.
 *
 * **Warning:** This replaces all existing class attributes!
 *
 * @param string $issuerId The issuer ID being used for this request.
 * @param string $classSuffix Developer-defined unique ID for this pass class.
 *
 * @return string The pass class ID: "{$issuerId}.{$classSuffix}"
 */
public function updateClass(string $issuerId, string $classSuffix)
{
  // Check if the class exists
  try {
    $updatedClass = $this->service->giftcardclass->get("{$issuerId}.{$classSuffix}");
  } catch (Google\Service\Exception $ex) {
    if (!empty($ex->getErrors()) && $ex->getErrors()[0]['reason'] == 'classNotFound') {
      // Class does not exist
      print("Class {$issuerId}.{$classSuffix} not found!");
      return "{$issuerId}.{$classSuffix}";
    } else {
      // Something else went wrong...
      print_r($ex);
      return "{$issuerId}.{$classSuffix}";
    }
  }

  // Update the class by adding a homepage
  $updatedClass->setHomepageUri(new Uri([
    'uri' => 'https://developers.google.com/wallet',
    'description' => 'Homepage description'
  ]));

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  $updatedClass->setReviewStatus('UNDER_REVIEW');

  $response = $this->service->giftcardclass->update("{$issuerId}.{$classSuffix}", $updatedClass);

  print "Class update response\n";
  print_r($response);

  return $response->id;
}

Python

如要開始以 Python 進行整合,請參閱我們提供的完整 查看程式碼範例

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
    try:
        response = self.client.giftcardclass().get(resourceId=f'{issuer_id}.{class_suffix}').execute()
    except HttpError as e:
        if e.status_code == 404:
            print(f'Class {issuer_id}.{class_suffix} not found!')
            return f'{issuer_id}.{class_suffix}'
        else:
            # Something else went wrong...
            print(e.error_details)
            return f'{issuer_id}.{class_suffix}'

    # Class exists
    updated_class = response

    # 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.client.giftcardclass().update(
        resourceId=f'{issuer_id}.{class_suffix}',
        body=updated_class).execute()

    print('Class update response')
    print(response)

    return f'{issuer_id}.{class_suffix}'

C#

如要開始在 C# 中整合,請參閱我們提供的完整 查看程式碼範例

/// <summary>
/// Update a class.
/// <para />
/// <strong>Warning:</strong> This replaces all existing class attributes!
/// </summary>
/// <param name="issuerId">The issuer ID being used for this request.</param>
/// <param name="classSuffix">Developer-defined unique ID for this pass class.</param>
/// <returns>The pass class ID: "{issuerId}.{classSuffix}"</returns>
public string UpdateClass(string issuerId, string classSuffix)
{
  // Check if the class exists
  Stream responseStream = service.Giftcardclass
      .Get($"{issuerId}.{classSuffix}")
      .ExecuteAsStream();

  StreamReader responseReader = new StreamReader(responseStream);
  JObject jsonResponse = JObject.Parse(responseReader.ReadToEnd());

  if (jsonResponse.ContainsKey("error"))
  {
    if (jsonResponse["error"].Value<int>("code") == 404)
    {
      // Class does not exist
      Console.WriteLine($"Class {issuerId}.{classSuffix} not found!");
      return $"{issuerId}.{classSuffix}";
    }
    else
    {
      // Something else went wrong...
      Console.WriteLine(jsonResponse.ToString());
      return $"{issuerId}.{classSuffix}";
    }
  }

  // Class exists
  GiftCardClass updatedClass = JsonConvert.DeserializeObject<GiftCardClass>(jsonResponse.ToString());

  // Update the class by adding a homepage
  updatedClass.HomepageUri = new Google.Apis.Walletobjects.v1.Data.Uri
  {
    UriValue = "https://developers.google.com/wallet",
    Description = "Homepage description"
  };

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  updatedClass.ReviewStatus = "UNDER_REVIEW";

  responseStream = service.Giftcardclass
      .Update(updatedClass, $"{issuerId}.{classSuffix}")
      .ExecuteAsStream();

  responseReader = new StreamReader(responseStream);
  jsonResponse = JObject.Parse(responseReader.ReadToEnd());

  Console.WriteLine("Class update response");
  Console.WriteLine(jsonResponse.ToString());

  return $"{issuerId}.{classSuffix}";
}

Node.js

如要在節點環境中展開整合作業,請參閱我們提供的完整 查看程式碼範例

/**
 * Update a class.
 *
 * **Warning:** This replaces all existing class attributes!
 *
 * @param {string} issuerId The issuer ID being used for this request.
 * @param {string} classSuffix Developer-defined unique ID for this pass class.
 *
 * @returns {string} The pass class ID: `${issuerId}.${classSuffix}`
 */
async updateClass(issuerId, classSuffix) {
  let response;

  // Check if the class exists
  try {
    response = await this.client.giftcardclass.get({
      resourceId: `${issuerId}.${classSuffix}`
    });
  } catch (err) {
    if (err.response && err.response.status === 404) {
      console.log(`Class ${issuerId}.${classSuffix} not found!`);
      return `${issuerId}.${classSuffix}`;
    } else {
      // Something else went wrong...
      console.log(err);
      return `${issuerId}.${classSuffix}`;
    }
  }

  // Class exists
  let updatedClass = response.data;

  // Update the class by adding a homepage
  updatedClass['homepageUri'] = {
    'uri': 'https://developers.google.com/wallet',
    'description': 'Homepage description'
  };

  // Note: reviewStatus must be 'UNDER_REVIEW' or 'DRAFT' for updates
  updatedClass['reviewStatus'] = 'UNDER_REVIEW';

  response = await this.client.giftcardclass.update({
    resourceId: `${issuerId}.${classSuffix}`,
    requestBody: updatedClass
  });

  console.log('Class update response');
  console.log(response);

  return `${issuerId}.${classSuffix}`;
}

更新票證物件

更新個別 GiftCardObject 只會影響執行下列操作的使用者 佈建該特定物件建議您定期更新個別電子郵件地址 可以反映影響客戶的異動,並保留 讓他們參與resourceId 值是物件 ID (ISSUER_ID.OBJECT_SUFFIX)。

# Update
PUT https://walletobjects.googleapis.com/walletobjects/v1/giftcardobject/{resourceId}

# Patch
PATCH https://walletobjects.googleapis.com/walletobjects/v1/giftcardobject/{resourceId}

詳情請參閱 API 參考資料

Java

如要開始在 Java 中整合,請參閱我們提供的完整 查看程式碼範例

/**
 * Update an object.
 *
 * <p><strong>Warning:</strong> This replaces all existing object attributes!
 *
 * @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 updateObject(String issuerId, String objectSuffix) throws IOException {
  GiftCardObject updatedObject;

  // Check if the object exists
  try {
    updatedObject =
        service.giftcardobject().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);
    }
  }

  // Object exists
  // Update the object by adding a link
  Uri newLink =
      new Uri()
          .setUri("https://developers.google.com/wallet")
          .setDescription("New link description");

  if (updatedObject.getLinksModuleData() == null) {
    // LinksModuleData was not set on the original object
    updatedObject.setLinksModuleData(new LinksModuleData().setUris(List.of(newLink)));
  } else {
    updatedObject.getLinksModuleData().getUris().add(newLink);
  }

  GiftCardObject response =
      service
          .giftcardobject()
          .update(String.format("%s.%s", issuerId, objectSuffix), updatedObject)
          .execute();

  System.out.println("Object update response");
  System.out.println(response.toPrettyString());

  return response.getId();
}

PHP

如要在 PHP 中開始整合,請參閱我們提供的完整 查看程式碼範例

/**
 * Update an object.
 *
 * **Warning:** This replaces all existing object attributes!
 *
 * @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 updateObject(string $issuerId, string $objectSuffix)
{
  // Check if the object exists
  try {
    $updatedObject = $this->service->giftcardobject->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}";
    }
  }

  // Update the object by adding a link
  $newLink = new Uri([
    'uri' => 'https://developers.google.com/wallet',
    'description' => 'New link description'
  ]);

  $linksModuleData = $updatedObject->getLinksModuleData();
  if (is_null($linksModuleData)) {
    // LinksModuleData was not set on the original object
    $linksModuleData = new LinksModuleData([
      'uris' => []
    ]);
  }
  $uris = $linksModuleData->getUris();
  array_push(
    $uris,
    $newLink
  );
  $linksModuleData->setUris($uris);

  $updatedObject->setLinksModuleData($linksModuleData);

  $response = $this->service->giftcardobject->update("{$issuerId}.{$objectSuffix}", $updatedObject);

  print "Object update response\n";
  print_r($response);

  return $response->id;
}

Python

如要開始以 Python 進行整合,請參閱我們提供的完整 查看程式碼範例

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
    try:
        response = self.client.giftcardobject().get(resourceId=f'{issuer_id}.{object_suffix}').execute()
    except HttpError as e:
        if e.status_code == 404:
            print(f'Object {issuer_id}.{object_suffix} not found!')
            return f'{issuer_id}.{object_suffix}'
        else:
            # Something else went wrong...
            print(e.error_details)
            return f'{issuer_id}.{object_suffix}'

    # Object exists
    updated_object = response

    # 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.client.giftcardobject().update(
        resourceId=f'{issuer_id}.{object_suffix}',
        body=updated_object).execute()

    print('Object update response')
    print(response)

    return f'{issuer_id}.{object_suffix}'

C#

如要開始在 C# 中整合,請參閱我們提供的完整 查看程式碼範例

/// <summary>
/// Update an object.
/// <para />
/// <strong>Warning:</strong> This replaces all existing class attributes!
/// </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 UpdateObject(string issuerId, string objectSuffix)
{
  // Check if the object exists
  Stream responseStream = service.Giftcardobject
      .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}";
    }
  }

  // Object exists
  GiftCardObject updatedObject = JsonConvert.DeserializeObject<GiftCardObject>(jsonResponse.ToString());

  // Update the object by adding a link
  Google.Apis.Walletobjects.v1.Data.Uri newLink = new Google.Apis.Walletobjects.v1.Data.Uri
  {
    UriValue = "https://developers.google.com/wallet",
    Description = "New link description"
  };

  if (updatedObject.LinksModuleData == null)
  {
    // LinksModuleData was not set on the original object
    updatedObject.LinksModuleData = new LinksModuleData
    {
      Uris = new List<Google.Apis.Walletobjects.v1.Data.Uri>()
    };
  }
  updatedObject.LinksModuleData.Uris.Add(newLink);

  responseStream = service.Giftcardobject
      .Update(updatedObject, $"{issuerId}.{objectSuffix}")
      .ExecuteAsStream();

  responseReader = new StreamReader(responseStream);
  jsonResponse = JObject.Parse(responseReader.ReadToEnd());

  Console.WriteLine("Object update response");
  Console.WriteLine(jsonResponse.ToString());

  return $"{issuerId}.{objectSuffix}";
}

Node.js

如要在節點環境中展開整合作業,請參閱我們提供的完整 查看程式碼範例

/**
 * Update an object.
 *
 * **Warning:** This replaces all existing object attributes!
 *
 * @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 updateObject(issuerId, objectSuffix) {
  let response;

  // Check if the object exists
  try {
    response = await this.client.giftcardobject.get({
      resourceId: `${issuerId}.${objectSuffix}`
    });
  } 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}`;
    }
  }

  // Object exists
  let updatedObject = response.data;

  // Update the object by adding a link
  let newLink = {
    'uri': 'https://developers.google.com/wallet',
    'description': 'New link description'
  }
  if (updatedObject['linksModuleData'] === undefined) {
    updatedObject['linksModuleData'] = {
      'uris': [newLink]
    };
  } else {
    updatedObject['linksModuleData']['uris'].push(newLink);
  }

  response = await this.client.giftcardobject.update({
    resourceId: `${issuerId}.${objectSuffix}`,
    requestBody: updatedObject
  });

  console.log('Object update response');
  console.log(response);

  return `${issuerId}.${objectSuffix}`;
}