Se usó la API de Cloud Translation para traducir esta página.

Actualizar clases Passes y Passes objetos

Mantener los pases actualizados es una forma importante de interactuar con tus clientes y crear una experiencia positiva.

Hay dos recursos que se pueden actualizar: LoyaltyClass y LoyaltyObject.

Prácticas recomendadas

La siguiente lista contiene información útil que debes tener en cuenta cuando actualices las clases y los objetos de tus tarjetas de lealtad:

Cuando quieras actualizar una clase o un objeto completo, envía una solicitud update. Cuando desees actualizar una pequeña cantidad de campos en una clase o un objeto, envía una solicitud patch.
Cuando realizas una solicitud update, se actualiza todo el objeto o la clase. Esto significa que se borrarán todos los campos no incluidos en la solicitud. Antes de enviar una solicitud update, te recomendamos que envíes una solicitud GET para asegurarte de que trabajas con la última versión y de que todos los campos previstos estén incluidos en tu solicitud.
Cuando se realiza una solicitud patch, solo se actualizan los campos con parches. Antes de enviar una solicitud patch, considera enviar de manera opcional una solicitud GET para comparar los cambios con la versión más reciente.
Cuando realizas solicitudes patch para actualizar arreglos, el arreglo original se reemplaza por el incluido en el cuerpo de la solicitud. No puedes modificar los elementos de un array de manera individual.
En algunos casos, es posible que no sepas cuándo se realizan los cambios o cuándo activar las actualizaciones. Considera programar periódicamente las solicitudes update o patch para todas las clases y los objetos.

Actualizar una clase Passes

Usa Google Wallet Business Console

Las clases de pases (no objetos) se pueden modificar directamente en la Consola de Google Pay y la Billetera.

Navega a la consola
Selecciona la API de la Billetera de Google.
Selecciona la clase que quieras modificar.
Selecciona Editar.
Actualiza las propiedades de la clase
Seleccione Guardar

Una vez que guardes los cambios, se actualizará automáticamente la clase para todos los titulares de lealtad.

Usa la API de la Billetera de Google

La actualización de LoyaltyClass afecta a todos los usuarios a los que se les aprovisionaron tarjetas de lealtad con esta clase. Por ejemplo, para actualizar el logotipo de tus tarjetas de lealtad, debes enviar una solicitud de update o patch a la API de la Billetera de Google en cualquiera de los siguientes extremos. El valor resourceId sería el ID de la clase (ISSUER_ID.CLASS_SUFFIX).

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

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

Para obtener más información, consulta la referencia de la API.

Java

Para comenzar la integración en Java, consulta nuestras muestras de código completas en 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 {
  LoyaltyClass updatedClass;

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

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

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

  return response.getId();
}

PHP

Para comenzar tu integración en PHP, consulta nuestras muestras de código completas en 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->loyaltyclass->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->loyaltyclass->update("{$issuerId}.{$classSuffix}", $updatedClass);

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

  return $response->id;
}

Python

Para comenzar la integración en Python, consulta nuestras muestras de código completas en 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.loyaltyclass().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.loyaltyclass().update(
        resourceId=f'{issuer_id}.{class_suffix}',
        body=updated_class).execute()

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

    return f'{issuer_id}.{class_suffix}'

C#

Para comenzar tu integración en C#, consulta nuestras muestras de código completas en 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.Loyaltyclass
      .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
  LoyaltyClass updatedClass = JsonConvert.DeserializeObject<LoyaltyClass>(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.Loyaltyclass
      .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

Para comenzar la integración en Node, consulta nuestras muestras de código completas en 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.loyaltyclass.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.loyaltyclass.update({
    resourceId: `${issuerId}.${classSuffix}`,
    requestBody: updatedClass
  });

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

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

Actualizar un objeto Passes

La actualización de un LoyaltyObject individual afecta solo al usuario al que se aprovisionó ese objeto específico. Debes actualizar con frecuencia las tarjetas de lealtad individuales para reflejar los cambios que afectan a tus clientes y mantenerlos interesados. El valor resourceId sería el ID del objeto (ISSUER_ID.OBJECT_SUFFIX).

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

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