REST Resource: genericobject

Kaynak: GenericObject

Genel Nesne

JSON gösterimi 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Alanlar
genericType

enum (GenericType)

Kartın ait olduğu GenericType öğesini belirtin.
cardTitle

object (LocalizedString)

Zorunlu. Kartın üstbilgisi. Bu genellikle işletmenin adı olur (ör. "XXX Spor Salonu", "AAA Sigorta"). Bu alan zorunludur ve geçişin en üst kısmındaki başlık satırında görünür.
subheader

object (LocalizedString)

Kartın başlık etiketi (ör. kartın kullanılabileceği konum). Kart ayrıntıları görünümünde başlık satırında başlığın hemen üstünde görünür.
header

object (LocalizedString)

Zorunlu. "%50 indirim kuponu", "Kütüphane kartı" veya "Kupon" gibi kartın başlığı. Bu alan zorunludur ve geçiş ayrıntıları görünümünün başlık satırında görünür.
hexBackgroundColor

string

Kartın arka plan rengi. Ayarlanmamışsa hero resminin baskın rengi kullanılır. Hero resmi ayarlanmamışsa logonun baskın rengi kullanılır. Logo ayarlanmamışsa Google tarafından bir renk seçilir.
notifications

object (Notifications)

Bu nesne için etkinleştirilen bildirim ayarları.
id

string

Zorunlu. Bir nesnenin benzersiz tanımlayıcısı. Bu kimlik, bir verenin tüm nesneleri arasında benzersiz olmalıdır. Bu değerin, issuerID'ın Google tarafından verildiği ve identifier'nin sizin tarafınızdan seçildiği issuerID.identifier biçimini izlemesi gerekir. Benzersiz tanımlayıcı yalnızca alfanümerik karakterler, ., _ veya - içerebilir.
classId

string

Zorunlu. Bu nesneyle ilişkili sınıf. Sınıf, bu nesneyle aynı türde olmalı, zaten mevcut olmalı ve onaylanmalıdır.

Sınıf kimlikleri, issuerID'ın Google tarafından, identifier'nin ise sizin tarafınızdan seçildiği issuerID.identifier biçimini izlemelidir.
barcode

object (Barcode)

Barkod türü ve değeri. Kartın barkodu yoksa kartın sağlayıcısının Barcode.alternate_text değerini ayarlayarak yalnızca bu değeri göstermesine izin verebiliriz.
heroImage

object (Image)

Kartın ön tarafında gösterilen banner resmi (varsa). Resim% 100 genişlikte gösterilir.
validTimeInterval

object (TimeInterval)

Bu nesnenin geçerli veya kullanılabilir olarak kabul edileceği dönem. Süre geçtiğinde nesne süresi dolmuş olarak kabul edilir. Bu durum, kullanıcının cihazlarında oluşturmayı etkiler.
imageModulesData[]

object (ImageModuleData)

Resim modülü verileri. Her ikisi de ayarlandığında sınıftaki resimden ve nesne düzeyindeki resimden yalnızca biri oluşturulur.
textModulesData[]

object (TextModuleData)

Metin modülü verileri. Sınıfta textModulesData da tanımlanmışsa her ikisi de gösterilir. Bu alanların gösterilen maksimum sayısı sınıftan 10 ve nesneden 10'dur.
groupingInfo

object (GroupingInfo)

Kartların nasıl gruplandırılacağını kontrol eden bilgiler.
smartTapRedemptionValue

string

Bu nesne için NFC üzerinden Smart Tap sertifikalı bir terminale iletilecek değer. Kartın Akıllı Dokunma'yı desteklemesi için sınıf düzeyindeki enableSmartTap ve redemptionIssuers alanları da doğru şekilde ayarlanmalıdır. Yalnızca ASCII karakterler desteklenir.
rotatingBarcode

object (RotatingBarcode)

Dönen barkod ayarları/ayrıntıları.
state

enum (State)

Nesnenin durumu. Bu alan, bir nesnenin uygulamada nasıl gösterileceğini belirlemek için kullanılır. Örneğin, inactive nesnesi "Süresi dolmuş kartlar" bölümüne taşınır. Bu sağlanmazsa nesne ACTIVE olarak kabul edilir.
hasUsers

boolean

Nesnenin kullanıcısı olup olmadığını belirtir. Bu alan platform tarafından belirlenir.
messages[]

object (Message)

Uygulamada gösterilen bir mesaj dizisi. Bu nesnenin tüm kullanıcıları, ilişkili mesajları alır. Bu alanların maksimum sayısı 10'dur.
passConstraints

object (PassConstraints)

Nesne için kısıtlamaları iletin. NFC ve ekran görüntüsü davranışlarını sınırlama da buna dahildir.
saveRestrictions

object (SaveRestrictions)

Kullanıcı geçişi kaydetmeye çalışmadan önce doğrulanması gereken nesne kısıtlamaları. Bu kısıtlamaların yalnızca kayıt sırasında uygulanacağını unutmayın. Kullanıcı geçişi kaydettikten sonra kısıtlamalar değişirse yeni kısıtlamalar, önceden kaydedilmiş geçişlere uygulanmaz.
valueAddedModuleData[]

object (ValueAddedModuleData)

İsteğe bağlı katma değer modülü verileri. Nesnede en fazla on tane olabilir.
linkedObjectIds[]

string

linkedObjectIds, bu genel nesneye otomatik olarak eklenmesi gereken etkinlik bileti, bağlılık, teklif, genel, hediye kartı, toplu taşıma ve biniş kartı gibi diğer nesnelerin bir listesidir. Kullanıcı bu genel kartı kaydettiyse bu linkedObjectIds, kullanıcının cüzdanına otomatik olarak gönderilir (bu tür bağlı kartları alma ayarını devre dışı bırakmadığı sürece).

linkedObjectIds'de bulunan nesnelerin zaten eklendiğinden emin olun. Aksi takdirde çağrılar başarısız olur. Bağlı nesnelerin bağlantısı kaldırılamaz. Başka bir ihraççının nesnelerini bağlayamazsınız. Tek bir nesneye bağlanabilecek nesne sayısı sınırlıdır. Sınıra ulaşıldığında görüşmedeki yeni bağlı nesneler sessizce yoksayılır.

Nesne kimlikleri issuer ID biçimini izlemelidir.identifier. Bunlardan ilki Google tarafından, ikincisi ise sizin tarafınızdan seçilir.

GenericType

Genel kartın türü.

Sıralamalar
GENERIC_TYPE_UNSPECIFIED Belirtilmemiş genel tür.
GENERIC_SEASON_PASS Tüm sezon
GENERIC_UTILITY_BILLS Altyapı hizmeti faturaları
GENERIC_PARKING_PASS Otopark kartı
GENERIC_VOUCHER Kupon
GENERIC_GYM_MEMBERSHIP Spor salonu üyelik kartları
GENERIC_LIBRARY_MEMBERSHIP Kütüphane üyelik kartları
GENERIC_RESERVATIONS Rezervasyonlar
GENERIC_AUTO_INSURANCE Araç sigortası kartları
GENERIC_HOME_INSURANCE Ev sigortası kartları
GENERIC_ENTRY_TICKET Giriş biletleri
GENERIC_RECEIPT Faturalar
GENERIC_LOYALTY_CARD Bağlılık kartları. Bu genel tür yerine özel bir Bağlılık kartı geçiş türü kullanılmasının önerilir. Özel bağlılık kartı bilet türü, genel bilet türünden daha fazla özellik ve işlev sunar.
GENERIC_OTHER Diğer tür

Bildirimler

Nesnenin bildirim etkinleştirilmesinin gerekip gerekmediğini belirtir. ExpiryNotification/UpcomingNotification özelliklerinden yalnızca birini destekleriz. expiryNotification, upcomingNotification'a göre daha önceliklidir. Diğer bir deyişle, expiryNotification ayarlanırsa upcomingNotification alanı yoksayılır.

JSON gösterimi 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Alanlar
expiryNotification

object (ExpiryNotification)

Kartın süresi dolmadan belirli bir zamanda bildirim tetiklenir.
upcomingNotification

object (UpcomingNotification)

Kart kullanılabilir hale gelmeden önce belirli bir zamanda bildirim tetiklenir.

ExpiryNotification

Kartı verenin, Google Cüzdan'ın kartın geçerlilik süresinin bitmesinden 2 gün önce son kullanma bildirimi göndermesini istediğini gösterir.

JSON gösterimi 
{
  "enableNotification": boolean
}
Alanlar
enableNotification

boolean

Nesnenin geçerlilik süresi bildiriminin etkinleştirilmesi gerekip gerekmediğini belirtir.

UpcomingNotification

Kartın geçerli/kullanılabilir hale gelmesinden 1 gün önce kart geçerlilik bildirimi gönderilmesini isteyen kart vereni gösterir.

JSON gösterimi 
{
  "enableNotification": boolean
}
Alanlar
enableNotification

boolean

Nesnenin yaklaşan bildirim özelliğinin etkinleştirilmesi gerekip gerekmediğini belirtir.

Yöntemler

addmessage

 Belirtilen nesne kimliği tarafından referans verilen genel nesneye bir mesaj ekler.

get

 Belirtilen nesne kimliğine sahip genel nesneyi döndürür.

insert

 Belirtilen kimliğe ve özelliklere sahip genel bir nesne ekler.

list

 Belirli bir veren kimliği için tüm genel nesnelerin listesini döndürür.

patch

 Belirtilen nesne kimliğinin referans verdiği genel nesneyi günceller.

update

 Belirtilen nesne kimliğinin referans verdiği genel nesneyi günceller.