Эта страница переведена с помощью Cloud Translation API.

Обновление классов проходов и объектов проходов

Обновление пропусков – это важный способ взаимодействия с клиентами и создания положительного опыта.

Существует два ресурса, которые можно обновить: TransitClass и TransitObject .

Лучшие практики

В следующем списке содержится полезная информация, которую следует учитывать при обновлении классов и объектов транзитных пропусков:

Если вы хотите обновить весь класс или объект, отправьте запрос update . Если вы хотите обновить небольшое количество полей в классе или объекте, отправьте запрос на patch .
Когда вы делаете запрос update , обновляется весь объект или класс. Это означает, что все поля, не включенные в запрос, будут очищены. Прежде чем отправлять запрос update , мы рекомендуем вам отправить запрос GET , чтобы убедиться, что вы работаете с последней версией и все необходимые поля включены в ваш запрос.
При отправке запроса patch обновляются только исправленные поля. Прежде чем отправлять запрос patch , рассмотрите возможность отправки запроса GET , чтобы сравнить ваши изменения с последней версией.
При отправке patch на обновление массивов исходный массив заменяется массивом, включенным в тело запроса. Вы не можете изменять элементы массива по отдельности.
В некоторых случаях вы можете не знать, когда происходят изменения или когда запускать обновления. Рассмотрите возможность периодического планирования запросов update или patch для всех классов и объектов.

Обновление класса пропусков

Используйте бизнес-консоль Google Кошелька

Классы Pass (не объекты) можно изменить непосредственно в консоли Google Pay & Wallet .

Перейдите в консоль
Выберите API Google Кошелька.
Выберите класс, который вы хотите изменить
Выберите Редактировать
Обновите свойства класса
Выберите Сохранить.

Как только вы сохраните изменения, класс автоматически обновится для всех владельцев транзита.

Используйте API Google Кошелька

Обновление TransitClass затрагивает всех пользователей, которым были предоставлены транзитные билеты с использованием этого класса. Например, чтобы обновить логотип для ваших проездных билетов, вы должны отправить запрос update или patch в API Google Кошелька на любой из следующих конечных точек. Значением resourceId будет идентификатор класса ( 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, ознакомьтесь с нашими полными примерами кода на 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, ознакомьтесь с нашими полными примерами кода на 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, ознакомьтесь с полными примерами кода на 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#, ознакомьтесь с полными примерами кода на 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, ознакомьтесь с полными примерами кода на 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 будет идентификатор объекта ( ISSUER_ID.OBJECT_SUFFIX ).

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

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