GetInAppMessagesContoh JSON respons API Amazon Pinpoint

Saat Anda memanggil operasi GetInAppMessagesAPI, ia mengembalikan daftar pesan yang menjadi hak titik akhir yang ditentukan. Aplikasi Anda kemudian dapat merender pesan berdasarkan nilai dalam respons.

Berikut ini adalah contoh objek JSON yang dikembalikan saat Anda memanggil GetInAppMessages API:

{
  "InAppMessagesResponse":{
    "InAppMessageCampaigns":[
      {
        "CampaignId":"inAppTestCampaign-4c545b28d21a490cb51b0b364example",
        "DailyCap":0,
        "InAppMessage":{
          "Content":[
            {
              "BackgroundColor":"#f8e71c",
              "BodyConfig":{
                "Alignment":"CENTER",
                "Body":"This is a sample in-app message sent using Amazon Pinpoint.",
                "TextColor":"#d0021b"
              },
              "HeaderConfig":{
                "Alignment":"CENTER",
                "Header":"Sample In-App Message",
                "TextColor":"#d0021b"
              },
              "ImageUrl":"https://example.com/images/thumbnail.png",
              "PrimaryBtn":{
                "DefaultConfig":{
                  "BackgroundColor":"#d0021b",
                  "BorderRadius":50,
                  "ButtonAction":"CLOSE",
                  "Text":"Dismiss",
                  "TextColor":"#f8e71c"
                }
              }
            }
          ],
          "Layout":"MIDDLE_BANNER"
        },
        "Priority":3,
        "Schedule":{
          "EndDate":"2021-11-06T00:08:05Z",
          "EventFilter":{
            "Dimensions":{
              "Attributes":{
                
              },
              "EventType":{
                "DimensionType":"INCLUSIVE",
                "Values":[
                  "_session.start"
                ]
              },
              "Metrics":{
                
              }
            }
          }
        },
        "SessionCap":0,
        "TotalCap":0,
        "TreatmentId":"0"
      }
    ]
  }
}

Bagian berikut memberikan informasi tentang komponen respons ini, dan atributnya.

Objek InAppMessageCampaigns

InAppMessageCampaignsObjek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
CampaignId	String yang berisi nama dan ID kampanye unik kampanye Amazon Pinpoint tempat pesan dikirim. Nama mendahului ID kampanye. Kedua nilai dipisahkan dengan tanda hubung (-).	Dibuat secara otomatis oleh Amazon Pinpoint saat Anda membuat kampanye.
TreatmentId	Integer yang mewakili ID perlakuan kampanye untuk pesan ini. Jika kampanye hanya memiliki satu perlakuan, nilainya adalah0.
Priority	Prioritas pesan dalam aplikasi, dinyatakan sebagai bilangan bulat antara 1 dan 5, inklusif, di mana 1 menunjukkan prioritas tertinggi, dan 5 menunjukkan prioritas terendah.	Langkah 1 dari proses pembuatan kampanye.
InAppMessage	Sebuah Objek InAppMessage yang berisi informasi tentang bagaimana pesan diberikan.	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
Schedule	Objek Jadwal yang berisi informasi tentang kapan pesan dikirim.	Langkah 4 dari proses pembuatan kampanye (jika kampanye dibuat di konsol) atau Schedule objek (jika kampanye dibuat menggunakan API atau SDK).
DailyCap	Berapa kali, ditampilkan sebagai bilangan bulat, bahwa pesan dalam aplikasi dapat ditampilkan kepada pengguna selama periode 24 jam.	Diwarisi dari pengaturan tingkat proyek. Jika kampanye menyertakan setelan yang mengesampingkan setelan proyek, maka setelan tersebut akan digunakan sebagai gantinya.
SessionCap	Berapa kali, dinyatakan sebagai bilangan bulat, bahwa pesan dalam aplikasi dapat ditampilkan kepada pengguna selama sesi aplikasi.
TotalCap	Jumlah total kali, dinyatakan sebagai bilangan bulat, bahwa setiap pesan dalam aplikasi dapat ditampilkan ke titik akhir per kampanye.

Objek InAppMessage

InAppMessageObjek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
Content	Array yang berisi InAppMessageContentobjek, yang menggambarkan isi pesan.	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
Layout	String yang menjelaskan bagaimana pesan dalam aplikasi akan muncul di perangkat penerima. Kemungkinan nilainya adalah: BOTTOM_BANNER— pesan yang muncul sebagai spanduk di bagian bawah halaman. TOP_BANNER— pesan yang muncul sebagai spanduk di bagian atas halaman. OVERLAYS— pesan yang mencakup seluruh layar. MOBILE_FEED— pesan yang muncul di jendela di depan halaman. MIDDLE_BANNER— pesan yang muncul sebagai spanduk di tengah halaman. CAROUSEL— tata letak yang dapat digulir hingga lima pesan unik.

Objek HeaderConfig

HeaderConfigObjek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
Alignment	Sebuah string yang menentukan perataan teks dari teks header. Nilai yang mungkin adalah LEFT, CENTER, dan RIGHT.	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
Header	Teks header pesan.
TextColor	Warna teks header, dinyatakan sebagai string yang menjelaskan kode warna hex (seperti "#000000" untuk hitam).

Objek BodyConfig

BodyConfigObjek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
Alignment	String yang menentukan perataan teks dari badan pesan. Nilai yang mungkin adalah LEFT, CENTER, dan RIGHT.	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
Body	Teks tubuh utama pesan.
TextColor	Warna teks tubuh, dinyatakan sebagai string yang berisi kode warna hex (seperti "#000000" untuk hitam).

Objek InAppMessageContent

InAppMessageContentObjek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
BackgroundColor	Warna latar belakang pesan dalam aplikasi, dinyatakan sebagai string yang berisi kode warna hex (seperti "#000000" untuk hitam).	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
BodyConfig	Sebuah BodyConfigobjek, yang berisi informasi yang terkait dengan isi isi utama pesan.
HeaderConfig	HeaderConfigObjek, yang berisi informasi yang terkait dengan header atau judul pesan.
ImageUrl	URL gambar yang muncul dalam pesan.
PrimaryBtn	InAppMessageButtonObjek yang berisi informasi tentang tombol utama dalam pesan.
SecondaryBtn	InAppMessageButtonObjek yang berisi informasi tentang tombol sekunder dalam pesan. Tidak ada jika template pesan dalam aplikasi tidak menentukan tombol sekunder.

Objek Schedule

ScheduleObjek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
EndDate	Waktu yang dijadwalkan, dalam format ISO 8601, ketika kampanye akan berakhir.	Langkah 4 dari proses pembuatan kampanye (jika kampanye dibuat di konsol) atau Schedule objek (jika kampanye dibuat menggunakan API atau SDK).
EventFilter	Informasi tentang peristiwa yang menyebabkan pesan dalam aplikasi ditampilkan. Saat Anda membuat acara yang cocok dengan kampanye dalam aplikasi Amazon Pinpoint, pesan akan ditampilkan.

Objek InAppMessageButton

Sebuah InAppMessageButton objek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
DefaultConfig	DefaultButtonConfigObjek yang berisi informasi tentang pengaturan default untuk tombol dalam pesan dalam aplikasi.	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
Android	OverrideButtonConfigObjek yang menentukan cara tombol berperilaku di perangkat Android. Ini mengesampingkan konfigurasi tombol default yang dirinci dalam objek. DefaultConfig
IOS	OverrideButtonConfigObjek yang menentukan cara tombol berperilaku pada perangkat iOS. Ini mengesampingkan konfigurasi tombol default yang dirinci dalam objek. DefaultConfig
Web	OverrideButtonConfigObjek yang menentukan cara tombol berperilaku di aplikasi web. Ini mengesampingkan konfigurasi tombol default yang dirinci dalam objek. DefaultConfig

Objek DefaultButtonConfig

Sebuah DefaultButtonConfig objek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
BackgroundColor	Warna latar belakang tombol, dinyatakan sebagai string yang berisi kode warna hex (seperti "#000000" untuk hitam).	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
BorderRadius	Radius batas tombol dalam piksel, dinyatakan sebagai bilangan bulat. Angka yang lebih besar menghasilkan sudut yang lebih bulat.
ButtonAction	String yang menjelaskan tindakan yang terjadi saat penerima memilih tombol dalam pesan dalam aplikasi. Kemungkinan nilainya adalah: LINK— Tautan ke tujuan web. DEEP_LINK— Tautan ke halaman tertentu dalam aplikasi. CLOSE— Menolak pesan.
Link	URL tujuan untuk sebuah tombol. Tidak ada untuk tombol di mana ButtonAction beradaCLOSE.
Text	Teks yang muncul di tombol.
TextColor	Warna teks pada tombol, dinyatakan sebagai string yang berisi kode warna hex (seperti "#000000" untuk hitam).

Objek OverrideButtonConfig

OverrideButtonConfigObjek hanya ada jika template pesan dalam aplikasi menggunakan tombol override. Tombol ganti adalah tombol yang memiliki konfigurasi khusus untuk jenis perangkat tertentu, seperti perangkat iOS, perangkat Android, atau browser web.

Sebuah OverrideButtonConfig objek berisi atribut berikut:

Atribut	Deskripsi	Dimana itu diatur
ButtonAction	Tindakan yang terjadi ketika penerima memilih tombol dalam pesan dalam aplikasi. Kemungkinan nilainya adalah: LINK— Tautan ke tujuan web. DEEP_LINK— Tautan ke halaman tertentu dalam aplikasi. CLOSE— Menolak pesan.	Berdasarkan konten dalam templat pesan dalam aplikasi yang ditentukan untuk kampanye.
Link	URL tujuan untuk sebuah tombol. Tidak ada untuk tombol di mana ButtonAction beradaCLOSE.
Text	Teks yang muncul di tombol.
TextColor	Warna teks pada tombol, dinyatakan sebagai string yang berisi kode warna hex (seperti "#000000" untuk hitam).