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

Crear clases Passes y Passes objetos

Casi todos los pases que puedes emitir para que un usuario final los guarde en su Billetera de Google se definen en función de dos componentes: una clase Passes y un objeto Passes. Cada vez que emitas un pase a un usuario, necesitarás una instancia de una clase Passes y un objeto Passes, que le indique a la API de la Billetera de Google qué tipo de pase debe construir y los detalles que se mostrarán en el pase, como el valor de la tarjeta de regalo o el nombre del titular de la entrada.

La API de la Billetera de Google proporciona un conjunto predefinido de clases Passes y objetos Passes de los que creas instancias y que luego usas para crear un pase que se emite a un usuario, como GiftCardClass y GiftCardObject, GenericClass y GenericObject, entre otros.

Cada instancia de clase Passes y objeto Passes se define como un objeto JSON, que tiene un conjunto de propiedades obligatorias y opcionales que corresponden al caso de uso específico para ese tipo de pase.

Crea una clase Passes

Las clases Passes pueden considerarse como una plantilla compartida a partir de la cual se crean pases. La clase Pases define ciertas propiedades que se incluirán en todos los pases que la usen. Una entidad emisora de pases puede crear varias clases, cada una con su propio conjunto distintivo de propiedades que definen atributos como el estilo y la apariencia, además de funciones adicionales como el Toque inteligente y la Inscripción y el acceso.

Las Clases de Pases se pueden crear con la API de REST de la Billetera de Google, el SDK de Android de la Billetera de Google o en la Billetera de Google Business Console.

Para los usuarios nuevos, Business Console es la forma más fácil de comenzar a crear una clase Passes, ya que proporciona una interfaz de usuario sencilla, en la que puedes definir los distintos campos de tu primera clase Passes completando los campos del formulario.

Para los usuarios avanzados, crear Clases Pases de manera programática es el mejor enfoque.

Usa Business Console de Google Wallet.

Para crear una clase Passes en la Consola de Business de la Billetera de Google, haz lo siguiente:

Ve a Google Pay y la Billetera Business Console y accede con tu cuenta de entidad emisora de la API de la Billetera de Google.
En la “API de la Billetera de Google” haz clic en el botón “Administrar pases” .
En "Obtener acceso de publicación", haz clic en el botón "Crear una clase". .
Elige un tipo de pase en el cuadro de diálogo. La Billetera de Google ofrece varios tipos de pases (entrada para evento, oferta, tarjeta de lealtad, etcétera). Para un caso de uso flexible, selecciona "Genérico" como el tipo de pase.
Completa los valores adecuados en los campos obligatorios.
Haz clic en el botón “Crear clase” para guardar la clase.

Usa la API de REST de la Billetera de Google

Para crear una clase Passes con la API de REST de la Billetera de Google, envía una solicitud POST a https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass. Para obtener más información, consulta la documentación de referencia.

Java

Para comenzar tu integración en Java, consulta nuestra guía completa muestras de código en GitHub.

/**
 * Create a class.
 *
 * @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 createClass(String issuerId, String classSuffix) throws IOException {
  // Check if the class exists
  try {
    service.giftcardclass().get(String.format("%s.%s", issuerId, classSuffix)).execute();

    System.out.printf("Class %s.%s already exists!%n", issuerId, classSuffix);
    return String.format("%s.%s", issuerId, classSuffix);
  } catch (GoogleJsonResponseException ex) {
    if (ex.getStatusCode() != 404) {
      // Something else went wrong...
      ex.printStackTrace();
      return String.format("%s.%s", issuerId, classSuffix);
    }
  }

  // See link below for more information on required properties
  // https://developers.google.com/wallet/retail/gift-cards/rest/v1/giftcardclass
  GiftCardClass newClass =
      new GiftCardClass()
          .setId(String.format("%s.%s", issuerId, classSuffix))
          .setIssuerName("Issuer name")
          .setReviewStatus("UNDER_REVIEW");

  GiftCardClass response = service.giftcardclass().insert(newClass).execute();

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

  return response.getId();
}

PHP

Para comenzar tu integración en PHP, consulta nuestra documentación muestras de código en GitHub.

/**
 * Create a class.
 *
 * @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 createClass(string $issuerId, string $classSuffix)
{
  // Check if the class exists
  try {
    $this->service->giftcardclass->get("{$issuerId}.{$classSuffix}");

    print("Class {$issuerId}.{$classSuffix} already exists!");
    return "{$issuerId}.{$classSuffix}";
  } catch (Google\Service\Exception $ex) {
    if (empty($ex->getErrors()) || $ex->getErrors()[0]['reason'] != 'classNotFound') {
      // Something else went wrong...
      print_r($ex);
      return "{$issuerId}.{$classSuffix}";
    }
  }

  // See link below for more information on required properties
  // https://developers.google.com/wallet/retail/gift-cards/rest/v1/giftcardclass
  $newClass = new GiftCardClass([
    'id' => "{$issuerId}.{$classSuffix}",
    'issuerName' => 'Issuer name',
    'reviewStatus' => 'UNDER_REVIEW'
  ]);

  $response = $this->service->giftcardclass->insert($newClass);

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

  return $response->id;
}

Python

Para comenzar tu integración en Python, consulta nuestra documentación muestras de código en GitHub.

def create_class(self, issuer_id: str, class_suffix: str) -> str:
    """Create a class.

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

    # See link below for more information on required properties
    # https://developers.google.com/wallet/retail/gift-cards/rest/v1/giftcardclass
    new_class = {
        'id': f'{issuer_id}.{class_suffix}',
        'issuerName': 'Issuer name',
        'reviewStatus': 'UNDER_REVIEW'
    }

    response = self.client.giftcardclass().insert(body=new_class).execute()

    print('Class insert response')
    print(response)

    return f'{issuer_id}.{class_suffix}'

C#

Para comenzar tu integración en C#, consulta nuestra muestras de código en GitHub.

/// <summary>
/// Create a class.
/// </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 CreateClass(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"))
  {
    Console.WriteLine($"Class {issuerId}.{classSuffix} already exists!");
    return $"{issuerId}.{classSuffix}";
  }
  else if (jsonResponse["error"].Value<int>("code") != 404)
  {
    // Something else went wrong...
    Console.WriteLine(jsonResponse.ToString());
    return $"{issuerId}.{classSuffix}";
  }

  // See link below for more information on required properties
  // https://developers.google.com/wallet/retail/gift-cards/rest/v1/giftcardclass
  GiftCardClass newClass = new GiftCardClass
  {
    Id = $"{issuerId}.{classSuffix}",
    IssuerName = "Issuer name",
    ReviewStatus = "UNDER_REVIEW"
  };

  responseStream = service.Giftcardclass
      .Insert(newClass)
      .ExecuteAsStream();

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

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

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

Node.js

Para comenzar tu integración en Node, consulta nuestra documentación muestras de código en GitHub.

/**
 * Create a class.
 *
 * @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 createClass(issuerId, classSuffix) {
  let response;

  // Check if the class exists
  try {
    response = await this.client.giftcardclass.get({
      resourceId: `${issuerId}.${classSuffix}`
    });

    console.log(`Class ${issuerId}.${classSuffix} already exists!`);

    return `${issuerId}.${classSuffix}`;
  } catch (err) {
    if (err.response && err.response.status !== 404) {
      // Something else went wrong...
      console.log(err);
      return `${issuerId}.${classSuffix}`;
    }
  }

  // See link below for more information on required properties
  // https://developers.google.com/wallet/retail/gift-cards/rest/v1/giftcardclass
  let newClass = {
    'id': `${issuerId}.${classSuffix}`,
    'issuerName': 'Issuer name',
    'reviewStatus': 'UNDER_REVIEW',
  };

  response = await this.client.giftcardclass.insert({
    requestBody: newClass
  });

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

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

Go

Para comenzar tu integración en Go, consulta nuestras muestras de código completas en GitHub. muestras de código en GitHub.

// Create a class.
func (d *demoGiftcard) createClass(issuerId, classSuffix string) {
	giftcardClass := new(walletobjects.GiftCardClass)
	giftcardClass.Id = fmt.Sprintf("%s.%s", issuerId, classSuffix)
	giftcardClass.IssuerName = "Issuer name"
	giftcardClass.ReviewStatus = "UNDER_REVIEW"
	res, err := d.service.Giftcardclass.Insert(giftcardClass).Do()
	if err != nil {
		log.Fatalf("Unable to insert class: %v", err)
	} else {
		fmt.Printf("Class insert id:\n%v\n", res.Id)
	}
}

Crea un objeto Passes

Un objeto Passes es una instancia de una clase Passes. Para crear pases En este objeto, debes proporcionar los siguientes atributos:

classId: La clase id de la clase Pases

id: Un ID único para tu cliente

Consulta las Plantilla de diseño para obtener más información sobre cómo se representan estos atributos en el tarjeta de regalo.

Muestra de código para crear un objeto Pases: