Skip to content

Commit 16bbe44

Browse files
trielofftrieloff
committed
[ci skip] updating documentation
1 parent 2fc6d7e commit 16bbe44

File tree

49 files changed

+1829
-1322
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1829
-1322
lines changed

‎STABILIZING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Stabilization Candidates
22

3-
_Generated on **Thu Sep 17 2020 16:19:28 GMT+0000 (UTC)**_
3+
_Generated on **Tue Sep 22 2020 01:52:47 GMT+0000 (UTC)**_
44

55

66
### Unknown Status, needs immediate attention

‎docs/reference/README.md

+88-82
Large diffs are not rendered by default.

‎docs/reference/adobe/experience/adcloud/advertisement.schema.json

+9-9
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,15 @@
132132
"xdm:adUnitType": "HTML5",
133133
"xdm:promotedAssetId": "4116761052"
134134
},
135+
{
136+
"xdm:creativeID": "301404063528",
137+
"xdm:keywordID": "147741280",
138+
"xdm:audienceID": "257600311580",
139+
"xdm:adGroupID": "32345812783",
140+
"xdm:campaignID": "663049855",
141+
"xdm:networkType": "search",
142+
"xdm:matchType": "broad"
143+
},
135144
{
136145
"@id": "14",
137146
"dsp:adKey": "yyyy029YLCDvseo8QhTE",
@@ -144,15 +153,6 @@
144153
"dsp:placementIds": [
145154
"1"
146155
]
147-
},
148-
{
149-
"xdm:creativeID": "301404063528",
150-
"xdm:keywordID": "147741280",
151-
"xdm:audienceID": "257600311580",
152-
"xdm:adGroupID": "32345812783",
153-
"xdm:campaignID": "663049855",
154-
"xdm:networkType": "search",
155-
"xdm:matchType": "broad"
156156
}
157157
]
158158
}

‎docs/reference/adobe/experience/adcloud/advertisement.schema.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,18 @@ Adobe Advertising Cloud Ad Details.
2323
}
2424
```
2525

26+
```json
27+
{
28+
"xdm:creativeID": "301404063528",
29+
"xdm:keywordID": "147741280",
30+
"xdm:audienceID": "257600311580",
31+
"xdm:adGroupID": "32345812783",
32+
"xdm:campaignID": "663049855",
33+
"xdm:networkType": "search",
34+
"xdm:matchType": "broad"
35+
}
36+
```
37+
2638
```json
2739
{
2840
"@id": "14",
@@ -39,18 +51,6 @@ Adobe Advertising Cloud Ad Details.
3951
}
4052
```
4153

42-
```json
43-
{
44-
"xdm:creativeID": "301404063528",
45-
"xdm:keywordID": "147741280",
46-
"xdm:audienceID": "257600311580",
47-
"xdm:adGroupID": "32345812783",
48-
"xdm:campaignID": "663049855",
49-
"xdm:networkType": "search",
50-
"xdm:matchType": "broad"
51-
}
52-
```
53-
5454

5555
# Adobe Advertising Cloud Ad Details Properties
5656

‎docs/reference/adobe/experience/adcloud/campaign.schema.json

+24-24
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,19 @@
7373
],
7474
"examples": [
7575
{
76-
"xdm:accountId": "123456",
77-
"xdm:dspId": "2",
78-
"xdm:campaignId": "987654",
79-
"xdm:placementId": "7656467",
80-
"xdm:packageId": "98766172",
81-
"xdm:advertiserId": "87612391",
82-
"xdm:experimentId": "9812987",
83-
"xdm:sampleGroupId": "8676378",
84-
"xdm:currency": "USD"
76+
"@id": "100001061",
77+
"searchads:campaignId": "10001234",
78+
"searchads:accountId": "10001456",
79+
"searchads:campaignName": "My First Campaign",
80+
"searchads:campaignDescription": "Branded Mobile Campaign",
81+
"searchads:campaignStatus": "Active",
82+
"searchads:channelType": "Search",
83+
"searchads:budget": 123.45,
84+
"searchads:budgetType": "Monthly",
85+
"searchads.adDeliveryType": "Standard",
86+
"searchads.CampaignObjective": "visit_web",
87+
"repo:createDate": "2019-04-26T14:00:00+00:00",
88+
"repo:modifyDate": "2019-04-26T14:00:00+00:00"
8589
},
8690
{
8791
"@id": "12",
@@ -98,6 +102,17 @@
98102
"repo:createDate": "2019-04-26T14:00:00+00:00",
99103
"repo:modifyDate": "2019-04-26T14:00:00+00:00"
100104
},
105+
{
106+
"xdm:accountId": "123456",
107+
"xdm:dspId": "2",
108+
"xdm:campaignId": "987654",
109+
"xdm:placementId": "7656467",
110+
"xdm:packageId": "98766172",
111+
"xdm:advertiserId": "87612391",
112+
"xdm:experimentId": "9812987",
113+
"xdm:sampleGroupId": "8676378",
114+
"xdm:currency": "USD"
115+
},
101116
{
102117
"xdm:id": "100001061",
103118
"xdm:campaignId": "10001234",
@@ -111,21 +126,6 @@
111126
"xdm.CampaignObjective": "visit_web",
112127
"repo:createDate": "2019-04-26T14:00:00+00:00",
113128
"repo:modifyDate": "2019-04-26T14:00:00+00:00"
114-
},
115-
{
116-
"@id": "100001061",
117-
"searchads:campaignId": "10001234",
118-
"searchads:accountId": "10001456",
119-
"searchads:campaignName": "My First Campaign",
120-
"searchads:campaignDescription": "Branded Mobile Campaign",
121-
"searchads:campaignStatus": "Active",
122-
"searchads:channelType": "Search",
123-
"searchads:budget": 123.45,
124-
"searchads:budgetType": "Monthly",
125-
"searchads.adDeliveryType": "Standard",
126-
"searchads.CampaignObjective": "visit_web",
127-
"repo:createDate": "2019-04-26T14:00:00+00:00",
128-
"repo:modifyDate": "2019-04-26T14:00:00+00:00"
129129
}
130130
]
131131
}

‎docs/reference/adobe/experience/adcloud/campaign.schema.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,19 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
1515

1616
```json
1717
{
18-
"xdm:accountId": "123456",
19-
"xdm:dspId": "2",
20-
"xdm:campaignId": "987654",
21-
"xdm:placementId": "7656467",
22-
"xdm:packageId": "98766172",
23-
"xdm:advertiserId": "87612391",
24-
"xdm:experimentId": "9812987",
25-
"xdm:sampleGroupId": "8676378",
26-
"xdm:currency": "USD"
18+
"@id": "100001061",
19+
"searchads:campaignId": "10001234",
20+
"searchads:accountId": "10001456",
21+
"searchads:campaignName": "My First Campaign",
22+
"searchads:campaignDescription": "Branded Mobile Campaign",
23+
"searchads:campaignStatus": "Active",
24+
"searchads:channelType": "Search",
25+
"searchads:budget": 123.45,
26+
"searchads:budgetType": "Monthly",
27+
"searchads.adDeliveryType": "Standard",
28+
"searchads.CampaignObjective": "visit_web",
29+
"repo:createDate": "2019-04-26T14:00:00+00:00",
30+
"repo:modifyDate": "2019-04-26T14:00:00+00:00"
2731
}
2832
```
2933

@@ -45,6 +49,20 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
4549
}
4650
```
4751

52+
```json
53+
{
54+
"xdm:accountId": "123456",
55+
"xdm:dspId": "2",
56+
"xdm:campaignId": "987654",
57+
"xdm:placementId": "7656467",
58+
"xdm:packageId": "98766172",
59+
"xdm:advertiserId": "87612391",
60+
"xdm:experimentId": "9812987",
61+
"xdm:sampleGroupId": "8676378",
62+
"xdm:currency": "USD"
63+
}
64+
```
65+
4866
```json
4967
{
5068
"xdm:id": "100001061",
@@ -62,24 +80,6 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
6280
}
6381
```
6482

65-
```json
66-
{
67-
"@id": "100001061",
68-
"searchads:campaignId": "10001234",
69-
"searchads:accountId": "10001456",
70-
"searchads:campaignName": "My First Campaign",
71-
"searchads:campaignDescription": "Branded Mobile Campaign",
72-
"searchads:campaignStatus": "Active",
73-
"searchads:channelType": "Search",
74-
"searchads:budget": 123.45,
75-
"searchads:budgetType": "Monthly",
76-
"searchads.adDeliveryType": "Standard",
77-
"searchads.CampaignObjective": "visit_web",
78-
"repo:createDate": "2019-04-26T14:00:00+00:00",
79-
"repo:modifyDate": "2019-04-26T14:00:00+00:00"
80-
}
81-
```
82-
8383

8484
# Ad Campaign Detail Properties
8585

‎docs/reference/adobe/experience/b2b/bizible/bizible-account-details.schema.json

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"meta:license": [
3+
"Copyright 2020 Adobe Systems Incorporated. All rights reserved.",
4+
"This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
5+
"you may not use this file except in compliance with the License. You may obtain a copy",
6+
"of the License at https://creativecommons.org/licenses/by/4.0/"
7+
],
8+
"$id": "https://ns.adobe.com/experience/b2b/bizible/bizible-account-details",
9+
"$schema": "http://json-schema.org/draft-06/schema#",
10+
"title": "Bizible Account Details",
11+
"type": "object",
12+
"meta:extensible": true,
13+
"meta:abstract": true,
14+
"meta:intendedToExtend": [
15+
"https://ns.adobe.com/xdm/context/account"
16+
],
17+
"description": "Bizible business account details.",
18+
"definitions": {
19+
"bizible-account-details": {
20+
"properties": {
21+
"bizible:engagementRating": {
22+
"title": "Engagement Rating",
23+
"description": "Computed engagement rating for a business account.",
24+
"type": "number"
25+
},
26+
"bizible:engagementScore": {
27+
"title": "Engagement Score",
28+
"description": "Computed engagement score for a business account.",
29+
"type": "number"
30+
}
31+
}
32+
}
33+
},
34+
"allOf": [
35+
{
36+
"$ref": "#/definitions/bizible-account-details"
37+
}
38+
],
39+
"meta:status": "experimental",
40+
"examples": [
41+
{}
42+
]
43+
}

‎docs/reference/adobe/experience/b2b/bizible/bizible-account-details.schema.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
2+
# Bizible Account Details Schema
3+
4+
```
5+
https://ns.adobe.com/experience/b2b/bizible/bizible-account-details
6+
```
7+
8+
Bizible business account details.
9+
10+
| [Abstract](../../../../../abstract.md) | [Extensible](../../../../../extensions.md) | [Status](../../../../../status.md) | [Identifiable](../../../../../id.md) | [Custom Properties](../../../../../extensions.md) | [Additional Properties](../../../../../extensions.md) | Defined In |
11+
|----------------------------------------|--------------------------------------------|------------------------------------|--------------------------------------|---------------------------------------------------|-------------------------------------------------------|------------|
12+
| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/b2b/bizible/bizible-account-details.schema.json](adobe/experience/b2b/bizible/bizible-account-details.schema.json) |
13+
14+
## Bizible Account Details Example
15+
```json
16+
{}
17+
```
18+
19+
# Bizible Account Details Properties
20+
21+
| Property | Type | Required | Defined by |
22+
|----------|------|----------|------------|
23+
| [bizible:engagementRating](#bizibleengagementrating) | `number` | Optional | Bizible Account Details (this schema) |
24+
| [bizible:engagementScore](#bizibleengagementscore) | `number` | Optional | Bizible Account Details (this schema) |
25+
| `*` | any | Additional | this schema *allows* additional properties |
26+
27+
## bizible:engagementRating
28+
### Engagement Rating
29+
30+
Computed engagement rating for a business account.
31+
32+
`bizible:engagementRating`
33+
* is optional
34+
* type: `number`
35+
* defined in this schema
36+
37+
### bizible:engagementRating Type
38+
39+
40+
`number`
41+
42+
43+
44+
45+
46+
47+
## bizible:engagementScore
48+
### Engagement Score
49+
50+
Computed engagement score for a business account.
51+
52+
`bizible:engagementScore`
53+
* is optional
54+
* type: `number`
55+
* defined in this schema
56+
57+
### bizible:engagementScore Type
58+
59+
60+
`number`
61+
62+
63+
64+
65+

‎docs/reference/adobe/experience/b2b/bizible/bizible-opportunity-details.schema.json

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"meta:license": [
3+
"Copyright 2020 Adobe Systems Incorporated. All rights reserved.",
4+
"This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
5+
"you may not use this file except in compliance with the License. You may obtain a copy",
6+
"of the License at https://creativecommons.org/licenses/by/4.0/"
7+
],
8+
"$id": "https://ns.adobe.com/experience/b2b/bizible/bizible-opportunity-details",
9+
"$schema": "http://json-schema.org/draft-06/schema#",
10+
"title": "Bizible Business Opportunity Details",
11+
"type": "object",
12+
"meta:extensible": true,
13+
"meta:abstract": true,
14+
"meta:intendedToExtend": [
15+
"https://ns.adobe.com/xdm/context/opportunity"
16+
],
17+
"description": "This mixin is used to capture and maintain additional Bizible opportunity attributes. They extend the ones used by industry crm systems.",
18+
"definitions": {
19+
"bizible-opportunity-details": {
20+
"properties": {
21+
"bizible:stage": {
22+
"title": "Opportunity Stage",
23+
"description": "Current stage of a business opportunity.",
24+
"type": "string"
25+
},
26+
"bizible:stagePrevious": {
27+
"title": "Opportunity Previous Stage",
28+
"description": "Previous stage of a business opportunity.",
29+
"type": "string"
30+
}
31+
}
32+
}
33+
},
34+
"allOf": [
35+
{
36+
"$ref": "#/definitions/bizible-opportunity-details"
37+
}
38+
],
39+
"meta:status": "experimental",
40+
"examples": [
41+
{}
42+
]
43+
}

0 commit comments

Comments
 (0)