[ci skip] updating documentation

braze-inc · Feb 23, 2022 · db6fb13 · db6fb13
1 parent 3aba5cf
commit db6fb13
Show file tree

Hide file tree

Showing 58 changed files with 1,622 additions and 1,413 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
@@ -1,6 +1,6 @@
 # Stabilization Candidates
 
-_Generated on **Wed Feb 23 2022 10:50:05 GMT+0000 (UTC)**_
+_Generated on **Wed Feb 23 2022 11:00:47 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/adcloud/advertisement.schema.json b/docs/reference/adobe/experience/adcloud/advertisement.schema.json
@@ -156,13 +156,6 @@
     "meta:titleId": "advertisement##title##451",
     "meta:descriptionId": "advertisement##description##55831",
     "examples": [
-        {
-            "xdm:adId": "4116904851",
-            "xdm:runtime": "HTML5",
-            "xdm:adClass": "video",
-            "xdm:adUnitType": "HTML5",
-            "xdm:promotedAssetId": "4116761052"
-        },
         {
             "xdm:creativeID": "301404063528",
             "xdm:keywordID": "147741280",
@@ -184,6 +177,13 @@
             "dsp:placementIds": [
                 "1"
             ]
+        },
+        {
+            "xdm:adId": "4116904851",
+            "xdm:runtime": "HTML5",
+            "xdm:adClass": "video",
+            "xdm:adUnitType": "HTML5",
+            "xdm:promotedAssetId": "4116761052"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/adcloud/advertisement.schema.md b/docs/reference/adobe/experience/adcloud/advertisement.schema.md
@@ -13,16 +13,6 @@ Adobe Advertising Cloud Ad Details.
 
 ## Adobe Advertising Cloud Ad Details Examples
 
-```json
-{
-  "xdm:adId": "4116904851",
-  "xdm:runtime": "HTML5",
-  "xdm:adClass": "video",
-  "xdm:adUnitType": "HTML5",
-  "xdm:promotedAssetId": "4116761052"
-}
-```
-
 ```json
 {
   "xdm:creativeID": "301404063528",
@@ -51,6 +41,16 @@ Adobe Advertising Cloud Ad Details.
 }
 ```
 
+```json
+{
+  "xdm:adId": "4116904851",
+  "xdm:runtime": "HTML5",
+  "xdm:adClass": "video",
+  "xdm:adUnitType": "HTML5",
+  "xdm:promotedAssetId": "4116761052"
+}
+```
+
 
 # Adobe Advertising Cloud Ad Details Properties
 

diff --git a/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.md b/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.md
@@ -567,6 +567,7 @@ The primary event type for this time-series record.
 | `listOperation.removeFromList` | List Operation Remove From List |
 | `listOperation.addToList` | List Operation Add To List |
 | `leadOperation.scoreChanged` | Lead Operation Score Changed |
+| `leadOperation.revenueStageChanged` | Lead Operation Revenue Stage changed |
 | `leadOperation.statusInCampaignProgressionChanged` | Lead Operation Status In Campaign Progression Changed |
 | `leadOperation.interestingMoment` | Lead Operation Interesting Moment |
 | `leadOperation.newLead` | Lead Operation New Lead |

diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.json b/docs/reference/adobe/experience/adcloud/campaign.schema.json
@@ -104,21 +104,6 @@
             "xdm:sampleGroupId": "8676378",
             "xdm:currency": "USD"
         },
-        {
-            "@id": "100001061",
-            "searchads:campaignId": "10001234",
-            "searchads:accountId": "10001456",
-            "searchads:campaignName": "My First Campaign",
-            "searchads:campaignDescription": "Branded Mobile Campaign",
-            "searchads:campaignStatus": "Active",
-            "searchads:channelType": "Search",
-            "searchads:budget": 123.45,
-            "searchads:budgetType": "Monthly",
-            "searchads.adDeliveryType": "Standard",
-            "searchads.CampaignObjective": "visit_web",
-            "repo:createDate": "2019-04-26T14:00:00+00:00",
-            "repo:modifyDate": "2019-04-26T14:00:00+00:00"
-        },
         {
             "@id": "12",
             "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor",
@@ -134,6 +119,21 @@
             "repo:createDate": "2019-04-26T14:00:00+00:00",
             "repo:modifyDate": "2019-04-26T14:00:00+00:00"
         },
+        {
+            "@id": "100001061",
+            "searchads:campaignId": "10001234",
+            "searchads:accountId": "10001456",
+            "searchads:campaignName": "My First Campaign",
+            "searchads:campaignDescription": "Branded Mobile Campaign",
+            "searchads:campaignStatus": "Active",
+            "searchads:channelType": "Search",
+            "searchads:budget": 123.45,
+            "searchads:budgetType": "Monthly",
+            "searchads.adDeliveryType": "Standard",
+            "searchads.CampaignObjective": "visit_web",
+            "repo:createDate": "2019-04-26T14:00:00+00:00",
+            "repo:modifyDate": "2019-04-26T14:00:00+00:00"
+        },
         {
             "xdm:id": "100001061",
             "xdm:campaignId": "10001234",

diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.md b/docs/reference/adobe/experience/adcloud/campaign.schema.md
@@ -27,24 +27,6 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
 }
 ```
 
-```json
-{
-  "@id": "100001061",
-  "searchads:campaignId": "10001234",
-  "searchads:accountId": "10001456",
-  "searchads:campaignName": "My First Campaign",
-  "searchads:campaignDescription": "Branded Mobile Campaign",
-  "searchads:campaignStatus": "Active",
-  "searchads:channelType": "Search",
-  "searchads:budget": 123.45,
-  "searchads:budgetType": "Monthly",
-  "searchads.adDeliveryType": "Standard",
-  "searchads.CampaignObjective": "visit_web",
-  "repo:createDate": "2019-04-26T14:00:00+00:00",
-  "repo:modifyDate": "2019-04-26T14:00:00+00:00"
-}
-```
-
 ```json
 {
   "@id": "12",
@@ -63,6 +45,24 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
 }
 ```
 
+```json
+{
+  "@id": "100001061",
+  "searchads:campaignId": "10001234",
+  "searchads:accountId": "10001456",
+  "searchads:campaignName": "My First Campaign",
+  "searchads:campaignDescription": "Branded Mobile Campaign",
+  "searchads:campaignStatus": "Active",
+  "searchads:channelType": "Search",
+  "searchads:budget": 123.45,
+  "searchads:budgetType": "Monthly",
+  "searchads.adDeliveryType": "Standard",
+  "searchads.CampaignObjective": "visit_web",
+  "repo:createDate": "2019-04-26T14:00:00+00:00",
+  "repo:modifyDate": "2019-04-26T14:00:00+00:00"
+}
+```
+
 ```json
 {
   "xdm:id": "100001061",

diff --git a/...reference/adobe/experience/adcloud/searchads/aggregateperformancebyad.schema.md b/...reference/adobe/experience/adcloud/searchads/aggregateperformancebyad.schema.md
@@ -341,6 +341,7 @@ The primary event type for this time-series record.
 | `listOperation.removeFromList` | List Operation Remove From List |
 | `listOperation.addToList` | List Operation Add To List |
 | `leadOperation.scoreChanged` | Lead Operation Score Changed |
+| `leadOperation.revenueStageChanged` | Lead Operation Revenue Stage changed |
 | `leadOperation.statusInCampaignProgressionChanged` | Lead Operation Status In Campaign Progression Changed |
 | `leadOperation.interestingMoment` | Lead Operation Interesting Moment |
 | `leadOperation.newLead` | Lead Operation New Lead |

diff --git a/.../adobe/experience/adcloud/searchads/aggregateperformancebyadbykeyword.schema.md b/.../adobe/experience/adcloud/searchads/aggregateperformancebyadbykeyword.schema.md
@@ -420,6 +420,7 @@ The primary event type for this time-series record.
 | `listOperation.removeFromList` | List Operation Remove From List |
 | `listOperation.addToList` | List Operation Add To List |
 | `leadOperation.scoreChanged` | Lead Operation Score Changed |
+| `leadOperation.revenueStageChanged` | Lead Operation Revenue Stage changed |
 | `leadOperation.statusInCampaignProgressionChanged` | Lead Operation Status In Campaign Progression Changed |
 | `leadOperation.interestingMoment` | Lead Operation Interesting Moment |
 | `leadOperation.newLead` | Lead Operation New Lead |

diff --git a/...ence/adobe/experience/adcloud/searchads/aggregateperformancebykeyword.schema.md b/...ence/adobe/experience/adcloud/searchads/aggregateperformancebykeyword.schema.md
@@ -399,6 +399,7 @@ The primary event type for this time-series record.
 | `listOperation.removeFromList` | List Operation Remove From List |
 | `listOperation.addToList` | List Operation Add To List |
 | `leadOperation.scoreChanged` | Lead Operation Score Changed |
+| `leadOperation.revenueStageChanged` | Lead Operation Revenue Stage changed |
 | `leadOperation.statusInCampaignProgressionChanged` | Lead Operation Status In Campaign Progression Changed |
 | `leadOperation.interestingMoment` | Lead Operation Interesting Moment |
 | `leadOperation.newLead` | Lead Operation New Lead |

diff --git a/...e/adobe/experience/adcloud/searchadvertising/aggregateperformancebyad.schema.md b/...e/adobe/experience/adcloud/searchadvertising/aggregateperformancebyad.schema.md
@@ -249,6 +249,7 @@ The primary event type for this time-series record.
 | `listOperation.removeFromList` | List Operation Remove From List |
 | `listOperation.addToList` | List Operation Add To List |
 | `leadOperation.scoreChanged` | Lead Operation Score Changed |
+| `leadOperation.revenueStageChanged` | Lead Operation Revenue Stage changed |
 | `leadOperation.statusInCampaignProgressionChanged` | Lead Operation Status In Campaign Progression Changed |
 | `leadOperation.interestingMoment` | Lead Operation Interesting Moment |
 | `leadOperation.newLead` | Lead Operation New Lead |

diff --git a/...xperience/adcloud/searchadvertising/aggregateperformancebyadbykeyword.schema.md b/...xperience/adcloud/searchadvertising/aggregateperformancebyadbykeyword.schema.md
@@ -252,6 +252,7 @@ The primary event type for this time-series record.
 | `listOperation.removeFromList` | List Operation Remove From List |
 | `listOperation.addToList` | List Operation Add To List |
 | `leadOperation.scoreChanged` | Lead Operation Score Changed |
+| `leadOperation.revenueStageChanged` | Lead Operation Revenue Stage changed |
 | `leadOperation.statusInCampaignProgressionChanged` | Lead Operation Status In Campaign Progression Changed |
 | `leadOperation.interestingMoment` | Lead Operation Interesting Moment |
 | `leadOperation.newLead` | Lead Operation New Lead |

diff --git a/...be/experience/adcloud/searchadvertising/aggregateperformancebykeyword.schema.md b/...be/experience/adcloud/searchadvertising/aggregateperformancebykeyword.schema.md
@@ -231,6 +231,7 @@ The primary event type for this time-series record.
 | `listOperation.removeFromList` | List Operation Remove From List |
 | `listOperation.addToList` | List Operation Add To List |
 | `leadOperation.scoreChanged` | Lead Operation Score Changed |
+| `leadOperation.revenueStageChanged` | Lead Operation Revenue Stage changed |
 | `leadOperation.statusInCampaignProgressionChanged` | Lead Operation Status In Campaign Progression Changed |
 | `leadOperation.interestingMoment` | Lead Operation Interesting Moment |
 | `leadOperation.newLead` | Lead Operation New Lead |

diff --git a/docs/reference/adobe/experience/customerJourneyManagement/message-interaction.schema.json b/docs/reference/adobe/experience/customerJourneyManagement/message-interaction.schema.json
@@ -202,6 +202,19 @@
                 "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"
+            }
+        },
         {
             "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "click",
             "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
@@ -219,19 +232,6 @@
                 "xdm:scopeID": "eyJ4ZG06YWN0aXZpdHlJZCI6IjQ1NjciLCJ4ZG06cGxhY2VtZW50SWQiOiIxMjM0NSJ9",
                 "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"
-            }
         }
     ]
 }
diff --git a/...erence/adobe/experience/customerJourneyManagement/message-interaction.schema.md b/...erence/adobe/experience/customerJourneyManagement/message-interaction.schema.md
@@ -36,6 +36,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"
+  }
+}
+```
+
 ```json
 {
   "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "click",
@@ -57,22 +73,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"
-  }
-}
-```
-
 
 # Adobe CJM ExperienceEvent - Message interaction details Properties
 

diff --git a/docs/reference/adobe/experience/decisioning/activity.schema.json b/docs/reference/adobe/experience/decisioning/activity.schema.json
@@ -92,6 +92,14 @@
     "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",
@@ -284,14 +292,6 @@
                     }
                 }
             ]
-        },
-        {
-            "@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,6 +18,17 @@ 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",
@@ -214,17 +225,6 @@ 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