Acara email - Amazon Pinpoint
Contoh acaraAtribut acara email

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

Acara email

Sebelum Anda dapat melihat acara Anda, Anda harus mengatur streaming acara, lihatMenyiapkan streaming acara. Saat mengatur streaming acara, Anda menentukan tujuan untuk data acara Anda untuk disimpan dan kemudian Anda dapat menggunakan tujuan untuk mengambil data acara Anda untuk dilihat. Saat Anda mengirim pesan email, Amazon Pinpoint dapat mengalirkan data yang memberikan informasi tambahan tentang jenis peristiwa berikut untuk pesan tersebut:

  • Mengirim

  • Pengiriman

  • Pentalan

  • Aduan

  • Membuka

  • Klik

  • Penolakan

  • Berhenti berlangganan

  • Kegagalan rendering

Jenis acara dalam daftar sebelumnya dijelaskan secara rinci dalam. Atribut acara email

Bergantung pada pengaturan API dan pengaturan yang Anda gunakan untuk mengirim pesan email, Anda mungkin melihat jenis acara tambahan atau data yang berbeda. Misalnya, jika Anda mengirim pesan menggunakan set konfigurasi yang memublikasikan data peristiwa ke Amazon Kinesis, seperti yang disediakan oleh Amazon Simple Email Service SES (Amazon), data juga dapat menyertakan peristiwa untuk kegagalan rendering template. Untuk informasi tentang data tersebut, lihat Pemantauan menggunakan penerbitan SES peristiwa Amazon di Panduan Pengembang Layanan Email Sederhana Amazon. Sebelum Anda dapat melihat acara Anda, Anda harus mengatur streaming acara, lihatMenyiapkan streaming acara. Saat mengatur streaming acara, Anda menentukan tujuan untuk data acara Anda untuk disimpan dan kemudian Anda dapat menggunakan tujuan untuk mengambil data acara Anda untuk dilihat.

Contoh acara

Kirim email

JSONObjek untuk acara pengiriman email berisi data yang ditunjukkan dalam contoh berikut.

{
  "event_type": "_email.send",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618622025,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "9a311b17-6f8e-4093-be61-4d0bbexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "received"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "send": {}
      }
    }
  }
}
Email terkirim

JSONObjek untuk acara yang dikirim email berisi data yang ditunjukkan dalam contoh berikut.

{
  "event_type": "_email.delivered",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618622690,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "e9a3000d-daa2-40dc-ac47-1cd34example"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "delivered"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "delivery": {
          "smtp_response": "250 ok:  Message 82080542 accepted",
          "reporting_mta": "a8-53.smtp-out.amazonses.com",
          "recipients": ["recipient@example.com"],
          "processing_time_millis": 1310
        }
      }
    }
  }
}
Klik email

JSONObjek untuk acara klik email berisi data yang ditunjukkan dalam contoh berikut.

{
  "event_type": "_email.click",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618713751,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "49c1413e-a69c-46dc-b1c4-6470eexample"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "https://aws.amazon.com/pinpoint/"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }, {
            "name": "Message-ID",
            "value": "null"
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "click": {
          "ip_address": "72.21.198.67",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.2 Safari/605.1.15",
          "link": "https://aws.amazon.com/pinpoint/"
        }
      }
    }
  }
}
Email terbuka

JSONObjek untuk acara terbuka email berisi data yang ditunjukkan dalam contoh berikut.

{
  "event_type": "_email.open",
  "event_timestamp": 1564618621380,
  "arrival_timestamp": 1564618712316,
  "event_version": "3.1",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "sdk": {}
  },
  "client": {
    "client_id": "8dc1f651-b3ec-46fc-9b67-2a050example"
  },
  "device": {
    "platform": {}
  },
  "session": {},
  "attributes": {
    "feedback": "opened"
  },
  "awsAccountId": "123456789012",
  "facets": {
    "email_channel": {
      "mail_event": {
        "mail": {
          "message_id": "0200000073rnbmd1-mbvdg3uo-q8ia-m3ku-ibd3-ms77kexample-000000",
          "message_send_timestamp": 1564618621380,
          "from_address": "sender@example.com",
          "destination": ["recipient@example.com"],
          "headers_truncated": false,
          "headers": [{
            "name": "From",
            "value": "sender@example.com"
          }, {
            "name": "To",
            "value": "recipient@example.com"
          }, {
            "name": "Subject",
            "value": "Amazon Pinpoint Test"
          }, {
            "name": "MIME-Version",
            "value": "1.0"
          }, {
            "name": "Content-Type",
            "value": "multipart/alternative;  boundary=\"----=_Part_314159_271828\""
          }, {
            "name": "Message-ID",
            "value": "null"
          }],
          "common_headers": {
            "from": "sender@example.com",
            "to": ["recipient@example.com"],
            "subject": "Amazon Pinpoint Test"
          }
        },
        "open": {
          "ip_address": "72.21.198.67",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko)"
        }
      }
    }
  }
}

Atribut acara email

Bagian ini mendefinisikan atribut yang disertakan dalam data aliran peristiwa yang dihasilkan Amazon Pinpoint saat Anda mengirim pesan email.

Atribut Deskripsi
event_type

Jenis peristiwa. Kemungkinan nilainya adalah:

  • _email.send — Amazon Pinpoint menerima pesan dan mencoba mengirimkannya ke penerima.

  • _email.delivered — Pesan telah dikirimkan ke penerima.

  • _email.rejected — Amazon Pinpoint menentukan bahwa pesan tersebut berisi malware dan tidak mencoba mengirimkannya.

  • _email.hardbounce — Masalah permanen mencegah Amazon Pinpoint menyampaikan pesan. Amazon Pinpoint tidak akan mencoba mengirimkan pesan lagi.

  • _email.softbounce — Masalah sementara mencegah Amazon Pinpoint menyampaikan pesan. Amazon Pinpoint akan mencoba mengirimkan pesan lagi untuk jangka waktu tertentu. Jika pesan masih tidak dapat dikirimkan, tidak ada lagi percobaan ulang yang akan dicoba. Status akhir dari email kemudian akan menjadiSOFTBOUNCE.

  • _email.complaint — Penerima menerima pesan, dan kemudian melaporkan pesan tersebut ke penyedia email mereka sebagai spam (misalnya, dengan menggunakan fitur “Laporkan Spam” dari klien email mereka).

  • _email.open — Penerima menerima pesan dan membukanya.

  • _email.click — Penerima menerima pesan dan mengklik tautan di dalamnya.

  • _email.unsubscribe — Penerima menerima pesan dan mengklik tautan berhenti berlangganan di dalamnya.

  • _email.rendering_failure — Email tidak dikirim karena kegagalan rendering. Hal ini dapat terjadi ketika data template hilang atau ketika ada ketidakcocokan antara parameter template dan data.
event_timestamp

Waktu ketika pesan dikirim, ditampilkan sebagai waktu Unix dalam milidetik. Nilai ini biasanya sama untuk semua peristiwa yang dihasilkan untuk pesan.
arrival_timestamp

Waktu ketika acara diterima oleh Amazon Pinpoint, ditampilkan sebagai waktu Unix dalam milidetik.
event_version

Versi JSON skema acara.

Tip

Periksa versi ini di aplikasi pemrosesan acara Anda sehingga Anda tahu kapan harus memperbarui aplikasi sebagai respons terhadap pembaruan skema.
application

Informasi tentang proyek Amazon Pinpoint yang terkait dengan acara tersebut. Lihat tabel Aplikasi untuk informasi selengkapnya.
client

Informasi tentang klien aplikasi yang diinstal pada perangkat yang melaporkan peristiwa tersebut. Untuk informasi selengkapnya, lihat tabel Klien.
device

Informasi tentang perangkat yang melaporkan acara tersebut. Untuk informasi selengkapnya, lihat tabel Perangkat.

Untuk acara email, objek ini kosong.
session Untuk acara email, objek ini kosong.
attributes

Atribut yang terkait dengan acara tersebut. Untuk informasi selengkapnya, lihat tabel Atribut.

Untuk peristiwa yang dilaporkan oleh salah satu aplikasi Anda, objek ini dapat menyertakan atribut khusus yang ditentukan oleh aplikasi. Untuk acara yang dibuat saat Anda mengirim pesan dari kampanye atau perjalanan, objek ini berisi atribut yang terkait dengan kampanye atau perjalanan. Untuk peristiwa yang dihasilkan saat Anda mengirim pesan transaksional, objek ini berisi informasi yang terkait dengan pesan itu sendiri.
client_context Untuk acara email, objek ini berisi custom objek, yang berisi legacy_identifier atribut. Nilai untuk legacy_identifier atribut adalah ID proyek tempat pesan dikirim.
facets

Informasi tambahan tentang pesan, seperti header email. Lihat tabel Facets untuk informasi lebih lanjut.
awsAccountId

ID AWS akun yang digunakan untuk mengirim pesan.

Aplikasi

Termasuk informasi tentang proyek Amazon Pinpoint yang terkait dengan acara tersebut.

Atribut Deskripsi
app_id

ID unik dari proyek Amazon Pinpoint yang melaporkan acara tersebut.
sdk

SDKYang digunakan untuk melaporkan peristiwa tersebut. Jika Anda mengirim pesan email transaksional dengan menelepon Amazon API Pinpoint secara langsung atau menggunakan konsol Amazon Pinpoint, objek ini kosong.

Atribut

Termasuk informasi tentang kampanye atau perjalanan yang menghasilkan acara.

Kampanye

Termasuk informasi tentang kampanye yang menghasilkan acara tersebut.

Atribut Deskripsi
feedback

Untuk _email.click peristiwa, nilai untuk atribut ini adalah tautan yang diklik penerima dalam pesan untuk menghasilkan acara. URL Untuk acara lain, nilai ini mewakili jenis acara, sepertireceived,opened, atauclicked.
treatment_id

Jika pesan dikirim menggunakan kampanye pengujian A/B, nilai ini mewakili nomor perlakuan pesan. Untuk kampanye standar dan pesan email transaksional, nilai ini adalah. 0
campaign_activity_id ID unik yang dihasilkan Amazon Pinpoint saat peristiwa terjadi.
campaign_id

ID unik kampanye yang mengirim pesan.

Perjalanan

Termasuk informasi tentang perjalanan yang menghasilkan acara tersebut.

Atribut Deskripsi
journey_run_id ID unik dari perjalanan lari yang mengirim pesan. Amazon Pinpoint menghasilkan dan menetapkan ID ini secara otomatis ke setiap perjalanan baru.
feedback

Untuk _email.click peristiwa, nilai untuk atribut ini adalah tautan yang diklik penerima dalam pesan untuk menghasilkan acara. URL Untuk acara lain, nilai ini mewakili jenis acara, sepertireceived,delivered, atauopened.
journey_id ID unik dari perjalanan yang mengirim pesan.
journey_activity_id ID unik dari aktivitas perjalanan yang mengirim pesan.

Klien

Pengenal unik klien yang ditargetkan oleh kampanye atau perjalanan.

Atribut Deskripsi
client_id ID klien. Nilainya adalah Endpoint ID untuk kampanye dan perjalanan, dan untuk pengiriman Transaksional, itu adalah. UUID

Faset

Termasuk informasi tentang pesan dan jenis acara.

Atribut Deskripsi
email_channel

Berisi mail_event objek, yang berisi dua objek:mail, dan objek yang sesuai dengan jenis acara.

Mail

Mencakup informasi tentang konten pesan email, dan metadata tentang pesan tersebut.

Atribut Deskripsi
message_id

ID unik dari pesan. Amazon Pinpoint secara otomatis menghasilkan ID ini saat menerima pesan.
message_send_timestamp

Tanggal dan waktu ketika pesan dikirim, dalam format yang ditentukan dalam RFC822.
from_address

Alamat email tempat pesan itu dikirim.
destination

Array yang berisi alamat email tempat pesan dikirim.
headers_truncated

Nilai Boolean yang menunjukkan apakah header email terpotong.
headers

Objek yang berisi beberapa pasangan nama-nilai yang sesuai dengan header dalam pesan. Objek ini biasanya berisi informasi tentang header berikut:

  • From— Alamat email pengirim.

  • To— Alamat email penerima.

  • Subject— Baris subjek email.

    Tip

    Header subjek tidak disertakan untuk acara kampanye _email.send.

  • MIME-Version— Menunjukkan bahwa pesan dalam MIME format. Jika header ini ada, nilainya selalu1.0.

  • Content-Type— Jenis MIME media dari konten pesan.
common_headers

Berisi informasi tentang beberapa header umum untuk pesan email. Informasi tersebut dapat mencakup tanggal ketika pesan dikirim, dan baris ke, dari, dan subjek pesan.