Bagikan melalui

Operasi API perjalanan pelanggan dasar

  • Artikel

Catatan

Pada tanggal 1 September 2023, Dynamics 365 Marketing dan Dynamics 365 Customer Insights akan dijual bersama dalam satu SKU produk bernama Dynamics 365 Customer Insights. Aplikasi individual akan diubah namanya menjadi Dynamics 365 Customer Insights - Perjalanan dan Dynamics 365 Customer Insights - Data. Untuk informasi selengkapnya, lihat Tanya Jawab Umum Dynamics 365 Customer Insights

Selain itu, pada 1 September 2023, pelanggan Dynamics 365 Marketing baru hanya akan menerima fitur pemasaran real-time. Untuk informasi selengkapnya, lihat Penginstalan pemasaran real-time default. Banyak halaman dokumentasi saat ini mengacu pada fitur keluar yang mungkin tidak tersedia atau mungkin berfungsi dalam cara yang berbeda dalam pemasaran real-time. Konten dokumentasi akan diperbarui pada bulan September untuk menunjukkan apakah konten tersebut berlaku untuk pemasaran real-time atau pemasaran keluar.

Penting

Artikel ini hanya berlaku untuk pemasaran keluar.

Pelanggan potensial mengikuti jalan saat mereka terlibat dengan perusahaan Anda. Mereka mulai dengan menemukan produk Anda, mengevaluasi apakah itu memenuhi kebutuhan mereka, mencari penawaran yang bagus, lalu akhirnya melakukan pembelian. Proses ini disebut perjalanan pelanggan .

Anda dapat menggunakan perjalanan pelanggan untuk membuat model yang memandu anggota segmen pemasaran melalui proses ini menggunakan pesan otomatis, pembuatan aktivitas, titik keputusan interaktif, dan banyak lagi. Informasi selengkapnya: Membuat perjalanan pelanggan.

API perjalanan pelanggan memungkinkan interaksi terprogram dengan rekaman perjalanan pelanggan, termasuk penerbitan dan validasi. API menggunakan API Web standar Microsoft Dataverse untuk memanipulasi entitas dan pesan. Informasi selengkapnya: Menggunakan Microsoft Dataverse API Web.

Saat Anda membuat perjalanan pelanggan, properti disimpan dalam msdyncrm_customerjourney entitas. Anda dapat menelusuri informasi metadata entitas menggunakan @odata.contextrespons GET .

Catatan

Sebelum Anda melakukan operasi, Anda harus menginstal Dynamics 365 Customer Insights - Journeys.

Artikel ini menunjukkan cara melakukan operasi pada msdyncrm_customerjourney entitas. Bidang adalah msdyncrm_name satu-satunya bidang yang diperlukan untuk membuat perjalanan pelanggan. Bidang yang digunakan dalam artikel ini untuk membuat perjalanan pelanggan diperlihatkan dalam tabel berikut.

Nama tampilan Nama skema Deskripsi atau nilai
Nama msdyncrm_name Nama perjalanan pelanggan
Alasan Status kode status Status perjalanan pelanggan saat ini. Berikut adalah kode status yang tersedia:
-Bagan 192350000
-Hidup 192350001
-Berhenti 192350002
- Hidup, Dapat Diedit 192350003
-Kesalahan 192350005
- Siaran Langsung 192350006
-Menghentikan 192350007
Segmen Penindasan msdyncrm_SuppressionSegmentId ID dari Segmen Penindasan terkait. Gunakan untuk mengatur referensi ke rekaman dari msdyncrm_segments kumpulan rekaman.
Interval Pengulangan (Hari) msdyncrm_recurrenceintervaldays Durasi iterasi (dalam hari). Bilangan bulat non-negatif.
Persetujuan Minimum msgdpr_requiredconsent - (1) Persetujuan 587030001
- (2) Transaksional 587030002
- (3) Langganan 587030003
- (4) Pemasaran 587030004
- (5) Pembuatan profil 587030005
Jumlah Pengulangan msdyncrm_recurrencecount Jumlah iterasi. Bilangan bulat non-negatif.
Definisi alur kerja msdyncrm_workflowdefinition Definisi desain perjalanan pelanggan. Informasi lebih lanjut: perjalanan pelanggan definisi alur kerja.
Perjalanan pelanggan Negara Desainer msdyncrm_customerjourneydesignerstate Ini adalah bidang tersembunyi, yang digunakan oleh perancang perjalanan pelanggan untuk mempertahankan keadaan internalnya. Bidang harus disalin jika Anda membuat salinan bidang dari msdyncrm_workflowdefinition perjalanan pelanggan lain atau rekaman templat perjalanan pelanggan.
Zona Waktu msdyncrm_customerjourneytimezone Zona waktu efektif untuk perjalanan pelanggan.
Pengaturan Konten msdyncrm_contentsettingsId ID Setelan Konten terkait. Gunakan untuk mereferensikan msdyncrm_contentsettingss rekaman dari kumpulan rekaman.
Tanggal dan Waktu Berakhir msdyncrm_enddatetime Nilai tanggal/waktu dalam ISO 8601 format UTC. Perhatikan bahwa presisi detik dan milidetik akan diabaikan.
Tanggal dan Waktu Mulai msdyncrm_startdatetime Nilai tanggal/waktu dalam ISO 8601 format UTC. Perhatikan bahwa presisi detik dan milidetik akan diabaikan.
Berulang msdyncrm_isrecurring Nilai Boolean.
Target Entitas msdyncrm_entitytarget -Kontak 0
-Rekening 1
Tipe msdyncrm_type -Otomatis 192350000
- LinkedIn 192350001
Status kode negara bagian Status perjalanan pelanggan.

Catatan

Bidang statuscode dan statecode menentukan status perjalanan pelanggan. Mengubah nilainya dapat mengakibatkan Publishing atau Stopping perjalanan pelanggan alur kerja. Jika Anda ingin go live menyimpan catatan dalam Going Live status (statuscode = 192350006). Untuk menghentikan rekaman perjalanan pelanggan, simpan rekaman Live dalam Stopping status (kode status = 192350007).

Gunakan alat Postman untuk menguji operasi. Informasi selengkapnya: Menggunakan Postman dengan Web API.

Membuat, mengambil, memperbarui, dan menghapus operasi

Buat permintaan

Permintaan ini membuat rekaman perjalanan pelanggan dan menetapkan statuscode ke Draft. Perjalanan pelanggan ini mencakup segmen dengan dan dan ID:24db2671-1529-e911-a9b7-000d3a1e6adc email dengan Unique Name: TC407937_DynamicSegment_2KZQ1pID: 15bd0ab8-c12a-e911-a9b6-000d3a1e6c14. Pengaturan Konten yang efektif memiliki catatan ID: 1922b1d8-0523-e911-a9ba-000d3a1e689f. Header respons OData-EntityId berisi URL ke rekaman yang baru dibuat ini (instans entitas), yang secara kurung menyertakan ID unik untuk rekaman ini.

Penting

Anda perlu mengganti OrgUrl dengan https://<add your environment name, like 'myorg.crm'>.dynamics.com. Anda juga bisa mendapatkan nama lingkungan dari Sumber Daya Pengembang Penyesuaian Pengaturan>>.

POST {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys
{
    "msgdpr_requiredconsent": 587030001,
    "msdyncrm_customerjourneydesignerstate": "{\"NextActivityID\":8,\"NextActivityItemID\":42}",
    "msdyncrm_workflowdefinition": "[{\"ActivityTypeId\":\"bpf_root\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"bpf_root\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New ActivityTypeName_bpf_root_TitleText\",\"ActivityItemId\":0}]}},{\"ActivityTypeId\":\"Segment\",\"ParentActivityId\":\"01\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"Segment\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New Segment group\",\"ActivityItemId\":23,\"SegmentMergeMethod\":\"Union\"},{\"ItemId\":\"24db2671-1529-e911-a9b7-000d3a1e6adc\",\"ActivityTypeId\":\"SegmentItem\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"TC407937_DynamicSegment_2KZQ1p\",\"ActivityItemId\":24,\"ContainmentMethod\":\"Inclusion\",\"SegmentSourceType\":\"Segment\",\"DciSegmentName\":\"TC407937_DynamicSegment_2KZQ1p\",\"SegmentDisplayName\":\"TC407937_DynamicSegment_2KZQ1p\",\"Description\":\"\"}]},\"EntityTarget\":\"contact\"},{\"ActivityTypeId\":\"Email\",\"ParentActivityId\":\"01_0\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0_2\",\"Properties\":{\"Items\":[{\"ItemId\":\"15bd0ab8-c12a-e911-a9b6-000d3a1e6c14\",\"ActivityTypeId\":\"Email\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"Relationship test\",\"ActivityItemId\":32}]},\"EntityTarget\":\"contact\"}]",
    "msdyncrm_customerjourneytimezone": 92,
    "msdyncrm_contentsettingsId@odata.bind": "/msdyncrm_contentsettingss(1922b1d8-0523-e911-a9ba-000d3a1e689f)",
    "msdyncrm_enddatetime": "2019-03-09T11:29:00.000Z",
    "msdyncrm_startdatetime": "2019-02-09T11:29:00.000Z",
    "msdyncrm_name": "Simple Email Sample",
    "msdyncrm_isrecurring": false,
    "msdyncrm_type": 192350000,
    "msdyncrm_entitytarget": 0,
    "statuscode": 192350000,
    "statecode": 0,
    "ownerid@odata.bind": "/systemusers(d0e20c01-d6c6-480f-aab5-0fa6749565a5)"
}

Ambil permintaan

Permintaan pengambilan mengambil mengambil daftar Live perjalanan pelanggan.

GET {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys?$filter=statuscode eq 192350001

Permintaan pembaruan

Dengan permintaan pembaruan, Anda memperbarui statuscode , yang secara efektif menerbitkannya.

PATCH {{OrgUrl}}api/data/v9.0/msdyncrm_customerjourneys(8aee9d91-8c2b-e911-a9b7-000d3a1e6adc)
{
    "statuscode": 192350006
}

Hapus permintaan

Dengan permintaan hapus, Anda menghapus perjalanan pelanggan yang Anda buat sebelumnya.

DELETE {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys(b6faa2b7-b92b-e911-8185-000d3af9d16a)

Periksa Kesalahan

Fitur Periksa Kesalahan memeriksa catatan saat ini untuk konten yang hilang dan kesalahan teknis dan kemudian menampilkan hasil validasi, termasuk pesan kesalahan yang akan membantu pengguna memecahkan masalah yang ditemukan.

Isi permintaan adalah objek JSON, yang berisi sejumlah elemen data dengan nilai yang msdyncrm_customerjourney sesuai dengan properti entitas. Bidang referensi (misalnya, ID Setelan Konten) tidak digunakan @odata.bind dengan referensi kumpulan data, tetapi menggunakan ID rekaman yang direferensikan. Tabel berikut menjelaskan pemetaan.

Tombol Properti msdyncrm_customerjourney entitas yang sesuai (nama logis)
FieldValueCustomerJourneyId msdyncrm_customerjourneyid
FieldValueStatusCode kode status
FieldValueName msdyncrm_name
FieldValueStartDateTime msdyncrm_startdatetime
FieldValueEndDateTime msdyncrm_enddatetime
FieldValueWorkflowDefinition msdyncrm_workflowdefinition
FieldValueIsRecurring msdyncrm_isrecurring
BidangNilaiUlangInterval-Hari msdyncrm_recurrenceintervaldays
BidangNilaiRecurrenceCount msdyncrm_recurrencecount
FieldValueRequiredConsent msgdpr_requiredconsent
FieldValueEntityTarget msdyncrm_entitytarget
FieldValueSuppressionSegmentId msdyncrm_suppressionsegmentid
BidangValueCustomerJourneyTimeZone msdyncrm_customerjourneytimezone

Memvalidasi permintaan perjalanan pelanggan

POST {{OrgUrl}}/api/data/v9.0/msdyncrm_CustomerJourneyValidate
{
    "FieldValueCustomerJourneyId": "{6628BBF7-C52A-E911-A9B7-000D3A1E6ADC}",
    "FieldValueStatusCode": 192350000,
    "FieldValueName": "Sample Customer Journey",
    "FieldValueStartDateTime": "2019-02-08T11:48:00.000Z",
    "FieldValueEndDateTime": "2019-03-08T11:48:00.000Z",
    "FieldValueWorkflowDefinition": "[{\"ActivityTypeId\":\"bpf_root\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"bpf_root\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New ActivityTypeName_bpf_root_TitleText\",\"ActivityItemId\":0}]}},{\"ActivityTypeId\":\"Segment\",\"ParentActivityId\":\"01\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0\",\"Properties\":{\"Items\":[{\"ItemId\":null,\"ActivityTypeId\":\"Segment\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"New Segment group\",\"ActivityItemId\":52,\"SegmentMergeMethod\":\"Union\"},{\"ItemId\":\"056bbe66-f025-e911-a9ba-000d3a1e689f\",\"ActivityTypeId\":\"SegmentItem\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"TC407937_DynamicSegment_bmkX5u\",\"ActivityItemId\":53,\"ContainmentMethod\":\"Inclusion\",\"SegmentSourceType\":\"Segment\",\"DciSegmentName\":\"TC407937_DynamicSegment_bmkX5u\",\"SegmentDisplayName\":\"TC407937_DynamicSegment_bmkX5u\",\"Description\":\"\"}]},\"EntityTarget\":\"contact\"},{\"ActivityTypeId\":\"Email\",\"ParentActivityId\":\"01_0\",\"ParentBranchId\":0,\"ParentRelationshipType\":\"Default\",\"ActivityId\":\"01_0_3\",\"Properties\":{\"Items\":[{\"ItemId\":\"15bd0ab8-c12a-e911-a9b6-000d3a1e6c14\",\"ActivityTypeId\":\"Email\",\"Title\":\"Undefined\",\"IsNameSystemDefined\":true,\"Name\":\"Relationship test\",\"ActivityItemId\":61}]},\"EntityTarget\":\"contact\"}]",
    "FieldValueIsRecurring": true,
    "FieldValueRecurrenceIntervalDays": 30,
    "FieldValueRecurrenceCount": 3,
    "FieldValueRequiredConsent": 587030001,
    "FieldValueContentSettingsId": "{1922B1D8-0523-E911-A9BA-000D3A1E689F}",
    "FieldValueEntityTarget": 0,
    "FieldValueSuppressionSegmentId": "{544A3E20-9B23-E911-A9B6-000D3A1E6C14}",
    "FieldValueCustomerJourneyTimeZone": 92
}

Memvalidasi respons perjalanan pelanggan

{
    "@odata.context": "{{orgUrl}}/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msdyncrm_CustomerJourneyValidateResponse",
    "ValidationResult": "{\"ActivityValidationResults\":[{\"ActivityId\":\"\",\"Fault\":\"ErrorRecurringCampaignEndDateDoesNotFitRequestedIterations\",\"Result\":\"Error\",\"ErrorMessageArguments\":[]}],\"Result\":\"Error\"}"
}

Hasil validasi

Tabel berikut menjelaskan skema objek yang ValidationResult diterima dalam respons Validasi perjalanan pelanggan.

Properti Tipe Description
Hasil String Hasil pemeriksaan kesalahan keseluruhan. Ini memiliki nilai-nilai berikut:
Valid – Catatan yang lulus pemeriksaan validasi.
Peringatan – Catatan yang lulus pemeriksaan validasi; ada masalah nonblocking dengannya.
Kesalahan – Catatan yang tidak lulus validasi; ada masalah pemblokiran dengannya.
ActivityValidationResults Object[] Array objek detail validasi. Masing-masing merujuk ke masalah tertentu yang bisa diterapkan ke rekaman perjalanan pelanggan, petak tertentu dalam desain alur kerja. Lihat skema hasil validasi Aktivitas.

Hasil validasi aktivitas

Tabel berikut menunjukkan skema objek yang terkandung dalam ActivityValidationResults array ValidationResult objek.

Properti Tipe Description
ActivityId String ID Aktivitas petak alur kerja aktual tempat hasil validasi diterapkan. Jika kosong, hasil validasi berlaku secara global untuk seluruh definisi alur kerja atau properti lain dari perjalanan pelanggan.
Kesalahan String Kode yang mengidentifikasi hasil validasi aktual. Lihat contoh validasi untuk mempelajari cara bekerja dengan pesan yang terkait dengan kode kesalahan.
Hasil String Tingkat keparahan hasil. Ini memiliki nilai-nilai berikut:
Valid – Entri informatif
Peringatan – Masalah tidak diblokir
Kesalahan – Masalah pemblokiran
ErrorMessageArguments Tali[] Daftar argumen opsional yang memberikan detail hasil validasi, misalnya, ID elemen yang gagal memenuhi kriteria validitas.