Esta página foi traduzida pela API Cloud Translation.

Criar classes de cartões e objetos de cartões

Quase todos os cartões que você pode emitir para um usuário final salvar na Carteira do Google são definidos por dois componentes: uma classe de cartões e um objeto de cartões. Sempre que você emitir um cartão para um usuário, você vai precisar de uma instância de uma classe de cartões e de um objeto de cartões, que informa à API Google Wallet qual tipo de cartão deve ser criado, além de detalhes a serem exibidos no cartão, como o valor de um vale-presente ou o nome de um titular.

A API Google Wallet oferece um conjunto predefinido de classes e objetos de cartão que você cria instâncias para gerar um cartão emitido para um usuário, como GiftCardClass e GiftCardObject, GenericClass e GenericObject, entre outros.

Cada instância de objeto de cartões e classe de cartões é definida como um objeto JSON, que tem um conjunto de propriedades obrigatórias e opcionais que correspondem ao caso de uso específico destinado ao tipo de cartão.

Criar uma classe de cartões

Uma classe de cartões pode ser considerada um modelo compartilhado que serve de base para a criação de cartões. Uma classe de cartões define certas propriedades que serão incluídas em todos os cartões que a utilizam. Um emissor de cartão pode criar várias classes, cada uma com o próprio conjunto distinto de propriedades que definem atributos como estilo e aparência, além de recursos adicionais, como Toque inteligente e inscrição e login.

As classes de cartão podem ser criadas usando a API REST da Carteira do Google, o SDK da Carteira do Google para Android ou no Console Business da Carteira do Google.

Para novos usuários, o Business Console é a maneira mais fácil de começar a criar uma classe de cartões, porque oferece uma interface de usuário simples, em que é possível definir os vários campos da sua primeira classe de cartões preenchendo os campos de formulário.

Para usuários avançados, a melhor abordagem é criar classes de cartões programaticamente.

Usar o Business Console da Carteira do Google

Para criar uma classe de cartões no Console Business da Carteira do Google, faça o seguinte:

Acesse o Business Console do Google Pay e da Carteira e faça login com sua conta de emissor da API Google Wallet.
No cartão "API Google Wallet", clique no botão "Gerenciar cartões".
Em "Obter acesso de publicação", clique no botão "Criar uma classe".
Escolha um tipo de cartão na caixa de diálogo. A Carteira do Google oferece vários tipos de cartão (ingressos para eventos, ofertas, cartões de fidelidade etc.). Para um caso de uso flexível, selecione "Genérico" como o tipo de cartão.
Preencha os valores adequados para os campos obrigatórios.
Clique no botão "Criar classe" para salvar sua turma.

Usar a API REST da Carteira do Google

Para criar uma classe de cartões usando a API REST da Carteira do Google, envie uma solicitação POST para https://walletobjects.googleapis.com/walletobjects/v1/giftCardClass. Para mais informações, consulte a documentação de referência.

Java

Para iniciar sua integração em Java, consulte nossos exemplos de código completos no GitHub (em inglês).

/**
 * 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 iniciar sua integração no PHP, consulte nossos exemplos de código completos no GitHub (em inglês).

/**
 * 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 iniciar sua integração no Python, consulte nossos exemplos completos de código no GitHub (em inglês).

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 iniciar sua integração em C#, consulte nossos exemplos de código completos no GitHub (em inglês).

/// <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 iniciar sua integração no Node, consulte nossos exemplos de código completos no GitHub (em inglês).

/**
 * 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 iniciar sua integração em Go, consulte nossos exemplos de código completos no GitHub (em inglês).

// 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)
	}
}

Criar um objeto de cartão

Um objeto de cartões é uma instância de uma classe de cartões. Para criar um objeto de cartões, é preciso fornecer os seguintes atributos:

classId: o id da classe de cartões

id: um ID exclusivo para o cliente

Consulte o modelo de layout para mais informações sobre como esses atributos são representados no vale-presente.

Exemplo de código para criar um objeto de cartões: