Engage SDK Perjalanan: Petunjuk integrasi teknis pihak ketiga

Google membuat platform di perangkat yang mengatur aplikasi pengguna menurut kategori dan memungkinkan pengalaman imersif baru untuk konsumsi dan penemuan konten aplikasi yang dipersonalisasi. Pengalaman layar penuh ini memberi partner developer peluang untuk menampilkan konten lengkap terbaik di saluran khusus di luar aplikasi mereka. Panduan ini berisi petunjuk bagi partner developer untuk mengintegrasikan konten perjalanan & acara mereka, menggunakan Engage SDK untuk mengisi area platform baru ini.

Detail integrasi

Terminologi

Integrasi ini mencakup jenis cluster berikut: Rekomendasi, Unggulan, Pemesanan, dan Lanjutkan Penelusuran.

  • Cluster Rekomendasi menampilkan saran perjalanan & acara yang dipersonalisasi dari setiap partner developer. Rekomendasi ini dapat dipersonalisasi untuk pengguna atau digeneralisasi (misalnya item yang sedang trending). Gunakan ini untuk menampilkan rekomendasi artikel, acara, penginapan, atau tempat menarik.

    • Cluster Rekomendasi dapat dibuat dari listingan ArticleEntity, EventEntity, LodgingEntity, PointOfInterestEntity, atau StoreEntity, tetapi tidak dapat berupa campuran berbagai jenis entity.

    Rekomendasi Anda menggunakan struktur berikut:

    • Cluster Rekomendasi: Tampilan UI yang berisi kelompok rekomendasi dari partner developer yang sama.

    • Entity: Objek yang mewakili satu item dalam cluster. Integrasi ini menawarkan beberapa entitas yang akan ditampilkan menggunakan Cluster Rekomendasi:

      • ArticleEntity: ArticleEntity mewakili rekomendasi untuk konten berbasis teks yang terkait dengan perjalanan & acara. Format ini dapat digunakan untuk artikel, postingan blog, konten pemasaran, cuplikan berita, dll.

        Gambar 1: UI yang menampilkan satu ArticleEntity dalam cluster Rekomendasi.
      • EventEntity: EventEntity mewakili peristiwa yang terjadi di masa mendatang. Waktu mulai peristiwa adalah informasi penting yang perlu disampaikan kepada pengguna.

        Gambar 2: UI yang menampilkan satu EventEntity dalam cluster Rekomendasi.
      • LodgingEntity: LodgingEntity mewakili akomodasi, seperti hotel, apartemen, rumah liburan untuk sewa jangka pendek dan jangka panjang.

        Gambar 3: UI yang menampilkan satu LodgingEntity dalam cluster Rekomendasi.
      • StoreEntity: StoreEntity mewakili toko, restoran, kafe, dll. StoreEntity menyoroti konten tempat tempat makan atau toko adalah bagian informasi penting yang perlu disampaikan kepada pengguna.

        Gambar 4: UI yang menampilkan satu StoreEntity dalam cluster Rekomendasi.
      • PointOfInterestEntity: PointOfInterestEntity mewakili tempat menarik seperti, SPBU, tempat acara, taman tema, museum, objek wisata, jalur pendakian, dll. Ini menyoroti konten dengan lokasi sebagai bagian informasi penting yang perlu disampaikan kepada pengguna. Alamat ini tidak boleh digunakan untuk penginapan, toko, atau tempat makan.

        Gambar 5: UI yang menampilkan satu PointOfInterestEntity dalam cluster Rekomendasi.
  • Cluster Pemesanan menampilkan konten yang baru-baru ini diakses oleh pengguna dari beberapa partner developer dalam satu pengelompokan UI. Setiap partner developer akan diizinkan untuk menyiarkan maksimum 10 entity di cluster Pemesanan.

    Konten reservasi Anda dapat menggunakan struktur berikut:

    • RestaurantReservationEntity: RestaurantReservationEntity mewakili reservasi untuk restoran atau kafe dan membantu pengguna melacak reservasi restoran mendatang atau yang sedang berlangsung.

      Gambar 6. UI menampilkan satu RestaurantReservationEntity dalam cluster Reservasi.
    • EventReservationEntity: EventReservationEntity mewakili reservasi untuk suatu acara dan membantu pengguna melacak reservasi acara mendatang atau yang sedang berlangsung. Peristiwa dapat mencakup, tetapi tidak terbatas pada, hal berikut:

      • Acara olahraga seperti reservasi untuk pertandingan sepak bola
      • Acara game seperti reservasi untuk eSports
      • Acara hiburan seperti reservasi untuk menonton film di bioskop, konser, teater, acara penandatanganan buku
      • Reservasi perjalanan atau tempat menarik seperti tur terpandu, tiket museum
      • Reservasi acara Sosial / Seminar / Konferensi
      • Reservasi sesi Pendidikan / Pelatihan
      Gambar 7. UI menampilkan satu EventReservationEntity dalam cluster Reservasi.
    • LodgingReservationEntity: LodgingEntityReservation mewakili pemesanan untuk penginapan perjalanan dan membantu pengguna melacak pemesanan hotel atau rental akomodasi mendatang atau yang sedang berlangsung.

      Gambar 8. UI menampilkan satu LodgingReservationEntity dalam cluster Reservasi.
    • TransportationReservationEntity: TransportationReservationEntity mewakili reservasi untuk transportasi dengan mode apa pun dan membantu pengguna melacak reservasi untuk penerbangan, feri, kereta, bus, layanan pesan-antar, atau kapal pesiar mendatang atau yang sedang berlangsung.

      Gambar 9. UI menampilkan satu TransportationReservationEntity dalam cluster Reservasi.
    • VehicleRentalReservationEntity: VehicleRentalReservationEntity mewakili reservasi rental kendaraan dan membantu pengguna melacak reservasi rental kendaraan mendatang atau yang sedang berlangsung.

      Gambar 10. UI menampilkan satu VehicleRentalReservationEntity dalam cluster Reservasi.
  • Cluster Unggulan menampilkan pilihan entity dari beberapa partner developer dalam satu pengelompokan UI. Akan ada satu cluster Unggulan yang ditampilkan di dekat bagian atas UI dengan penempatan prioritas di atas semua cluster Rekomendasi. Setiap partner developer akan diizinkan untuk menyiarkan hingga 10 entity di cluster Unggulan.

    • GenericFeaturedEntity: GenericFeaturedEntity berbeda dengan item Rekomendasi karena item Unggulan harus digunakan untuk satu konten teratas dari developer dan harus mewakili satu konten yang paling penting yang akan menarik dan relevan bagi pengguna.

      Gambar 11: UI yang menampilkan FeaturedCluster dengan daftar GenericFeaturedEntity
  • Cluster Lanjutkan Penelusuran membantu pengguna melanjutkan perjalanan penelusuran perjalanan mereka sebelumnya dengan menampilkan daftar kueri penelusuran yang baru-baru ini ditelusuri pengguna di semua aplikasi perjalanan mereka. Cluster akan disematkan di posisi kedua, setelah reservasi dan sebelum cluster rekomendasi dan unggulan. Setiap partner developer akan diizinkan untuk menyiarkan maksimal 3 entity di cluster Lanjutkan Penelusuran.

    • PointOfInterestEntity: PointOfInterestEntity mewakili tempat menarik seperti, SPBU, tempat acara, taman hiburan, museum, objek wisata, jalur pendakian, dll. Ini menyoroti konten yang sebelumnya ditelusuri pengguna.

Persiapan

Level API minimum: 19

Tambahkan library com.google.android.engage:engage-core ke aplikasi Anda:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.5.2'
}

Ringkasan

Desain ini didasarkan pada implementasi layanan terikat.

Data yang dapat dipublikasikan klien tunduk pada batas berikut untuk berbagai jenis cluster:

Jenis cluster Batas cluster Batas entity minimum dalam cluster Batas maksimum entity dalam cluster
Cluster Rekomendasi Maksimal 5 Minimal 5 Maksimal 25 (ArticleEntity, EventEntity, LodgingEntity, StoreEntity, atau PointOfInterestEntity)
Cluster Reservasi Maksimal 1 Minimal 1 Maksimal 10 (RestaurantReservationEntity, EventReservationEntity, LodgingReservationEntity, TransportationReservationEntity, atau VehicleRentalReservationEntity)
Cluster Unggulan Maksimal 1 Minimal 1 Maksimal 10 (GenericFeaturedEntity)
Lanjutkan Cluster Penelusuran Maksimal 1 Minimal 1 Maksimal 3 (PointOfInterestEntity)

Langkah 1: Memberikan data entity

SDK telah menentukan entity yang berbeda untuk mewakili setiap jenis item. Kami mendukung entity berikut untuk kategori Perjalanan & Acara:

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. EventEntity
  4. LodgingEntity
  5. StoreEntity
  6. PointOfInterestEntity
  7. RestaurantReservationEntity
  8. EventReservationEntity
  9. LodgingReservationEntity
  10. TransportationReservationEntity
  11. VehicleRentalReservationEntity

Diagram di bawah ini menguraikan atribut dan persyaratan yang tersedia untuk setiap jenis.

GenericFeaturedEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Gambar poster Wajib

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Catatan: Jika badge disediakan, pastikan ruang aman sebesar 24 dp di bagian atas dan bawah gambar

Lihat Spesifikasi Gambar untuk panduan.
Judul Opsional Judul entity.

Teks bebas

Ukuran teks yang direkomendasikan: 50 karakter

Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

Badge Opsional

Setiap badge adalah teks bebas (maks. 15 karakter) atau gambar kecil.

Perlakuan UX khusus di atas gambar/video, Misalnya, sebagai overlay badge pada gambar

  • "Pembaruan langsung"
  • Durasi pembacaan artikel
Badge - Teks Opsional

Judul untuk badge

Catatan: Teks atau gambar diperlukan untuk badge

Teks bebas

Ukuran teks yang direkomendasikan: maks. 15 karakter

Badge - Gambar Opsional

Gambar kecil

Perlakuan UX khusus, misalnya sebagai overlay badge pada thumbnail gambar/video.

Catatan: Teks atau gambar diperlukan untuk badge

Lihat Spesifikasi Gambar untuk panduan.
Kategori Konten Opsional Deskripsikan kategori konten dalam entitas.

Daftar Enums

Lihat bagian Kategori Konten untuk mendapatkan panduan.

ArticleEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entity.

Teks bebas

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Gambar poster Opsional

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Catatan: Gambar sangat direkomendasikan. Jika badge disediakan, pastikan ruang aman 24 dp di bagian atas dan bawah gambar

Lihat Spesifikasi Gambar untuk panduan.
Sumber - Judul Opsional Nama penulis, organisasi, atau reporter

Teks bebas

Ukuran teks yang direkomendasikan: Di bawah 25 karakter

Sumber - Gambar Opsional Gambar sumber seperti penulis, organisasi, reporter Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

Badge Opsional

Setiap badge adalah teks bebas (maks. 15 karakter) atau gambar kecil.

Perlakuan UX khusus di atas gambar/video, misalnya, sebagai overlay badge pada gambar

  • "Pembaruan langsung"
  • Durasi pembacaan artikel
Badge - Teks Opsional

Judul untuk badge

Catatan: Teks atau gambar diperlukan untuk badge

Teks bebas

Ukuran teks yang direkomendasikan: maks. 15 karakter

Badge - Gambar Opsional

Gambar kecil

Perlakuan UX khusus, misalnya sebagai overlay badge pada thumbnail gambar/video.

Catatan: Teks atau gambar diperlukan untuk badge

Lihat Spesifikasi Gambar untuk panduan.
Waktu Publikasi Konten Opsional Ini adalah stempel waktu epoch dalam milidetik saat konten dipublikasikan / diperbarui di aplikasi. Stempel waktu epoch dalam milidetik
Waktu Engagement Terakhir Wajib Bersyarat

Stempel waktu epoch dalam milidetik saat pengguna berinteraksi dengan entitas ini terakhir kali.

Catatan: Kolom ini wajib diisi jika entitas ini merupakan bagian dari cluster reservasi.

Stempel waktu epoch dalam milidetik
Persentase Progres Wajib Bersyarat

Persentase konten lengkap yang telah dikonsumsi oleh pengguna hingga saat ini.

Catatan: Kolom ini wajib diisi jika entitas ini merupakan bagian dari cluster reservasi.

Nilai int antara 0~100 inklusif.
Kategori Konten Opsional Deskripsikan kategori konten dalam entitas.

Daftar Enums

Lihat bagian Kategori Konten untuk mendapatkan panduan.

EventEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entitas.

String

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Waktu Mulai yang dilokalkan - Stempel waktu Wajib

Stempel waktu epoch saat peristiwa diperkirakan akan dimulai.

Joda-Time Instan
Waktu Mulai yang dilokalkan - Zona Waktu Wajib

Zona waktu tempat acara diperkirakan akan dimulai.

Joda-Time DateTimeZone
Mode peristiwa Wajib

Kolom untuk menunjukkan apakah acara akan diadakan secara virtual, tatap muka, atau keduanya.

Enum: VIRTUAL, IN_PERSON, atau HYBRID
Gambar poster Wajib

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Catatan: Gambar sangat direkomendasikan. Jika badge disediakan, pastikan ruang aman 24 dp di bagian atas dan bawah gambar

Lihat Spesifikasi Gambar untuk panduan.
Lokasi - Negara Wajib Bersyarat

Negara tempat peristiwa terjadi.

Catatan: Hal ini diperlukan untuk acara yang bersifat IN_PERSON atau HYBRID

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kota Wajib Bersyarat

Kota tempat acara berlangsung.

Catatan: Hal ini diperlukan untuk acara yang bersifat IN_PERSON atau HYBRID

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Tampilan Wajib Bersyarat

Alamat atau nama tempat acara akan berlangsung yang harus ditampilkan kepada pengguna.

Catatan: Hal ini diperlukan untuk acara yang bersifat IN_PERSON atau HYBRID

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Opsional Alamat jalan (jika ada) lokasi tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kode pos Opsional Kode pos (jika ada) lokasi tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Lingkungan Opsional Lingkungan (jika ada) tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Waktu akhir Opsional

Stempel waktu epoch saat peristiwa diperkirakan akan berakhir.

Catatan: Nilai ini akan direpresentasikan dalam milidetik.

Stempel waktu epoch dalam milidetik
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

Badge Opsional

Setiap badge adalah teks bebas (maks. 15 karakter) atau gambar kecil.

Badge - Teks Opsional

Judul untuk badge

Catatan: Teks atau gambar diperlukan untuk badge

Teks bebas

Ukuran teks yang direkomendasikan: maks. 15 karakter

Badge - Gambar Opsional

Gambar kecil

Perlakuan UX khusus, misalnya sebagai overlay badge pada thumbnail gambar/video.

Catatan: Teks atau gambar diperlukan untuk badge

Lihat Spesifikasi Gambar untuk panduan.
Harga - CurrentPrice Wajib bersyarat

Harga tiket/kartu saat ini untuk acara.

Harus diberikan jika harga yang dicoret disediakan.

Teks bebas
Harga - StrikethroughPrice Opsional Harga asli tiket/kartu untuk acara. Teks bebas
Info Harga Opsional Keterangan harga untuk menampilkan promo, acara, diskon anggota, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Kategori Konten Opsional Deskripsikan kategori konten dalam entitas.

Daftar Enums yang Memenuhi Syarat

  • TYPE_MOVIES_AND_TV_SHOWS (Contoh - Bioskop)
  • TYPE_DIGITAL_GAMES (Contoh - eSports)
  • TYPE_MUSIC (Contoh - Konser)
  • TYPE_TRAVEL_AND_LOCAL (Contoh - Tur, festival)
  • TYPE_HEALTH_AND_FITENESS (Contoh - Kelas yoga)
  • TYPE_EDUCATION (Contoh - Kelas)
  • TYPE_SPORTS (Contoh - Pertandingan sepak bola)
  • TYPE_DATING (Contoh - pertemuan)

Lihat bagian Kategori Konten untuk mendapatkan panduan.

LodgingEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entitas.

String

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Gambar poster Wajib

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Catatan: Jika badge disediakan, pastikan ruang aman sebesar 24 dp di bagian atas dan bawah gambar

Lihat Spesifikasi Gambar untuk panduan.
Lokasi - Negara Wajib Negara tempat penginapan terjadi.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kota Wajib Kota tempat penginapan berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Tampilan Wajib Alamat penginapan yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Opsional Alamat jalan (jika ada) penginapan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) tempat penginapan berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kode pos Opsional Kode pos (jika ada) penginapan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Lingkungan Opsional Lingkungan (jika ada) penginapan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Badge Opsional

Setiap badge adalah teks bebas (maks. 15 karakter) atau gambar kecil.

Badge - Teks Opsional

Judul untuk badge

Catatan: Teks atau gambar diperlukan untuk badge

Teks bebas

Ukuran teks yang direkomendasikan: maks. 15 karakter

Badge - Gambar Opsional

Gambar kecil

Perlakuan UX khusus, misalnya sebagai overlay badge pada thumbnail gambar/video.

Catatan: Teks atau gambar diperlukan untuk badge

Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

AvailabilityTimeWindow - Localized Start Time - Timestamp Opsional Stempel waktu epoch saat penginapan diperkirakan akan buka/tersedia. Joda-Time Instan
AvailabilityTimeWindow - Localized Start Time - Timezone Opsional Zona waktu tempat penginapan diperkirakan akan buka/tersedia. Joda-Time DateTimeZone
AvailabilityTimeWindow - Localized End Time - Stempel Waktu Opsional Stempel waktu epoch hingga penginapan diperkirakan akan buka/tersedia. Joda-Time Instan
AvailabilityTimeWindow - Localized End Time - Timezone Opsional Zona waktu tempat penginapan diperkirakan akan buka/tersedia. Joda-Time DateTimeZone
Rating - Nilai maks Opsional

Nilai skala rating maksimum.

Harus diberikan jika nilai rating saat ini juga disediakan.

Angka >= 0,0
Rating - Nilai saat ini Opsional

Nilai skala rating saat ini.

Harus diberikan jika nilai rating maksimum juga disediakan.

Angka >= 0,0
Rating - Jumlah Opsional

Jumlah rating untuk penginapan.

Catatan: Berikan kolom ini jika aplikasi Anda ingin mengontrol cara tampilannya kepada pengguna. Berikan string ringkas yang dapat ditampilkan kepada pengguna. Misalnya, jika jumlahnya 1.000.000, pertimbangkan untuk menggunakan singkatan seperti 1M, sehingga tidak akan terpotong pada ukuran tampilan yang lebih kecil.

String
Rating - Nilai Jumlah Opsional

Jumlah rating untuk penginapan.

Catatan: Berikan kolom ini jika Anda tidak ingin menangani logika singkatan tampilan sendiri. Jika Count dan Count Value ada, kami akan menggunakan Count untuk ditampilkan kepada pengguna

Panjang
Harga - CurrentPrice Wajib bersyarat

Harga penginapan saat ini.

Harus diberikan jika harga yang dicoret disediakan.

Teks bebas
Harga - StrikethroughPrice Opsional Harga asli penginapan, yang dicoret di UI. Teks bebas
Info Harga Opsional Keterangan harga untuk menampilkan promo, acara, diskon anggota, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

StoreEntity

Objek StoreEntity mewakili setiap toko yang ingin dipublikasikan oleh partner developer, seperti tempat makan atau restoran populer yang relevan dengan pengalaman perjalanan seseorang.

Atribut Persyaratan Deskripsi Format
Gambar poster Wajib Minimal satu gambar harus diberikan. Lihat Spesifikasi Gambar untuk panduan.
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Opsional Nama toko.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Lokasi Opsional Lokasi toko.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Keterangan Opsional Keterangan untuk menampilkan promo, acara, atau info terbaru terkait toko, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Cetak kecil keterangan Opsional Teks cetak kecil untuk keterangan.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Deskripsi Opsional Deskripsi toko.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 90 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Kategori Opsional

Kategori toko, dalam konteks tempat makan, dapat berupa masakan seperti "Prancis", "Amerika baru", "ramen", "makanan mewah".

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Rating - Nilai maks Opsional

Nilai skala rating maksimum.

Harus diberikan jika nilai rating saat ini juga disediakan.

Angka >= 0,0
Rating - Nilai saat ini Opsional

Nilai skala rating saat ini.

Harus diberikan jika nilai rating maksimum juga disediakan.

Angka >= 0,0
Rating - Jumlah Opsional

Jumlah rating untuk penginapan.

Catatan: Berikan kolom ini jika aplikasi Anda ingin mengontrol cara tampilannya kepada pengguna. Berikan string ringkas yang dapat ditampilkan kepada pengguna. Misalnya, jika jumlahnya 1.000.000, pertimbangkan untuk menggunakan singkatan seperti 1M, sehingga tidak akan terpotong pada ukuran tampilan yang lebih kecil.

String
Rating - Nilai Jumlah Opsional

Jumlah rating untuk penginapan.

Catatan: Berikan kolom ini jika Anda tidak ingin menangani logika singkatan tampilan sendiri. Jika Count dan Count Value ada, kami akan menggunakan Count untuk ditampilkan kepada pengguna

Panjang

PointOfInterestEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entitas.

String

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Gambar poster Wajib

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Catatan: Gambar sangat direkomendasikan. Jika badge disediakan, pastikan ruang aman 24 dp di bagian atas dan bawah gambar

Lihat Spesifikasi Gambar untuk panduan.
Lokasi - Negara Wajib Negara tempat lokasi menarik terjadi.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kota Wajib Kota tempat lokasi menarik terjadi.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Tampilan Wajib Alamat lokasi menarik yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Opsional Alamat jalan (jika ada) dari lokasi menarik.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) tempat lokasi menarik berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kode pos Opsional Kode pos (jika ada) lokasi menarik.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Lingkungan Opsional Lingkungan (jika ada) lokasi menarik.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

AvailabilityTimeWindow - Localized Start Time - Timestamp Opsional Stempel waktu epoch saat lokasi menarik diperkirakan akan buka/tersedia. Joda-Time Instan
AvailabilityTimeWindow - Localized Start Time - Timezone Opsional Zona waktu tempat lokasi menarik diperkirakan akan buka/tersedia. Joda-Time DateTimeZone
AvailabilityTimeWindow - Localized End Time - Stempel Waktu Opsional Stempel waktu epoch hingga lokasi menarik diperkirakan akan buka/tersedia. Joda-Time Instan
AvailabilityTimeWindow - Localized End Time - Timezone Opsional Zona waktu tempat lokasi menarik diperkirakan akan buka/tersedia. Joda-Time DateTimeZone
Badge Opsional

Setiap badge adalah teks bebas (maks. 15 karakter) atau gambar kecil.

Badge - Teks Opsional

Judul untuk badge

Catatan: Teks atau gambar diperlukan untuk badge

Teks bebas

Ukuran teks yang direkomendasikan: maks. 15 karakter

Badge - Gambar Opsional

Gambar kecil

Perlakuan UX khusus, misalnya sebagai overlay badge pada thumbnail gambar/video.

Catatan: Teks atau gambar diperlukan untuk badge

Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

Rating - Nilai maks Opsional

Nilai skala rating maksimum.

Harus diberikan jika nilai rating saat ini juga disediakan.

Angka >= 0,0
Rating - Nilai saat ini Opsional

Nilai skala rating saat ini.

Harus diberikan jika nilai rating maksimum juga disediakan.

Angka >= 0,0
Rating - Jumlah Opsional

Jumlah rating untuk lokasi menarik.

Catatan: Berikan kolom ini jika aplikasi Anda ingin mengontrol cara tampilannya kepada pengguna. Berikan string ringkas yang dapat ditampilkan kepada pengguna. Misalnya, jika jumlahnya 1.000.000, pertimbangkan untuk menggunakan singkatan seperti 1M, sehingga tidak akan terpotong pada ukuran tampilan yang lebih kecil.

String
Rating - Nilai Jumlah Opsional

Jumlah rating untuk lokasi menarik.

Catatan: Berikan kolom ini jika Anda tidak ingin menangani logika singkatan tampilan sendiri. Jika Count dan Count Value ada, kami akan menggunakan Count untuk ditampilkan kepada pengguna

Panjang
Harga - CurrentPrice Wajib bersyarat

Harga tiket/kartu masuk saat ini untuk lokasi menarik.

Harus diberikan jika harga yang dicoret disediakan.

Teks bebas
Harga - StrikethroughPrice Opsional Harga asli tiket/kartu masuk untuk lokasi menarik. Teks bebas
Info Harga Opsional Keterangan harga untuk menampilkan promo, acara, diskon anggota, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Kategori Konten Opsional Deskripsikan kategori konten dalam entitas.

Daftar Enums yang Memenuhi Syarat

  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_MOVIES_AND_TV_SHOWS (Contoh - teater)
  • TYPE_MEDICAL (Contoh - rumah sakit)
  • TYPE_EDUCATION (Contoh - sekolah)
  • TYPE_SPORTS (Contoh - stadion)

Lihat bagian Kategori Konten untuk mendapatkan panduan.

RestaurantReservationEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entitas.

String

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Waktu Mulai Reservasi yang Dilokalkan - Stempel Waktu Wajib Stempel waktu epoch saat reservasi diperkirakan akan dimulai. Joda-Time Instan
Waktu Mulai Reservasi yang Dilokalkan - Zona Waktu Wajib Zona waktu tempat pemesanan diperkirakan akan dimulai. Joda-Time DateTimeZone
Lokasi - Negara Wajib Negara tempat restoran berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kota Wajib Kota tempat restoran berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Tampilan Wajib Alamat restoran yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Opsional Alamat jalan (jika ada) restoran.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) tempat restoran berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kode pos Opsional Kode pos (jika ada) restoran.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Lingkungan Opsional Lingkungan (jika ada) restoran.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Gambar poster Opsional Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9 Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

Ukuran Tabel Opsional Jumlah orang dalam grup reservasi Bilangan bulat > 0

EventReservationEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entitas.

String

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Waktu Mulai yang dilokalkan - Stempel waktu Wajib

Stempel waktu epoch saat peristiwa diperkirakan akan dimulai.

Joda-Time Instan
Waktu Mulai yang dilokalkan - Zona Waktu Wajib

Zona waktu tempat acara diperkirakan akan dimulai.

Joda-Time DateTimeZone
Mode peristiwa Wajib

Kolom untuk menunjukkan apakah acara akan diadakan secara virtual, tatap muka, atau keduanya.

Enum: VIRTUAL, IN_PERSON, atau HYBRID
Lokasi - Negara Wajib Bersyarat

Negara tempat peristiwa terjadi.

Catatan: Hal ini diperlukan untuk acara yang bersifat IN_PERSON atau HYBRID

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kota Wajib Bersyarat

Kota tempat acara berlangsung.

Catatan: Hal ini diperlukan untuk acara yang bersifat IN_PERSON atau HYBRID

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Tampilan Wajib Bersyarat

Alamat atau nama tempat acara akan berlangsung yang harus ditampilkan kepada pengguna.

Catatan: Hal ini diperlukan untuk acara yang bersifat IN_PERSON atau HYBRID

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Opsional Alamat jalan (jika ada) lokasi tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kode pos Opsional Kode pos (jika ada) lokasi tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Lingkungan Opsional Lingkungan (jika ada) tempat acara diselenggarakan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Gambar poster Opsional

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Catatan: Gambar sangat direkomendasikan. Jika badge disediakan, pastikan ruang aman 24 dp di bagian atas dan bawah gambar

Lihat Spesifikasi Gambar untuk panduan.
Waktu Akhir yang dilokalkan - Stempel waktu Opsional

Stempel waktu epoch saat peristiwa diperkirakan berakhir.

Joda-Time Instan
Waktu Berakhir yang dilokalkan - Zona Waktu Opsional

Zona waktu tempat acara diperkirakan akan berakhir.

Joda-Time DateTimeZone
Penyedia Layanan - Nama Opsional

Nama penyedia layanan.

Catatan: Teks atau gambar diperlukan untuk penyedia layanan.

Teks bebas. Misalnya, nama penyelenggara acara/tur
Penyedia Layanan - Gambar Opsional

Logo/gambar penyedia layanan.

Catatan: Teks atau gambar diperlukan untuk penyedia layanan.

Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

Badge Opsional

Setiap badge adalah teks bebas (maks. 15 karakter) atau gambar kecil.

Badge - Teks Opsional

Judul untuk badge

Catatan: Teks atau gambar diperlukan untuk badge

Teks bebas

Ukuran teks yang direkomendasikan: maks. 15 karakter

Badge - Gambar Opsional

Gambar kecil

Perlakuan UX khusus, misalnya sebagai overlay badge pada thumbnail gambar/video.

Catatan: Teks atau gambar diperlukan untuk badge

Lihat Spesifikasi Gambar untuk panduan.
ID Reservasi Opsional ID reservasi untuk reservasi acara. Teks bebas
Harga - CurrentPrice Wajib bersyarat

Harga tiket/kartu saat ini untuk acara.

Harus diberikan jika harga yang dicoret disediakan.

Teks bebas
Harga - StrikethroughPrice Opsional Harga asli tiket/kartu untuk acara. Teks bebas
Info Harga Opsional Keterangan harga untuk menampilkan promo, acara, diskon anggota, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Rating - Nilai maks Opsional

Nilai skala rating maksimum.

Harus diberikan jika nilai rating saat ini juga disediakan.

Angka >= 0,0
Rating - Nilai saat ini Opsional

Nilai skala rating saat ini.

Harus diberikan jika nilai rating maksimum juga disediakan.

Angka >= 0,0
Rating - Jumlah Opsional

Jumlah rating untuk peristiwa.

Catatan: Berikan kolom ini jika aplikasi Anda ingin mengontrol cara tampilannya kepada pengguna. Berikan string ringkas yang dapat ditampilkan kepada pengguna. Misalnya, jika jumlahnya 1.000.000, pertimbangkan untuk menggunakan singkatan seperti 1M, sehingga tidak akan terpotong pada ukuran tampilan yang lebih kecil.

String
Rating - Nilai Jumlah Opsional

Jumlah rating untuk peristiwa.

Catatan: Berikan kolom ini jika Anda tidak ingin menangani logika singkatan tampilan sendiri. Jika Count dan Count Value ada, kami akan menggunakan Count untuk ditampilkan kepada pengguna

Panjang
Kategori Konten Opsional Deskripsikan kategori konten dalam entitas.

Daftar Enums yang Memenuhi Syarat

  • TYPE_MOVIES_AND_TV_SHOWS (Contoh - Bioskop)
  • TYPE_DIGITAL_GAMES (Contoh - eSports)
  • TYPE_MUSIC (Contoh - Konser)
  • TYPE_TRAVEL_AND_LOCAL (Contoh - Tur, festival)
  • TYPE_HEALTH_AND_FITENESS (Contoh - Kelas yoga)
  • TYPE_EDUCATION (Contoh - Kelas)
  • TYPE_SPORTS (Contoh - Pertandingan sepak bola)
  • TYPE_DATING (Contoh - pertemuan)

Lihat bagian Kategori Konten untuk mendapatkan panduan.

LodgingReservationEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entity.

Teks bebas. Misalnya, "Kunjungan Anda mulai 12 Desember"

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Waktu Check-in yang Dilokalkan - Stempel Waktu Wajib Stempel waktu epoch yang mewakili waktu check in untuk reservasi. Joda-Time Instan
Waktu Check-in yang Dilokalkan - Zona Waktu Wajib Zona waktu tempat waktu check in untuk reservasi berada. Joda-Time Instan
Waktu Check-out yang Dilokalkan - Stempel Waktu Wajib Stempel waktu epoch yang mewakili waktu check out untuk reservasi. Joda-Time Instan
Waktu Check-out yang Dilokalkan - Zona Waktu Wajib Zona waktu tempat waktu check out untuk reservasi berada. Joda-Time DateTimeZone
Lokasi - Negara Wajib Negara tempat penginapan berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kota Wajib Kota tempat penginapan berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Tampilan Wajib Alamat penginapan yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Alamat Opsional Alamat jalan (jika ada) penginapan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) tempat penginapan berada.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Kode pos Opsional Kode pos (jika ada) penginapan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi - Lingkungan Opsional Lingkungan (jika ada) penginapan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Gambar poster Opsional

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Catatan: Jika badge disediakan, pastikan ruang aman 24 dp di bagian atas dan bawah gambar

Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

ID Reservasi Opsional ID reservasi untuk reservasi penginapan. Teks bebas
Rating - Nilai maks Opsional

Nilai skala rating maksimum.

Harus diberikan jika nilai rating saat ini juga disediakan.

Angka >= 0,0
Rating - Nilai saat ini Opsional

Nilai skala rating saat ini.

Harus diberikan jika nilai rating maksimum juga disediakan.

Angka >= 0,0
Rating - Jumlah Opsional

Jumlah rating untuk penginapan.

Catatan: Berikan kolom ini jika aplikasi Anda ingin mengontrol cara tampilannya kepada pengguna. Berikan string ringkas yang dapat ditampilkan kepada pengguna. Misalnya, jika jumlahnya 1.000.000, pertimbangkan untuk menggunakan singkatan seperti 1M, sehingga tidak akan terpotong pada ukuran tampilan yang lebih kecil.

String
Rating - Nilai Jumlah Opsional

Jumlah rating untuk penginapan.

Catatan: Berikan kolom ini jika Anda tidak ingin menangani logika singkatan tampilan sendiri. Jika Count dan Count Value ada, kami akan menggunakan Count untuk ditampilkan kepada pengguna

Panjang
Harga - CurrentPrice Wajib bersyarat

Harga penginapan saat ini.

Harus diberikan jika harga yang dicoret disediakan.

Teks bebas
Harga - StrikethroughPrice Opsional Harga asli penginapan, yang dicoret di UI. Teks bebas
Info Harga Opsional Keterangan harga untuk menampilkan promo, acara, diskon anggota, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

TransportationReservationEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entity.

Teks bebas. Misalnya, "SFO to SAN"

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Jenis Transportasi Wajib Moda/jenis transportasi untuk reservasi. Enum: FLIGHT, TRAIN, BUS, atau FERRY
Waktu Keberangkatan yang Dilokalkan - Stempel Waktu Wajib Stempel waktu epoch yang mewakili waktu keberangkatan. Joda-Time Instan
Waktu Keberangkatan yang Dilokalkan - Zona Waktu Wajib Zona waktu waktu keberangkatan. Joda-Time DateTimeZone
Waktu Kedatangan yang Dilokalkan - Stempel Waktu Wajib Stempel waktu epoch yang mewakili waktu kedatangan. Joda-Time Instan
Waktu Kedatangan yang Dilokalkan - Zona Waktu Wajib Zona waktu waktu tiba. Joda-Time DateTimeZone
Nomor Transportasi Wajib Nomor penerbangan, nomor bus, nomor kereta, atau nomor feri/kapal pesiar. Teks bebas
Waktu Boarding yang Dilokalkan - Stempel Waktu Wajib Stempel waktu epoch yang mewakili waktu boarding untuk reservasi (jika ada) Joda-Time Instan
Waktu Boarding yang Dilokalkan - Zona Waktu Wajib Zona waktu waktu keberangkatan untuk reservasi (jika ada) Joda-Time DateTimeZone
Lokasi Keberangkatan - Negara Opsional Negara keberangkatan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Keberangkatan - Kota Opsional Kota keberangkatan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Keberangkatan - Alamat Display Opsional Lokasi keberangkatan yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Keberangkatan - Alamat Opsional Alamat jalan (jika ada) lokasi keberangkatan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Keberangkatan - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) lokasi keberangkatan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Keberangkatan - Kode pos Opsional Kode pos (jika ada) lokasi keberangkatan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Keberangkatan - Lingkungan Opsional Lingkungan (jika ada) lokasi keberangkatan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Kedatangan - Negara Opsional Negara kedatangan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Kedatangan - Kota Opsional Kota tujuan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Kedatangan - Alamat Tampilan Opsional Lokasi kedatangan yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Kedatangan - Alamat Opsional Alamat jalan (jika ada) lokasi kedatangan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Kedatangan - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) lokasi kedatangan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Kedatangan - Kode pos Opsional Kode pos (jika ada) lokasi kedatangan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Lokasi Kedatangan - Kawasan Opsional Lingkungan (jika ada) lokasi kedatangan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Penyedia Layanan - Nama Opsional

Nama penyedia layanan.

Catatan: Teks atau gambar diperlukan untuk penyedia layanan.

Teks bebas. Misalnya, Nama maskapai penerbangan
Penyedia Layanan - Gambar Opsional

Logo/gambar penyedia layanan.

Catatan: Teks atau gambar diperlukan untuk penyedia layanan.

Lihat Spesifikasi Gambar untuk panduan.
Gambar poster Opsional

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

ID Reservasi Opsional ID reservasi untuk reservasi transportasi. Teks bebas
Harga - CurrentPrice Wajib bersyarat

Harga reservasi saat ini.

Harus diberikan jika harga yang dicoret disediakan.

Teks bebas
Harga - StrikethroughPrice Opsional Harga asli reservasi, yang dicoret di UI. Teks bebas
Info Harga Opsional Keterangan harga untuk menampilkan promo, acara, diskon anggota, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

VehicleRentalReservationEntity

Atribut Persyaratan Deskripsi Format
URI Tindakan Wajib

Deep Link ke entity dalam aplikasi penyedia.

Catatan: Anda dapat menggunakan deep link untuk atribusi. Lihat FAQ ini

URI
Judul Wajib Judul entity.

Teks bebas. Misalnya, "Avis Union Square SF"

Ukuran teks yang direkomendasikan: Maksimal 50 karakter

Waktu Pengambilan yang Dilokalkan - Stempel Waktu Wajib Stempel waktu epoch yang mewakili waktu pengambilan untuk reservasi. Joda-Time Instan
Waktu Pengambilan yang Dilokalkan - Zona Waktu Wajib Zona waktu waktu pengambilan untuk reservasi. Joda-Time DateTimeZone
Waktu Pengembalian yang Dilokalkan - Stempel Waktu Opsional Stempel waktu epoch yang mewakili waktu check out untuk reservasi. Joda-Time Instan
Waktu Pengembalian yang Dilokalkan - Zona Waktu Opsional Zona waktu waktu check out untuk reservasi. Joda-Time DateTimeZone
Alamat Pengambilan - Negara Opsional Negara lokasi pengambilan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengambilan - Kota Opsional Kota lokasi pengambilan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengambilan - Alamat Tampilan Opsional Lokasi pengambilan yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengambilan - Alamat Opsional Alamat jalan (jika ada) lokasi pengambilan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengambilan - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) lokasi pengambilan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengambilan - Kode pos Opsional Kode pos (jika ada) lokasi pengambilan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengambilan - Lingkungan Opsional Kawasan (jika ada) lokasi pengambilan.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengembalian - Negara Opsional Negara lokasi pengembalian.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengembalian - Kota Opsional Kota lokasi pengembalian.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengembalian - Alamat Tampilan Opsional Lokasi pengembalian yang akan ditampilkan kepada pengguna.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengembalian - Alamat Opsional Alamat jalan (jika ada) dari lokasi pengembalian.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengembalian - Negara Bagian Opsional Negara bagian atau provinsi (jika berlaku) lokasi kembali.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengembalian - Kode pos Opsional Kode pos (jika ada) lokasi pengembalian.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Alamat Pengembalian - Lingkungan Opsional Lingkungan (jika ada) lokasi pengembalian.

Teks bebas

Ukuran teks yang direkomendasikan: maks. ~20 karakter

Penyedia Layanan - Nama Opsional

Nama penyedia layanan.

Catatan: Teks atau gambar diperlukan untuk penyedia layanan.

Teks bebas. Misalnya, "Sewa Mobil Avis"
Penyedia Layanan - Gambar Opsional

Logo/gambar penyedia layanan.

Catatan: Teks atau gambar diperlukan untuk penyedia layanan.

Lihat Spesifikasi Gambar untuk panduan.
Gambar poster Opsional

Kami hanya akan menampilkan 1 gambar jika beberapa gambar disediakan. Rasio aspek yang direkomendasikan adalah 16:9

Lihat Spesifikasi Gambar untuk panduan.
Deskripsi Opsional

Satu paragraf teks untuk mendeskripsikan entity.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan: 180 karakter

Daftar subtitel Opsional

Maksimal 3 subtitel, dengan setiap subtitel berisi satu baris teks.

Catatan: Deskripsi atau daftar subtitel akan ditampilkan kepada pengguna, bukan keduanya.

Teks bebas

Ukuran teks yang direkomendasikan untuk setiap subtitel: maksimal 50 karakter

ID Konfirmasi Opsional ID konfirmasi untuk pemesanan rental kendaraan. Teks bebas
Harga - CurrentPrice Wajib bersyarat

Harga reservasi saat ini.

Harus diberikan jika harga yang dicoret disediakan.

Teks bebas
Harga - StrikethroughPrice Opsional Harga asli reservasi, yang dicoret di UI. Teks bebas
Info Harga Opsional Keterangan harga untuk menampilkan promo, acara, diskon anggota, jika tersedia.

Teks bebas

Ukuran teks yang direkomendasikan: di bawah 45 karakter (Teks yang terlalu panjang dapat menampilkan elipsis)

Spesifikasi gambar

Spesifikasi yang diperlukan untuk aset gambar tercantum dalam tabel ini:

Rasio aspek Piksel minimum Piksel yang direkomendasikan

Persegi (1x1)

Pilihan

300x300 1200x1200
Lanskap (1,91x1) 600x314 1200x628
Potret (4x5) 480x600 960x1200

Gambar harus dihosting di CDN publik agar Google dapat mengaksesnya.

Format file

PNG, JPG, GIF statis, WebP

Ukuran file maksimum

5120 KB

Rekomendasi tambahan

  • Area aman gambar: Tempatkan konten penting Anda di 80% bagian tengah gambar.
  • Gunakan latar belakang transparan agar gambar dapat ditampilkan dengan benar di setelan tema Gelap dan Terang.

Kategori Konten

Kategori konten memungkinkan aplikasi memublikasikan konten yang termasuk dalam beberapa kategori. Tindakan ini akan memetakan konten dengan beberapa kategori yang telah ditentukan sebelumnya, yaitu:

  • TYPE_EDUCATION
  • TYPE_SPORTS
  • TYPE_MOVIES_AND_TV_SHOWS
  • TYPE_BOOKS
  • TYPE_AUDIOBOOKS
  • TYPE_MUSIC
  • TYPE_DIGITAL_GAMES
  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_HOME_AND_AUTO
  • TYPE_BUSINESS
  • TYPE_NEWS
  • TYPE_FOOD_AND_DRINK
  • TYPE_SHOPPING
  • TYPE_HEALTH_AND_FITENESS
  • TYPE_MEDICAL
  • TYPE_PARENTING
  • TYPE_DATING

Gambar harus dihosting di CDN publik agar Google dapat mengaksesnya.

Pedoman untuk menggunakan kategori konten

  1. Beberapa entity seperti ArticleEntity dan GenericFeaturedEntity memenuhi syarat untuk menggunakan kategori konten apa pun. Untuk entity lain seperti EventEntity, EventReservationEntity, PointOfInterestEntity, hanya subkumpulan kategori ini yang memenuhi syarat. Periksa daftar kategori yang memenuhi syarat untuk jenis entity sebelum mengisi daftar.
  2. Gunakan jenis entity tertentu untuk beberapa kategori konten melalui kombinasi entity Generik dan ContentCategory:

  3. Kolom ContentCategory bersifat opsional dan harus dibiarkan kosong jika konten tidak termasuk dalam kategori yang disebutkan sebelumnya.

  4. Jika beberapa kategori konten disediakan, berikan dalam urutan relevansi terhadap konten dengan kategori konten yang paling relevan ditempatkan terlebih dahulu dalam daftar.

Langkah 2: Menyediakan data Cluster

Sebaiknya jalankan tugas publikasi konten di latar belakang (misalnya, menggunakan WorkManager) dan dijadwalkan secara berkala atau berbasis peristiwa (misalnya, setiap kali pengguna membuka aplikasi atau saat pengguna menambahkan sesuatu ke keranjangnya).

AppEngageTravelClient bertanggung jawab untuk memublikasikan cluster.

Ada API berikut untuk memublikasikan cluster di klien:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishReservationCluster
  • publishContinueSearchCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteReservationCluster
  • deleteContinueSearchCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

API ini digunakan untuk memeriksa apakah layanan tersedia untuk integrasi, dan apakah konten dapat ditampilkan di perangkat atau tidak.

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

API ini digunakan untuk memublikasikan daftar objek RecommendationCluster.

Kotlin

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

Saat layanan menerima permintaan tersebut, tindakan berikut akan terjadi dalam satu transaksi:

  • Data RecommendationCluster yang ada dari partner developer akan dihapus.
  • Data dari permintaan akan diuraikan dan disimpan di Cluster Rekomendasi yang diperbarui.

Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

publishFeaturedCluster

API ini digunakan untuk memublikasikan daftar objek FeaturedCluster.

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Saat layanan menerima permintaan tersebut, tindakan berikut akan terjadi dalam satu transaksi:

  • Data FeaturedCluster yang ada dari partner developer akan dihapus.
  • Data dari permintaan akan diuraikan dan disimpan di Cluster Unggulan yang diperbarui.

Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

publishReservationCluster

API ini digunakan untuk memublikasikan objek ReservationCluster.

Kotlin

client.publishReservationCluster(
    PublishReservationClusterRequest.Builder()
      .setReservationCluster(
        ReservationCluster.Builder()
          .addLodgingReservationEntity(lodgingReservationEntity)
          .addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
          .addTransportationReservationEntity(transportationReservationEntity)
          .addEventReservationEntity(eventReservationEntity)
          .addRestaurantReservationEntity(restaurantReservationEntity)
          .build())
      .build())

Java

client.publishReservationCluster(
            new PublishReservationClusterRequest.Builder()
                .setReservationCluster(
                    new ReservationCluster.Builder()
                        .addLodgingReservationEntity(lodgingReservationEntity)
                        .addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
                        .addTransportationReservationEntity(transportationReservationEntity)
                        .addEventReservationEntity(eventReservationEntity)
                        .addRestaurantReservationEntity(restaurantReservationEntity)
                        .build())
                .build());

Saat layanan menerima permintaan tersebut, tindakan berikut akan terjadi dalam satu transaksi:

  • Data ReservationCluster yang ada dari partner developer akan dihapus.
  • Data dari permintaan akan diuraikan dan disimpan di Cluster Reservasi yang diperbarui.

Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

publishContinueSearchCluster

API ini digunakan untuk memublikasikan daftar objek ContinueSearchCluster.

Kotlin

client.publishContinueSearchCluster(
    PublishContinueSearchClusterRequest.Builder()
      .setContinueSearchCluster(
        ContinueSearchCluster.Builder()
          .addPointOfInterestEntity(entity1)
          .addPointOfInterestEntity(entity2)
          .build())
      .build())

Java

client.publishContinueSearchCluster(
            new PublishContinueSearchClusterRequest.Builder()
                .setContinueSearchCluster(
                    new ContinueSearchCluster.Builder()
                        .addPointOfInterestEntity(entity1)
                        .addPointOfInterestEntity(entity2)
                        .build())
                .build());

Saat layanan menerima permintaan tersebut, tindakan berikut akan terjadi dalam satu transaksi:

  • Data ContinueSearchCluster yang ada dari partner developer akan dihapus.
  • Data dari permintaan akan diuraikan dan disimpan di Cluster Lanjutkan Penelusuran yang diperbarui.

Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

publishUserAccountManagementRequest

API ini digunakan untuk memublikasikan kartu Login. Tindakan login mengarahkan pengguna ke halaman login aplikasi sehingga aplikasi dapat memublikasikan konten (atau memberikan konten yang lebih dipersonalisasi)

Metadata berikut adalah bagian dari Kartu Login -

Atribut Persyaratan Deskripsi
URI Tindakan Wajib Deeplink ke Tindakan (yaitu membuka halaman login aplikasi)
Gambar Opsional - Jika tidak diberikan, Judul harus diberikan

Gambar Ditampilkan pada Kartu

Gambar rasio aspek 16x9 dengan resolusi 1264x712

Judul Opsional - Jika tidak diberikan, Gambar harus diberikan Judul pada Kartu
Teks Tindakan Opsional Teks yang Ditampilkan pada CTA (yaitu Login)
Subjudul Opsional Subjudul Opsional pada Kartu

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Saat layanan menerima permintaan tersebut, tindakan berikut akan terjadi dalam satu transaksi:

  • Data UserAccountManagementCluster yang ada dari partner developer akan dihapus.
  • Data dari permintaan akan diuraikan dan disimpan di Cluster UserAccountManagementCluster yang diperbarui.

Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

updatePublishStatus

Jika untuk alasan bisnis internal apa pun, tidak ada cluster yang dipublikasikan, kami sebaiknya memperbarui status publikasi menggunakan API updatePublishStatus. Hal ini penting karena:

  • Memberikan status dalam semua skenario, bahkan saat konten dipublikasikan (STATUS == PUBLISHED), sangat penting untuk mengisi dasbor yang menggunakan status eksplisit ini untuk menyampaikan kondisi dan metrik integrasi Anda yang lain.
  • Jika tidak ada konten yang dipublikasikan, tetapi status integrasi tidak rusak (STATUS == NOT_PUBLISHED), Google dapat menghindari pemicuan pemberitahuan di dasbor kondisi aplikasi. Fitur ini mengonfirmasi bahwa konten tidak dipublikasikan karena situasi yang diharapkan dari sudut pandang penyedia.
  • Hal ini membantu developer memberikan analisis tentang kapan data dipublikasikan atau tidak.
  • Google dapat menggunakan kode status untuk mendorong pengguna melakukan tindakan tertentu dalam aplikasi sehingga mereka dapat melihat konten aplikasi atau mengatasinya.

Daftar kode status publikasi yang memenuhi syarat adalah:

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Jika konten tidak dipublikasikan karena pengguna tidak login, Google merekomendasikan untuk memublikasikan Kartu Login. Jika karena alasan apa pun penyedia tidak dapat memublikasikan Kartu Login, sebaiknya panggil API updatePublishStatus dengan kode status NOT_PUBLISHED_REQUIRES_SIGN_IN

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationClusters

API ini digunakan untuk menghapus konten Cluster Rekomendasi.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Saat menerima permintaan, layanan akan menghapus data yang ada dari Cluster Rekomendasi. Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

deleteFeaturedCluster

API ini digunakan untuk menghapus konten Cluster Unggulan.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Saat menerima permintaan, layanan akan menghapus data yang ada dari Cluster Unggulan. Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

deleteReservationCluster

API ini digunakan untuk menghapus konten Cluster Reservasi.

Kotlin

client.deleteReservationCluster()

Java

client.deleteReservationCluster();

Saat menerima permintaan, layanan akan menghapus data yang ada dari Cluster Reservasi. Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

deleteUserManagementCluster

API ini digunakan untuk menghapus konten Cluster UserAccountManagement.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Saat menerima permintaan, layanan akan menghapus data yang ada dari Cluster UserAccountManagement. Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

deleteContinueSearchCluster

API ini digunakan untuk menghapus konten Cluster Lanjutkan Penelusuran.

Kotlin

client.deleteContinueSearchCluster()

Java

client.deleteContinueSearchCluster();

Saat menerima permintaan, layanan akan menghapus data yang ada dari Cluster Lanjutkan Penelusuran. Jika terjadi error, seluruh permintaan akan ditolak, dan status yang ada dipertahankan.

deleteClusters

API ini digunakan untuk menghapus konten jenis cluster tertentu.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_RESERVATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_RESERVATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                .addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
                .build());

Saat menerima permintaan tersebut, layanan akan menghapus data yang ada dari semua cluster yang cocok dengan jenis cluster yang ditentukan. Klien dapat memilih untuk meneruskan satu atau beberapa jenis cluster. Jika terjadi error, seluruh permintaan akan ditolak dan status yang ada dipertahankan.

Penanganan error

Sangat disarankan untuk memproses hasil tugas dari API publikasi sehingga tindakan lanjutan dapat diambil untuk memulihkan dan mengirim ulang tugas yang berhasil.

Kotlin

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

Error akan ditampilkan sebagai AppEngageException dengan penyebab disertakan sebagai kode error.

Kode error Nama error Catatan
1 SERVICE_NOT_FOUND Layanan tidak tersedia di perangkat yang ditentukan.
2 SERVICE_NOT_AVAILABLE Layanan tersedia di perangkat tertentu, tetapi tidak tersedia pada saat panggilan (misalnya, dinonaktifkan secara eksplisit).
3 SERVICE_CALL_EXECUTION_FAILURE Eksekusi tugas gagal karena masalah threading. Dalam hal ini, tindakan tersebut dapat dicoba lagi.
4 SERVICE_CALL_PERMISSION_DENIED Pemanggil tidak diizinkan untuk melakukan panggilan layanan.
5 SERVICE_CALL_INVALID_ARGUMENT Permintaan berisi data yang tidak valid (misalnya, lebih dari jumlah cluster yang diizinkan).
6 SERVICE_CALL_INTERNAL Terjadi error di sisi layanan.
7 SERVICE_CALL_RESOURCE_EXHAUSTED Panggilan layanan terlalu sering dilakukan.

Langkah 3: Menangani intent siaran

Selain melakukan panggilan API publikasi konten melalui tugas, Anda juga harus menyiapkan BroadcastReceiver untuk menerima permintaan publikasi konten.

Tujuan intent siaran terutama untuk pengaktifan kembali aplikasi dan memaksa sinkronisasi data. Intent siaran tidak didesain untuk dikirim terlalu sering. Intent itu hanya dipicu jika Layanan Engage menyimpulkan bahwa konten mungkin sudah tidak berlaku (misalnya, seminggu yang lalu). Dengan demikian, pengguna menjadi lebih yakin bahwa mereka dapat memiliki pengalaman konten baru meskipun aplikasi tidak dijalankan dalam waktu yang lama.

BroadcastReceiver harus disiapkan dengan dua cara berikut:

  • Daftarkan instance class BroadcastReceiver secara dinamis menggunakan Context.registerReceiver(). Hal ini memungkinkan komunikasi dari aplikasi yang masih aktif dalam memori.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

}
  • Deklarasikan penerapan secara statis dengan tag <receiver> di file AndroidManifest.xml Anda. Hal ini memungkinkan aplikasi menerima intent siaran ketika tidak sedang berjalan, dan juga memungkinkan aplikasi untuk memublikasikan konten.
<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
   </receiver>
</application>

Intent berikut dikirim oleh layanan:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Sebaiknya mulai panggilan publishRecommendationClusters saat menerima intent ini.
  • com.google.android.engage.action.PUBLISH_FEATURED Sebaiknya mulai panggilan publishFeaturedCluster saat menerima intent ini.

Alur kerja integrasi

Untuk panduan langkah demi langkah cara memverifikasi integrasi Anda setelah selesai, lihat Alur kerja integrasi developer untuk Engage.

FAQ

Lihat Pertanyaan Umum tentang Engage SDK untuk mengetahui FAQ.

Kontak

Hubungi engage-developers@google.com jika ada pertanyaan selama proses integrasi.

Langkah berikutnya

Setelah menyelesaikan integrasi ini, langkah-langkah Anda berikutnya adalah sebagai berikut:

  • Kirim email ke engage-developers@google.com dan lampirkan APK terintegrasi yang siap diuji oleh Google.
  • Google melakukan verifikasi dan peninjauan secara internal untuk memastikan integrasi berfungsi seperti yang diharapkan. Jika diperlukan perubahan, Google akan menghubungi Anda dengan menyertakan detail yang diperlukan.
  • Setelah pengujian selesai dan tidak ada perubahan yang diperlukan, Google akan menghubungi Anda untuk memberi tahu bahwa Anda dapat mulai memublikasikan APK yang diupdate dan terintegrasi ke Play Store.
  • Setelah Google mengonfirmasi bahwa APK yang diupdate telah dipublikasikan ke Play Store, cluster Rekomendasi, Unggulan, Pemesanan, dan Lanjutkan Penelusuran dapat dipublikasikan dan terlihat oleh pengguna.