更新卡券类和卡券对象

及时更新卡券是与客户互动的重要方式, 营造积极的体验

有两个资源可以更新:TransitClassTransitObject

最佳做法

以下列表包含在更新 公交卡类和对象:

  • 如果您要更新整个类或对象,请发送 update 请求。 如果您要更新类或对象中的少量字段,请将 patch 请求。
  • 当您发出 update 请求时,整个对象或类都会更新。 这意味着,请求中未包含的所有字段都将被清除。 在发送 update 请求之前,我们建议您先将 GET 请求发送到 确保您使用的是最新版本 字段。
  • 发出 patch 请求时,只有修补后的字段 已更新。在发送 patch 请求之前,不妨考虑选择性地发送 GET 请求,用于将您所做的更改与最新版本进行比较。
  • 在发出更新数组的 patch 请求时,原始数组为 替换为请求正文中包含的 ID。您不能修改 元素。
  • 在某些情况下,您可能不知道何时或何时会触发更改 更新。建议您定期为以下时间范围的 updatepatch 请求安排时间: 所有类和对象

更新卡券类

使用 Google 电子钱包商家控制台

您可以直接在 Google Pay 和钱包控制台

  1. 前往控制台
  2. 选择 Google Wallet API
  3. 选择要修改的课程
  4. 选择修改
  5. 更新类属性
  6. 选择保存

保存更改后,系统会针对您 公交用户。

使用 Google Wallet API

更新 TransitClass 会影响所有已预配的用户 使用此类访问公交卡。例如,要更新 您的公交卡,请向以下地址提交 updatepatch 请求: 在以下任一端点上访问 Google Wallet API。resourceId 值为类 ID (ISSUER_ID.CLASS_SUFFIX)。

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

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

有关详情,请参阅 API 参考文档

Java

若要开始使用 Java 进行集成,请参阅 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/**
 * 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 {
  TransitClass updatedClass;

  // Check if the class exists
  try {
    updatedClass =
        service.transitclass().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");

  TransitClass response =
      service
          .transitclass()
          .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 进行集成,请参阅我们的完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/**
 * 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->transitclass->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->transitclass->update("{$issuerId}.{$classSuffix}", $updatedClass);

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

  return $response->id;
}

Python

要开始在 Python 中进行集成,请参阅我们完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

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.transitclass().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.transitclass().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# 进行集成,请参阅我们的完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/// <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.Transitclass
      .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
  TransitClass updatedClass = JsonConvert.DeserializeObject<TransitClass>(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.Transitclass
      .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

若要开始在 Node 中进行集成,请参阅我们完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/**
 * 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.transitclass.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.transitclass.update({
    resourceId: `${issuerId}.${classSuffix}`,
    requestBody: updatedClass
  });

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

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

更新卡券对象

更新单个 TransitObject 只会影响 预配了该特定对象您应该定期更新 公交卡,以反映那些对客户有影响的变化,并 互动。resourceId 值将为对象 ID (ISSUER_ID.OBJECT_SUFFIX)。

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

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

有关详情,请参阅 API 参考文档

Java

若要开始使用 Java 进行集成,请参阅 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/**
 * 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 {
  TransitObject updatedObject;

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

  TransitObject response =
      service
          .transitobject()
          .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 进行集成,请参阅我们的完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/**
 * 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->transitobject->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->transitobject->update("{$issuerId}.{$objectSuffix}", $updatedObject);

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

  return $response->id;
}

Python

要开始在 Python 中进行集成,请参阅我们完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

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.transitobject().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.transitobject().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# 进行集成,请参阅我们的完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/// <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.Transitobject
      .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
  TransitObject updatedObject = JsonConvert.DeserializeObject<TransitObject>(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.Transitobject
      .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

若要开始在 Node 中进行集成,请参阅我们完整 <ph type="x-smartling-placeholder"></ph> GitHub 上的代码示例

/**
 * 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.transitobject.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.transitobject.update({
    resourceId: `${issuerId}.${objectSuffix}`,
    requestBody: updatedObject
  });

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

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