Skip to content

Commit d98e82b

Browse files
gricher-crtogricher-crto
authored
Merge pull request #112 from criteo/update-oas-2025-02-17
Update OAS up to 2025-01
2 parents 5ecd5a8 + 6d27891 commit d98e82b

5 files changed

+70
-38
lines changed

‎api-specifications/marketingsolutions_preview.json

+21-21
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "Criteo API",
55
"description": "Criteo API - MarketingSolutions",
6-
"version": "preview"
6+
"version": "Preview"
77
},
88
"servers": [
99
{
@@ -19561,72 +19561,72 @@
1956119561
"format": "date-time"
1956219562
},
1956319563
"total": {
19564-
"type": "integer",
19564+
"type": "string",
1956519565
"description": "The number of total products at endDate moment",
1956619566
"format": "int64"
1956719567
},
1956819568
"variant": {
19569-
"type": "integer",
19569+
"type": "string",
1957019570
"description": "The number of total variant products at endDate moment",
1957119571
"format": "int64"
1957219572
},
1957319573
"displayable": {
19574-
"type": "integer",
19574+
"type": "string",
1957519575
"description": "The number of total displayable products at endDate moment",
1957619576
"format": "int64"
1957719577
},
1957819578
"nonDisplayable": {
19579-
"type": "integer",
19579+
"type": "string",
1958019580
"description": "The number of total non-displayable products at endDate moment",
1958119581
"format": "int64"
1958219582
},
1958319583
"added": {
19584-
"type": "integer",
19584+
"type": "string",
1958519585
"description": "The number of inserted products during the period between startDate and endDate",
1958619586
"format": "int64"
1958719587
},
1958819588
"deleted": {
19589-
"type": "integer",
19589+
"type": "string",
1959019590
"description": "The number of deleted products during the period between startDate and endDate",
1959119591
"format": "int64"
1959219592
},
1959319593
"updated": {
19594-
"type": "integer",
19594+
"type": "string",
1959519595
"description": "The number of updated products during the period between startDate and endDate",
1959619596
"format": "int64"
1959719597
},
1959819598
"blacklisted": {
19599-
"type": "integer",
19599+
"type": "string",
1960019600
"description": "The number of total blacklisted products at endDate moment",
1960119601
"format": "int64"
1960219602
},
1960319603
"outOfStock": {
19604-
"type": "integer",
19604+
"type": "string",
1960519605
"description": "The number of total out-of-stock products at endDate moment",
1960619606
"format": "int64"
1960719607
},
1960819608
"missingImage": {
19609-
"type": "integer",
19609+
"type": "string",
1961019610
"description": "The number of total missing image products at endDate moment",
1961119611
"format": "int64"
1961219612
},
1961319613
"missingUrl": {
19614-
"type": "integer",
19614+
"type": "string",
1961519615
"description": "The number of total missing url products at endDate moment",
1961619616
"format": "int64"
1961719617
},
1961819618
"missingPrice": {
19619-
"type": "integer",
19619+
"type": "string",
1962019620
"description": "The number of total missing price products at endDate moment",
1962119621
"format": "int64"
1962219622
},
1962319623
"missingName": {
19624-
"type": "integer",
19624+
"type": "string",
1962519625
"description": "The number of total missing name products at endDate moment",
1962619626
"format": "int64"
1962719627
},
1962819628
"missingDescription": {
19629-
"type": "integer",
19629+
"type": "string",
1963019630
"description": "The number of total missing description products at endDate moment",
1963119631
"format": "int64"
1963219632
}
@@ -19671,35 +19671,35 @@
1967119671
"description": "The status of the operation.\nThe operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED)"
1967219672
},
1967319673
"importRequestTimestamp": {
19674-
"type": "integer",
19674+
"type": "string",
1967519675
"description": "The date when the original batch request was sent.",
1967619676
"format": "int64",
1967719677
"nullable": true,
1967819678
"x-nullable": true
1967919679
},
1968019680
"numberOfProductsInTheBatch": {
19681-
"type": "integer",
19681+
"type": "string",
1968219682
"description": "The number of products present in the batch.",
1968319683
"format": "int32",
1968419684
"nullable": true,
1968519685
"x-nullable": true
1968619686
},
1968719687
"numberOfProductsUpserted": {
19688-
"type": "integer",
19688+
"type": "string",
1968919689
"description": "The number of products upserted.",
1969019690
"format": "int32",
1969119691
"nullable": true,
1969219692
"x-nullable": true
1969319693
},
1969419694
"numberOfProductsDeleted": {
19695-
"type": "integer",
19695+
"type": "string",
1969619696
"description": "The number of products deleted.",
1969719697
"format": "int32",
1969819698
"nullable": true,
1969919699
"x-nullable": true
1970019700
},
1970119701
"numberOfProductsWithErrors": {
19702-
"type": "integer",
19702+
"type": "string",
1970319703
"description": "The number of products with errors.",
1970419704
"format": "int32",
1970519705
"nullable": true,
@@ -19713,7 +19713,7 @@
1971319713
"description": "The list of errors with details."
1971419714
},
1971519715
"numberOfProductsWithWarnings": {
19716-
"type": "integer",
19716+
"type": "string",
1971719717
"description": "The number of products with Warnings.",
1971819718
"format": "int32",
1971919719
"nullable": true,

‎api-specifications/retailmedia_2024-07.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6679,7 +6679,7 @@
66796679
"nullable": true,
66806680
"readOnly": true
66816681
},
6682-
"metadata": {
6682+
"meta": {
66836683
"$ref": "#/components/schemas/ProductMetadata"
66846684
},
66856685
"data": {

‎api-specifications/retailmedia_2024-10.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7586,7 +7586,7 @@
75867586
"nullable": true,
75877587
"readOnly": true
75887588
},
7589-
"metadata": {
7589+
"meta": {
75907590
"$ref": "#/components/schemas/ProductMetadata"
75917591
},
75927592
"data": {

‎api-specifications/retailmedia_2025-01.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7787,7 +7787,7 @@
77877787
"nullable": true,
77887788
"readOnly": true
77897789
},
7790-
"metadata": {
7790+
"meta": {
77917791
"$ref": "#/components/schemas/ProductMetadata"
77927792
},
77937793
"data": {

‎api-specifications/retailmedia_preview.json

+46-14
Original file line numberDiff line numberDiff line change
@@ -4452,17 +4452,17 @@
44524452
"content": {
44534453
"text/plain": {
44544454
"schema": {
4455-
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeBrandIdSearchResult"
4455+
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata"
44564456
}
44574457
},
44584458
"application/json": {
44594459
"schema": {
4460-
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeBrandIdSearchResult"
4460+
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata"
44614461
}
44624462
},
44634463
"text/json": {
44644464
"schema": {
4465-
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeBrandIdSearchResult"
4465+
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata"
44664466
}
44674467
}
44684468
}
@@ -5219,35 +5219,35 @@
52195219
"description": "The status of the operation.\nThe operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED)"
52205220
},
52215221
"importRequestTimestamp": {
5222-
"type": "integer",
5222+
"type": "string",
52235223
"description": "The date when the original batch request was sent.",
52245224
"format": "int64",
52255225
"nullable": true,
52265226
"x-nullable": true
52275227
},
52285228
"numberOfProductsInTheBatch": {
5229-
"type": "integer",
5229+
"type": "string",
52305230
"description": "The number of products present in the batch.",
52315231
"format": "int32",
52325232
"nullable": true,
52335233
"x-nullable": true
52345234
},
52355235
"numberOfProductsUpserted": {
5236-
"type": "integer",
5236+
"type": "string",
52375237
"description": "The number of products upserted.",
52385238
"format": "int32",
52395239
"nullable": true,
52405240
"x-nullable": true
52415241
},
52425242
"numberOfProductsDeleted": {
5243-
"type": "integer",
5243+
"type": "string",
52445244
"description": "The number of products deleted.",
52455245
"format": "int32",
52465246
"nullable": true,
52475247
"x-nullable": true
52485248
},
52495249
"numberOfProductsWithErrors": {
5250-
"type": "integer",
5250+
"type": "string",
52515251
"description": "The number of products with errors.",
52525252
"format": "int32",
52535253
"nullable": true,
@@ -5261,7 +5261,7 @@
52615261
"description": "The list of errors with details."
52625262
},
52635263
"numberOfProductsWithWarnings": {
5264-
"type": "integer",
5264+
"type": "string",
52655265
"description": "The number of products with Warnings.",
52665266
"format": "int32",
52675267
"nullable": true,
@@ -7464,7 +7464,7 @@
74647464
"nullable": true,
74657465
"readOnly": true
74667466
},
7467-
"metadata": {
7467+
"meta": {
74687468
"$ref": "#/components/schemas/ProductMetadata"
74697469
},
74707470
"data": {
@@ -13122,9 +13122,12 @@
1312213122
"description": "Category information for a preferred line item page",
1312313123
"x-nullable": false
1312413124
},
13125-
"EntityResourceCollectionOutcomeBrandIdSearchResult": {
13125+
"EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata": {
1312613126
"type": "object",
1312713127
"properties": {
13128+
"metadata": {
13129+
"$ref": "#/components/schemas/PagingOffsetLimitMetadata"
13130+
},
1312813131
"data": {
1312913132
"type": "array",
1313013133
"items": {
@@ -13152,7 +13155,7 @@
1315213155
}
1315313156
},
1315413157
"additionalProperties": false,
13155-
"description": "A top-level object that encapsulates a Criteo API response for several entities."
13158+
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata."
1315613159
},
1315713160
"ValueResourceInputBrandIdSearchRequest": {
1315813161
"type": "object",
@@ -13164,6 +13167,32 @@
1316413167
"additionalProperties": false,
1316513168
"description": "A top-level object that encapsulates a Criteo API request for a single value objects."
1316613169
},
13170+
"PagingOffsetLimitMetadata": {
13171+
"required": [
13172+
"limit",
13173+
"offset"
13174+
],
13175+
"type": "object",
13176+
"properties": {
13177+
"count": {
13178+
"type": "integer",
13179+
"format": "int64",
13180+
"nullable": true
13181+
},
13182+
"offset": {
13183+
"type": "integer",
13184+
"description": "The (zero-based) starting offset in the collection.",
13185+
"format": "int32"
13186+
},
13187+
"limit": {
13188+
"type": "integer",
13189+
"description": "The number of elements to be returned.",
13190+
"format": "int32"
13191+
}
13192+
},
13193+
"additionalProperties": false,
13194+
"description": "Metadata for paging data."
13195+
},
1316713196
"EntityResourceBrandIdSearchResult": {
1316813197
"type": "object",
1316913198
"properties": {
@@ -13233,16 +13262,19 @@
1323313262
"description": "An object that represents the result from a brand ID search."
1323413263
},
1323513264
"BrandIdSearchRequest": {
13265+
"required": [
13266+
"retailerIds"
13267+
],
1323613268
"type": "object",
1323713269
"properties": {
1323813270
"retailerIds": {
13271+
"minItems": 1,
1323913272
"type": "array",
1324013273
"items": {
1324113274
"type": "integer",
1324213275
"format": "int32"
1324313276
},
13244-
"description": "IDs of the retailers we want to limit the search to",
13245-
"nullable": true
13277+
"description": "IDs of the retailers we want to limit the search to"
1324613278
},
1324713279
"name": {
1324813280
"type": "string",

0 commit comments

Comments
 (0)