Gunakan hasil kueri Amazon Pinpoint analytics JSON - Amazon Pinpoint
Struktur JSONObjek dan bidang JSON

Pemberitahuan akhir dukungan: Pada 30 Oktober 2026, AWS akan mengakhiri dukungan untuk Amazon Pinpoint. Setelah 30 Oktober 2026, Anda tidak akan lagi dapat mengakses konsol Amazon Pinpoint atau sumber daya Amazon Pinpoint (titik akhir, segmen, kampanye, perjalanan, dan analitik). Untuk informasi selengkapnya, lihat Amazon Pinpoint akhir dukungan. Catatan: APIs terkait dengan SMS, suara, push seluler, OTP, dan validasi nomor telepon tidak terpengaruh oleh perubahan ini dan didukung oleh AWS End User Messaging.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Gunakan hasil kueri Amazon Pinpoint analytics JSON

Saat Anda menggunakan Amazon Pinpoint Analytics APIs untuk menanyakan data analitik, Amazon Pinpoint menampilkan hasilnya dalam respons JSON. Untuk metrik aplikasi, metrik kampanye, dan metrik keterlibatan perjalanan, data dalam respons mematuhi skema JSON standar untuk melaporkan data analitik Amazon Pinpoint.

Ini berarti Anda dapat menggunakan bahasa pemrograman atau alat pilihan Anda untuk menerapkan solusi khusus yang menanyakan data untuk satu atau lebih metrik ini, menangkap hasil setiap kueri, dan kemudian menulis hasilnya ke tabel, objek, atau lokasi lain. Anda kemudian dapat bekerja dengan hasil kueri di lokasi tersebut dengan menggunakan layanan atau aplikasi lain.

Sebagai contoh, Anda dapat:

  • Buat dasbor khusus yang menanyakan serangkaian metrik secara teratur dan menampilkan hasilnya dengan menggunakan kerangka visualisasi data pilihan Anda.

  • Buat laporan yang melacak tingkat keterlibatan dengan menanyakan metrik yang sesuai dan menampilkan hasilnya dalam bagan atau jenis laporan lain yang Anda desain.

  • Parse dan tulis data analitik ke format penyimpanan tertentu, lalu port hasilnya ke solusi penyimpanan jangka panjang.

Perhatikan bahwa Amazon Pinpoint Analytics APIs tidak dirancang untuk membuat atau menyimpan objek persisten apa pun yang selanjutnya dapat Anda baca atau gunakan dalam proyek Amazon Pinpoint atau akun Amazon Pinpoint Anda. Sebaliknya, ini APIs dirancang untuk membantu Anda mengambil data analitik dan mentransfer data tersebut ke layanan dan aplikasi lain untuk analisis, penyimpanan, atau pelaporan lebih lanjut. Mereka melakukan ini sebagian dengan menggunakan struktur dan skema respons JSON yang sama untuk semua data analitik yang dapat Anda kueri secara terprogram untuk metrik aplikasi, metrik kampanye, dan metrik keterlibatan perjalanan.

Topik ini menjelaskan struktur, objek, dan bidang dalam respons JSON terhadap kueri untuk metrik aplikasi, metrik kampanye, atau metrik keterlibatan perjalanan. Untuk informasi tentang bidang dalam respons JSON terhadap kueri untuk metrik eksekusi perjalanan atau metrik eksekusi aktivitas perjalanan, lihatMetrik standar yang berlaku untuk proyek, kampanye, dan perjalanan Amazon Pinpoint.

Struktur JSON

Untuk membantu Anda mengurai dan menggunakan hasil kueri, Amazon Pinpoint APIs Analytics menggunakan struktur respons JSON yang sama untuk semua data analitik Amazon Pinpoint yang dapat Anda kueri secara terprogram untuk metrik aplikasi, metrik kampanye, dan metrik keterlibatan perjalanan. Setiap respons JSON menentukan nilai yang mendefinisikan kueri, seperti ID proyek ()ApplicationId. Respons juga mencakup satu (dan hanya satu) KpiResult objek. KpiResultObjek berisi hasil keseluruhan yang ditetapkan untuk kueri.

Setiap KpiResult objek berisi Rows objek. Ini adalah array objek yang berisi hasil query dan metadata yang relevan tentang nilai-nilai dalam hasil tersebut. Struktur dan isi suatu Rows objek memiliki karakteristik umum sebagai berikut:

  • Setiap baris hasil query adalah objek JSON terpisah, bernamaValues, dalam Rows objek. Misalnya, jika query mengembalikan tiga nilai, Rows objek berisi tiga Values objek. Setiap Values objek berisi hasil individual untuk kueri.

  • Setiap kolom hasil kueri adalah properti dari Values objek yang diterapkan. Nama kolom disimpan di Key bidang Values objek.

  • Untuk hasil kueri yang dikelompokkan, setiap Values objek memiliki GroupedBys objek terkait. GroupedBysObjek menunjukkan bidang mana yang digunakan untuk mengelompokkan hasil. Ini juga memberikan nilai pengelompokan untuk Values objek terkait.

  • Jika hasil kueri untuk metrik adalah nol, Rows objek kosong.

Di luar karakteristik umum ini, struktur dan isi Rows objek bervariasi tergantung pada metrik. Ini karena Amazon Pinpoint mendukung dua jenis metrik, metrik nilai tunggal, dan metrik multi-nilai.

Metrik nilai tunggal hanya menyediakan satu nilai kumulatif. Contohnya adalah persentase pesan yang dikirimkan ke penerima oleh semua proses kampanye. Metrik multi-nilai menyediakan lebih dari satu nilai dan mengelompokkan nilai-nilai tersebut dengan bidang yang relevan. Contohnya adalah persentase pesan yang dikirimkan ke penerima untuk setiap proses kampanye, dikelompokkan berdasarkan kampanye yang dijalankan.

Anda dapat dengan cepat menentukan apakah metrik adalah metrik nilai tunggal atau metrik multi-nilai dengan mengacu pada nama metrik. Jika nama tidak mengandunggrouped-by, itu adalah metrik nilai tunggal. Jika ya, itu adalah metrik multi-nilai. Untuk daftar lengkap metrik yang dapat Anda kueri secara terprogram, lihat. Metrik standar yang berlaku untuk proyek, kampanye, dan perjalanan Amazon Pinpoint

Metrik nilai tunggal

Untuk metrik nilai tunggal, Rows objek berisi Values objek yang:

  • Menentukan nama ramah metrik yang ditanyakan.

  • Memberikan nilai untuk metrik yang ditanyakan.

  • Mengidentifikasi tipe data dari nilai yang dikembalikan.

Misalnya, respons JSON berikut berisi hasil kueri untuk metrik nilai tunggal. Metrik ini melaporkan jumlah titik akhir unik yang dikirimkan pesan oleh semua kampanye yang terkait dengan proyek, mulai 1 Agustus 2019 hingga 31 Agustus 2019:

{
    "ApplicationDateRangeKpiResponse":{
        "ApplicationId":"1234567890123456789012345example",
        "EndTime":"2019-08-31T23:59:59Z",
        "KpiName":"unique-deliveries",
        "KpiResult":{
            "Rows":[
                {
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"1368.0"
                        }
                    ]
                }
            ]
        },
        "StartTime":"2019-08-01T00:00:00Z"
    }
}

Dalam contoh ini, tanggapan menunjukkan bahwa semua kampanye proyek mengirimkan pesan ke 1.368 titik akhir unik dari 1 Agustus 2019 hingga 31 Agustus 2019, di mana:

  • Keyadalah nama ramah metrik yang nilainya ditentukan di Value bidang (UniqueDeliveries).

  • Typeadalah tipe data dari nilai yang ditentukan dalam Value bidang (Double).

  • Valueadalah nilai aktual untuk metrik yang ditanyakan, termasuk filter apa pun yang diterapkan (1368.0).

Jika hasil kueri untuk metrik nilai tunggal adalah nol (tidak lebih besar dari atau sama dengan nol), Rows objek kosong. Amazon Pinpoint mengembalikan nilai null untuk metrik jika tidak ada data yang dikembalikan untuk metrik tersebut. Sebagai contoh:

{
    "ApplicationDateRangeKpiResponse":{
        "ApplicationId":"2345678901234567890123456example",
        "EndTime":"2019-08-31T23:59:59Z",
        "KpiName":"unique-deliveries",
        "KpiResult":{
            "Rows":[

            ]
        },
        "StartTime":"2019-08-01T00:00:00Z"
    }
}

Metrik nilai ganda

Struktur dan isi Rows objek untuk metrik multi-nilai sebagian besar sama dengan metrik nilai tunggal. RowsObjek untuk metrik multi-nilai juga berisi objek. Values ValuesObjek menentukan nama ramah metrik yang ditanyakan, memberikan nilai untuk metrik itu, dan mengidentifikasi tipe data dari nilai tersebut.

Namun, Rows objek untuk metrik multi-nilai juga berisi satu atau lebih objek. GroupedBy Ada satu GroupedBy objek untuk setiap Values objek dalam hasil query. GroupedByObjek menunjukkan bidang mana yang digunakan untuk mengelompokkan data dalam hasil dan tipe data bidang itu. Ini juga menunjukkan nilai pengelompokan untuk bidang itu (untuk Values objek terkait).

Misalnya, respons JSON berikut berisi hasil kueri untuk metrik multi-nilai yang melaporkan jumlah titik akhir unik yang dikirimkan pesan, untuk setiap kampanye yang terkait dengan proyek, mulai 1 Agustus 2019 hingga 31 Agustus 2019:

{
    "ApplicationDateRangeKpiResponse":{
        "ApplicationId":"1234567890123456789012345example",
        "EndTime":"2019-08-31T23:59:59Z",
        "KpiName":"unique-deliveries-grouped-by-campaign",
        "KpiResult":{
            "Rows":[
                {
                    "GroupedBys":[
                        {
                            "Key":"CampaignId",
                            "Type":"String",
                            "Value":"80b8efd84042ff8d9c96ce2f8example"
                        }
                    ],
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"123.0"
                        }
                    ]
                },
                {
                    "GroupedBys":[
                        {
                            "Key":"CampaignId",
                            "Type":"String",
                            "Value":"810c7aab86d42fb2b56c8c966example"
                        }
                    ],
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"456.0"
                        }
                    ]
                },
                {
                    "GroupedBys":[
                        {
                            "Key":"CampaignId",
                            "Type":"String",
                            "Value":"42d8c7eb0990a57ba1d5476a3example"
                        }
                    ],
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"789.0"
                        }
                    ]
                }
            ]
        },
        "StartTime":"2019-08-01T00:00:00Z"
    }
}

Dalam contoh ini, tanggapan menunjukkan bahwa tiga kampanye proyek mengirimkan pesan ke titik akhir unik dari 1 Agustus 2019 hingga 31 Agustus 2019. Untuk masing-masing kampanye tersebut, rincian jumlah pengiriman adalah:

  • Kampanye 80b8efd84042ff8d9c96ce2f8example mengirimkan pesan ke 123 titik akhir unik.

  • Kampanye 810c7aab86d42fb2b56c8c966example mengirimkan pesan ke 456 titik akhir unik.

  • Kampanye 42d8c7eb0990a57ba1d5476a3example mengirimkan pesan ke 789 titik akhir unik.

Dimana struktur umum objek dan bidang adalah:

  • GroupedBys.Key— Nama properti atau bidang yang menyimpan nilai pengelompokan yang ditentukan dalam GroupedBys.Value bidang (CampaignId).

  • GroupedBys.Type— Tipe data dari nilai yang ditentukan dalam GroupedBys.Value bidang (String).

  • GroupedBys.Value— Nilai aktual untuk bidang yang digunakan untuk mengelompokkan data, seperti yang ditentukan dalam GroupedBys.Key bidang (ID kampanye).

  • Values.Key— Nama ramah metrik yang nilainya ditentukan di Values.Value bidang (UniqueDeliveries).

  • Values.Type— Tipe data dari nilai yang ditentukan dalam Values.Value bidang (Double).

  • Values.Value— Nilai aktual untuk metrik yang ditanyakan, termasuk filter apa pun yang diterapkan.

Jika hasil kueri untuk metrik multi-nilai adalah nol (tidak lebih besar dari atau sama dengan nol) untuk proyek, kampanye, atau sumber daya tertentu lainnya, Amazon Pinpoint tidak menampilkan objek atau bidang apa pun untuk sumber daya. Jika hasil kueri untuk metrik multi-nilai adalah nol untuk semua sumber daya, Amazon Pinpoint mengembalikan objek kosong. Rows

Objek dan bidang JSON

Selain menentukan nilai yang mendefinisikan kueri, seperti ID proyek (ApplicationId), setiap respons JSON terhadap kueri untuk metrik aplikasi, metrik kampanye, atau metrik keterlibatan perjalanan menyertakan KpiResult objek. Objek ini berisi kumpulan hasil keseluruhan untuk kueri, yang dapat Anda uraikan untuk mengirim data analitik ke layanan atau aplikasi lain. Setiap KpiResult objek berisi beberapa atau semua objek dan bidang standar berikut, tergantung pada metrik.

Objek atau bidang Deskripsi
Rows Sebuah array objek yang berisi hasil set untuk query.
Rows.GroupedBys Untuk metrik multi-nilai, larik bidang yang mendefinisikan bidang dan nilai yang digunakan untuk mengelompokkan data dalam hasil kueri.
Rows.GroupedBys.Key Untuk metrik multi-nilai, nama properti atau bidang yang menyimpan nilai yang ditentukan dalam bidang. GroupedBys.Value
Rows.GroupedBys.Type Untuk metrik multi-nilai, tipe data dari nilai yang ditentukan di bidang. GroupedBys.Value
Rows.GroupedBys.Value Untuk metrik multi-nilai, nilai aktual untuk bidang yang digunakan untuk mengelompokkan data dalam hasil kueri. Nilai ini berkorelasi dengan objek terkaitValues.
Rows.Values Sebuah array bidang yang berisi hasil query.
Rows.Values.Key Nama ramah dari metrik yang ditanyakan. Nilai metrik ditentukan di Values.Value bidang.
Rows.Values.Type Tipe data dari nilai yang ditentukan di Values.Value bidang.
Rows.Values.Value Nilai aktual untuk metrik yang ditanyakan, termasuk filter apa pun yang diterapkan.

Untuk informasi tentang bidang dalam respons JSON terhadap kueri untuk metrik eksekusi perjalanan atau metrik eksekusi aktivitas perjalanan, lihatMetrik standar yang berlaku untuk proyek, kampanye, dan perjalanan Amazon Pinpoint.