[ci skip] updating documentation

braze-inc · Jan 30, 2022 · d756db1 · d756db1
1 parent 37fce85
commit d756db1
Show file tree

Hide file tree

Showing 50 changed files with 1,541 additions and 1,541 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
@@ -1,6 +1,6 @@
 # Stabilization Candidates
 
-_Generated on **Fri Jan 21 2022 00:03:20 GMT+0000 (UTC)**_
+_Generated on **Sun Jan 30 2022 07:20:36 GMT+0000 (UTC)**_
 
 
 ### Unknown Status, needs immediate attention
@@ -13,8 +13,8 @@ _Generated on **Fri Jan 21 2022 00:03:20 GMT+0000 (UTC)**_
 
 |Schema|Status|Status Modified Date|Last Non-trivial Change|Raw Commit Log Since Status Change|
 |------|------|--------------------|-----------------------|----------------------------------|
-|[schemas/descriptors/relationship/descriptorRelationship](schemas/descriptors/relationship/descriptorRelationship.schema.json)|experimental|**287**|**211**|[613a327](https://github.com/adobe/xdm/commit/613a3270dace69bcfef0d391e0b3717946fa3a22 "Removed extension folder from localization") [b4ac040](https://github.com/adobe/xdm/commit/b4ac0402a6f317427c1b6511584fd79372b028ab "Merge master") [f30f47d](https://github.com/adobe/xdm/commit/f30f47d4fc34a62c3af366b3a2deef5cfc281d04 "Added meta:tileId and meta:descriptionId to resolver of compatibility check") [26c8c21](https://github.com/adobe/xdm/commit/26c8c21ed74e24d631c8edef8945dd1048f99cbb "Excluded null values and append random number to keys") [8616f86](https://github.com/adobe/xdm/commit/8616f862621868dfb4ffa7286938186de4822d96 "Added meta:createdDate attribute")|
-|[schemas/destinations/solutions/analytics-experienceevent](schemas/destinations/solutions/analytics-experienceevent.schema.json)|experimental|**146**|**142**|[8245ce9](https://github.com/adobe/xdm/commit/8245ce978f7e238bda59c5f0f0c6e8bb541a7998 "Revert the ID to those in en-US file") [d83cc36](https://github.com/adobe/xdm/commit/d83cc365740a81bf0c470b89b0dd690adb125326 "Added titleId and created Localization files") [613a327](https://github.com/adobe/xdm/commit/613a3270dace69bcfef0d391e0b3717946fa3a22 "Removed extension folder from localization") [b4ac040](https://github.com/adobe/xdm/commit/b4ac0402a6f317427c1b6511584fd79372b028ab "Merge master") [f30f47d](https://github.com/adobe/xdm/commit/f30f47d4fc34a62c3af366b3a2deef5cfc281d04 "Added meta:tileId and meta:descriptionId to resolver of compatibility check") [26c8c21](https://github.com/adobe/xdm/commit/26c8c21ed74e24d631c8edef8945dd1048f99cbb "Excluded null values and append random number to keys")|
+|[schemas/descriptors/relationship/descriptorRelationship](schemas/descriptors/relationship/descriptorRelationship.schema.json)|experimental|**296**|**220**|[613a327](https://github.com/adobe/xdm/commit/613a3270dace69bcfef0d391e0b3717946fa3a22 "Removed extension folder from localization") [b4ac040](https://github.com/adobe/xdm/commit/b4ac0402a6f317427c1b6511584fd79372b028ab "Merge master") [f30f47d](https://github.com/adobe/xdm/commit/f30f47d4fc34a62c3af366b3a2deef5cfc281d04 "Added meta:tileId and meta:descriptionId to resolver of compatibility check") [26c8c21](https://github.com/adobe/xdm/commit/26c8c21ed74e24d631c8edef8945dd1048f99cbb "Excluded null values and append random number to keys") [8616f86](https://github.com/adobe/xdm/commit/8616f862621868dfb4ffa7286938186de4822d96 "Added meta:createdDate attribute")|
+|[schemas/destinations/solutions/analytics-experienceevent](schemas/destinations/solutions/analytics-experienceevent.schema.json)|experimental|**155**|**152**|[8245ce9](https://github.com/adobe/xdm/commit/8245ce978f7e238bda59c5f0f0c6e8bb541a7998 "Revert the ID to those in en-US file") [d83cc36](https://github.com/adobe/xdm/commit/d83cc365740a81bf0c470b89b0dd690adb125326 "Added titleId and created Localization files") [613a327](https://github.com/adobe/xdm/commit/613a3270dace69bcfef0d391e0b3717946fa3a22 "Removed extension folder from localization") [b4ac040](https://github.com/adobe/xdm/commit/b4ac0402a6f317427c1b6511584fd79372b028ab "Merge master") [f30f47d](https://github.com/adobe/xdm/commit/f30f47d4fc34a62c3af366b3a2deef5cfc281d04 "Added meta:tileId and meta:descriptionId to resolver of compatibility check") [26c8c21](https://github.com/adobe/xdm/commit/26c8c21ed74e24d631c8edef8945dd1048f99cbb "Excluded null values and append random number to keys")|
 
 
 ### Stabilizing

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",
@@ -172,6 +165,13 @@
             "xdm:networkType": "search",
             "xdm:matchType": "broad"
         },
+        {
+            "xdm:adId": "4116904851",
+            "xdm:runtime": "HTML5",
+            "xdm:adClass": "video",
+            "xdm:adUnitType": "HTML5",
+            "xdm:promotedAssetId": "4116761052"
+        },
         {
             "@id": "14",
             "dsp:adKey": "yyyy029YLCDvseo8QhTE",

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",
@@ -35,6 +25,16 @@ Adobe Advertising Cloud Ad Details.
 }
 ```
 
+```json
+{
+  "xdm:adId": "4116904851",
+  "xdm:runtime": "HTML5",
+  "xdm:adClass": "video",
+  "xdm:adUnitType": "HTML5",
+  "xdm:promotedAssetId": "4116761052"
+}
+```
+
 ```json
 {
   "@id": "14",

diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.json b/docs/reference/adobe/experience/adcloud/campaign.schema.json
@@ -104,6 +104,21 @@
             "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",
@@ -132,21 +147,6 @@
             "xdm.CampaignObjective": "visit_web",
             "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"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.md b/docs/reference/adobe/experience/adcloud/campaign.schema.md
@@ -27,6 +27,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
 {
   "@id": "12",
@@ -62,24 +80,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"
-}
-```
-
 
 # Ad Campaign Detail Properties
 

diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json
@@ -70,6 +70,12 @@
     "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",
@@ -80,12 +86,6 @@
                 "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,6 +20,15 @@ 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",
@@ -34,15 +43,6 @@ 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/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/...eference/adobe/experience/decisioning/experienceevent-proposition-interaction.schema.json b/...eference/adobe/experience/decisioning/experienceevent-proposition-interaction.schema.json
@@ -47,6 +47,24 @@
     "meta:titleId": "proposition-interaction##title##38171",
     "meta:descriptionId": "proposition-interaction##description##45571",
     "examples": [
+        {
+            "https://ns.adobe.com/experience/decisioning/propositions": [
+                {
+                    "xdm:items": [
+                        {
+                            "xdm:id": "experience1"
+                        }
+                    ]
+                },
+                {
+                    "xdm:items": [
+                        {
+                            "xdm:id": "personalized-offer:f67bab756ed6ee4"
+                        }
+                    ]
+                }
+            ]
+        },
         {
             "@id": "a7864a96-1eac-4934-ab44-54ad037b4f2b",
             "xdm:timestamp": "2020-09-26T15:52:25+00:00",
@@ -91,24 +109,6 @@
                     "xdm:scope": "scope:12cfc3fa94281acb"
                 }
             ]
-        },
-        {
-            "https://ns.adobe.com/experience/decisioning/propositions": [
-                {
-                    "xdm:items": [
-                        {
-                            "xdm:id": "experience1"
-                        }
-                    ]
-                },
-                {
-                    "xdm:items": [
-                        {
-                            "xdm:id": "personalized-offer:f67bab756ed6ee4"
-                        }
-                    ]
-                }
-            ]
         }
     ]
 }