[ci skip] updating documentation

braze-inc · Feb 17, 2022 · 982bfd6 · 982bfd6
1 parent 11b970d
commit 982bfd6
Show file tree

Hide file tree

Showing 47 changed files with 1,344 additions and 1,342 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
@@ -1,6 +1,6 @@
 # Stabilization Candidates
 
-_Generated on **Thu Feb 17 2022 17:15:49 GMT+0000 (UTC)**_
+_Generated on **Thu Feb 17 2022 17:25:14 GMT+0000 (UTC)**_
 
 
 ### Unknown Status, needs immediate attention

diff --git a/docs/reference/README.md b/docs/reference/README.md
diff --git a/docs/reference/adobe/experience/aep-mobile-lifecycle-details.schema.json b/docs/reference/adobe/experience/aep-mobile-lifecycle-details.schema.json
@@ -181,13 +181,6 @@
     ],
     "meta:status": "stable",
     "examples": [
-        {
-            "xdm:application": {
-                "xdm:isClose": true,
-                "xdm:closeType": "close",
-                "xdm:sessionLength": 5030
-            }
-        },
         {
             "xdm:application": {
                 "xdm:id": "A123",
@@ -211,6 +204,13 @@
                 "xdm:screenHeight": 667,
                 "xdm:screenWidth": 375
             }
+        },
+        {
+            "xdm:application": {
+                "xdm:isClose": true,
+                "xdm:closeType": "close",
+                "xdm:sessionLength": 5030
+            }
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/aep-mobile-lifecycle-details.schema.md b/docs/reference/adobe/experience/aep-mobile-lifecycle-details.schema.md
@@ -20,16 +20,6 @@ Application lifecycle information recorded via an ExperienceEvent that is specif
 
 ## AEP Mobile Lifecycle Details Examples
 
-```json
-{
-  "xdm:application": {
-    "xdm:isClose": true,
-    "xdm:closeType": "close",
-    "xdm:sessionLength": 5030
-  }
-}
-```
-
 ```json
 {
   "xdm:application": {
@@ -57,6 +47,16 @@ Application lifecycle information recorded via an ExperienceEvent that is specif
 }
 ```
 
+```json
+{
+  "xdm:application": {
+    "xdm:isClose": true,
+    "xdm:closeType": "close",
+    "xdm:sessionLength": 5030
+  }
+}
+```
+
 
 # AEP Mobile Lifecycle Details Properties
 

diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json
@@ -70,12 +70,6 @@
     "meta:titleId": "notificationsubscription##title##11091",
     "meta:descriptionId": "notificationsubscription##description##35941",
     "examples": [
-        {
-            "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
-            "xdm:type": "Campaign/SubscriptionList",
-            "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
-            "xdm:emailAddress": "[email protected]"
-        },
         {
             "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
             "xdm:type": "Campaign/SubscriptionList",
@@ -86,6 +80,12 @@
                 "xdm:remarkID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3be",
                 "xdm:remarkText": "Sorry, leave me alone. These are my personal comments"
             }
+        },
+        {
+            "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
+            "xdm:type": "Campaign/SubscriptionList",
+            "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
+            "xdm:emailAddress": "[email protected]"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md
@@ -20,15 +20,6 @@ Adobe Campaign notification subscriptions allow end-users opt into topics that c
 
 ## Notification Subscription Examples
 
-```json
-{
-  "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
-  "xdm:type": "Campaign/SubscriptionList",
-  "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
-  "xdm:emailAddress": "[email protected]"
-}
-```
-
 ```json
 {
   "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
@@ -43,6 +34,15 @@ Adobe Campaign notification subscriptions allow end-users opt into topics that c
 }
 ```
 
+```json
+{
+  "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
+  "xdm:type": "Campaign/SubscriptionList",
+  "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
+  "xdm:emailAddress": "[email protected]"
+}
+```
+
 
 # Notification Subscription Properties
 

diff --git a/docs/reference/adobe/experience/customerJourneyManagement/message-interaction.schema.json b/docs/reference/adobe/experience/customerJourneyManagement/message-interaction.schema.json
@@ -206,19 +206,6 @@
                 "xdm:activityID": "4567"
             }
         },
-        {
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "submit",
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/trackingType": "tracked",
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/entityType": "landing_page",
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage": {
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpageID": "1234",
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source": "journey",
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType": "internal",
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName": "December Offers"
-            }
-        },
         {
             "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "subscription",
             "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags": [
@@ -232,6 +219,19 @@
                 "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/sourceType": "internal",
                 "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionChoice": "yes"
             }
+        },
+        {
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "submit",
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/trackingType": "tracked",
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/entityType": "landing_page",
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage": {
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpageID": "1234",
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source": "journey",
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType": "internal",
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName": "December Offers"
+            }
         }
     ]
 }
diff --git a/...erence/adobe/experience/customerJourneyManagement/message-interaction.schema.md b/...erence/adobe/experience/customerJourneyManagement/message-interaction.schema.md
@@ -40,22 +40,6 @@ Describes interaction made by the profile on the message.
 }
 ```
 
-```json
-{
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "submit",
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/trackingType": "tracked",
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/entityType": "landing_page",
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage": {
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpageID": "1234",
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source": "journey",
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType": "internal",
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName": "December Offers"
-  }
-}
-```
-
 ```json
 {
   "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "subscription",
@@ -73,6 +57,22 @@ Describes interaction made by the profile on the message.
 }
 ```
 
+```json
+{
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "submit",
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/trackingType": "tracked",
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/entityType": "landing_page",
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage": {
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpageID": "1234",
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source": "journey",
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType": "internal",
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName": "December Offers"
+  }
+}
+```
+
 
 # Adobe CJM ExperienceEvent - Message interaction details Properties
 

diff --git a/docs/reference/adobe/experience/customerJourneyManagement/profile-counters-v2.schema.json b/docs/reference/adobe/experience/customerJourneyManagement/profile-counters-v2.schema.json
@@ -62,10 +62,7 @@
     "meta:descriptionId": "profilecounters##description##16505",
     "examples": [
         {
-            "xdm:namespace": {
-                "xdm:code": "ECID"
-            },
-            "xdm:id": "92312748749128",
+            "xdm:xid": "xid-92312748749128",
             "xdm:frequencyMap": {
                 "counter_id": {
                     "xdm:value": 100,
@@ -74,7 +71,10 @@
             }
         },
         {
-            "xdm:xid": "xid-92312748749128",
+            "xdm:namespace": {
+                "xdm:code": "ECID"
+            },
+            "xdm:id": "92312748749128",
             "xdm:frequencyMap": {
                 "counter_id": {
                     "xdm:value": 100,

diff --git a/...erence/adobe/experience/customerJourneyManagement/profile-counters-v2.schema.md b/...erence/adobe/experience/customerJourneyManagement/profile-counters-v2.schema.md
@@ -15,10 +15,7 @@ Holds a map of objects containing counter_value and expiryDate, keyed by counter
 
 ```json
 {
-  "xdm:namespace": {
-    "xdm:code": "ECID"
-  },
-  "xdm:id": "92312748749128",
+  "xdm:xid": "xid-92312748749128",
   "xdm:frequencyMap": {
     "counter_id": {
       "xdm:value": 100,
@@ -30,7 +27,10 @@ Holds a map of objects containing counter_value and expiryDate, keyed by counter
 
 ```json
 {
-  "xdm:xid": "xid-92312748749128",
+  "xdm:namespace": {
+    "xdm:code": "ECID"
+  },
+  "xdm:id": "92312748749128",
   "xdm:frequencyMap": {
     "counter_id": {
       "xdm:value": 100,

diff --git a/docs/reference/adobe/experience/decisioning/activity.schema.json b/docs/reference/adobe/experience/decisioning/activity.schema.json
@@ -92,14 +92,6 @@
     "meta:titleId": "activity##title##64091",
     "meta:descriptionId": "activity##description##26151",
     "examples": [
-        {
-            "@id": "xcore:offer-activity:fd55d033fea4b82",
-            "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
-            "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
-            "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
-            "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
-            "https://ns.adobe.com/experience/decisioning/status": "draft"
-        },
         {
             "@id": "xcore:offer-activity:fd55d033fea4b82",
             "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
@@ -292,6 +284,14 @@
                     }
                 }
             ]
+        },
+        {
+            "@id": "xcore:offer-activity:fd55d033fea4b82",
+            "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
+            "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
+            "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
+            "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
+            "https://ns.adobe.com/experience/decisioning/status": "draft"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/decisioning/activity.schema.md b/docs/reference/adobe/experience/decisioning/activity.schema.md
@@ -18,17 +18,6 @@ Controls a decisioning process and describes some form of action that is planned
 
 ## Decision Activity Examples
 
-```json
-{
-  "@id": "xcore:offer-activity:fd55d033fea4b82",
-  "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
-  "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
-  "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
-  "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
-  "https://ns.adobe.com/experience/decisioning/status": "draft"
-}
-```
-
 ```json
 {
   "@id": "xcore:offer-activity:fd55d033fea4b82",
@@ -225,6 +214,17 @@ Controls a decisioning process and describes some form of action that is planned
 }
 ```
 
+```json
+{
+  "@id": "xcore:offer-activity:fd55d033fea4b82",
+  "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
+  "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
+  "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
+  "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
+  "https://ns.adobe.com/experience/decisioning/status": "draft"
+}
+```
+
 
 # Decision Activity Properties
 

diff --git a/docs/reference/adobe/experience/decisioning/content-details.schema.json b/docs/reference/adobe/experience/decisioning/content-details.schema.json
@@ -82,6 +82,21 @@
                 }
             ]
         },
+        {
+            "https://ns.adobe.com/experience/decisioning/placement": "uri:xcore:placement-0003",
+            "https://ns.adobe.com/experience/decisioning/components": [
+                {
+                    "@type": "https://ns.adobe.com/experience/offer-management/content-component-html",
+                    "dc:format": "text/html",
+                    "dc:language": [
+                        "de"
+                    ],
+                    "repo:name": "widget_quickbooking.html",
+                    "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc",
+                    "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id=&quot;urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc&quot;"
+                }
+            ]
+        },
         {
             "https://ns.adobe.com/experience/decisioning/placement": "uri:xcore:placement-0002",
             "https://ns.adobe.com/experience/decisioning/components": [
@@ -98,21 +113,6 @@
                     "https://ns.adobe.com/experience/decisioning/linkURL": "https://www.mycompany.com/product?trackId=12345"
                 }
             ]
-        },
-        {
-            "https://ns.adobe.com/experience/decisioning/placement": "uri:xcore:placement-0003",
-            "https://ns.adobe.com/experience/decisioning/components": [
-                {
-                    "@type": "https://ns.adobe.com/experience/offer-management/content-component-html",
-                    "dc:format": "text/html",
-                    "dc:language": [
-                        "de"
-                    ],
-                    "repo:name": "widget_quickbooking.html",
-                    "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc",
-                    "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id=&quot;urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc&quot;"
-                }
-            ]
         }
     ]
 }