此页面由 Cloud Translation API 翻译。

创建卡券类和卡券对象

您可以发行供最终用户保存在其 Google 钱包中的所有卡券几乎都由两个组件定义：卡券类和卡券对象。每当您向用户发放卡券时，您都需要卡券类和卡券对象的一个实例，用于告知 Google Wallet API 要构建哪种类型的卡券，以及卡券上显示的详细信息，如礼品卡值或持票人姓名。

Google Wallet API 提供了一组预定义的卡券类和卡券对象，您可以为其创建实例，然后用于创建发放给用户的卡券，例如 GiftCardClass 和 GiftCardObject、GenericClass 和 GenericObject 等。

每个卡券类和卡券对象实例均定义为一个 JSON 对象，其中包含一组必需属性和可选属性，这些属性与用于该卡券类型的特定用例相对应。

创建卡券类

卡券类可以视为据以创建卡券的共享模板。卡券类定义了一些属性，这些属性将包含在使用该类的所有卡券中。卡券发行方可以创建多个类，每个类都有自己的一组独特属性，这些属性定义样式和外观等属性以及智能触碰、注册和登录等附加功能。

卡券类可以使用 Google Wallet REST API、Google Wallet Android SDK 或 Google 钱包商家控制台创建。

对于新用户来说，使用商家控制台是着手创建卡券类的最简单方法，因为它提供了简单的界面，您可以通过填写表单字段来定义第一个卡券类的各个字段。

对于高级用户来说，以编程方式创建卡券类是最佳方法。

使用 Google 电子钱包商家控制台

如需在 Google 钱包商家控制台中创建卡券类，请执行以下操作：

转到 Google Pay 和钱包业务控制台，使用您的 Google Wallet API 发行方帐号登录。
在“Google Wallet API”卡片上，点击“管理卡券”按钮。
在“获取发布权限”下，点击“创建课程”按钮。
从对话框中选择一种卡券类型。Google 电子钱包提供各种卡券类型（活动门票、优惠、会员卡等）。如需灵活的使用情形，请选择“Generic”作为卡券类型。
在必填字段中填写相应的值。
点击“创建课程”按钮保存您的课程。

使用 Google Wallet REST API

如需使用 Google Wallet REST API 创建卡券类，请向 https://walletobjects.googleapis.com/walletobjects/v1/transitClass 发送 POST 请求。如需了解详情，请参阅参考文档。

Java

如需开始使用 Java 进行集成，请参阅 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.transitclass().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/tickets/transit-passes/qr-code/rest/v1/transitclass
  TransitClass newClass =
      new TransitClass()
          .setId(String.format("%s.%s", issuerId, classSuffix))
          .setIssuerName("Issuer name")
          .setReviewStatus("UNDER_REVIEW")
          .setLogo(
              new Image()
                  .setSourceUri(
                      new ImageUri()
                          .setUri(
                              "https://live.staticflickr.com/65535/48690277162_cd05f03f4d_o.png"))
                  .setContentDescription(
                      new LocalizedString()
                          .setDefaultValue(
                              new TranslatedString()
                                  .setLanguage("en-US")
                                  .setValue("Logo description"))))
          .setTransitType("BUS");

  TransitClass response = service.transitclass().insert(newClass).execute();

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

  return response.getId();
}

PHP

如要开始使用 PHP 进行集成，请参阅 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->transitclass->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/tickets/transit-passes/qr-code/rest/v1/transitclass
  $newClass = new TransitClass([
    'id' => "{$issuerId}.{$classSuffix}",
    'issuerName' => 'Issuer name',
    'reviewStatus' => 'UNDER_REVIEW',
    'logo' => new Image([
      'sourceUri' => new ImageUri([
        'uri' => 'https://live.staticflickr.com/65535/48690277162_cd05f03f4d_o.png'
      ]),
      'contentDescription' => new LocalizedString([
        'defaultValue' => new TranslatedString([
          'language' => 'en-US',
          'value' => 'Logo description'
        ])
      ])
    ]),
    'transitType' => 'BUS'
  ]);

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

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

  return $response->id;
}

Python

如需开始使用 Python 进行集成，请参阅 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.transitclass().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/tickets/transit-passes/qr-code/rest/v1/transitclass
    new_class = {
        'id': f'{issuer_id}.{class_suffix}',
        'issuerName': 'Issuer name',
        'reviewStatus': 'UNDER_REVIEW',
        'logo': {
            'sourceUri': {
                'uri':
                    'https://live.staticflickr.com/65535/48690277162_cd05f03f4d_o.png'
            },
            'contentDescription': {
                'defaultValue': {
                    'language': 'en-US',
                    'value': 'Logo description'
                }
            }
        },
        'transitType': 'BUS'
    }

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

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

    return f'{issuer_id}.{class_suffix}'

C#

如需开始使用 C# 进行集成，请参阅 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.Transitclass
      .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/tickets/transit-passes/qr-code/rest/v1/transitclass
  TransitClass newClass = new TransitClass
  {
    Id = $"{issuerId}.{classSuffix}",
    IssuerName = "Issuer name",
    ReviewStatus = "UNDER_REVIEW",
    Logo = new Image
    {
      SourceUri = new ImageUri
      {
        Uri = "https://live.staticflickr.com/65535/48690277162_cd05f03f4d_o.png"
      },
      ContentDescription = new LocalizedString
      {
        DefaultValue = new TranslatedString
        {
          Language = "en-US",
          Value = "Logo description"
        }
      }
    },
    TransitType = "BUS"
  };

  responseStream = service.Transitclass
      .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

如需开始在 Node 中进行集成，请参阅 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.transitclass.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/tickets/transit-passes/qr-code/rest/v1/transitclass
  let newClass = {
    'id': `${issuerId}.${classSuffix}`,
    'issuerName': 'Issuer name',
    'reviewStatus': 'UNDER_REVIEW',
    'logo': {
      'sourceUri': {
        'uri': 'https://live.staticflickr.com/65535/48690277162_cd05f03f4d_o.png'
      },
      'contentDescription': {
        'defaultValue': {
          'language': 'en-US',
          'value': 'Logo description'
        }
      }
    },
    'transitType': 'BUS'
  };

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

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

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

Go

如需开始使用 Go 进行集成，请参阅 GitHub 上 GitHub 上的完整代码示例。

// Create a class.
func (d *demoTransit) createClass(issuerId, classSuffix string) {
	logo := walletobjects.Image{
		SourceUri: &walletobjects.ImageUri{
			Uri: "http://farm8.staticflickr.com/7340/11177041185_a61a7f2139_o.jpg",
		},
	}
	transitClass := new(walletobjects.TransitClass)
	transitClass.Id = fmt.Sprintf("%s.%s", issuerId, classSuffix)
	transitClass.IssuerName = "Issuer name"
	transitClass.ReviewStatus = "UNDER_REVIEW"
	transitClass.Logo = &logo
	transitClass.TransitType = "BUS"
	res, err := d.service.Transitclass.Insert(transitClass).Do()
	if err != nil {
		log.Fatalf("Unable to insert class: %v", err)
	} else {
		fmt.Printf("Class insert id:\n%v\n", res.Id)
	}
}

创建卡券对象

卡券对象是卡券类的一个实例。若要创建卡券对象，您必须提供以下属性：

classId：卡券类的 id

id：您的客户的唯一 ID

如需详细了解如何在公交卡中表示这些属性，请参阅布局模板。

用于创建卡券对象的代码示例：