Dijeli putem

Osnovne put klijenta API operacije

  • Članak

Napomena

1. rujna 2023. Dynamics 365 Marketing i Dynamics 365 Customer Insights prodavat će se zajedno kao jedan SKU proizvoda pod nazivom Dynamics 365 Customer Insights. Pojedinačne aplikacije preimenovat će se u Dynamics 365 Customer Insights – putovi i Dynamics 365 Customer Insights – podaci. Dodatne informacije potražite u Najčešćim pitanjima o sustavu Dynamics 365 Customer Insights

Nadalje, 1. runja 2023. novi klijenti s aplikacijom Dynamics 365 Marketing dobit će samo značajke marketinga u stvarnom vremenu. Dodatne informacije potražite u Zadana instalacija marketinga u stvarnom vremenu. Mnogo stranica dokumentacije trenutno upućuje na izlazne značajke koje možda nisu dostupne ili funkcioniraju drugačije u marketingu u stvarnom vremenu. Sadržaj dokumentacije ažurirat će se u rujnu kako bi se naznačilo odnosi li se na marketing u stvarnom vremenu ili na izlazni marketing.

Važno

Ovaj se članak odnosi samo na izlazni marketing.

Potencijalni kupci slijede put dok stupaju u interakciju s vašom tvrtkom. Počinju otkrivanjem vašeg proizvoda, procjenom zadovoljava li njihove potrebe, traženjem dobre ponude, a zatim konačno kupnjom. Taj se proces naziva put klijenta .

Putovanja kupaca možete koristiti za stvaranje modela koji vodi članove marketinških segmenata kroz ovaj postupak pomoću automatiziranih poruka, generiranja aktivnosti, interaktivnih točaka odlučivanja i još mnogo toga. Više informacija: Stvaranje put klijenta.

Put klijenta API omogućuje programsku interakciju s put klijenta zapisima, uključujući objavljivanje i provjeru valjanosti. API koristi standardni Microsoft Dataverse web-API za rukovanje entitetima i porukama. Dodatne informacije: Korištenje web-API-ja Microsoft Dataverse .

Kada kreirate put klijenta, svojstva se pohranjuju u entitet. msdyncrm_customerjourney Informacije o metapodacima entiteta možete pregledavati pomoću @odata.contextodgovora GET .

Napomena

Prije izvođenja operacija trebali biste instalirati Dynamics 365 Customer Insights - Putovanja.

Ovaj članak pokazuje kako izvršiti operacije na entitetu msdyncrm_customerjourney . Polje msdyncrm_name je jedino obavezno polje za kreiranje put klijenta. Polja koja se koriste u ovom članku za stvaranje put klijenta prikazana su u sljedećoj tablici.

Zaslonski naziv Naziv sheme Opis ili vrijednost
Ime/naziv msdyncrm_name Naziv put klijenta
Razlog statusa šifrastanja Trenutno stanje put klijenta. Slijede dostupni kodovi stanja:
-Nacrt 192350000
-Živjeti 192350001
-Zaustavljen 192350002
- Uživo, može se uređivati 192350003
-Greška 192350005
- Ide uživo 192350006
-Plomba 192350007
Segment potiskivanja msdyncrm_SuppressionSegmentId ID pridruženog segmenta potiskivanja. Koristite ga za postavljanje reference na zapis iz msdyncrm_segments skupa zapisa.
Interval ponavljanja (dani) msdyncrm_recurrenceintervaldays Trajanje iteracije (u danima). Cijeli broj koji nije negativan.
Minimalni pristanak msgdpr_requiredconsent - (1) Privola 587030001
- (2) Transakcijski 587030002
- (3) Pretplate 587030003
- (4) Marketing 587030004
- (5) Profiliranje 587030005
Broj ponavljanja msdyncrm_recurrencecount Broj iteracija. Cijeli broj koji nije negativan.
Definicija tijeka rada msdyncrm_workflowdefinition Definicija dizajna put klijenta. Više informacija: put klijenta definicija tijeka rada.
Put klijenta stanje dizajnera msdyncrm_customerjourneydesignerstate Ovo je skriveno polje koje put klijenta dizajner koristi kako bi zadržao svoje unutarnje stanje. Polje treba kopirati ako stvarate kopiju msdyncrm_workflowdefinition polja iz drugog zapisa put klijenta ili put klijenta predloška.
Vremenska zona msdyncrm_customerjourneytimezone Efektivna vremenska zona za put klijenta.
Postavke sadržaja msdyncrm_contentsettingsId ID pridruženih postavki sadržaja. Koristite ga za referenciranje zapisa iz skupa zapisa msdyncrm_contentsettingss .
Datum i vrijeme završetka msdyncrm_enddatetime Vrijednost datuma/vremena u ISO 8601 UTC obliku. Imajte na umu da će se preciznost sekundi i milisekundi zanemariti.
Datum i vrijeme početka msdyncrm_startdatetime Vrijednost datuma/vremena u ISO 8601 UTC obliku. Imajte na umu da će se preciznost sekundi i milisekundi zanemariti.
Ponavlja se? msdyncrm_isrecurring Booleova vrijednost.
Ciljni entitet msdyncrm_entitytarget -Kontakt 0
-Račun 1
Tip msdyncrm_type -Automatiziran 192350000
- LinkedIn 192350001
Stanje šifrastanja Stanje put klijenta.

Napomena

Polja statuscode i statecode definiraju stanje put klijenta. Promjena njihovih vrijednosti može rezultirati put klijenta Publishing tijek rada ili Stopping njega. Ako zapis želite go live spremiti u Going Live stanje (statuscode = 192350006). Da biste zaustavili zapis put klijenta, spremite zapis uživo u Stopping stanje (statuscode = 192350007).

Za testiranje operacija koristite alat Poštar. Više informacija: Koristite poštara s web-API-jem.

Stvaranje, dohvaćanje, ažuriranje i brisanje operacija

Stvori zahtjev

Ovaj zahtjev stvara put klijenta zapis i postavlja na statuscodeDraft. Ovaj put klijenta uključuje segment sa ID:24db2671-1529-e911-a9b7-000d3a1e6adc i Unique Name: TC407937_DynamicSegment_2KZQ1pe-poštu s ID: 15bd0ab8-c12a-e911-a9b6-000d3a1e6c14. Efektivne postavke sadržaja imaju zapis ID: 1922b1d8-0523-e911-a9ba-000d3a1e689f. Zaglavlje odgovora OData-EntityId sadrži URL ovog novostvorenog zapisa (instance entiteta), koji u zagradi uključuje jedinstveni ID za ovaj zapis.

Važno

Morate zamijeniti OrgUrl https://<add your environment name, like 'myorg.crm'>.dynamics.com. Naziv okruženja možete dobiti i iz odjeljka Postavke>prilagodbe>, razvojni resursi.

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)"
}

Dohvati zahtjev

Zahtjev za dohvaćanje dohvaća popis Live putovanja kupaca.

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

Zahtjev za ažuriranjem

Pomoću zahtjeva za ažuriranjem ažurirate statuscode na, koji ga učinkovito objavljuje.

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

Zahtjev za brisanje

Pomoću zahtjeva za brisanje brišete put klijenta koji ste prethodno stvorili.

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

Provjeri ima li pogrešaka

Značajka Provjeri ima li pogrešaka provjerava trenutni zapis na sadržaj koji nedostaje i tehničke pogreške, a zatim prikazuje rezultate provjere valjanosti, uključujući poruke o pogreškama koje bi korisniku trebale pomoći u rješavanju svih pronađenih problema.

Tijelo zahtjeva je JSON objekt koji sadrži broj podatkovnih elemenata s vrijednostima koje odgovaraju svojstvima entiteta msdyncrm_customerjourney . Referentno polje (na primjer, ID postavki sadržaja) ne koristi se s referencom skupa zapisa, ali koristi @odata.bind ID referentnog zapisa. Sljedeća tablica objašnjava mapiranje.

Tipka Odgovarajuće svojstvo msdyncrm_customerjourney entitet (logički naziv)
FieldValueCustomerJourneyId msdyncrm_customerjourneyid
Šifra statusa FieldValueCode šifrastanja
NazivVrijednosti polja msdyncrm_name
PoljeValueStartDateTime msdyncrm_startdatetime
FieldValueEndDateTime msdyncrm_enddatetime
Definicija tijeka rada FieldValueWorkflowDefinition msdyncrm_workflowdefinition
FieldValueIsRecurring msdyncrm_isrecurring
FieldValueRecurrenceIntervalDays msdyncrm_recurrenceintervaldays
FieldValueRecurrenceCount msdyncrm_recurrencecount
FieldValueRequiredConsent msgdpr_requiredconsent
FieldValueEntityTarget msdyncrm_entitytarget
FieldValueSuppressionSegmentId msdyncrm_suppressionsegmentid
FieldValueCustomerJourneyTimeZone msdyncrm_customerjourneytimezone

Provjera valjanosti put klijenta zahtjeva

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
}

Provjera valjanosti put klijenta odgovora

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

Rezultat provjere valjanosti

Sljedeća tablica opisuje shemu objekta primljenog ValidationResult u odgovoru Provjera valjanosti put klijenta.

Svojstvo Tip Opis
Rezultat String Ukupni rezultat provjere pogreške. Ima sljedeće vrijednosti:
Valjano – zapisi koji su prošli provjeru valjanosti.
Upozorenje – zapisi koji su prošli provjeru valjanosti; s njom postoje problemi s deblokiranjem.
Pogreška – zapisi koji nisu prošli provjeru valjanosti; postoje problemi s blokiranjem.
ActivityValidationResults Object[] Niz detaljnih objekata provjere valjanosti. Svaki se odnosi na određeni problem koji se može primijeniti na put klijenta zapis, određenu pločicu unutar dizajna tijeka rada. Pogledajte shemu rezultata provjere valjanosti aktivnosti.

Rezultat provjere valjanosti aktivnosti

Sljedeća tablica prikazuje shemu objekata sadržanih u ActivityValidationResults polju objekta ValidationResult .

Svojstvo Tip Opis
ActivityId String ID aktivnosti stvarne pločice tijeka rada na koju se primjenjuje rezultat provjere valjanosti. Ako je prazan, rezultat provjere valjanosti primjenjuje se globalno na cijeli definicija tijeka rada ili druga svojstva put klijenta.
Mana String Šifra koja identificira stvarni rezultat provjere valjanosti. Pogledajte uzorak provjere valjanosti da biste saznali kako raditi s porukama povezanima sa šiframa kvarova.
Rezultat String Ozbiljnost rezultata. Ima sljedeće vrijednosti:
Valjano – informativan unos
Upozorenje – problem s neblokiranjem
Pogreška – problem s blokiranjem
ErrorMessageArguments Niz[] Neobavezni popis argumenata koji sadrži detalje rezultata provjere valjanosti, na primjer, ID elementa koji ne zadovoljava kriterije valjanosti.