本頁面由 Cloud Translation API 翻譯而成。

建立票證類別和票證物件

凡是可發出供使用者儲存在 Google 錢包中的票證，幾乎都由兩個元件定義：票證類別和票證物件。每次核發票證給使用者時，您必須同時建立「Pass 類別」和「Pass 物件」，以便 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 錢包提供各種票證類型 (活動票券、優惠、會員卡等)。如果是彈性用途，請選取「一般」做為票證類型
為必填欄位填入適當的值。
按一下「建立課程」按鈕即可儲存課程。

使用 Google Wallet REST API

如要使用 Google Wallet REST API 建立 Passes 類別，請傳送 POST 要求至 https://walletobjects.googleapis.com/walletobjects/v1/offerClass。詳情請參閱參考說明文件。

Java

如要開始在 Java 中整合，請參閱我們提供的完整查看程式碼範例

/**
 * 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.offerclass().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/offers/rest/v1/offerclass
  OfferClass newClass =
      new OfferClass()
          .setId(String.format("%s.%s", issuerId, classSuffix))
          .setIssuerName("Issuer name")
          .setReviewStatus("UNDER_REVIEW")
          .setProvider("Provider name")
          .setTitle("Offer title")
          .setRedemptionChannel("ONLINE");

  OfferClass response = service.offerclass().insert(newClass).execute();

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

  return response.getId();
}

PHP

如要在 PHP 中開始整合，請參閱我們提供的完整查看程式碼範例

/**
 * 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->offerclass->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/offers/rest/v1/offerclass
  $newClass = new OfferClass([
    'id' => "{$issuerId}.{$classSuffix}",
    'issuerName' => 'Issuer name',
    'reviewStatus' => 'UNDER_REVIEW',
    'provider' => 'Provider name',
    'title' => 'Offer title',
    'redemptionChannel' => 'ONLINE'
  ]);

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

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

  return $response->id;
}

Python

如要開始以 Python 進行整合，請參閱我們提供的完整查看程式碼範例

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.offerclass().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/offers/rest/v1/offerclass
    new_class = {
        'id': f'{issuer_id}.{class_suffix}',
        'issuerName': 'Issuer name',
        'reviewStatus': 'UNDER_REVIEW',
        'provider': 'Provider name',
        'title': 'Offer title',
        'redemptionChannel': 'ONLINE'
    }

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

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

    return f'{issuer_id}.{class_suffix}'

C#

如要開始在 C# 中整合，請參閱我們提供的完整查看程式碼範例

/// <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.Offerclass
      .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/offers/rest/v1/offerclass
  OfferClass newClass = new OfferClass
  {
    Id = $"{issuerId}.{classSuffix}",
    IssuerName = "Issuer name",
    ReviewStatus = "UNDER_REVIEW",
    Provider = "Provider name",
    Title = "Offer title",
    RedemptionChannel = "ONLINE"
  };

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

如要在節點環境中展開整合作業，請參閱我們提供的完整查看程式碼範例

/**
 * 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.offerclass.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/offers/rest/v1/offerclass
  let newClass = {
    'id': `${issuerId}.${classSuffix}`,
    'issuerName': 'Issuer name',
    'reviewStatus': 'UNDER_REVIEW',
    'provider': 'Provider name',
    'title': 'Offer title',
    'redemptionChannel': 'ONLINE'
  };

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

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

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

Go

如要在 Go 中開始進行整合作業，請參閱 GitHub 上的完整程式碼範例 GitHub 上的程式碼範例。

// Create a class.
func (d *demoOffer) createClass(issuerId, classSuffix string) {
	offerClass := new(walletobjects.OfferClass)
	offerClass.Id = fmt.Sprintf("%s.%s", issuerId, classSuffix)
	offerClass.RedemptionChannel = "ONLINE"
	offerClass.ReviewStatus = "UNDER_REVIEW"
	offerClass.Title = "Offer title"
	offerClass.IssuerName = "Issuer name"
	offerClass.Provider = "Provider name"
	res, err := d.service.Offerclass.Insert(offerClass).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

詳情請參閱版面配置範本，進一步瞭解這些屬性在方案。

建立 Passes 物件的程式碼範例：