REST Resource: genericobject

Kaynak: GenelObject

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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Alanlar
genericType

enum (GenericType)

Kartın ait olduğu GenericType belirtin.
cardTitle

object (LocalizedString)

Zorunlu. Kartın başlığı. Bu genellikle "XXX Spor Salonu", "AAA Sigorta" gibi bir İşletme adıdır. Bu alan, gereklidir ve kartın en üstündeki başlık satırında görünür.
subheader

object (LocalizedString)

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

object (LocalizedString)

Zorunlu. Kartın başlığı (ör. "%50 kupon indirimi") veya "Kütüphane kartı" veya "Kupon" yazın. Bu alan zorunludur ve kart 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. Ayarlanmazsa hero resmin baskın rengi kullanılır. Lokomotif resim ayarlanmamışsa logonun baskın rengi kullanılır. Logo ayarlanmazsa 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ıdır. Bu kimlik, bir kartı veren kuruluşa ait tüm nesneler arasında benzersiz olmalıdır. Bu değerin, issuerID değerinin Google tarafından verildiği ve identifier değerinin sizin tarafınızdan seçildiği issuerID.identifier biçimine uygun olması gerekir. Benzersiz tanımlayıcı yalnızca alfanümerik karakterler, ., _ veya - içerebilir.
classId

string

Zorunlu. Bu nesneyle ilişkilendirilen sınıf. Sınıfın bu nesne ile aynı türde olması, zaten mevcut olması ve onaylanması gerekir.

Sınıf kimlikleri, issuerID değerinin Google tarafından verildiği ve identifier değerinin sizin tarafınızdan seçildiği issuerID.identifier biçiminde olmalıdır.
barcode

object (Barcode)

Barkod türü ve değeri. Kartın barkodu yoksa kartı veren kuruluşun Barcode.alternatif_metin'i ayarlamasına ve sadece onu görüntülemesine izin verebiliriz.
heroImage

object (Image)

Varsa kartın önünde gösterilen banner resmi. Resim, %100 genişlikte görüntülenir.
validTimeInterval

object (TimeInterval)

Bu nesnenin geçerli veya kullanılabilir olarak kabul edileceği dönem. Süre geçtiğinde, nesnenin süresinin dolmuş olduğu 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ıftan ve nesne düzeyinden yalnızca bir resim oluşturulur.
textModulesData[]

object (TextModuleData)

Metin modülü verileri. Sınıfta textModulesData politikası da tanımlanmışsa her ikisi de gösterilir. Bu alanlardan en fazla 10 tanesi sınıftan ve 10 nesneden oluşabilir.
groupingInfo

object (GroupingInfo)

Kartların birlikte nasıl gruplandırılacağını belirleyen bilgiler.
smartTapRedemptionValue

string

Bu nesne için NFC üzerinden Smart Tap sertifikalı bir terminale iletilecek değer. Kartın Akıllı Ödeme'yi desteklemesi için enableSmartTap ve redemptionIssuers sınıf düzeyi alanlarının da doğru şekilde ayarlanması gerekir. 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örüntüleneceğini belirlemek için kullanılır. Örneğin, bir inactive nesnesi "Süresi dolmuş kartlar"a taşınır bölümüne ekleyin. Sağlanmazsa nesne ACTIVE olarak kabul edilir.
hasUsers

boolean

Nesnenin kullanıcı olup olmadığını belirtir. Bu alan platform tarafından ayarlanır.
passConstraints

object (PassConstraints)

Nesne için kısıtlamaları aktarın. NFC ve ekran görüntüsü alma davranışlarını sınırlandırır.
saveRestrictions

object (SaveRestrictions)

Kullanıcının kartı kaydetmeye çalışmadan önce doğrulanması gereken nesneyle ilgili kısıtlamalar. Bu kısıtlamaların yalnızca programdan yararlanma süresi boyunca geçerli olacağını unutmayın. Kullanıcı kartı kaydettikten sonra kısıtlamalar değişirse yeni kısıtlamalar daha önce kaydedilmiş kartlara uygulanmaz.

GenericType

Genel kartın türü.

Sıralamalar
GENERIC_TYPE_UNSPECIFIED Belirtilmemiş genel tür.
GENERIC_SEASON_PASS Tüm sezon
GENERIC_UTILITY_BILLS Su/elektrik/doğalgaz/internet 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 Otomobil sigortası kartları
GENERIC_HOME_INSURANCE Ev sigortası kartları
GENERIC_ENTRY_TICKET Giriş biletleri
GENERIC_RECEIPT Faturalar
GENERIC_OTHER Diğer tür

Bildirimler

Nesnede bildirimin etkinleştirilmesi gerekip gerekmediğini belirtir. Expiry Notification/Previous Notification yalnızca bir tanesini destekleriz. expiryNotification, upcomingNotification özelliğine göre önceliklidir. Diğer bir deyişle, expiryNotification ayarlanırsa upcomingNotification alanını yok sayarız.

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

object (ExpiryNotification)

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

object (UpcomingNotification)

Kart kullanılabilir hâle gelmeden önce belirli bir zamanda bir bildirim tetiklenir.

ExpiryNotification

Kartı veren kuruluşun, Google Cüzdan'ın kartın son kullanma tarihinden 2 gün önce geçerlilik süresiyle ilgili bildirim göndermesini istediğini belirtir.

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

boolean

Nesne için süre sonu bildiriminin etkinleştirilmesi gerekip gerekmediğini belirtir.

UpcomingNotification

Kartı veren kuruluşun, kartın geçerli/kullanılabilir hale gelmesinden 1 gün önce Google Cüzdan'ın yaklaşan bir kart geçerlilik bildirimi göndermesini istediğini belirtir.

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

boolean

Nesnede, yaklaşan bildirimin etkinleştirilmesi gerekip gerekmediğini belirtir.

Yöntemler

addmessage

 Belirtilen nesne kimliğinin başvuruda bulunduğu genel nesneye bir mesaj ekler.

get

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

insert

 Verilen 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 başvuruda bulunduğu genel nesneyi günceller.

update

 Belirtilen nesne kimliğinin başvuruda bulunduğu genel nesneyi günceller.