Skip to content

Commit c385a74

Browse files
update-oas-botgricher-crto
update-oas-bot
authored and
gricher-crto
committed
Update OAS for Preview
1 parent 5140503 commit c385a74

File tree

2 files changed

+460
-14
lines changed

2 files changed

+460
-14
lines changed

‎api-specifications/marketingsolutions_preview.json‎

Lines changed: 174 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -749,11 +749,11 @@
749749
],
750750
"responses": {
751751
"200": {
752-
"description": "The list of self-services Creatives is returned.",
752+
"description": "The list of self-services Creatives is returned.This list will contain creatives in draft status as well which will have some properties as null",
753753
"content": {
754754
"application/json": {
755755
"schema": {
756-
"$ref": "#/components/schemas/ResourceCollectionOutcomeOfCreative"
756+
"$ref": "#/components/schemas/ResourceCollectionOutcomeOfCreativeRead"
757757
}
758758
}
759759
}
@@ -4951,23 +4951,19 @@
49514951
},
49524952
"descriptionFont": {
49534953
"type": "string",
4954-
"description": "Font of the description\r\nValid supported font like \"Arial\"",
4955-
"nullable": true
4954+
"description": "Font of the description\r\nValid supported font like \"Arial\""
49564955
},
49574956
"descriptionText": {
49584957
"type": "string",
4959-
"description": "The description text of the banner",
4960-
"nullable": true
4958+
"description": "The description text of the banner"
49614959
},
49624960
"headlineFont": {
49634961
"type": "string",
4964-
"description": "Font of the headline\r\nValid supported font like \"Arial\"",
4965-
"nullable": true
4962+
"description": "Font of the headline\r\nValid supported font like \"Arial\""
49664963
},
49674964
"headlineText": {
49684965
"type": "string",
4969-
"description": "The headline text of the banner",
4970-
"nullable": true
4966+
"description": "The headline text of the banner"
49714967
},
49724968
"imageDisplay": {
49734969
"enum": [
@@ -5058,7 +5054,98 @@
50585054
"description": "Color of the image set's headline text.\r\nA valid RGB24 color in hexadecimal (e.g. \"AB00FF\")"
50595055
}
50605056
},
5061-
"description": "Entity consists of the color aliases of the creative's elements"
5057+
"description": "Entity consists of the color aliases of the creative's elements",
5058+
"nullable": true
5059+
},
5060+
"AdaptiveReadAttributes": {
5061+
"type": "object",
5062+
"properties": {
5063+
"callsToAction": {
5064+
"type": "array",
5065+
"items": {
5066+
"type": "string"
5067+
},
5068+
"description": "A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate\r\nresponse, such as “Buy now” or “Go!”.",
5069+
"nullable": true
5070+
},
5071+
"colors": {
5072+
"$ref": "#/components/schemas/AdaptiveColors"
5073+
},
5074+
"descriptionFont": {
5075+
"type": "string",
5076+
"description": "Font of the description\r\nValid supported font like \"Arial\"",
5077+
"nullable": true
5078+
},
5079+
"descriptionText": {
5080+
"type": "string",
5081+
"description": "The description text of the banner",
5082+
"nullable": true
5083+
},
5084+
"headlineFont": {
5085+
"type": "string",
5086+
"description": "Font of the headline\r\nValid supported font like \"Arial\"",
5087+
"nullable": true
5088+
},
5089+
"headlineText": {
5090+
"type": "string",
5091+
"description": "The headline text of the banner",
5092+
"nullable": true
5093+
},
5094+
"imageDisplay": {
5095+
"enum": [
5096+
"ShowFullImage",
5097+
"ZoomOnImage"
5098+
],
5099+
"type": "string",
5100+
"description": "Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated\r\nspace (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some\r\nimage cropping.",
5101+
"nullable": true
5102+
},
5103+
"imageSets": {
5104+
"type": "array",
5105+
"items": {
5106+
"$ref": "#/components/schemas/ImageSet"
5107+
},
5108+
"description": "Multiple image sets, each image set consists of multiple images and a headline text.",
5109+
"nullable": true
5110+
},
5111+
"landingPageUrl": {
5112+
"type": "string",
5113+
"description": "Web redirection of the landing page url",
5114+
"format": "uri",
5115+
"nullable": true
5116+
},
5117+
"layouts": {
5118+
"type": "array",
5119+
"items": {
5120+
"enum": [
5121+
"Editorial",
5122+
"Montage",
5123+
"InBannerVideo"
5124+
],
5125+
"type": "string"
5126+
},
5127+
"description": "The Adaptive layouts that are enabled.\r\nIt can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".",
5128+
"nullable": true
5129+
},
5130+
"logos": {
5131+
"type": "array",
5132+
"items": {
5133+
"$ref": "#/components/schemas/ImageShape"
5134+
},
5135+
"description": "Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net",
5136+
"nullable": true
5137+
},
5138+
"videos": {
5139+
"type": "array",
5140+
"items": {
5141+
"$ref": "#/components/schemas/VideoDetail"
5142+
},
5143+
"description": "Multiple videos potentially in different shapes.",
5144+
"nullable": true
5145+
}
5146+
},
5147+
"description": "The attributes specific to Adaptive creatives read",
5148+
"nullable": true
50625149
},
50635150
"AdaptiveWriteAttributes": {
50645151
"required": [
@@ -8833,6 +8920,62 @@
88338920
"description": "A creative is a project with the necessary information to display a creative",
88348921
"nullable": true
88358922
},
8923+
"CreativeRead": {
8924+
"required": [
8925+
"advertiserId",
8926+
"author",
8927+
"name",
8928+
"status"
8929+
],
8930+
"type": "object",
8931+
"properties": {
8932+
"adaptiveAttributes": {
8933+
"$ref": "#/components/schemas/AdaptiveReadAttributes"
8934+
},
8935+
"advertiserId": {
8936+
"type": "string",
8937+
"description": "Advertiser linked to the Creative"
8938+
},
8939+
"author": {
8940+
"type": "string",
8941+
"description": "The login of the person who created this creative ("
8942+
},
8943+
"datasetId": {
8944+
"type": "string",
8945+
"description": "Data set id linked to the Creative",
8946+
"nullable": true
8947+
},
8948+
"description": {
8949+
"type": "string",
8950+
"description": "The description of the creative",
8951+
"nullable": true
8952+
},
8953+
"dynamicAttributes": {
8954+
"$ref": "#/components/schemas/DynamicAttributes"
8955+
},
8956+
"format": {
8957+
"type": "string",
8958+
"description": "The format of the creative",
8959+
"nullable": true
8960+
},
8961+
"htmlTagAttributes": {
8962+
"$ref": "#/components/schemas/HtmlTagAttributes"
8963+
},
8964+
"imageAttributes": {
8965+
"$ref": "#/components/schemas/ImageAttributes"
8966+
},
8967+
"name": {
8968+
"type": "string",
8969+
"description": "The name of the creative"
8970+
},
8971+
"status": {
8972+
"type": "string",
8973+
"description": "The status of the creative"
8974+
}
8975+
},
8976+
"description": "A CreativeRead is a project with the necessary information to display a creative",
8977+
"nullable": true
8978+
},
88368979
"CreativeWrite": {
88378980
"required": [
88388981
"datasetId",
@@ -13826,13 +13969,13 @@
1382613969
},
1382713970
"description": "A top-level object that encapsulates a Criteo API response for several entities."
1382813971
},
13829-
"ResourceCollectionOutcomeOfCreative": {
13972+
"ResourceCollectionOutcomeOfCreativeRead": {
1383013973
"type": "object",
1383113974
"properties": {
1383213975
"data": {
1383313976
"type": "array",
1383413977
"items": {
13835-
"$ref": "#/components/schemas/ResourceOfCreative"
13978+
"$ref": "#/components/schemas/ResourceOfCreativeRead"
1383613979
},
1383713980
"nullable": true
1383813981
},
@@ -14035,6 +14178,24 @@
1403514178
"description": "A class that represents a domain entity exposed by an API.",
1403614179
"nullable": true
1403714180
},
14181+
"ResourceOfCreativeRead": {
14182+
"type": "object",
14183+
"properties": {
14184+
"attributes": {
14185+
"$ref": "#/components/schemas/CreativeRead"
14186+
},
14187+
"id": {
14188+
"type": "string",
14189+
"description": "Unique identifier of this resource.",
14190+
"nullable": true
14191+
},
14192+
"type": {
14193+
"type": "string",
14194+
"nullable": true
14195+
}
14196+
},
14197+
"description": "A class that represents a domain entity exposed by an API."
14198+
},
1403814199
"ResourceOfCreativeWrite": {
1403914200
"type": "object",
1404014201
"properties": {

0 commit comments

Comments
 (0)