Osnovne dejavnosti strank operacije API-ja
opomba,
1. septembra 2023 bosta Dynamics 365 Marketing in Dynamics 365 Customer Insights na prodaj skupaj v okviru ene inventarne enote izdelka, imenovane Dynamics 365 Customer Insights. Posamezni aplikaciji bosta preimenovani v Dynamics 365 Customer Insights – Dejavnosti oziroma Dynamics 365 Customer Insights – Podatki. Več informacij je v pogostih vprašanjih za Dynamics 365 Customer Insights
Poleg tega bodo 1. septembra 2023 novi uporabniki storitve Dynamics 365 Marketing prejeli samo funkcije sprotnega trženja. Več informacij je v razdelku Privzeta namestitev sprotnega trženja. Številne strani z dokumentacijo se trenutno nanašajo na odhodne funkcije, ki v sprotnem trženju morda niso na voljo ali delujejo drugače. Vsebina dokumentacije bo posodobljena septembra, da bo razvidno, ali se nanaša na sprotno ali odhodno trženje.
Pomembno
Ta članek se nanaša samo na izhodno trženje.
Potencialne stranke sledijo poti, ko sodelujejo z vašim podjetjem. Začnejo tako, da odkrijejo vaš izdelek, ocenijo, ali ustreza njihovim potrebam, poiščejo dobro ponudbo, nato pa končno opravijo nakup. Ta postopek se imenuje dejavnosti strank.
Potovanja strank lahko uporabite za ustvarjanje modela, ki člane trženjskih segmentov vodi skozi ta proces z uporabo avtomatiziranega sporočanja, ustvarjanja dejavnosti, interaktivnih točk odločanja in drugega. Več informacij: Ustvarite dejavnosti strank.
API dejavnosti strank omogoča programsko interakcijo z zapisi dejavnosti strank, vključno z objavo in preverjanjem. API uporablja standardni Microsoft Dataverse spletni API za manipulacijo entitet in sporočil. Več informacij: Uporabite Microsoft Dataverse spletni API.
Ko ustvarite dejavnosti strank, so lastnosti shranjene v entiteti msdyncrm_customerjourney . Po informacijah o metapodatkih entitete lahko brskate z uporabo @odata.contextv GET odgovoru.
opomba,
Preden izvedete operacije, morate namestiti Dynamics 365 Customer Insights - Journeys.
Ta članek prikazuje, kako izvajati operacije na entiteti msdyncrm_customerjourney . Polje msdyncrm_name je edino obvezno polje za ustvarjanje dejavnosti strank. Polja, ki se v tem članku uporabljajo za ustvarjanje dejavnosti strank, so prikazana v naslednji tabeli.
| Prikazno ime | Ime sheme | Opis ali vrednost |
|---|---|---|
| Imenu | ime_msdyncrm | Ime dejavnosti strank |
| Razlog stanj | koda stanja | Trenutno stanje dejavnosti strank. Na voljo so naslednje statusne kode: - Osnutek 192350000- V živo 192350001- Ustavljeno 192350002- V živo, možnost urejanja 192350003- Napaka 192350005- V živo 192350006- Ustavljanje 192350007 |
| Segment zatiranja | msdyncrm_SuppressionSegmentId | ID povezanega segmenta zatiranja. Uporabite ga za nastavitev sklica na zapis iz msdyncrm_segments niza zapisov. |
| Interval ponovitve (dnevi) | msdyncrm_recurrenceintervaldays | Trajanje ponovitve (v dnevih). Nenegativno celo število. |
| Minimalno soglasje | msgdpr_requiredconsent | - (1) Soglasje 587030001 - (2) Transakcijski 587030002- (3) Naročnine 587030003- (4) Trženje 587030004 - (5) Profiliranje 587030005 |
| Število ponovitev | msdyncrm_recurrencecount | Število ponovitev. Nenegativno celo število. |
| Opredelitev poteka dela | msdyncrm_workflowdefinition | Definicija oblikovanja dejavnosti strank. Več informacij: dejavnosti strank opredelitev poteka dela. |
| Dejavnosti strank Designer State | msdyncrm_customerjourneydesignerstate | To je skrito polje, ki ga oblikovalec dejavnosti strank uporablja za ohranitev svojega notranjega stanja. Polje je treba kopirati, če ustvarjate kopijo msdyncrm_workflowdefinition polja iz drugega zapisa predloge dejavnosti strank ali dejavnosti strank. |
| Časovni pas | msdyncrm_customerjourneytimezone | Učinkoviti časovni pas za dejavnosti strank. |
| Nastavitve vsebine | msdyncrm_contentsettingsId | ID povezanih nastavitev vsebine. Uporabite ga za sklicevanje na zapis iz niza msdyncrm_contentsettingss zapisov. |
| Končni datum in ura | msdyncrm_enddatetime | Vrednost datuma/časa v ISO 8601 formatu UTC. Upoštevajte, da natančnost sekund in milisekund ne bo upoštevana. |
| Začetni datum in ura | msdyncrm_startdatetime | Vrednost datuma/časa v ISO 8601 formatu UTC. Upoštevajte, da natančnost sekund in milisekund ne bo upoštevana. |
| Se ponavlja | msdyncrm_se ponavlja | Logična vrednost. |
| Cilj entitete | msdyncrm_entitytarget | - Kontakt 0- Račun 1 |
| Vnesi | vrsta_msdyncrm | - Avtomatizirano 192350000192350001 |
| Status | koda zvezne države | Status dejavnosti strank. |
opomba,
Polji statuscode in statecode opredeljujejo stanje dejavnosti strank. Spreminjanje njihovih vrednosti lahko povzroči Publishing ali Stopping potek dela dejavnosti strank. Če želite go live shraniti zapis v Going Live stanju (statuscode = 192350006). Če želite ustaviti zapis dejavnosti strank, shranite zapis v živo v Stopping stanju (statuscode = 192350007).
Za preizkus operacij uporabite orodje Postman. Več informacij: Uporaba poštarja s spletnim API-jem.
Operacije ustvarjanja, pridobivanja, posodabljanja in brisanja
Ustvari zahtevo
Ta zahteva ustvari zapis dejavnosti strank in nastavi statuscode na Draft. Ta dejavnosti strank vključuje segment z ID:24db2671-1529-e911-a9b7-000d3a1e6adc in Unique Name: TC407937_DynamicSegment_2KZQ1pin e-pošto z ID: 15bd0ab8-c12a-e911-a9b6-000d3a1e6c14. Učinkovite nastavitve vsebine imajo zapis ID: 1922b1d8-0523-e911-a9ba-000d3a1e689f. Glava odgovora OData-EntityId vsebuje URL do tega na novo ustvarjenega zapisa (primerka entitete), ki v oklepaju vključuje enolični ID za ta zapis.
Pomembno
Morate zamenjati OrgUrl z https://<add your environment name, like 'myorg.crm'>.dynamics.com. Ime okolja lahko dobite tudi v Nastavitve>Prilagajanja>Viri za razvijalce.
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)"
}
Pridobi zahtevo
Zahteva za pridobitev pridobi seznam Live poti strank.
GET {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys?$filter=statuscode eq 192350001
Zahteva za posodobitev
Z zahtevo za posodobitev posodobite statuscode na, ki jo dejansko objavi.
PATCH {{OrgUrl}}api/data/v9.0/msdyncrm_customerjourneys(8aee9d91-8c2b-e911-a9b7-000d3a1e6adc)
{
"statuscode": 192350006
}
Izbris zahteve
Z zahtevo za brisanje izbrišete dejavnosti strank, ki ste ga ustvarili prej.
DELETE {{OrgUrl}}/api/data/v9.0/msdyncrm_customerjourneys(b6faa2b7-b92b-e911-8185-000d3af9d16a)
Preverite napake
Funkcija Preveri napake preveri trenutni zapis glede manjkajoče vsebine in tehničnih napak ter nato prikaže rezultate preverjanja, vključno s sporočili o napakah, ki naj bi uporabniku pomagala rešiti morebitne najdene težave.
Telo zahteve je objekt JSON, ki vsebuje število podatkovnih elementov z vrednostmi, ki ustrezajo lastnostim msdyncrm_customerjourney entitete. Referenčno polje (na primer ID nastavitev vsebine) ne uporablja @odata.bind s sklicem niza zapisov, ampak uporablja ID zapisa, na katerega se sklicuje. Naslednja tabela pojasnjuje preslikavo.
| Tipka | Ustrezna lastnost entiteta msdyncrm_customerjourney (logično ime) |
|---|---|
| FieldValueCustomerJourneyId | msdyncrm_customerjourneyid |
| FieldValueStatusCode | koda stanja |
| FieldValueName | ime_msdyncrm |
| FieldValueStartDateTime | msdyncrm_startdatetime |
| FieldValueEndDateTime | msdyncrm_enddatetime |
| FieldValueWorkflowDefinition | msdyncrm_workflowdefinition |
| FieldValueIsRecurring | msdyncrm_se ponavlja |
| FieldValueRecurrenceIntervalDays | msdyncrm_recurrenceintervaldays |
| FieldValueRecurrenceCount | msdyncrm_recurrencecount |
| FieldValueRequiredConsent | msgdpr_requiredconsent |
| FieldValueEntityTarget | msdyncrm_entitytarget |
| FieldValueSuppressionSegmentId | msdyncrm_suppressionsegmentid |
| FieldValueCustomerJourneyTimeZone | msdyncrm_customerjourneytimezone |
Potrdite zahtevo dejavnosti strank
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
}
Preverite odgovor dejavnosti strank
{
"@odata.context": "{{orgUrl}}/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.msdyncrm_CustomerJourneyValidateResponse",
"ValidationResult": "{\"ActivityValidationResults\":[{\"ActivityId\":\"\",\"Fault\":\"ErrorRecurringCampaignEndDateDoesNotFitRequestedIterations\",\"Result\":\"Error\",\"ErrorMessageArguments\":[]}],\"Result\":\"Error\"}"
}
Rezultat validacije
Naslednja tabela opisuje shemo ValidationResult objekta, prejetega v odzivu Validate dejavnosti strank.
| Lastnost | Vnesi | Description |
|---|---|---|
| Rezultat | String | Splošni rezultat preverjanja napak. Ima naslednje vrednosti: Veljavni – Zapisi, ki so prestali preverjanje veljavnosti. Opozorilo – Zapisi, ki so prestali preverjanje veljavnosti; obstajajo težave z neblokiranjem. Napaka – Zapisi, ki niso prestali preverjanja; obstajajo težave z blokiranjem. |
| ActivityValidationResults | Object[] |
Matrika objektov s podrobnostmi preverjanja. Vsak se nanaša na določeno težavo, ki se lahko nanaša na zapis dejavnosti strank, določeno ploščico v načrtu poteka dela. Oglejte si Shemo rezultatov preverjanja dejavnosti. |
Rezultat validacije dejavnosti
Naslednja tabela prikazuje shemo objektov, ki jih vsebuje ActivityValidationResults matrika ValidationResult objekta.
| Lastnost | Vnesi | Description |
|---|---|---|
| ActivityId | String | ID dejavnosti dejanske ploščice poteka dela, za katero velja rezultat preverjanja. Če je prazno, se rezultat preverjanja uporablja globalno za celotno opredelitev poteka dela ali druge lastnosti dejavnosti strank. |
| Napaka | String | Koda, ki identificira dejanski rezultat validacije. Oglejte si validacijski vzorec če želite izvedeti, kako delati s sporočili, povezanimi s kodami napak. |
| Rezultat | String | Resnost rezultata. Ima naslednje vrednosti: Veljavno – Informativni vnos Opozorilo – Težava brez blokiranja Napaka – Težava z blokiranjem |
| Argumenti sporočila o napaki | Vrvica[] | Izbirni seznam argumentov, ki zagotavlja podrobnosti o rezultatu preverjanja, na primer ID elementa, ki ne izpolnjuje meril veljavnosti. |