Cette page a été traduite par l'API Cloud Translation.

Mettre à jour les classes de cartes et les objets Cartes

Maintenir vos cartes à jour est un moyen important d'interagir avec vos clients et de créer une expérience positive.

Deux ressources peuvent être mises à jour: TransitClass et TransitObject.

Bonnes pratiques

La liste suivante contient des informations utiles à prendre en compte lorsque vous mettez à jour les classes et les objets de vos titres de transport:

Lorsque vous souhaitez mettre à jour une classe ou un objet entier, envoyez une requête update. Lorsque vous souhaitez mettre à jour un petit nombre de champs dans une classe ou un objet, envoyez une requête patch.
Lorsque vous effectuez une requête update, l'objet ou la classe entier est mis à jour. Cela signifie que tous les champs non inclus dans la demande seront effacés. Avant d'envoyer une requête update, nous vous recommandons d'envoyer une requête GET pour vous assurer que vous utilisez la dernière version et que tous les champs prévus sont inclus dans votre requête.
Lors d'une requête patch, seuls les champs corrigés sont mis à jour. Avant d'envoyer une requête patch, vous pouvez éventuellement envoyer une requête GET pour comparer vos modifications à la dernière version.
Lorsque vous effectuez des requêtes patch pour mettre à jour des tableaux, le tableau d'origine est remplacé par celui inclus dans le corps de la requête. Vous ne pouvez pas modifier individuellement les éléments d'un tableau.
Dans certains cas, vous ne savez pas quand des modifications se produisent ou quand déclencher des mises à jour. Envisagez de planifier régulièrement les requêtes update ou patch pour toutes les classes et tous les objets.

Mettre à jour une classe de carte

Utiliser la Business Console de Google Wallet

Les classes de carte (pas les objets) peuvent être modifiées directement dans la Google Pay & Wallet Console.

Accéder à la console
Sélectionnez API Google Wallet.
Sélectionnez le cours que vous souhaitez modifier.
Sélectionnez Modifier.
Mettre à jour les propriétés de classe
Sélectionnez Enregistrer.

Une fois les modifications enregistrées, la classe est automatiquement mise à jour pour tous les titulaires de transports en commun.

Utiliser l'API Google Wallet

La mise à jour de TransitClass affecte tous les utilisateurs disposant de titres de transport à l'aide de cette classe. Par exemple, pour mettre à jour le logo de vos titres de transport, vous devez envoyer une requête update ou patch à l'API Google Wallet sur l'un des points de terminaison suivants. La valeur resourceId correspond à l'ID de classe (ISSUER_ID.CLASS_SUFFIX).

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

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

Pour en savoir plus, consultez la documentation de référence de l'API.

Java

Pour commencer votre intégration en Java, consultez nos exemples de code complets sur 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

Pour commencer votre intégration en PHP, consultez nos exemples de code complets sur 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

Pour commencer votre intégration dans Python, consultez nos exemples de code complets sur 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#

Pour commencer votre intégration en C#, consultez nos exemples de code complets sur 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

Pour commencer votre intégration dans Node, consultez nos exemples de code complets sur 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}`;
}

Mettre à jour un objet Cartes

La mise à jour d'un TransitObject individuel n'affecte que l'utilisateur qui a reçu cet objet spécifique. Nous vous conseillons de mettre à jour régulièrement les titres de transport individuels afin de refléter les modifications qui affectent vos clients et maintiennent leur engagement. La valeur resourceId correspond à l'ID de l'objet (ISSUER_ID.OBJECT_SUFFIX).

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

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