Эта страница переведена с помощью Cloud Translation API.

Создание классов проходов и объектов проходов

Почти все пропуски, которые вы можете выдать конечному пользователю для сохранения в своем Google Кошельке, определяются двумя компонентами: классом пропусков и объектом пропусков. Каждый раз, когда вы выдаете пропуск пользователю, вам понадобится экземпляр класса Passes и объекта Passes, который сообщает API Google Wallet, какой тип пропуска нужно создать, а также детали, которые нужно отобразить на пропуске, например стоимость подарочной карты или имя владельца билета.

API Google Кошелька предоставляет предопределенный набор классов Passes и объектов Passes, экземпляры которых вы создаете, а затем используете для создания пропуска, выдаваемого пользователю, например GiftCardClass и GiftCardObject , GenericClass и GenericObject и другие.

Каждый экземпляр класса Passes и объекта Passes определяется как объект JSON, который имеет набор обязательных и дополнительных свойств, соответствующих конкретному варианту использования, предназначенному для этого типа прохода.

Создайте класс пропусков

Класс пропусков можно рассматривать как общий шаблон, на основе которого создаются проходы. Класс проходов определяет определенные свойства, которые будут включены во все проходы, которые его используют. Эмитент пропуска может создать несколько классов, каждый со своим собственным набором свойств, определяющих такие атрибуты, как стиль и внешний вид, а также дополнительные функции, такие как Smart Tap, а также регистрацию и вход в систему.

Классы Passes можно создавать с помощью REST API Google Кошелька, Google Wallet Android SDK или в бизнес-консоли Google Wallet.

Для новых пользователей бизнес-консоль — это самый простой способ начать работу с созданием класса Passes, поскольку она предоставляет простой пользовательский интерфейс, в котором вы можете определить различные поля вашего первого класса Passes, заполнив поля формы.

Для опытных пользователей лучшим подходом является программное создание классов Passes.

Используйте бизнес-консоль Google Кошелька

Чтобы создать класс Passes в консоли Google Wallet Business, выполните следующие действия:

Перейдите в бизнес-консоль Google Pay и Wallet и войдите в свою учетную запись эмитента API Google Кошелька.
На карточке «API Google Кошелька» нажмите кнопку «Управление пропусками».
В разделе «Получить доступ к публикации» нажмите кнопку «Создать курс».
Выберите тип пропуска в диалоговом окне. Google Кошелек предлагает различные типы пропусков (билет на мероприятие, предложение, карта лояльности и т. д.). Для гибкого варианта использования выберите «Общий» в качестве типа пропуска.
Заполните соответствующие значения в обязательных полях.
Нажмите кнопку «Создать класс», чтобы сохранить класс.

Используйте REST API Google Кошелька.

Чтобы создать класс пропусков с помощью REST API Google Кошелька, отправьте запрос POST на адрес https://walletobjects.googleapis.com/walletobjects/v1/transitClass . Дополнительную информацию смотрите в справочной документации .

Ява

Чтобы начать интеграцию с 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, ознакомьтесь с полными примерами кода на 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#, ознакомьтесь с полными примерами кода на 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, ознакомьтесь с нашими полными примерами кода на 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)
	}
}

Создайте объект пропусков

Объект Passes является экземпляром класса Passes. Чтобы создать объект Passes, необходимо предоставить следующие атрибуты:

classId : id класса Passes.

id : уникальный идентификатор вашего клиента.

Дополнительную информацию о том, как эти атрибуты представлены в транзитном проездном, см. в шаблоне макета .

Пример кода для создания объекта Passes:

Ява