diff --git a/api-specifications/marketingsolutions_2023-07.json b/api-specifications/marketingsolutions_2023-07.json index 32b5e72..8680640 100644 --- a/api-specifications/marketingsolutions_2023-07.json +++ b/api-specifications/marketingsolutions_2023-07.json @@ -1987,7 +1987,8 @@ "text/json": { } } } - } + }, + "deprecated": true }, "post": { "tags": [ @@ -2059,7 +2060,8 @@ "text/json": { } } } - } + }, + "deprecated": true } }, "/2023-07/marketing-solutions/ad-sets/search": { @@ -4212,64 +4214,77 @@ } ], "requestBody": { + "description": "The query message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "queryMessage" + } }, "responses": { "200": { "description": "Success", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" - }, - "example": { - "data": [ - { - "type": "TransparencyReport", - "attributes": { - "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", - "files": [ - { - "fileName": "report.csv", - "url": "https://www.example.com/transparency" - } - ] - } - } - ] + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" } } } @@ -4277,31 +4292,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4309,32 +4361,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4353,26 +4441,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4381,37 +4468,31 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, - "text/csv": { + "application/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4419,46 +4500,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4466,47 +4569,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4526,25 +4650,208 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "reportQuery" + } }, "responses": { "200": { @@ -4553,37 +4860,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4591,46 +4898,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4638,47 +4985,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4697,26 +5083,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4725,37 +5110,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4763,46 +5148,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4810,47 +5235,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -11058,41 +11522,67 @@ }, "description": "Size entity containing width and height of the creative" }, - "TransparencyReportDataMessage": { - "required": [ - "data" - ], + "TransparencyReportListResponse": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransparencyReportEntityMessage" - } + "$ref": "#/components/schemas/TransparencyReportResource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Errors that occured during this call.", + "nullable": true, + "readOnly": true } }, - "description": "This is the message defining the response for Transparency report" + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several value objects." }, - "ProblemsDetails": { + "Outcome": { "type": "object", "properties": { + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, "errors": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Errors that occured during this call.", "nullable": true, "readOnly": true } }, - "description": "Common problems object" + "additionalProperties": false, + "description": "The outcome of an API call." }, "TransparencyQueryMessage": { "required": [ - "startDate", - "endDate" + "endDate", + "startDate" ], "type": "object", "properties": { @@ -11113,67 +11603,31 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Transparency report", - "example": { - "shouldDisplayProductIds": false, - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Transparency report" }, - "PlacementsReportQueryDataMessage": { - "required": [ - "data" - ], + "PlacementsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/PlacementsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/PlacementsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Placements report", - "example": { - "data": [ - { - "type": "PlacementReport", - "attributes": { - "advertiserIds": "123,456,789", - "campaignIds": "111,222,333,444", - "adsetIds": "135,246,357,468", - "environment": "web", - "placement": "MyPlacement", - "dimensions": [ - "AdsetId", - "AdvertiserId", - "Placement" - ], - "metrics": [ - "clicks", - "displays", - "cost" - ], - "currency": "EUR", - "disclosed": false, - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-08-29T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, "StatisticsReportQueryMessage": { "required": [ - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -11183,7 +11637,6 @@ "nullable": true }, "adSetIds": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -11192,7 +11645,6 @@ "nullable": true }, "adSetNames": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -11201,7 +11653,6 @@ "nullable": true }, "adSetStatus": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -11210,7 +11661,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -11237,14 +11687,15 @@ "MarketingObjective", "ChannelId", "Channel", - "Goal" + "Goal", + "AdChannel", + "SocialPlatform" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -11276,203 +11727,73 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Adset report", - "example": { - "advertiserIds": "123,456,789", - "adSetIds": [ - "12345", - "54321" - ], - "adSetNames": [ - "myAdSet1", - "myAdSet2" - ], - "adSetStatus": [ - "Active" - ], - "dimensions": [ - "CampaignId", - "Campaign", - "AdsetId", - "Adset", - "AdvertiserId", - "Advertiser", - "AdId", - "Ad", - "CouponId", - "Coupon", - "CategoryId", - "Category", - "Hour", - "Day", - "Week", - "Month", - "Year", - "Os", - "Device" - ], - "metrics": [ - "Clicks", - "Displays", - "Cpc", - "Visits" - ], - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-09-01T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Adset report" }, - "TransactionsReportQueryDataMessage": { - "required": [ - "data" - ], + "TransactionsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransactionsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/TransactionsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Transactions report", - "example": { - "data": [ - { - "type": "TransactionsReport", - "attributes": { - "advertiserIds": "123,456,789", - "eventType": "display", - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-03T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, - "TransparencyReportEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransparencyReportResource": { "type": "object", "properties": { "type": { "type": "string", - "readOnly": true + "description": "Type of the resource.", + "nullable": true }, "attributes": { - "$ref": "#/components/schemas/TransparencyReportAttributes" + "$ref": "#/components/schemas/TransparencyReport" } }, - "description": "This is the message defining the entity response for Transparency report" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "ProblemDetails": { + "PlacementsReportQueryMessageResource": { "type": "object", "properties": { - "traceId": { - "type": "string", - "description": "The request correlation ID this problem comes from.", - "nullable": true - }, - "traceIdentifier": { - "type": "string", - "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", - "nullable": true - }, "type": { - "enum": [ - "unknown", - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "The problem's category.", - "nullable": true - }, - "code": { - "type": "string", - "description": "A machine-readable error code, expressed as a string value.", - "nullable": true - }, - "instance": { - "type": "string", - "description": "A URI that identifies the specific occurrence of the problem.", - "nullable": true - }, - "title": { - "type": "string", - "description": "A short human-readable description of the problem type", - "nullable": true - }, - "detail": { "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem", - "nullable": true - }, - "source": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", + "description": "Type of the resource.", "nullable": true }, - "stackTrace": { - "type": "string", - "nullable": true - } - }, - "description": "Common problem object." - }, - "PlacementsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, "attributes": { "$ref": "#/components/schemas/PlacementsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransactionsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransactionsReportQueryMessageResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/TransactionsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransparencyReportAttributes": { + "TransparencyReport": { "required": [ "advertiserId", - "tokenValidUntil", - "files" + "files", + "tokenValidUntil" ], "type": "object", "properties": { @@ -11484,24 +11805,24 @@ "format": "date-time" }, "files": { - "uniqueItems": false, "type": "array", "items": { "$ref": "#/components/schemas/TransparencyReportFile" } } }, + "additionalProperties": false, "description": "This is the message defining the attribute response for Transparency report" }, "PlacementsReportQueryMessage": { "required": [ "advertiserIds", - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -11530,7 +11851,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -11541,14 +11861,17 @@ "AdsetName", "AdvertiserName", "CampaignId", - "CampaignName" + "CampaignName", + "AdChannel", + "SocialPlatform", + "CategoryId", + "CategoryName" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -11586,14 +11909,15 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Placements report" }, "TransactionsReportQueryMessage": { "required": [ "currency", + "endDate", "format", - "startDate", - "endDate" + "startDate" ], "type": "object", "properties": { @@ -11632,6 +11956,7 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Transaction report" }, "TransparencyReportFile": { @@ -11648,6 +11973,7 @@ "type": "string" } }, + "additionalProperties": false, "description": "This is the message defining the file response for Transparency report" }, "GetPortfolioResponse": { diff --git a/api-specifications/marketingsolutions_2023-10.json b/api-specifications/marketingsolutions_2023-10.json index 396fc93..59ea4f6 100644 --- a/api-specifications/marketingsolutions_2023-10.json +++ b/api-specifications/marketingsolutions_2023-10.json @@ -1648,7 +1648,8 @@ "text/json": { } } } - } + }, + "deprecated": true }, "post": { "tags": [ @@ -1720,7 +1721,8 @@ "text/json": { } } } - } + }, + "deprecated": true } }, "/2023-10/marketing-solutions/ad-sets/search": { @@ -3873,64 +3875,77 @@ } ], "requestBody": { + "description": "The query message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "queryMessage" + } }, "responses": { "200": { "description": "Success", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" - }, - "example": { - "data": [ - { - "type": "TransparencyReport", - "attributes": { - "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", - "files": [ - { - "fileName": "report.csv", - "url": "https://www.example.com/transparency" - } - ] - } - } - ] + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" } } } @@ -3938,31 +3953,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -3970,32 +4022,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4014,26 +4102,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4042,37 +4129,31 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, - "text/csv": { + "application/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4080,46 +4161,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4127,47 +4230,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4187,25 +4311,208 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "reportQuery" + } }, "responses": { "200": { @@ -4214,37 +4521,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4252,46 +4559,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4299,47 +4646,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4358,26 +4744,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4386,37 +4771,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4424,46 +4809,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4471,47 +4896,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -10465,41 +10929,67 @@ }, "description": "Size entity containing width and height of the creative" }, - "TransparencyReportDataMessage": { - "required": [ - "data" - ], + "TransparencyReportListResponse": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransparencyReportEntityMessage" - } + "$ref": "#/components/schemas/TransparencyReportResource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Errors that occured during this call.", + "nullable": true, + "readOnly": true } }, - "description": "This is the message defining the response for Transparency report" + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several value objects." }, - "ProblemsDetails": { + "Outcome": { "type": "object", "properties": { + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, "errors": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Errors that occured during this call.", "nullable": true, "readOnly": true } }, - "description": "Common problems object" + "additionalProperties": false, + "description": "The outcome of an API call." }, "TransparencyQueryMessage": { "required": [ - "startDate", - "endDate" + "endDate", + "startDate" ], "type": "object", "properties": { @@ -10520,67 +11010,31 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Transparency report", - "example": { - "shouldDisplayProductIds": false, - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Transparency report" }, - "PlacementsReportQueryDataMessage": { - "required": [ - "data" - ], + "PlacementsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/PlacementsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/PlacementsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Placements report", - "example": { - "data": [ - { - "type": "PlacementReport", - "attributes": { - "advertiserIds": "123,456,789", - "campaignIds": "111,222,333,444", - "adsetIds": "135,246,357,468", - "environment": "web", - "placement": "MyPlacement", - "dimensions": [ - "AdsetId", - "AdvertiserId", - "Placement" - ], - "metrics": [ - "clicks", - "displays", - "cost" - ], - "currency": "EUR", - "disclosed": false, - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-08-29T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, "StatisticsReportQueryMessage": { "required": [ - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -10590,7 +11044,6 @@ "nullable": true }, "adSetIds": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10599,7 +11052,6 @@ "nullable": true }, "adSetNames": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10608,7 +11060,6 @@ "nullable": true }, "adSetStatus": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10617,7 +11068,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -10644,14 +11094,15 @@ "MarketingObjective", "ChannelId", "Channel", - "Goal" + "Goal", + "AdChannel", + "SocialPlatform" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10683,203 +11134,73 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Adset report", - "example": { - "advertiserIds": "123,456,789", - "adSetIds": [ - "12345", - "54321" - ], - "adSetNames": [ - "myAdSet1", - "myAdSet2" - ], - "adSetStatus": [ - "Active" - ], - "dimensions": [ - "CampaignId", - "Campaign", - "AdsetId", - "Adset", - "AdvertiserId", - "Advertiser", - "AdId", - "Ad", - "CouponId", - "Coupon", - "CategoryId", - "Category", - "Hour", - "Day", - "Week", - "Month", - "Year", - "Os", - "Device" - ], - "metrics": [ - "Clicks", - "Displays", - "Cpc", - "Visits" - ], - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-09-01T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Adset report" }, - "TransactionsReportQueryDataMessage": { - "required": [ - "data" - ], + "TransactionsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransactionsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/TransactionsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Transactions report", - "example": { - "data": [ - { - "type": "TransactionsReport", - "attributes": { - "advertiserIds": "123,456,789", - "eventType": "display", - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-03T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, - "TransparencyReportEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransparencyReportResource": { "type": "object", "properties": { "type": { "type": "string", - "readOnly": true + "description": "Type of the resource.", + "nullable": true }, "attributes": { - "$ref": "#/components/schemas/TransparencyReportAttributes" + "$ref": "#/components/schemas/TransparencyReport" } }, - "description": "This is the message defining the entity response for Transparency report" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "ProblemDetails": { + "PlacementsReportQueryMessageResource": { "type": "object", "properties": { - "traceId": { - "type": "string", - "description": "The request correlation ID this problem comes from.", - "nullable": true - }, - "traceIdentifier": { - "type": "string", - "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", - "nullable": true - }, "type": { - "enum": [ - "unknown", - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "The problem's category.", - "nullable": true - }, - "code": { - "type": "string", - "description": "A machine-readable error code, expressed as a string value.", - "nullable": true - }, - "instance": { - "type": "string", - "description": "A URI that identifies the specific occurrence of the problem.", - "nullable": true - }, - "title": { - "type": "string", - "description": "A short human-readable description of the problem type", - "nullable": true - }, - "detail": { "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem", - "nullable": true - }, - "source": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", + "description": "Type of the resource.", "nullable": true }, - "stackTrace": { - "type": "string", - "nullable": true - } - }, - "description": "Common problem object." - }, - "PlacementsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, "attributes": { "$ref": "#/components/schemas/PlacementsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransactionsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransactionsReportQueryMessageResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/TransactionsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransparencyReportAttributes": { + "TransparencyReport": { "required": [ "advertiserId", - "tokenValidUntil", - "files" + "files", + "tokenValidUntil" ], "type": "object", "properties": { @@ -10891,24 +11212,24 @@ "format": "date-time" }, "files": { - "uniqueItems": false, "type": "array", "items": { "$ref": "#/components/schemas/TransparencyReportFile" } } }, + "additionalProperties": false, "description": "This is the message defining the attribute response for Transparency report" }, "PlacementsReportQueryMessage": { "required": [ "advertiserIds", - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -10937,7 +11258,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -10948,14 +11268,17 @@ "AdsetName", "AdvertiserName", "CampaignId", - "CampaignName" + "CampaignName", + "AdChannel", + "SocialPlatform", + "CategoryId", + "CategoryName" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10993,14 +11316,15 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Placements report" }, "TransactionsReportQueryMessage": { "required": [ "currency", + "endDate", "format", - "startDate", - "endDate" + "startDate" ], "type": "object", "properties": { @@ -11039,6 +11363,7 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Transaction report" }, "TransparencyReportFile": { @@ -11055,6 +11380,7 @@ "type": "string" } }, + "additionalProperties": false, "description": "This is the message defining the file response for Transparency report" }, "GetPortfolioResponse": { diff --git a/api-specifications/marketingsolutions_2024-01.json b/api-specifications/marketingsolutions_2024-01.json index 60bcfcf..da45b08 100644 --- a/api-specifications/marketingsolutions_2024-01.json +++ b/api-specifications/marketingsolutions_2024-01.json @@ -1648,7 +1648,8 @@ "text/json": { } } } - } + }, + "deprecated": true }, "post": { "tags": [ @@ -1720,7 +1721,8 @@ "text/json": { } } } - } + }, + "deprecated": true } }, "/2024-01/marketing-solutions/ad-sets/search": { @@ -3869,64 +3871,77 @@ } ], "requestBody": { + "description": "The query message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "queryMessage" + } }, "responses": { "200": { "description": "Success", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" - }, - "example": { - "data": [ - { - "type": "TransparencyReport", - "attributes": { - "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", - "files": [ - { - "fileName": "report.csv", - "url": "https://www.example.com/transparency" - } - ] - } - } - ] + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" } } } @@ -3934,31 +3949,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -3966,32 +4018,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4010,26 +4098,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4038,37 +4125,31 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, - "text/csv": { + "application/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4076,46 +4157,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4123,47 +4226,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4183,25 +4307,208 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "reportQuery" + } }, "responses": { "200": { @@ -4210,37 +4517,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4248,46 +4555,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4295,47 +4642,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4354,26 +4740,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4382,37 +4767,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4420,46 +4805,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4467,47 +4892,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -10738,41 +11202,67 @@ }, "description": "Size entity containing width and height of the creative" }, - "TransparencyReportDataMessage": { - "required": [ - "data" - ], + "TransparencyReportListResponse": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransparencyReportEntityMessage" - } + "$ref": "#/components/schemas/TransparencyReportResource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Errors that occured during this call.", + "nullable": true, + "readOnly": true } }, - "description": "This is the message defining the response for Transparency report" + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several value objects." }, - "ProblemsDetails": { + "Outcome": { "type": "object", "properties": { + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, "errors": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Errors that occured during this call.", "nullable": true, "readOnly": true } }, - "description": "Common problems object" + "additionalProperties": false, + "description": "The outcome of an API call." }, "TransparencyQueryMessage": { "required": [ - "startDate", - "endDate" + "endDate", + "startDate" ], "type": "object", "properties": { @@ -10793,67 +11283,31 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Transparency report", - "example": { - "shouldDisplayProductIds": false, - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Transparency report" }, - "PlacementsReportQueryDataMessage": { - "required": [ - "data" - ], + "PlacementsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/PlacementsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/PlacementsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Placements report", - "example": { - "data": [ - { - "type": "PlacementReport", - "attributes": { - "advertiserIds": "123,456,789", - "campaignIds": "111,222,333,444", - "adsetIds": "135,246,357,468", - "environment": "web", - "placement": "MyPlacement", - "dimensions": [ - "AdsetId", - "AdvertiserId", - "Placement" - ], - "metrics": [ - "clicks", - "displays", - "cost" - ], - "currency": "EUR", - "disclosed": false, - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-08-29T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, "StatisticsReportQueryMessage": { "required": [ - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -10863,7 +11317,6 @@ "nullable": true }, "adSetIds": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10872,7 +11325,6 @@ "nullable": true }, "adSetNames": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10881,7 +11333,6 @@ "nullable": true }, "adSetStatus": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10890,7 +11341,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -10917,14 +11367,15 @@ "MarketingObjective", "ChannelId", "Channel", - "Goal" + "Goal", + "AdChannel", + "SocialPlatform" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10956,203 +11407,73 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Adset report", - "example": { - "advertiserIds": "123,456,789", - "adSetIds": [ - "12345", - "54321" - ], - "adSetNames": [ - "myAdSet1", - "myAdSet2" - ], - "adSetStatus": [ - "Active" - ], - "dimensions": [ - "CampaignId", - "Campaign", - "AdsetId", - "Adset", - "AdvertiserId", - "Advertiser", - "AdId", - "Ad", - "CouponId", - "Coupon", - "CategoryId", - "Category", - "Hour", - "Day", - "Week", - "Month", - "Year", - "Os", - "Device" - ], - "metrics": [ - "Clicks", - "Displays", - "Cpc", - "Visits" - ], - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-09-01T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Adset report" }, - "TransactionsReportQueryDataMessage": { - "required": [ - "data" - ], + "TransactionsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransactionsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/TransactionsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Transactions report", - "example": { - "data": [ - { - "type": "TransactionsReport", - "attributes": { - "advertiserIds": "123,456,789", - "eventType": "display", - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-03T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, - "TransparencyReportEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransparencyReportResource": { "type": "object", "properties": { "type": { "type": "string", - "readOnly": true + "description": "Type of the resource.", + "nullable": true }, "attributes": { - "$ref": "#/components/schemas/TransparencyReportAttributes" + "$ref": "#/components/schemas/TransparencyReport" } }, - "description": "This is the message defining the entity response for Transparency report" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "ProblemDetails": { + "PlacementsReportQueryMessageResource": { "type": "object", "properties": { - "traceId": { - "type": "string", - "description": "The request correlation ID this problem comes from.", - "nullable": true - }, - "traceIdentifier": { - "type": "string", - "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", - "nullable": true - }, "type": { - "enum": [ - "unknown", - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "The problem's category.", - "nullable": true - }, - "code": { - "type": "string", - "description": "A machine-readable error code, expressed as a string value.", - "nullable": true - }, - "instance": { - "type": "string", - "description": "A URI that identifies the specific occurrence of the problem.", - "nullable": true - }, - "title": { - "type": "string", - "description": "A short human-readable description of the problem type", - "nullable": true - }, - "detail": { "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem", - "nullable": true - }, - "source": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", + "description": "Type of the resource.", "nullable": true }, - "stackTrace": { - "type": "string", - "nullable": true - } - }, - "description": "Common problem object." - }, - "PlacementsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, "attributes": { "$ref": "#/components/schemas/PlacementsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransactionsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransactionsReportQueryMessageResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/TransactionsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransparencyReportAttributes": { + "TransparencyReport": { "required": [ "advertiserId", - "tokenValidUntil", - "files" + "files", + "tokenValidUntil" ], "type": "object", "properties": { @@ -11164,24 +11485,24 @@ "format": "date-time" }, "files": { - "uniqueItems": false, "type": "array", "items": { "$ref": "#/components/schemas/TransparencyReportFile" } } }, + "additionalProperties": false, "description": "This is the message defining the attribute response for Transparency report" }, "PlacementsReportQueryMessage": { "required": [ "advertiserIds", - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -11210,7 +11531,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -11221,14 +11541,17 @@ "AdsetName", "AdvertiserName", "CampaignId", - "CampaignName" + "CampaignName", + "AdChannel", + "SocialPlatform", + "CategoryId", + "CategoryName" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -11266,14 +11589,15 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Placements report" }, "TransactionsReportQueryMessage": { "required": [ "currency", + "endDate", "format", - "startDate", - "endDate" + "startDate" ], "type": "object", "properties": { @@ -11312,6 +11636,7 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Transaction report" }, "TransparencyReportFile": { @@ -11328,6 +11653,7 @@ "type": "string" } }, + "additionalProperties": false, "description": "This is the message defining the file response for Transparency report" }, "GetPortfolioResponse": { diff --git a/api-specifications/marketingsolutions_2024-04.json b/api-specifications/marketingsolutions_2024-04.json index ff72ebb..2a6a6cb 100644 --- a/api-specifications/marketingsolutions_2024-04.json +++ b/api-specifications/marketingsolutions_2024-04.json @@ -1648,7 +1648,8 @@ "text/json": { } } } - } + }, + "deprecated": true }, "post": { "tags": [ @@ -1720,7 +1721,8 @@ "text/json": { } } } - } + }, + "deprecated": true } }, "/2024-04/marketing-solutions/ad-sets/search": { @@ -3869,64 +3871,77 @@ } ], "requestBody": { + "description": "The query message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "queryMessage" + } }, "responses": { "200": { "description": "Success", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" - }, - "example": { - "data": [ - { - "type": "TransparencyReport", - "attributes": { - "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", - "files": [ - { - "fileName": "report.csv", - "url": "https://www.example.com/transparency" - } - ] - } - } - ] + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" } } } @@ -3934,31 +3949,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -3966,32 +4018,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4010,26 +4098,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4038,37 +4125,31 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, - "text/csv": { + "application/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4076,46 +4157,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4123,47 +4226,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4183,25 +4307,208 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "reportQuery" + } }, "responses": { "200": { @@ -4210,37 +4517,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4248,46 +4555,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4295,47 +4642,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4354,26 +4740,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4382,37 +4767,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4420,46 +4805,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4467,47 +4892,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -10738,41 +11202,67 @@ }, "description": "Size entity containing width and height of the creative" }, - "TransparencyReportDataMessage": { - "required": [ - "data" - ], + "TransparencyReportListResponse": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransparencyReportEntityMessage" - } + "$ref": "#/components/schemas/TransparencyReportResource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Errors that occured during this call.", + "nullable": true, + "readOnly": true } }, - "description": "This is the message defining the response for Transparency report" + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several value objects." }, - "ProblemsDetails": { + "Outcome": { "type": "object", "properties": { + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, "errors": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Errors that occured during this call.", "nullable": true, "readOnly": true } }, - "description": "Common problems object" + "additionalProperties": false, + "description": "The outcome of an API call." }, "TransparencyQueryMessage": { "required": [ - "startDate", - "endDate" + "endDate", + "startDate" ], "type": "object", "properties": { @@ -10793,67 +11283,31 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Transparency report", - "example": { - "shouldDisplayProductIds": false, - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Transparency report" }, - "PlacementsReportQueryDataMessage": { - "required": [ - "data" - ], + "PlacementsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/PlacementsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/PlacementsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Placements report", - "example": { - "data": [ - { - "type": "PlacementReport", - "attributes": { - "advertiserIds": "123,456,789", - "campaignIds": "111,222,333,444", - "adsetIds": "135,246,357,468", - "environment": "web", - "placement": "MyPlacement", - "dimensions": [ - "AdsetId", - "AdvertiserId", - "Placement" - ], - "metrics": [ - "clicks", - "displays", - "cost" - ], - "currency": "EUR", - "disclosed": false, - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-08-29T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, "StatisticsReportQueryMessage": { "required": [ - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -10863,7 +11317,6 @@ "nullable": true }, "adSetIds": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10872,7 +11325,6 @@ "nullable": true }, "adSetNames": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10881,7 +11333,6 @@ "nullable": true }, "adSetStatus": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10890,7 +11341,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -10917,14 +11367,15 @@ "MarketingObjective", "ChannelId", "Channel", - "Goal" + "Goal", + "AdChannel", + "SocialPlatform" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10956,203 +11407,73 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Adset report", - "example": { - "advertiserIds": "123,456,789", - "adSetIds": [ - "12345", - "54321" - ], - "adSetNames": [ - "myAdSet1", - "myAdSet2" - ], - "adSetStatus": [ - "Active" - ], - "dimensions": [ - "CampaignId", - "Campaign", - "AdsetId", - "Adset", - "AdvertiserId", - "Advertiser", - "AdId", - "Ad", - "CouponId", - "Coupon", - "CategoryId", - "Category", - "Hour", - "Day", - "Week", - "Month", - "Year", - "Os", - "Device" - ], - "metrics": [ - "Clicks", - "Displays", - "Cpc", - "Visits" - ], - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-09-01T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Adset report" }, - "TransactionsReportQueryDataMessage": { - "required": [ - "data" - ], + "TransactionsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransactionsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/TransactionsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Transactions report", - "example": { - "data": [ - { - "type": "TransactionsReport", - "attributes": { - "advertiserIds": "123,456,789", - "eventType": "display", - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-03T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, - "TransparencyReportEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransparencyReportResource": { "type": "object", "properties": { "type": { "type": "string", - "readOnly": true + "description": "Type of the resource.", + "nullable": true }, "attributes": { - "$ref": "#/components/schemas/TransparencyReportAttributes" + "$ref": "#/components/schemas/TransparencyReport" } }, - "description": "This is the message defining the entity response for Transparency report" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "ProblemDetails": { + "PlacementsReportQueryMessageResource": { "type": "object", "properties": { - "traceId": { - "type": "string", - "description": "The request correlation ID this problem comes from.", - "nullable": true - }, - "traceIdentifier": { - "type": "string", - "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", - "nullable": true - }, "type": { - "enum": [ - "unknown", - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "The problem's category.", - "nullable": true - }, - "code": { - "type": "string", - "description": "A machine-readable error code, expressed as a string value.", - "nullable": true - }, - "instance": { - "type": "string", - "description": "A URI that identifies the specific occurrence of the problem.", - "nullable": true - }, - "title": { - "type": "string", - "description": "A short human-readable description of the problem type", - "nullable": true - }, - "detail": { "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem", - "nullable": true - }, - "source": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", + "description": "Type of the resource.", "nullable": true }, - "stackTrace": { - "type": "string", - "nullable": true - } - }, - "description": "Common problem object." - }, - "PlacementsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, "attributes": { "$ref": "#/components/schemas/PlacementsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransactionsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransactionsReportQueryMessageResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/TransactionsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransparencyReportAttributes": { + "TransparencyReport": { "required": [ "advertiserId", - "tokenValidUntil", - "files" + "files", + "tokenValidUntil" ], "type": "object", "properties": { @@ -11164,24 +11485,24 @@ "format": "date-time" }, "files": { - "uniqueItems": false, "type": "array", "items": { "$ref": "#/components/schemas/TransparencyReportFile" } } }, + "additionalProperties": false, "description": "This is the message defining the attribute response for Transparency report" }, "PlacementsReportQueryMessage": { "required": [ "advertiserIds", - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -11210,7 +11531,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -11221,14 +11541,17 @@ "AdsetName", "AdvertiserName", "CampaignId", - "CampaignName" + "CampaignName", + "AdChannel", + "SocialPlatform", + "CategoryId", + "CategoryName" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -11266,14 +11589,15 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Placements report" }, "TransactionsReportQueryMessage": { "required": [ "currency", + "endDate", "format", - "startDate", - "endDate" + "startDate" ], "type": "object", "properties": { @@ -11312,6 +11636,7 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Transaction report" }, "TransparencyReportFile": { @@ -11328,6 +11653,7 @@ "type": "string" } }, + "additionalProperties": false, "description": "This is the message defining the file response for Transparency report" }, "GetPortfolioResponse": { diff --git a/api-specifications/marketingsolutions_2024-07.json b/api-specifications/marketingsolutions_2024-07.json index b5dd610..02349c2 100644 --- a/api-specifications/marketingsolutions_2024-07.json +++ b/api-specifications/marketingsolutions_2024-07.json @@ -3869,64 +3869,77 @@ } ], "requestBody": { + "description": "The query message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "queryMessage" + } }, "responses": { "200": { "description": "Success", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" - }, - "example": { - "data": [ - { - "type": "TransparencyReport", - "attributes": { - "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", - "files": [ - { - "fileName": "report.csv", - "url": "https://www.example.com/transparency" - } - ] - } - } - ] + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" } } } @@ -3934,31 +3947,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -3966,32 +4016,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4010,26 +4096,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4038,37 +4123,31 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, - "text/csv": { + "application/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4076,46 +4155,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4123,47 +4224,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4183,25 +4305,208 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "reportQuery" + } }, "responses": { "200": { @@ -4210,37 +4515,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4248,46 +4553,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4295,47 +4640,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4354,26 +4738,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4382,37 +4765,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4420,46 +4803,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4467,47 +4890,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -10430,41 +10892,67 @@ }, "description": "Size entity containing width and height of the creative" }, - "TransparencyReportDataMessage": { - "required": [ - "data" - ], + "TransparencyReportListResponse": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransparencyReportEntityMessage" - } + "$ref": "#/components/schemas/TransparencyReportResource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Errors that occured during this call.", + "nullable": true, + "readOnly": true } }, - "description": "This is the message defining the response for Transparency report" + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several value objects." }, - "ProblemsDetails": { + "Outcome": { "type": "object", "properties": { + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, "errors": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Errors that occured during this call.", "nullable": true, "readOnly": true } }, - "description": "Common problems object" + "additionalProperties": false, + "description": "The outcome of an API call." }, "TransparencyQueryMessage": { "required": [ - "startDate", - "endDate" + "endDate", + "startDate" ], "type": "object", "properties": { @@ -10485,67 +10973,31 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Transparency report", - "example": { - "shouldDisplayProductIds": false, - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Transparency report" }, - "PlacementsReportQueryDataMessage": { - "required": [ - "data" - ], + "PlacementsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/PlacementsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/PlacementsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Placements report", - "example": { - "data": [ - { - "type": "PlacementReport", - "attributes": { - "advertiserIds": "123,456,789", - "campaignIds": "111,222,333,444", - "adsetIds": "135,246,357,468", - "environment": "web", - "placement": "MyPlacement", - "dimensions": [ - "AdsetId", - "AdvertiserId", - "Placement" - ], - "metrics": [ - "clicks", - "displays", - "cost" - ], - "currency": "EUR", - "disclosed": false, - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-08-29T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, "StatisticsReportQueryMessage": { "required": [ - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -10555,7 +11007,6 @@ "nullable": true }, "adSetIds": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10564,7 +11015,6 @@ "nullable": true }, "adSetNames": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10573,7 +11023,6 @@ "nullable": true }, "adSetStatus": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10582,7 +11031,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -10609,14 +11057,15 @@ "MarketingObjective", "ChannelId", "Channel", - "Goal" + "Goal", + "AdChannel", + "SocialPlatform" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10648,203 +11097,73 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Adset report", - "example": { - "advertiserIds": "123,456,789", - "adSetIds": [ - "12345", - "54321" - ], - "adSetNames": [ - "myAdSet1", - "myAdSet2" - ], - "adSetStatus": [ - "Active" - ], - "dimensions": [ - "CampaignId", - "Campaign", - "AdsetId", - "Adset", - "AdvertiserId", - "Advertiser", - "AdId", - "Ad", - "CouponId", - "Coupon", - "CategoryId", - "Category", - "Hour", - "Day", - "Week", - "Month", - "Year", - "Os", - "Device" - ], - "metrics": [ - "Clicks", - "Displays", - "Cpc", - "Visits" - ], - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-09-01T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Adset report" }, - "TransactionsReportQueryDataMessage": { - "required": [ - "data" - ], + "TransactionsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransactionsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/TransactionsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Transactions report", - "example": { - "data": [ - { - "type": "TransactionsReport", - "attributes": { - "advertiserIds": "123,456,789", - "eventType": "display", - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-03T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, - "TransparencyReportEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransparencyReportResource": { "type": "object", "properties": { "type": { "type": "string", - "readOnly": true + "description": "Type of the resource.", + "nullable": true }, "attributes": { - "$ref": "#/components/schemas/TransparencyReportAttributes" + "$ref": "#/components/schemas/TransparencyReport" } }, - "description": "This is the message defining the entity response for Transparency report" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "ProblemDetails": { + "PlacementsReportQueryMessageResource": { "type": "object", "properties": { - "traceId": { - "type": "string", - "description": "The request correlation ID this problem comes from.", - "nullable": true - }, - "traceIdentifier": { - "type": "string", - "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", - "nullable": true - }, "type": { - "enum": [ - "unknown", - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "The problem's category.", - "nullable": true - }, - "code": { - "type": "string", - "description": "A machine-readable error code, expressed as a string value.", - "nullable": true - }, - "instance": { - "type": "string", - "description": "A URI that identifies the specific occurrence of the problem.", - "nullable": true - }, - "title": { - "type": "string", - "description": "A short human-readable description of the problem type", - "nullable": true - }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem", - "nullable": true - }, - "source": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", - "nullable": true - }, - "stackTrace": { "type": "string", + "description": "Type of the resource.", "nullable": true - } - }, - "description": "Common problem object." - }, - "PlacementsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" }, "attributes": { "$ref": "#/components/schemas/PlacementsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransactionsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransactionsReportQueryMessageResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/TransactionsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransparencyReportAttributes": { + "TransparencyReport": { "required": [ "advertiserId", - "tokenValidUntil", - "files" + "files", + "tokenValidUntil" ], "type": "object", "properties": { @@ -10856,24 +11175,24 @@ "format": "date-time" }, "files": { - "uniqueItems": false, "type": "array", "items": { "$ref": "#/components/schemas/TransparencyReportFile" } } }, + "additionalProperties": false, "description": "This is the message defining the attribute response for Transparency report" }, "PlacementsReportQueryMessage": { "required": [ "advertiserIds", - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -10902,7 +11221,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -10913,14 +11231,17 @@ "AdsetName", "AdvertiserName", "CampaignId", - "CampaignName" + "CampaignName", + "AdChannel", + "SocialPlatform", + "CategoryId", + "CategoryName" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -10958,14 +11279,15 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Placements report" }, "TransactionsReportQueryMessage": { "required": [ "currency", + "endDate", "format", - "startDate", - "endDate" + "startDate" ], "type": "object", "properties": { @@ -11004,6 +11326,7 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Transaction report" }, "TransparencyReportFile": { @@ -11020,6 +11343,7 @@ "type": "string" } }, + "additionalProperties": false, "description": "This is the message defining the file response for Transparency report" }, "GetPortfolioResponse": { diff --git a/api-specifications/marketingsolutions_preview.json b/api-specifications/marketingsolutions_preview.json index 019af53..aadaf2d 100644 --- a/api-specifications/marketingsolutions_preview.json +++ b/api-specifications/marketingsolutions_preview.json @@ -3,7 +3,7 @@ "info": { "title": "Criteo API", "description": "Criteo API - MarketingSolutions", - "version": "Preview" + "version": "preview" }, "servers": [ { @@ -3923,26 +3923,40 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GenerateCategoriesReportRequest" + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GenerateCategoriesReportRequest" + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GenerateCategoriesReportRequest" + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GenerateCategoriesReportRequest" + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesRequest" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesRequest" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesRequest" + } + }, + "application/*+xml": { + "schema": { + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -3951,37 +3965,31 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, - "text/csv": { + "application/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "type": "string", - "format": "binary" + "format": "byte" } } } @@ -3989,49 +3997,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4039,49 +4066,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4110,64 +4156,77 @@ } ], "requestBody": { + "description": "The query message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TransparencyQueryMessage" + }, + "example": { + "shouldDisplayProductIds": false, + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "queryMessage" + } }, "responses": { "200": { "description": "Success", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" - }, - "example": { - "data": [ - { - "type": "TransparencyReport", - "attributes": { - "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", - "files": [ - { - "fileName": "report.csv", - "url": "https://www.example.com/transparency" - } - ] - } - } - ] + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransparencyReportDataMessage" + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/TransparencyReportListResponse" } } } @@ -4175,31 +4234,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4207,32 +4303,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4251,26 +4383,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/PlacementsReportQueryDataMessage" + "$ref": "#/components/schemas/PlacementsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4279,37 +4410,31 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, - "text/csv": { + "application/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "type": "string", - "format": "binary" + "format": "byte" } } } @@ -4317,46 +4442,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/csv": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4364,47 +4511,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } }, - "text/xml": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { + "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4412,55 +4580,79 @@ } } }, - "/preview/reports/async-audience-performance": { + "/preview/reports/creatives": { "post": { "tags": [ "Analytics" ], - "description": "This Statistics endpoint provides an export Id that lets you retrieve data.", - "operationId": "GetAsyncAudienceReport", + "description": "With Creatives endpoint, you can analyse the daily performances of your creatives on the main metrics: clicks, ctr, displays.", + "operationId": "GetCreativesReport", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesRequest" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesRequest" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesRequest" + } + }, + "application/*+xml": { + "schema": { + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { - "202": { + "200": { "description": "Success", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + "$ref": "#/components/schemas/JsonReportRowsListResponse" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + "$ref": "#/components/schemas/JsonReportRowsListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + "$ref": "#/components/schemas/JsonReportRowsListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/JsonReportRowsListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/JsonReportRowsListResponse" } } } @@ -4468,195 +4660,137 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, - "text/json": { + "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } - } - } - } - }, - "/preview/reports/async-statistics": { - "post": { - "tags": [ - "Analytics" - ], - "description": "This Statistics endpoint provides an export Id that let you retrieve data.", - "operationId": "GetAsyncAdsetReport", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GenerateStatisticsReportRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateStatisticsReportRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GenerateStatisticsReportRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GenerateStatisticsReportRequest" - } - } }, - "x-bodyName": "dataMessage" - }, - "responses": { - "202": { - "description": "Success", + "403": { + "description": "Forbidden", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, - "text/json": { + "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -4664,37 +4798,51 @@ } } }, - "/preview/reports/creatives": { + "/preview/reports/top-products": { "post": { "tags": [ "Analytics" ], - "description": "With Creatives endpoint, you can analyse the daily performances of your creatives on the main metrics: clicks, ctr, displays.", - "operationId": "GetCreativesReport", + "description": "With the topProducts endpoint, you can analyse the performances for each publisher, by top displays, top clicks or top sales.", + "operationId": "GetTopProductsReport", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/GenerateCreativesReportRequest" + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/GenerateCreativesReportRequest" + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GenerateCreativesReportRequest" + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/GenerateCreativesReportRequest" + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesRequest" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesRequest" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesRequest" + } + }, + "application/*+xml": { + "schema": { + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -4702,17 +4850,27 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/ReportDataMessage" + "$ref": "#/components/schemas/JsonReportRowsListResponse" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ReportDataMessage" + "$ref": "#/components/schemas/JsonReportRowsListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ReportDataMessage" + "$ref": "#/components/schemas/JsonReportRowsListResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/JsonReportRowsListResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/JsonReportRowsListResponse" } } } @@ -4720,34 +4878,68 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -4755,246 +4947,68 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - } - } - } - } - } - }, - "/preview/reports/top-products": { - "post": { - "tags": [ - "Analytics" - ], - "description": "With the topProducts endpoint, you can analyse the performances for each publisher, by top displays, top clicks or top sales.", - "operationId": "GetTopProductsReport", - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/GenerateTopProductsReportRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateTopProductsReportRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GenerateTopProductsReportRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/GenerateTopProductsReportRequest" - } - } - }, - "x-bodyName": "dataMessage" - }, - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ReportDataMessage" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportDataMessage" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ReportDataMessage" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - }, - "example": { - "errors": [ - { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", - "type": "validation", - "code": "required-field", - "instance": "", - "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" - } - ] - } - }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "1234e1717d88aa8a", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", - "instance": "", + "instance": "/report", "title": "Start date and end date are required.", - "detail": "", - "source": { }, - "stackTrace": "" + "detail": "" } ] } }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } - } - } - } - } - } - }, - "/preview/reports/{report-id}/output": { - "get": { - "tags": [ - "Analytics" - ], - "description": "This endpoint gives you the output of the report.", - "operationId": "GetAsyncExportOutput", - "parameters": [ - { - "name": "report-id", - "in": "path", - "description": "Id of the report", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ExportResult" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResult" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ExportResult" - } - } - } - } - } - } - }, - "/preview/reports/{report-id}/status": { - "get": { - "tags": [ - "Analytics" - ], - "description": "This endpoint gives you the status of the report.", - "operationId": "GetAsyncExportStatus", - "parameters": [ - { - "name": "report-id", - "in": "path", - "description": "Id of the report", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" - } - }, - "application/json": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + "$ref": "#/components/schemas/Outcome" } }, - "text/json": { + "text/xml": { "schema": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + "$ref": "#/components/schemas/Outcome" } } } @@ -5014,25 +5028,208 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatisticsReportQueryMessage" + }, + "example": { + "advertiserIds": "123,456,789", + "adSetIds": [ + "12345", + "54321" + ], + "adSetNames": [ + "myAdSet1", + "myAdSet2" + ], + "adSetStatus": [ + "Active" + ], + "dimensions": [ + "CampaignId", + "Campaign", + "AdsetId", + "Adset", + "AdvertiserId", + "Advertiser", + "AdId", + "Ad", + "CouponId", + "Coupon", + "CategoryId", + "Category", + "Hour", + "Day", + "Week", + "Month", + "Year", + "Os", + "Device" + ], + "metrics": [ + "Clicks", + "Displays", + "Cpc", + "Visits" + ], + "currency": "EUR", + "format": "csv", + "timezone": "Europe/Paris", + "startDate": "2024-04-24T00:00:00.0000000+02:00", + "endDate": "2024-04-27T00:00:00.0000000+02:00" } } - }, - "x-bodyName": "reportQuery" + } }, "responses": { "200": { @@ -5041,37 +5238,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -5079,46 +5276,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" - } + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -5126,47 +5363,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -5185,26 +5461,25 @@ "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/TransactionsReportQueryDataMessage" + "$ref": "#/components/schemas/TransactionsReportQueryMessageListRequest" } } - }, - "x-bodyName": "dataMessage" + } }, "responses": { "200": { @@ -5213,37 +5488,37 @@ "text/plain": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/json": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/csv": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "text/xml": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", - "format": "binary" + "format": "byte" } } } @@ -5251,46 +5526,86 @@ "400": { "description": "Bad Request", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", "type": "validation", "code": "required-field", "instance": "/report", - "title": "Start date and end date are required." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -5298,47 +5613,86 @@ "403": { "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "b7888125-dddb-c94e-9240-eb930c4ea146", - "traceIdentifier": "1234e1717d88aa8a", - "type": "access-control", - "code": "insufficient-advertiser-permission", + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", "instance": "/report", - "title": "Insufficient advertiser permission.", - "detail": "You do not have the rights to report on this advertiser." + "title": "Start date and end date are required.", + "detail": "" } ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "905125ba2e35bd81e02ea712e4a05e2d", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/xml": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { - "$ref": "#/components/schemas/ProblemsDetails" + "$ref": "#/components/schemas/Outcome" } } } @@ -5346,339 +5700,454 @@ } } }, - "/preview/marketing-solutions/ad-sets/targeting/supply-vendors": { - "get": { + "/preview/reports/async-audience-performance": { + "post": { "tags": [ - "Campaign" + "Analytics" ], - "description": "Fetch the list of available supply vendors for any Ad Set targetings", - "operationId": "GetSupplyVendorList", + "description": "This Statistics endpoint provides an export Id that lets you retrieve data.", + "operationId": "GetAsyncAudienceReport", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + } + }, + "application/*+xml": { + "schema": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequest" + } + } + } + }, "responses": { - "200": { - "description": "the errors/warnings if any", + "202": { + "description": "Success", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/SupplyVendorListResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SupplyVendorListResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SupplyVendorListResponse" - } - } - } - }, - "401": { - "description": "The API client is not properly authenticated.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "403": { - "description": "The API client is not authorized to access this resource or the resource does not exist.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - } - } - } - }, - "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids": { - "get": { - "tags": [ - "Campaign" - ], - "description": "Get the Deal Id Targeting configuration for the ad set whose id is specified", - "operationId": "GetAdSetTargetingDealIds", - "parameters": [ - { - "name": "ad-set-id", - "in": "path", - "description": "Id of the Ad Set", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "the Deal Id Targeting configuration", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, - "application/json": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, - "text/json": { + "text/xml": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } } } }, - "401": { - "description": "The API client is not properly authenticated.", + "400": { + "description": "Bad Request", "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } } }, "403": { - "description": "The API client is not authorized to access this resource or the resource does not exist.", + "description": "Forbidden", "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } } } } - }, - "put": { + } + }, + "/preview/reports/async-statistics": { + "post": { "tags": [ - "Campaign" - ], - "description": "Set the Deal Id Targeting configuration for the ad set whose id is specified", - "operationId": "SetAdSetTargetingDealIds", - "parameters": [ - { - "name": "ad-set-id", - "in": "path", - "description": "Id of the Ad Set", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } + "Analytics" ], + "description": "This Statistics endpoint provides an export Id that let you retrieve data.", + "operationId": "GetAsyncAdsetReport", "requestBody": { - "description": "the new Deal Id Targeting configuration", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + "$ref": "#/components/schemas/GenerateStatisticsReportRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + "$ref": "#/components/schemas/GenerateStatisticsReportRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + "$ref": "#/components/schemas/GenerateStatisticsReportRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + "$ref": "#/components/schemas/GenerateStatisticsReportRequest" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateStatisticsReportRequest" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/GenerateStatisticsReportRequest" + } + }, + "application/*+xml": { + "schema": { + "$ref": "#/components/schemas/GenerateStatisticsReportRequest" } } - }, - "x-bodyName": "adSetDealIdTargetings" + } }, "responses": { - "200": { - "description": "the errors/warnings if any", + "202": { + "description": "Success", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsSetResultResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsSetResultResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsSetResultResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } } } }, "400": { "description": "Bad Request", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "401": { - "description": "The API client is not properly authenticated.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "403": { - "description": "The API client is not authorized to access this resource or the resource does not exist.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - } - } - } - }, - "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids/disable": { - "post": { - "tags": [ - "Campaign" - ], - "description": "Disable the Deal Id Targeting configuration for the ad set whose id is specified", - "operationId": "DisableAdSetTargetingDealIds", - "parameters": [ - { - "name": "ad-set-id", - "in": "path", - "description": "Id of the Ad Set", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "the errors/warnings if any", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsDisableResultResponse" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsDisableResultResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/AdSetTargetingDealIdsDisableResultResponse" - } - } - } - }, - "401": { - "description": "The API client is not properly authenticated.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } } }, "403": { - "description": "The API client is not authorized to access this resource or the resource does not exist.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - } - } - } - }, - "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positioning": { - "get": { - "tags": [ - "Campaign" - ], - "description": "Get the Video Positioning Targeting configuration for the ad set whose id is specified", - "operationId": "GetAdSetTargetingVideoPositioning", - "parameters": [ - { - "name": "ad-set-id", - "in": "path", - "description": "Id of the Ad Set", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "the Video Positioning Targeting configuration", + "description": "Forbidden", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningResponse" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningResponse" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningResponse" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "401": { - "description": "The API client is not properly authenticated.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "403": { - "description": "The API client is not authorized to access this resource or the resource does not exist.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } } } - }, - "put": { + } + }, + "/preview/reports/{report-id}/output": { + "get": { "tags": [ - "Campaign" + "Analytics" ], - "description": "Set the Video Positioning Targeting configuration for the ad set whose id is specified", - "operationId": "SetAdSetTargetingVideoPositioning", + "description": "This endpoint gives you the output of the report.", + "operationId": "GetAsyncExportOutput", "parameters": [ { - "name": "ad-set-id", + "name": "report-id", "in": "path", - "description": "Id of the Ad Set", + "description": "Id of the report", "required": true, "style": "simple", "schema": { @@ -5686,92 +6155,42 @@ } } ], - "requestBody": { - "description": "the new Video Positioning Targeting configuration", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" - } - } - }, - "x-bodyName": "adSetTargetingVideoPositioning" - }, "responses": { "200": { - "description": "the errors/warnings if any", + "description": "Success", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningSetResultResponse" + "$ref": "#/components/schemas/ExportResult" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningSetResultResponse" + "$ref": "#/components/schemas/ExportResult" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningSetResultResponse" + "$ref": "#/components/schemas/ExportResult" } } } - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "401": { - "description": "The API client is not properly authenticated.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "403": { - "description": "The API client is not authorized to access this resource or the resource does not exist.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } } } } }, - "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positionings/disable": { - "post": { + "/preview/reports/{report-id}/status": { + "get": { "tags": [ - "Campaign" + "Analytics" ], - "description": "Disable the Video Positioning Targeting configuration for the ad set whose id is specified", - "operationId": "DisableAdSetTargetingVideoPositioning", + "description": "This endpoint gives you the status of the report.", + "operationId": "GetAsyncExportStatus", "parameters": [ { - "name": "ad-set-id", + "name": "report-id", "in": "path", - "description": "Id of the Ad Set", + "description": "Id of the report", "required": true, "style": "simple", "schema": { @@ -5781,21 +6200,31 @@ ], "responses": { "200": { - "description": "the errors/warnings if any", + "description": "Success", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningDisableResultResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningDisableResultResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AdSetTargetingVideoPositioningDisableResultResponse" + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResponse" } } } @@ -5803,185 +6232,137 @@ "400": { "description": "Bad Request", "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "401": { - "description": "The API client is not properly authenticated.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - }, - "403": { - "description": "The API client is not authorized to access this resource or the resource does not exist.", - "content": { - "text/plain": { }, - "application/json": { }, - "text/json": { } - } - } - } - } - }, - "/preview/advertisers": { - "post": { - "tags": [ - "Advertiser" - ], - "description": "Create a new advertiser based on provided parameters. This could take up to 30 seconds.", - "operationId": "createAdvertiser", - "requestBody": { - "description": "", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/AdvertiserCreationRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdvertiserCreationRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/AdvertiserCreationRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/AdvertiserCreationRequest" - } - } - }, - "required": true, - "x-bodyName": "advertiserCreation" - }, - "responses": { - "201": { - "description": "Success", - "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" }, "example": { - "data": { - "type": "advertiser", - "id": "73550" - }, - "errors": [ ], - "warnings": [ ] + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "cb381a21702b247f", + "traceId": "4823b9b572a6c770bde30f943f68046b", "type": "validation", - "code": "invalid", - "title": "Failed to create Advertiser", - "detail": "Failed to create Advertiser" + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" } - ], - "warnings": [ ] + ] } }, - "text/plain": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" } }, - "text/json": { + "text/xml": { "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" } } } }, - "401": { - "description": "Unauthorized", + "403": { + "description": "Forbidden", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/UnauthorizedResponseV2" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "cb381a21702b247f", - "type": "authentication", - "code": "invalid", - "title": "Permission Denied; This endpoint expects a user token", - "detail": "Permission Denied; This endpoint expects a user token" + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" } - ], - "warnings": [ ] + ] } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/UnauthorizedResponseV2" + "$ref": "#/components/schemas/Outcome" + }, + "example": { + "warnings": [ ], + "errors": [ + { + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" + } + ] } }, "text/json": { "schema": { - "$ref": "#/components/schemas/UnauthorizedResponseV2" - } - } - } - }, - "500": { - "description": "Server Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" }, "example": { + "warnings": [ ], "errors": [ { - "traceId": "cb381a21702b247f", - "type": "availability", - "code": "internal-error", - "title": "Internal Server Error", - "detail": "Internal Server Error" + "traceId": "4823b9b572a6c770bde30f943f68046b", + "type": "validation", + "code": "required-field", + "instance": "/report", + "title": "Start date and end date are required.", + "detail": "" } - ], - "warnings": [ ] + ] } }, - "text/plain": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" } }, - "text/json": { + "text/xml": { "schema": { - "$ref": "#/components/schemas/AdvertiserCreationResponse" + "$ref": "#/components/schemas/Outcome" } } } @@ -5989,96 +6370,65 @@ } } }, - "/preview/advertisers/me": { + "/preview/marketing-solutions/ad-sets/targeting/supply-vendors": { "get": { "tags": [ - "Advertiser" + "Campaign" ], - "description": "Fetch the portfolio of Advertisers for this account", - "operationId": "ApiPortfolioGet", + "description": "Fetch the list of available supply vendors for any Ad Set targetings", + "operationId": "GetSupplyVendorList", "responses": { "200": { - "description": "Success", + "description": "the errors/warnings if any", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/GetPortfolioResponse" - }, - "example": { - "data": [ - { - "type": "advertiser", - "id": "13", - "attributes": { - "advertiserName": "ClientName1" - } - }, - { - "type": "advertiser", - "id": "1352", - "attributes": { - "advertiserName": "ClientName2" - } - }, - { - "type": "advertiser", - "id": "73550", - "attributes": { - "advertiserName": "ClientName3" - } - } - ], - "errors": [ ], - "warnings": [ ] + "$ref": "#/components/schemas/SupplyVendorListResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/GetPortfolioResponse" + "$ref": "#/components/schemas/SupplyVendorListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/GetPortfolioResponse" + "$ref": "#/components/schemas/SupplyVendorListResponse" } } } }, "401": { - "description": "Unauthorized", + "description": "The API client is not properly authenticated.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/GetPortfolioResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetPortfolioResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/GetPortfolioResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } + } + }, + "403": { + "description": "The API client is not authorized to access this resource or the resource does not exist.", + "content": { + "text/plain": { }, + "application/json": { }, + "text/json": { } } } } } }, - "/preview/advertisers/{advertiser-id}/datasets": { + "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids": { "get": { "tags": [ - "Advertiser" + "Campaign" ], - "description": "Retrieves corresponding Datasets for a given Advertiser. Only those Datasets are included for which the given Advertiser is marked a primary.", - "operationId": "getDatasetList", + "description": "Get the Deal Id Targeting configuration for the ad set whose id is specified", + "operationId": "GetAdSetTargetingDealIds", "parameters": [ { - "name": "advertiser-id", + "name": "ad-set-id", "in": "path", - "description": "The id of the Advertiser for which Datasets are being retrieved.", + "description": "Id of the Ad Set", "required": true, "style": "simple", "schema": { @@ -6088,345 +6438,364 @@ ], "responses": { "200": { - "description": "Success", + "description": "the Deal Id Targeting configuration", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/AdvertiserDatasetListResponse" - }, - "example": { - "data": [ - { - "type": "dataset", - "id": "73550", - "attributes": { - "name": "Dataset 1" - } - } - ], - "errors": [ ], - "warnings": [ ] + "$ref": "#/components/schemas/AdSetTargetingDealIdsResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + "$ref": "#/components/schemas/AdSetTargetingDealIdsResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + "$ref": "#/components/schemas/AdSetTargetingDealIdsResponse" } } } }, + "401": { + "description": "The API client is not properly authenticated.", + "content": { + "text/plain": { }, + "application/json": { }, + "text/json": { } + } + }, "403": { - "description": "Forbidden", + "description": "The API client is not authorized to access this resource or the resource does not exist.", "content": { - "application/json": { + "text/plain": { }, + "application/json": { }, + "text/json": { } + } + } + } + }, + "put": { + "tags": [ + "Campaign" + ], + "description": "Set the Deal Id Targeting configuration for the ad set whose id is specified", + "operationId": "SetAdSetTargetingDealIds", + "parameters": [ + { + "name": "ad-set-id", + "in": "path", + "description": "Id of the Ad Set", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "the new Deal Id Targeting configuration", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SetAdSetTargetingDealIdsRequest" + } + } + }, + "x-bodyName": "adSetDealIdTargetings" + }, + "responses": { + "200": { + "description": "the errors/warnings if any", + "content": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/AdvertiserDatasetListResponse" - }, - "example": { - "data": [ ], - "errors": [ - { - "traceId": "cb381a21702b247f", - "type": "authorization", - "code": "permission-denied", - "title": "Permission denied, you do not have access this to resource", - "detail": "Permission denied, you do not have access this to resource" - } - ], - "warnings": [ ] + "$ref": "#/components/schemas/AdSetTargetingDealIdsSetResultResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + "$ref": "#/components/schemas/AdSetTargetingDealIdsSetResultResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + "$ref": "#/components/schemas/AdSetTargetingDealIdsSetResultResponse" } } } }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { }, + "application/json": { }, + "text/json": { } + } + }, "401": { - "description": "Unauthorized", + "description": "The API client is not properly authenticated.", + "content": { + "text/plain": { }, + "application/json": { }, + "text/json": { } + } + }, + "403": { + "description": "The API client is not authorized to access this resource or the resource does not exist.", "content": { - "application/json": { - "example": { - "errors": [ - { - "traceId": "cb381a21702b247f", - "type": "authentication", - "code": "invalid", - "title": "Permission Denied; This endpoint expects a user token", - "detail": "Permission Denied; This endpoint expects a user token" - } - ], - "warnings": [ ] - } - }, "text/plain": { }, + "application/json": { }, "text/json": { } } } } } }, - "/preview/industries": { - "get": { + "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids/disable": { + "post": { "tags": [ - "Advertiser" + "Campaign" + ], + "description": "Disable the Deal Id Targeting configuration for the ad set whose id is specified", + "operationId": "DisableAdSetTargetingDealIds", + "parameters": [ + { + "name": "ad-set-id", + "in": "path", + "description": "Id of the Ad Set", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } ], - "description": "Returns the list of available industries for new advertisers.", - "operationId": "listIndustries", "responses": { "200": { - "description": "Success", + "description": "the errors/warnings if any", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ListAvailableIndustriesResponse" - }, - "example": { - "data": [ - { - "type": "industry", - "id": "13" - }, - { - "type": "industry", - "id": "1352" - }, - { - "type": "industry", - "id": "73550" - } - ], - "errors": [ ], - "warnings": [ ] + "$ref": "#/components/schemas/AdSetTargetingDealIdsDisableResultResponse" } }, - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ListAvailableIndustriesResponse" + "$ref": "#/components/schemas/AdSetTargetingDealIdsDisableResultResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ListAvailableIndustriesResponse" + "$ref": "#/components/schemas/AdSetTargetingDealIdsDisableResultResponse" } } } + }, + "401": { + "description": "The API client is not properly authenticated.", + "content": { + "text/plain": { }, + "application/json": { }, + "text/json": { } + } + }, + "403": { + "description": "The API client is not authorized to access this resource or the resource does not exist.", + "content": { + "text/plain": { }, + "application/json": { }, + "text/json": { } + } } } } }, - "/preview/catalog/stats/merchants/{merchant-id}": { + "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positioning": { "get": { "tags": [ - "Catalog" + "Campaign" ], - "description": "get an stats request", + "description": "Get the Video Positioning Targeting configuration for the ad set whose id is specified", + "operationId": "GetAdSetTargetingVideoPositioning", "parameters": [ { - "name": "merchant-id", + "name": "ad-set-id", "in": "path", - "description": "merchant-id to get", + "description": "Id of the Ad Set", "required": true, "style": "simple", "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "lastNumHours", - "in": "query", - "description": "the last number of hours", - "style": "form", - "schema": { - "type": "integer", - "format": "int32" + "type": "string" } } ], "responses": { - "503": { - "description": "Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")]", + "200": { + "description": "the Video Positioning Targeting configuration", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningResponse" } - } - } - }, - "401": { - "description": "Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")]", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningResponse" } - } - } - }, - "403": { - "description": "Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")]", - "content": { - "application/json": { + }, + "text/json": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningResponse" } } } }, - "500": { - "description": "Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")]", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } }, - "429": { - "description": "Too Many Requests. Allowed error types and errors: [(type=\"availability\", code=\"too-many-requests\")]", + "401": { + "description": "The API client is not properly authenticated.", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } }, - "200": { - "description": "The successful response of GET stats request", + "403": { + "description": "The API client is not authorized to access this resource or the resource does not exist.", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StatisticsOkResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } } } - } - }, - "/preview/catalog/products/batch": { - "post": { + }, + "put": { "tags": [ - "Catalog" + "Campaign" + ], + "description": "Set the Video Positioning Targeting configuration for the ad set whose id is specified", + "operationId": "SetAdSetTargetingVideoPositioning", + "parameters": [ + { + "name": "ad-set-id", + "in": "path", + "description": "Id of the Ad Set", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } ], - "description": "Used to publish a batch of operations to insert, update and deletes products.\n The batch is processed asynchronously.The response provides an operationToken which can be used to track\n the status of the report of the operation.", "requestBody": { + "description": "the new Video Positioning Targeting configuration", "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductsCustomBatchRequest" + "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SetAdSetTargetingVideoPositioningRequest" } } }, - "required": true, - "x-bodyName": "body" + "x-bodyName": "adSetTargetingVideoPositioning" }, "responses": { - "202": { - "description": "Batch accepted. The status of the operation can be tracked using the report endpoint and the operationToken.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BatchAcceptedResponse" - } - } - } - }, - "400": { - "description": "Bad Request. Allowed error types and errors: [(type=\"validation\", code=\"required-field\"),(type=\"validation\", code=\"required-field\"),(type=\"validation\", code=\"json-format\")]", + "200": { + "description": "the errors/warnings if any", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningSetResultResponse" } - } - } - }, - "401": { - "description": "Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")]", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningSetResultResponse" } - } - } - }, - "403": { - "description": "Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")]", - "content": { - "application/json": { + }, + "text/json": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningSetResultResponse" } } } }, - "413": { - "description": "Request too large. By default, payload up to 16 MB is rejected.", - "content": { - "application/json": { } - } - }, - "429": { - "description": "Too Many Requests. Allowed error types and errors: [(type=\"availability\", code=\"too-many-requests\")]", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } }, - "500": { - "description": "Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")]", + "401": { + "description": "The API client is not properly authenticated.", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } }, - "503": { - "description": "Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")]", + "403": { + "description": "The API client is not authorized to access this resource or the resource does not exist.", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } } } } }, - "/preview/catalog/products/batch/report/{operation-token}": { - "get": { + "/preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positionings/disable": { + "post": { "tags": [ - "Catalog" + "Campaign" ], - "description": "Get the report of an asynchronous batch operation previously requested", + "description": "Disable the Video Positioning Targeting configuration for the ad set whose id is specified", + "operationId": "DisableAdSetTargetingVideoPositioning", "parameters": [ { - "name": "operation-token", + "name": "ad-set-id", "in": "path", - "description": "The token returned by the batch endpoint.", + "description": "Id of the Ad Set", "required": true, "style": "simple", "schema": { @@ -6436,217 +6805,304 @@ ], "responses": { "200": { - "description": "The report object", + "description": "the errors/warnings if any", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ReportOkResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningDisableResultResponse" } - } - } - }, - "400": { - "description": "Bad Request. Allowed error types and errors: [(type=\"validation\", code=\"catalog-operation-token-is-malformed\"),(type=\"validation\", code=\"catalog-operation-report-is-expired\")]", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningDisableResultResponse" } - } - } - }, - "401": { - "description": "Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")]", - "content": { - "application/json": { + }, + "text/json": { "schema": { - "$ref": "#/components/schemas/FailResponse" + "$ref": "#/components/schemas/AdSetTargetingVideoPositioningDisableResultResponse" } } } }, - "403": { - "description": "Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")]", + "400": { + "description": "Bad Request", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } }, - "404": { - "description": "Not Found. Allowed error types and errors: [(type=\"validation\", code=\"catalog-operation-not-found\")]", + "401": { + "description": "The API client is not properly authenticated.", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } }, - "429": { - "description": "Too Many Requests", + "403": { + "description": "The API client is not authorized to access this resource or the resource does not exist.", "content": { - "application/json": { } - } - }, - "500": { - "description": "Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")]", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } - } - }, - "503": { - "description": "Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")]", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FailResponse" - } - } + "text/plain": { }, + "application/json": { }, + "text/json": { } } } } } }, - "/preview/ads/{ad-id}/product-filter": { - "delete": { + "/preview/advertisers": { + "post": { "tags": [ - "Reco" + "Advertiser" ], - "description": "Disable product filtering for a given ad", - "operationId": "DisableProductFiltering", - "parameters": [ - { - "name": "ad-id", - "in": "path", - "description": "ID of the ad", - "required": true, - "style": "simple", - "schema": { - "type": "string" + "description": "Create a new advertiser based on provided parameters. This could take up to 30 seconds.", + "operationId": "createAdvertiser", + "requestBody": { + "description": "", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserCreationRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserCreationRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserCreationRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserCreationRequest" + } } - } - ], + }, + "required": true, + "x-bodyName": "advertiserCreation" + }, "responses": { - "200": { - "description": "Successful operation", + "201": { + "description": "Success", "content": { - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" + "$ref": "#/components/schemas/AdvertiserCreationResponse" + }, + "example": { + "data": { + "type": "advertiser", + "id": "73550" + }, + "errors": [ ], + "warnings": [ ] } }, - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" + "$ref": "#/components/schemas/AdvertiserCreationResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" + "$ref": "#/components/schemas/AdvertiserCreationResponse" } } } }, "400": { - "description": "Operation failure", + "description": "Bad Request", "content": { - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserCreationResponse" + }, + "example": { + "errors": [ + { + "traceId": "cb381a21702b247f", + "type": "validation", + "code": "invalid", + "title": "Failed to create Advertiser", + "detail": "Failed to create Advertiser" + } + ], + "warnings": [ ] } }, - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserCreationResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserCreationResponse" } } } }, - "403": { - "description": "Operation failure", + "401": { + "description": "Unauthorized", "content": { - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/UnauthorizedResponseV2" + }, + "example": { + "errors": [ + { + "traceId": "cb381a21702b247f", + "type": "authentication", + "code": "invalid", + "title": "Permission Denied; This endpoint expects a user token", + "detail": "Permission Denied; This endpoint expects a user token" + } + ], + "warnings": [ ] } }, - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/UnauthorizedResponseV2" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/UnauthorizedResponseV2" } } } }, - "404": { - "description": "Operation failure", + "500": { + "description": "Server Error", "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserCreationResponse" + }, + "example": { + "errors": [ + { + "traceId": "cb381a21702b247f", + "type": "availability", + "code": "internal-error", + "title": "Internal Server Error", + "detail": "Internal Server Error" + } + ], + "warnings": [ ] + } + }, "text/plain": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserCreationResponse" } }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserCreationResponse" + } + } + } + } + } + } + }, + "/preview/advertisers/me": { + "get": { + "tags": [ + "Advertiser" + ], + "description": "Fetch the portfolio of Advertisers for this account", + "operationId": "ApiPortfolioGet", + "responses": { + "200": { + "description": "Success", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/GetPortfolioResponse" + }, + "example": { + "data": [ + { + "type": "advertiser", + "id": "13", + "attributes": { + "advertiserName": "ClientName1" + } + }, + { + "type": "advertiser", + "id": "1352", + "attributes": { + "advertiserName": "ClientName2" + } + }, + { + "type": "advertiser", + "id": "73550", + "attributes": { + "advertiserName": "ClientName3" + } + } + ], + "errors": [ ], + "warnings": [ ] + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/GetPortfolioResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/GetPortfolioResponse" } } } }, - "409": { - "description": "Operation failure", + "401": { + "description": "Unauthorized", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/GetPortfolioResponse" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/GetPortfolioResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/GetPortfolioResponse" } } } } } - }, + } + }, + "/preview/advertisers/{advertiser-id}/datasets": { "get": { "tags": [ - "Reco" + "Advertiser" ], - "description": "Fetch product filtering configuration for a given ad", - "operationId": "FetchProductFilteringConfig", + "description": "Retrieves corresponding Datasets for a given Advertiser. Only those Datasets are included for which the given Advertiser is marked a primary.", + "operationId": "getDatasetList", "parameters": [ { - "name": "ad-id", + "name": "advertiser-id", "in": "path", - "description": "ID of the ad", + "description": "The id of the Advertiser for which Datasets are being retrieved.", "required": true, "style": "simple", "schema": { @@ -6656,167 +7112,230 @@ ], "responses": { "200": { - "description": "Successful operation. Returns the product filtering configuration if it exists, or empty data if it doesn't.", + "description": "Success", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" - } - } - } - }, - "400": { - "description": "Operation failure", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + }, + "example": { + "data": [ + { + "type": "dataset", + "id": "73550", + "attributes": { + "name": "Dataset 1" + } + } + ], + "errors": [ ], + "warnings": [ ] } }, - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserDatasetListResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserDatasetListResponse" } } } }, "403": { - "description": "Operation failure", + "description": "Forbidden", "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + }, + "example": { + "data": [ ], + "errors": [ + { + "traceId": "cb381a21702b247f", + "type": "authorization", + "code": "permission-denied", + "title": "Permission denied, you do not have access this to resource", + "detail": "Permission denied, you do not have access this to resource" + } + ], + "warnings": [ ] + } + }, "text/plain": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/AdvertiserDatasetListResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "example": { + "errors": [ + { + "traceId": "cb381a21702b247f", + "type": "authentication", + "code": "invalid", + "title": "Permission Denied; This endpoint expects a user token", + "detail": "Permission Denied; This endpoint expects a user token" + } + ], + "warnings": [ ] } }, + "text/plain": { }, + "text/json": { } + } + } + } + } + }, + "/preview/industries": { + "get": { + "tags": [ + "Advertiser" + ], + "description": "Returns the list of available industries for new advertisers.", + "operationId": "listIndustries", + "responses": { + "200": { + "description": "Success", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/ListAvailableIndustriesResponse" + }, + "example": { + "data": [ + { + "type": "industry", + "id": "13" + }, + { + "type": "industry", + "id": "1352" + }, + { + "type": "industry", + "id": "73550" + } + ], + "errors": [ ], + "warnings": [ ] + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ListAvailableIndustriesResponse" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/ListAvailableIndustriesResponse" } } } } } - }, - "post": { + } + }, + "/preview/catalog/stats/merchants/{merchant-id}": { + "get": { "tags": [ - "Reco" + "Catalog" ], - "description": "Enable product filtering for a given ad", - "operationId": "EnableProductFiltering", + "description": "get an stats request", "parameters": [ { - "name": "ad-id", + "name": "merchant-id", "in": "path", - "description": "ID of the ad", + "description": "merchant-id to get", "required": true, "style": "simple", "schema": { - "type": "string" + "type": "integer", + "format": "int32" + } + }, + { + "name": "lastNumHours", + "in": "query", + "description": "the last number of hours", + "style": "form", + "schema": { + "type": "integer", + "format": "int32" } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" - } - } - }, - "x-bodyName": "createProductFilterRequest" - }, "responses": { - "200": { - "description": "successful operation", + "503": { + "description": "Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" + "$ref": "#/components/schemas/FailResponse" } } } }, - "400": { - "description": "Operation failure", + "401": { + "description": "Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, - "text/json": { + } + } + }, + "403": { + "description": "Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")]", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } }, - "403": { - "description": "Operation failure", + "500": { + "description": "Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")]", "content": { - "text/plain": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, + } + } + }, + "429": { + "description": "Too Many Requests. Allowed error types and errors: [(type=\"availability\", code=\"too-many-requests\")]", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, - "text/json": { + } + } + }, + "200": { + "description": "The successful response of GET stats request", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/StatisticsOkResponse" } } } @@ -6824,135 +7343,96 @@ } } }, - "/preview/product-sets": { + "/preview/catalog/products/batch": { "post": { "tags": [ - "Reco" + "Catalog" ], - "description": "Create a new product set", - "operationId": "CreateProductSet", + "description": "Used to publish a batch of operations to insert, update and deletes products.\n The batch is processed asynchronously.The response provides an operationToken which can be used to track\n the status of the report of the operation.", "requestBody": { "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" + "$ref": "#/components/schemas/ProductsCustomBatchRequest" } } }, - "x-bodyName": "request" + "required": true, + "x-bodyName": "body" }, "responses": { - "200": { - "description": "Product set created successfully", + "202": { + "description": "Batch accepted. The status of the operation can be tracked using the report endpoint and the operationToken.", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + "$ref": "#/components/schemas/BatchAcceptedResponse" } } } }, "400": { - "description": "Unable to parse the request parameters", + "description": "Bad Request. Allowed error types and errors: [(type=\"validation\", code=\"required-field\"),(type=\"validation\", code=\"required-field\"),(type=\"validation\", code=\"json-format\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } }, - "422": { - "description": "Cannot process entity content", + "401": { + "description": "Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } }, "403": { - "description": "Operation forbidden", + "description": "Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, - "text/json": { + } + } + }, + "413": { + "description": "Request too large. By default, payload up to 16 MB is rejected.", + "content": { + "application/json": { } + } + }, + "429": { + "description": "Too Many Requests. Allowed error types and errors: [(type=\"availability\", code=\"too-many-requests\")]", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } }, "500": { - "description": "Internal Error", + "description": "Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, - "text/json": { + } + } + }, + "503": { + "description": "Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")]", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } @@ -6960,18 +7440,17 @@ } } }, - "/preview/product-sets/dataset/{dataset-id}": { + "/preview/catalog/products/batch/report/{operation-token}": { "get": { "tags": [ - "Reco" + "Catalog" ], - "description": "Fetch product sets of a given dataset", - "operationId": "FetchProductSets", + "description": "Get the report of an asynchronous batch operation previously requested", "parameters": [ { - "name": "dataset-id", + "name": "operation-token", "in": "path", - "description": "The ID of the dataset that should be used for product set retrieval", + "description": "The token returned by the batch endpoint.", "required": true, "style": "simple", "schema": { @@ -6981,81 +7460,77 @@ ], "responses": { "200": { - "description": "Products sets fetched successfully", + "description": "The report object", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ResourceCollectionOutcomeOfProductSet" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ResourceCollectionOutcomeOfProductSet" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ResourceCollectionOutcomeOfProductSet" + "$ref": "#/components/schemas/ReportOkResponse" } } } }, "400": { - "description": "Unable to parse the request parameters", + "description": "Bad Request. Allowed error types and errors: [(type=\"validation\", code=\"catalog-operation-token-is-malformed\"),(type=\"validation\", code=\"catalog-operation-report-is-expired\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, - "text/json": { + } + } + }, + "401": { + "description": "Unauthorized. Allowed error types and errors: [(type=\"authentication\", code=\"not-authenticated\")]", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } }, "403": { - "description": "Operation forbidden", + "description": "Forbidden. Allowed error types and errors: [(type=\"authorization\", code=\"not-authorized\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, - "text/json": { + } + } + }, + "404": { + "description": "Not Found. Allowed error types and errors: [(type=\"validation\", code=\"catalog-operation-not-found\")]", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } }, + "429": { + "description": "Too Many Requests", + "content": { + "application/json": { } + } + }, "500": { - "description": "Internal Error", + "description": "Internal Server Error. Allowed error types and errors: [(type=\"availability\", code=\"internal-error\")]", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } - }, - "text/json": { + } + } + }, + "503": { + "description": "Service Unavailable. Allowed error types and errors: [(type=\"availability\", code=\"service-unavailable\")]", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Outcome" + "$ref": "#/components/schemas/FailResponse" } } } @@ -7063,18 +7538,18 @@ } } }, - "/preview/product-sets/{product-set-id}": { + "/preview/ads/{ad-id}/product-filter": { "delete": { "tags": [ "Reco" ], - "description": "Remove a product set", - "operationId": "RemoveProductSet", + "description": "Disable product filtering for a given ad", + "operationId": "DisableProductFiltering", "parameters": [ { - "name": "product-set-id", + "name": "ad-id", "in": "path", - "description": "ID of the product set to remove", + "description": "ID of the ad", "required": true, "style": "simple", "schema": { @@ -7083,8 +7558,28 @@ } ], "responses": { - "204": { - "description": "ProductSet removed successfully", + "200": { + "description": "Successful operation", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" + } + } + } + }, + "400": { + "description": "Operation failure", "content": { "text/plain": { "schema": { @@ -7103,8 +7598,8 @@ } } }, - "400": { - "description": "Request was not valid", + "403": { + "description": "Operation failure", "content": { "text/plain": { "schema": { @@ -7123,8 +7618,8 @@ } } }, - "403": { - "description": "Operation forbidden", + "404": { + "description": "Operation failure", "content": { "text/plain": { "schema": { @@ -7143,8 +7638,8 @@ } } }, - "500": { - "description": "Internal Error", + "409": { + "description": "Operation failure", "content": { "text/plain": { "schema": { @@ -7169,13 +7664,13 @@ "tags": [ "Reco" ], - "description": "Fetch an existing product set", - "operationId": "FetchProductSet", + "description": "Fetch product filtering configuration for a given ad", + "operationId": "FetchProductFilteringConfig", "parameters": [ { - "name": "product-set-id", + "name": "ad-id", "in": "path", - "description": "ID of the product set", + "description": "ID of the ad", "required": true, "style": "simple", "schema": { @@ -7185,27 +7680,27 @@ ], "responses": { "200": { - "description": "Product set fetched successfully", + "description": "Successful operation. Returns the product filtering configuration if it exists, or empty data if it doesn't.", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" } } } }, "400": { - "description": "Unable to parse the request parameters", + "description": "Operation failure", "content": { "text/plain": { "schema": { @@ -7225,27 +7720,7 @@ } }, "403": { - "description": "Operation forbidden", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Outcome" - } - } - } - }, - "500": { - "description": "Internal Error", + "description": "Operation failure", "content": { "text/plain": { "schema": { @@ -7265,20 +7740,18 @@ } } } - } - }, - "/preview/product-sets/{product-set-id}/product-filters": { - "get": { + }, + "post": { "tags": [ "Reco" ], - "description": "Fetch product filtering usages for a given product set", - "operationId": "FetchProductFilteringUsages", + "description": "Enable product filtering for a given ad", + "operationId": "EnableProductFiltering", "parameters": [ { - "name": "product-set-id", + "name": "ad-id", "in": "path", - "description": "ID of the product set", + "description": "ID of the ad", "required": true, "style": "simple", "schema": { @@ -7286,23 +7759,48 @@ } } ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductFilterRequest" + } + } + }, + "x-bodyName": "createProductFilterRequest" + }, "responses": { "200": { "description": "successful operation", "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfProductFilterConfig" + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfProductFilterConfig" + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfProductFilterConfig" + "$ref": "#/components/schemas/ValueResourceOutcomeOfProductFilterConfig" } } } @@ -7350,533 +7848,442 @@ } } }, - "/preview/recommendation/search": { + "/preview/product-sets": { "post": { "tags": [ - "OnSiteRecommendation" + "Reco" ], - "description": "Retrieves a list of products recommended for the given user. This end point can either rely on a Criteo UserId, or a list of user events to perform the recommendation.", - "operationId": "ApiV1RecoPost", + "description": "Create a new product set", + "operationId": "CreateProductSet", "requestBody": { "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/OnSiteRecoRequest" + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/OnSiteRecoRequest" + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/OnSiteRecoRequest" + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/OnSiteRecoRequest" + "$ref": "#/components/schemas/ValueResourceInputOfCreateProductSetRequest" } } }, "x-bodyName": "request" }, "responses": { + "200": { + "description": "Product set created successfully", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + } + } + } + }, "400": { - "description": "Bad Request", + "description": "Unable to parse the request parameters", "content": { - "application/json": { } + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } } }, - "200": { - "description": "Success", + "422": { + "description": "Cannot process entity content", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } + } + }, + "403": { + "description": "Operation forbidden", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OnSiteRecoResponse" + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, - "401": { - "description": "Unauthorized", + "500": { + "description": "Internal Error", "content": { - "application/json": { } + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } } } } } }, - "/preview/brand-safety/oci": { - "description": "This resource represents a brand-safety rule. Each brand-safety rule determines which context will be applied to the selected target.", - "delete": { + "/preview/product-sets/dataset/{dataset-id}": { + "get": { "tags": [ - "Campaign" + "Reco" ], - "description": "Delete OCI brand-safety rule.", - "operationId": "deleteOCIbrandSafetyRule", + "description": "Fetch product sets of a given dataset", + "operationId": "FetchProductSets", "parameters": [ { - "name": "target-type", - "in": "query", - "description": "Defines a target for a rule.", - "required": true, - "style": "form", - "schema": { - "$ref": "#/components/schemas/TargetType" - } - }, - { - "name": "target-id", - "in": "query", - "description": "Unique target identifier.", + "name": "dataset-id", + "in": "path", + "description": "The ID of the dataset that should be used for product set retrieval", "required": true, - "style": "form", + "style": "simple", "schema": { - "minimum": 1, - "type": "integer" + "type": "string" } } ], "responses": { - "204": { - "description": "Rule deleted" - }, - "400": { - "description": "Invalid input", + "200": { + "description": "Products sets fetched successfully", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ResourceCollectionOutcomeOfProductSet" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Bad request error example", - "value": { - "errors": [ - { - "type": "validation", - "code": "invalid", - "title": "Invalid json", - "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/brand-safety/oci", - "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" - } - ] - } - } + "$ref": "#/components/schemas/ResourceCollectionOutcomeOfProductSet" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ResourceCollectionOutcomeOfProductSet" } } } }, - "401": { - "description": "Unauthorized", + "400": { + "description": "Unable to parse the request parameters", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Unauthorized response.", - "value": { - "errors": [ - { - "type": "authentication", - "code": "not-authenticated", - "title": "Unauthorized request", - "detail": "JWT provided invalid or expired", - "instance": "/v2/brand-safety/oci", - "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, "403": { - "description": "Forbidden", + "description": "Operation forbidden", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Forbidden response.", - "value": { - "errors": [ - { - "type": "authorization", - "code": "not-authorized", - "title": "User has no access to the resource", - "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/brand-safety/oci", - "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, "500": { - "description": "Internal service error", + "description": "Internal Error", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Internal service error response.", - "value": { - "errors": [ - { - "type": "availability", - "code": "internal-error", - "title": "Internal service error", - "detail": "An internal error has occurred", - "instance": "/v2/brand-safety/oci", - "traceId": "6d247cae-7497-4039-9310-69f426566365" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } } } - }, - "get": { + } + }, + "/preview/product-sets/{product-set-id}": { + "delete": { "tags": [ - "Campaign" + "Reco" ], - "description": "Get OCI brand-safety rule for the specified target", - "operationId": "getOCIbrandSafetyRule", + "description": "Remove a product set", + "operationId": "RemoveProductSet", "parameters": [ { - "name": "target-type", - "in": "query", - "description": "Defines a target for a rule.", - "required": true, - "style": "form", - "schema": { - "$ref": "#/components/schemas/TargetType" - } - }, - { - "name": "target-id", - "in": "query", - "description": "Unique target identifier.", + "name": "product-set-id", + "in": "path", + "description": "ID of the product set to remove", "required": true, - "style": "form", + "style": "simple", "schema": { - "minimum": 1, - "type": "integer" + "type": "string" } } ], "responses": { - "200": { - "description": "Rule found", + "204": { + "description": "ProductSet removed successfully", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Ok response for OCI brand safety endpoints", - "value": { - "data": { - "id": "42", - "type": "OciBrandSafetyRule", - "attributes": { - "target": { - "id": 42, - "type": "Campaign" - }, - "blacklisted": [ - "gv_adult", - "gv_arms" - ] - } - } - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, "400": { - "description": "Invalid input", + "description": "Request was not valid", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Bad request error example", - "value": { - "errors": [ - { - "type": "validation", - "code": "invalid", - "title": "Invalid json", - "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/brand-safety/oci", - "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Unauthorized response.", - "value": { - "errors": [ - { - "type": "authentication", - "code": "not-authenticated", - "title": "Unauthorized request", - "detail": "JWT provided invalid or expired", - "instance": "/v2/brand-safety/oci", - "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, "403": { - "description": "Forbidden", + "description": "Operation forbidden", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Forbidden response.", - "value": { - "errors": [ - { - "type": "authorization", - "code": "not-authorized", - "title": "User has no access to the resource", - "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/brand-safety/oci", - "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, "500": { - "description": "Internal service error", + "description": "Internal Error", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Internal service error response.", - "value": { - "errors": [ - { - "type": "availability", - "code": "internal-error", - "title": "Internal service error", - "detail": "An internal error has occurred", - "instance": "/v2/brand-safety/oci", - "traceId": "6d247cae-7497-4039-9310-69f426566365" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } } } }, - "post": { + "get": { "tags": [ - "Campaign" + "Reco" ], - "description": "Create or update a new or replace existing OCI brand-safety rule.", - "operationId": "upsertOCIbrandSafetyRule", - "requestBody": { - "description": "OCI brand-safety rule input", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OciBrandSafetyRule" - } + "description": "Fetch an existing product set", + "operationId": "FetchProductSet", + "parameters": [ + { + "name": "product-set-id", + "in": "path", + "description": "ID of the product set", + "required": true, + "style": "simple", + "schema": { + "type": "string" } - }, - "required": true - }, + } + ], "responses": { "200": { - "description": "Rule created", + "description": "Product set fetched successfully", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Ok response for OCI brand safety endpoints", - "value": { - "data": { - "id": "42", - "type": "OciBrandSafetyRule", - "attributes": { - "target": { - "id": 42, - "type": "Campaign" - }, - "blacklisted": [ - "gv_adult", - "gv_arms" - ] - } - } - } - } + "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ResourceOutcomeOfProductSet" } } } }, "400": { - "description": "Invalid input", + "description": "Unable to parse the request parameters", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Bad request error example", - "value": { - "errors": [ - { - "type": "validation", - "code": "invalid", - "title": "Invalid json", - "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/brand-safety/oci", - "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Unauthorized response.", - "value": { - "errors": [ - { - "type": "authentication", - "code": "not-authenticated", - "title": "Unauthorized request", - "detail": "JWT provided invalid or expired", - "instance": "/v2/brand-safety/oci", - "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, "403": { - "description": "Forbidden", + "description": "Operation forbidden", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Forbidden response.", - "value": { - "errors": [ - { - "type": "authorization", - "code": "not-authorized", - "title": "User has no access to the resource", - "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/brand-safety/oci", - "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } }, "500": { - "description": "Internal service error", + "description": "Internal Error", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciBrandSafetyResponse" - }, - "examples": { - "sample": { - "summary": "Internal service error response.", - "value": { - "errors": [ - { - "type": "availability", - "code": "internal-error", - "title": "Internal service error", - "detail": "An internal error has occurred", - "instance": "/v2/brand-safety/oci", - "traceId": "6d247cae-7497-4039-9310-69f426566365" - } - ] - } - } + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" } } } @@ -7884,49 +8291,190 @@ } } }, - "/preview/targeting/oci": { - "description": "This resource represents a targeting rule. Each targeting rule is determines which contextual data will be aimed for the selected target.", - "delete": { + "/preview/product-sets/{product-set-id}/product-filters": { + "get": { "tags": [ - "Campaign" + "Reco" ], - "description": "Delete OCI targeting rule.", - "operationId": "deleteOCItargetingRule", + "description": "Fetch product filtering usages for a given product set", + "operationId": "FetchProductFilteringUsages", "parameters": [ { - "name": "target-type", - "in": "query", - "description": "Defines a target for a rule.", - "required": true, - "style": "form", - "schema": { - "$ref": "#/components/schemas/TargetType" - } - }, - { - "name": "target-id", - "in": "query", - "description": "Unique target identifier.", + "name": "product-set-id", + "in": "path", + "description": "ID of the product set", "required": true, - "style": "form", + "style": "simple", "schema": { - "minimum": 1, - "type": "integer" + "type": "string" } } ], "responses": { - "204": { - "description": "Rule deleted" + "200": { + "description": "successful operation", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfProductFilterConfig" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfProductFilterConfig" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfProductFilterConfig" + } + } + } }, "400": { - "description": "Invalid input", + "description": "Operation failure", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" - }, - "examples": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } + } + }, + "403": { + "description": "Operation failure", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Outcome" + } + } + } + } + } + } + }, + "/preview/recommendation/search": { + "post": { + "tags": [ + "OnSiteRecommendation" + ], + "description": "Retrieves a list of products recommended for the given user. This end point can either rely on a Criteo UserId, or a list of user events to perform the recommendation.", + "operationId": "ApiV1RecoPost", + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/OnSiteRecoRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnSiteRecoRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OnSiteRecoRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/OnSiteRecoRequest" + } + } + }, + "x-bodyName": "request" + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { } + } + }, + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnSiteRecoResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { } + } + } + } + } + }, + "/preview/brand-safety/oci": { + "description": "This resource represents a brand-safety rule. Each brand-safety rule determines which context will be applied to the selected target.", + "delete": { + "tags": [ + "Campaign" + ], + "description": "Delete OCI brand-safety rule.", + "operationId": "deleteOCIbrandSafetyRule", + "parameters": [ + { + "name": "target-type", + "in": "query", + "description": "Defines a target for a rule.", + "required": true, + "style": "form", + "schema": { + "$ref": "#/components/schemas/TargetType" + } + }, + { + "name": "target-id", + "in": "query", + "description": "Unique target identifier.", + "required": true, + "style": "form", + "schema": { + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Rule deleted" + }, + "400": { + "description": "Invalid input", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OciBrandSafetyResponse" + }, + "examples": { "sample": { "summary": "Bad request error example", "value": { @@ -7936,7 +8484,7 @@ "code": "invalid", "title": "Invalid json", "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" } ] @@ -7951,7 +8499,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -7963,7 +8511,7 @@ "code": "not-authenticated", "title": "Unauthorized request", "detail": "JWT provided invalid or expired", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" } ] @@ -7978,7 +8526,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -7990,7 +8538,7 @@ "code": "not-authorized", "title": "User has no access to the resource", "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" } ] @@ -8005,7 +8553,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8017,7 +8565,7 @@ "code": "internal-error", "title": "Internal service error", "detail": "An internal error has occurred", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "6d247cae-7497-4039-9310-69f426566365" } ] @@ -8033,8 +8581,8 @@ "tags": [ "Campaign" ], - "description": "Get OCI targeting rule for specified target.", - "operationId": "getOCItargetingRule", + "description": "Get OCI brand-safety rule for the specified target", + "operationId": "getOCIbrandSafetyRule", "parameters": [ { "name": "target-type", @@ -8064,37 +8612,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { + "summary": "Ok response for OCI brand safety endpoints", "value": { - "value": { - "summary": "Ok response for OCI targeting endpoints", - "value": { - "data": { - "id": "42", - "type": "OciTargetingRule", - "attributes": { - "target": { - "id": 42, - "type": "Campaign" - }, - "rule": { - "operator": "Or", - "children": [ - { - "operator": "Value", - "value": "gs_auto" - }, - { - "operator": "Value", - "value": "gs_business" - } - ] - } - } - } + "data": { + "id": "42", + "type": "OciBrandSafetyRule", + "attributes": { + "target": { + "id": 42, + "type": "Campaign" + }, + "blacklisted": [ + "gv_adult", + "gv_arms" + ] } } } @@ -8108,7 +8643,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8120,7 +8655,7 @@ "code": "invalid", "title": "Invalid json", "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" } ] @@ -8135,7 +8670,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8147,7 +8682,7 @@ "code": "not-authenticated", "title": "Unauthorized request", "detail": "JWT provided invalid or expired", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" } ] @@ -8162,7 +8697,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8174,7 +8709,7 @@ "code": "not-authorized", "title": "User has no access to the resource", "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" } ] @@ -8189,7 +8724,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8201,7 +8736,7 @@ "code": "internal-error", "title": "Internal service error", "detail": "An internal error has occurred", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "6d247cae-7497-4039-9310-69f426566365" } ] @@ -8217,14 +8752,14 @@ "tags": [ "Campaign" ], - "description": "Create or update new or update existing OCI targeting rule.", - "operationId": "upsertOCItargetingRule", + "description": "Create or update a new or replace existing OCI brand-safety rule.", + "operationId": "upsertOCIbrandSafetyRule", "requestBody": { - "description": "OCI targeting rule input", + "description": "OCI brand-safety rule input", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingRule" + "$ref": "#/components/schemas/OciBrandSafetyRule" } } }, @@ -8236,33 +8771,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { - "summary": "Ok response for OCI targeting endpoints", + "summary": "Ok response for OCI brand safety endpoints", "value": { "data": { "id": "42", - "type": "OciTargetingRule", + "type": "OciBrandSafetyRule", "attributes": { "target": { "id": 42, "type": "Campaign" }, - "rule": { - "operator": "Or", - "children": [ - { - "operator": "Value", - "value": "gs_auto" - }, - { - "operator": "Value", - "value": "gs_business" - } - ] - } + "blacklisted": [ + "gv_adult", + "gv_arms" + ] } } } @@ -8276,7 +8802,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8288,7 +8814,7 @@ "code": "invalid", "title": "Invalid json", "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" } ] @@ -8303,7 +8829,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8315,7 +8841,7 @@ "code": "not-authenticated", "title": "Unauthorized request", "detail": "JWT provided invalid or expired", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" } ] @@ -8330,7 +8856,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8342,7 +8868,7 @@ "code": "not-authorized", "title": "User has no access to the resource", "detail": "Invalid json. Path: line 2, position 42.", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" } ] @@ -8357,7 +8883,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OciTargetingResponse" + "$ref": "#/components/schemas/OciBrandSafetyResponse" }, "examples": { "sample": { @@ -8369,7 +8895,7 @@ "code": "internal-error", "title": "Internal service error", "detail": "An internal error has occurred", - "instance": "/v2/targeting/oci", + "instance": "/v2/brand-safety/oci", "traceId": "6d247cae-7497-4039-9310-69f426566365" } ] @@ -8382,89 +8908,64 @@ } } }, - "/preview/advertisers/{advertiserId}/targeting/bundle-rules": { + "/preview/targeting/oci": { + "description": "This resource represents a targeting rule. Each targeting rule is determines which contextual data will be aimed for the selected target.", "delete": { "tags": [ "Campaign" ], - "description": "Removes some bundles from the current list of targeted bundles for a given advertiser.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "DeleteAdvertiserBundleRules", + "description": "Delete OCI targeting rule.", + "operationId": "deleteOCItargetingRule", "parameters": [ { - "name": "advertiserId", - "in": "path", - "description": "The advertiser id", + "name": "target-type", + "in": "query", + "description": "Defines a target for a rule.", "required": true, - "style": "simple", + "style": "form", "schema": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/TargetType" + } + }, + { + "name": "target-id", + "in": "query", + "description": "Unique target identifier.", + "required": true, + "style": "form", + "schema": { + "minimum": 1, + "type": "integer" } } ], - "requestBody": { - "description": "Contains the list of items to delete from the list", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - } - }, - "x-bodyName": "apiRequest" - }, "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - } - } + "204": { + "description": "Rule deleted" }, "400": { - "description": "Bad Request", + "description": "Invalid input", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Bad request error example", + "value": { + "errors": [ + { + "type": "validation", + "code": "invalid", + "title": "Invalid json", + "detail": "Invalid json. Path: line 2, position 42.", + "instance": "/v2/targeting/oci", + "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" + } + ] + } + } } } } @@ -8472,19 +8973,26 @@ "401": { "description": "Unauthorized", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Unauthorized response.", + "value": { + "errors": [ + { + "type": "authentication", + "code": "not-authenticated", + "title": "Unauthorized request", + "detail": "JWT provided invalid or expired", + "instance": "/v2/targeting/oci", + "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" + } + ] + } + } } } } @@ -8492,19 +9000,53 @@ "403": { "description": "Forbidden", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Forbidden response.", + "value": { + "errors": [ + { + "type": "authorization", + "code": "not-authorized", + "title": "User has no access to the resource", + "detail": "Invalid json. Path: line 2, position 42.", + "instance": "/v2/targeting/oci", + "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" + } + ] + } + } } - }, - "text/json": { + } + } + }, + "500": { + "description": "Internal service error", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Internal service error response.", + "value": { + "errors": [ + { + "type": "availability", + "code": "internal-error", + "title": "Internal service error", + "detail": "An internal error has occurred", + "instance": "/v2/targeting/oci", + "traceId": "6d247cae-7497-4039-9310-69f426566365" + } + ] + } + } } } } @@ -8515,78 +9057,126 @@ "tags": [ "Campaign" ], - "description": "Returns a list of all targeted bundles for an advertiser.", - "operationId": "GetAdvertiserBundleRules", + "description": "Get OCI targeting rule for specified target.", + "operationId": "getOCItargetingRule", "parameters": [ { - "name": "advertiserId", - "in": "path", - "description": "The advertiser id", + "name": "target-type", + "in": "query", + "description": "Defines a target for a rule.", "required": true, - "style": "simple", + "style": "form", "schema": { - "type": "integer", - "format": "int32" + "$ref": "#/components/schemas/TargetType" + } + }, + { + "name": "target-id", + "in": "query", + "description": "Unique target identifier.", + "required": true, + "style": "form", + "schema": { + "minimum": 1, + "type": "integer" } } ], "responses": { "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - } - } - }, - "400": { - "description": "Bad Request", + "description": "Rule found", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "value": { + "value": { + "summary": "Ok response for OCI targeting endpoints", + "value": { + "data": { + "id": "42", + "type": "OciTargetingRule", + "attributes": { + "target": { + "id": 42, + "type": "Campaign" + }, + "rule": { + "operator": "Or", + "children": [ + { + "operator": "Value", + "value": "gs_auto" + }, + { + "operator": "Value", + "value": "gs_business" + } + ] + } + } + } + } + } + } + } } - }, + } + } + }, + "400": { + "description": "Invalid input", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Bad request error example", + "value": { + "errors": [ + { + "type": "validation", + "code": "invalid", + "title": "Invalid json", + "detail": "Invalid json. Path: line 2, position 42.", + "instance": "/v2/targeting/oci", + "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" + } + ] + } + } } - }, - "text/json": { + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Unauthorized response.", + "value": { + "errors": [ + { + "type": "authentication", + "code": "not-authenticated", + "title": "Unauthorized request", + "detail": "JWT provided invalid or expired", + "instance": "/v2/targeting/oci", + "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" + } + ] + } + } } } } @@ -8594,19 +9184,53 @@ "403": { "description": "Forbidden", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Forbidden response.", + "value": { + "errors": [ + { + "type": "authorization", + "code": "not-authorized", + "title": "User has no access to the resource", + "detail": "Invalid json. Path: line 2, position 42.", + "instance": "/v2/targeting/oci", + "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" + } + ] + } + } } - }, - "text/json": { + } + } + }, + "500": { + "description": "Internal service error", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Internal service error response.", + "value": { + "errors": [ + { + "type": "availability", + "code": "internal-error", + "title": "Internal service error", + "detail": "An internal error has occurred", + "instance": "/v2/targeting/oci", + "traceId": "6d247cae-7497-4039-9310-69f426566365" + } + ] + } + } } } } @@ -8617,84 +9241,83 @@ "tags": [ "Campaign" ], - "description": "Inserts a list of targeted bundles for an advertiser and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", - "operationId": "PostAdvertiserBundleRules", - "parameters": [ - { - "name": "advertiserId", - "in": "path", - "description": "The advertiser id", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], + "description": "Create or update new or update existing OCI targeting rule.", + "operationId": "upsertOCItargetingRule", "requestBody": { - "description": "Description of the targeting rule to setup", + "description": "OCI targeting rule input", "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + "$ref": "#/components/schemas/OciTargetingRule" } } }, - "x-bodyName": "apiRequest" + "required": true }, "responses": { "200": { - "description": "Success", + "description": "Rule created", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Ok response for OCI targeting endpoints", + "value": { + "data": { + "id": "42", + "type": "OciTargetingRule", + "attributes": { + "target": { + "id": 42, + "type": "Campaign" + }, + "rule": { + "operator": "Or", + "children": [ + { + "operator": "Value", + "value": "gs_auto" + }, + { + "operator": "Value", + "value": "gs_business" + } + ] + } + } + } + } + } } } } }, "400": { - "description": "Bad Request", + "description": "Invalid input", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Bad request error example", + "value": { + "errors": [ + { + "type": "validation", + "code": "invalid", + "title": "Invalid json", + "detail": "Invalid json. Path: line 2, position 42.", + "instance": "/v2/targeting/oci", + "traceId": "56ed4096-f96a-4944-8881-05468efe0ec9" + } + ] + } + } } } } @@ -8702,19 +9325,26 @@ "401": { "description": "Unauthorized", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Unauthorized response.", + "value": { + "errors": [ + { + "type": "authentication", + "code": "not-authenticated", + "title": "Unauthorized request", + "detail": "JWT provided invalid or expired", + "instance": "/v2/targeting/oci", + "traceId": "308125b1-e9a7-4712-b420-cc11e681e337" + } + ] + } + } } } } @@ -8722,31 +9352,67 @@ "403": { "description": "Forbidden", "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Forbidden response.", + "value": { + "errors": [ + { + "type": "authorization", + "code": "not-authorized", + "title": "User has no access to the resource", + "detail": "Invalid json. Path: line 2, position 42.", + "instance": "/v2/targeting/oci", + "traceId": "1a786adf-d06f-4a01-903b-bc37981cdf79" + } + ] + } + } } - }, - "text/json": { + } + } + }, + "500": { + "description": "Internal service error", + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" + "$ref": "#/components/schemas/OciTargetingResponse" + }, + "examples": { + "sample": { + "summary": "Internal service error response.", + "value": { + "errors": [ + { + "type": "availability", + "code": "internal-error", + "title": "Internal service error", + "detail": "An internal error has occurred", + "instance": "/v2/targeting/oci", + "traceId": "6d247cae-7497-4039-9310-69f426566365" + } + ] + } + } } } } } } - }, - "put": { + } + }, + "/preview/advertisers/{advertiserId}/targeting/bundle-rules": { + "delete": { "tags": [ "Campaign" ], - "description": "Updates the targeted bundles for an advertiser by adding a list of bundles to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "PutAdvertiserBundleRules", + "description": "Removes some bundles from the current list of targeted bundles for a given advertiser.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "DeleteAdvertiserBundleRules", "parameters": [ { "name": "advertiserId", @@ -8761,7 +9427,7 @@ } ], "requestBody": { - "description": "Contains the list of items to add to the existing list", + "description": "Contains the list of items to delete from the list", "content": { "application/json-patch+json": { "schema": { @@ -8868,15 +9534,13 @@ } } } - } - }, - "/preview/advertisers/{advertiserId}/targeting/domain-rules": { - "delete": { + }, + "get": { "tags": [ "Campaign" ], - "description": "Removes some domains from the current list of targeted domains for a given advertiser.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "DeleteAdvertiserDomainRules", + "description": "Returns a list of all targeted bundles for an advertiser.", + "operationId": "GetAdvertiserBundleRules", "parameters": [ { "name": "advertiserId", @@ -8890,32 +9554,6 @@ } } ], - "requestBody": { - "description": "Contains the list of items to delete from the list", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - } - }, - "x-bodyName": "apiRequest" - }, "responses": { "200": { "description": "Success", @@ -8999,12 +9637,12 @@ } } }, - "get": { + "post": { "tags": [ "Campaign" ], - "description": "Returns a list of all targeted domains for an advertiser.", - "operationId": "GetAdvertiserDomainRules", + "description": "Inserts a list of targeted bundles for an advertiser and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", + "operationId": "PostAdvertiserBundleRules", "parameters": [ { "name": "advertiserId", @@ -9018,6 +9656,32 @@ } } ], + "requestBody": { + "description": "Description of the targeting rule to setup", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + } + }, + "x-bodyName": "apiRequest" + }, "responses": { "200": { "description": "Success", @@ -9101,80 +9765,12 @@ } } }, - "post": { - "tags": [ - "Campaign" - ], - "description": "Inserts a list of targeted domains for an advertiser and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", - "operationId": "PostAdvertiserDomainRules", - "parameters": [ - { - "name": "advertiserId", - "in": "path", - "description": "The advertiser id", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "description": "Description of the targeting rule to setup", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" - } - } - }, - "x-bodyName": "apiRequest" - }, - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" - } - } - } - } - } - }, "put": { "tags": [ "Campaign" ], - "description": "Updates the targeted domains for an advertiser by adding a list of domains to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "PutAdvertiserDomainRules", + "description": "Updates the targeted bundles for an advertiser by adding a list of bundles to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "PutAdvertiserBundleRules", "parameters": [ { "name": "advertiserId", @@ -9298,18 +9894,18 @@ } } }, - "/preview/campaigns/{campaignId}/targeting/bundle-rules": { + "/preview/advertisers/{advertiserId}/targeting/domain-rules": { "delete": { "tags": [ "Campaign" ], - "description": "Removes some bundles from the current list of targeted bundles for a given campaign.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "DeleteCampaignBundleRules", + "description": "Removes some domains from the current list of targeted domains for a given advertiser.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "DeleteAdvertiserDomainRules", "parameters": [ { - "name": "campaignId", + "name": "advertiserId", "in": "path", - "description": "The campaign id", + "description": "The advertiser id", "required": true, "style": "simple", "schema": { @@ -9431,13 +10027,13 @@ "tags": [ "Campaign" ], - "description": "Returns a list of all targeted bundles for a campaign.", - "operationId": "GetCampaignBundleRules", + "description": "Returns a list of all targeted domains for an advertiser.", + "operationId": "GetAdvertiserDomainRules", "parameters": [ { - "name": "campaignId", + "name": "advertiserId", "in": "path", - "description": "The campaign id", + "description": "The advertiser id", "required": true, "style": "simple", "schema": { @@ -9533,13 +10129,13 @@ "tags": [ "Campaign" ], - "description": "Inserts a list of targeted bundles for a campaign and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", - "operationId": "PostCampaignBundleRules", + "description": "Inserts a list of targeted domains for an advertiser and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", + "operationId": "PostAdvertiserDomainRules", "parameters": [ { - "name": "campaignId", + "name": "advertiserId", "in": "path", - "description": "The campaign id", + "description": "The advertiser id", "required": true, "style": "simple", "schema": { @@ -9594,66 +10190,6 @@ } } } - }, - "400": { - "description": "Bad Request", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ApiErrorResponse" - } - } - } } } }, @@ -9661,13 +10197,13 @@ "tags": [ "Campaign" ], - "description": "Updates the targeted bundles for a campaign by adding a list of bundles to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "PutCampaignBundleRules", + "description": "Updates the targeted domains for an advertiser by adding a list of domains to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "PutAdvertiserDomainRules", "parameters": [ { - "name": "campaignId", + "name": "advertiserId", "in": "path", - "description": "The campaign id", + "description": "The advertiser id", "required": true, "style": "simple", "schema": { @@ -9786,13 +10322,13 @@ } } }, - "/preview/campaigns/{campaignId}/targeting/domain-rules": { + "/preview/campaigns/{campaignId}/targeting/bundle-rules": { "delete": { "tags": [ "Campaign" ], - "description": "Removes some domains from the current list of targeted domains for a given campaign.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "DeleteCampaignDomainRules", + "description": "Removes some bundles from the current list of targeted bundles for a given campaign.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "DeleteCampaignBundleRules", "parameters": [ { "name": "campaignId", @@ -9919,8 +10455,8 @@ "tags": [ "Campaign" ], - "description": "Returns a list of all targeted domains for a campaign.", - "operationId": "GetCampaignDomainRules", + "description": "Returns a list of all targeted bundles for a campaign.", + "operationId": "GetCampaignBundleRules", "parameters": [ { "name": "campaignId", @@ -10021,8 +10557,8 @@ "tags": [ "Campaign" ], - "description": "Inserts a list of targeted domains for a campaign and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", - "operationId": "PostCampaignDomainRules", + "description": "Inserts a list of targeted bundles for a campaign and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", + "operationId": "PostCampaignBundleRules", "parameters": [ { "name": "campaignId", @@ -10149,8 +10685,8 @@ "tags": [ "Campaign" ], - "description": "Updates the targeted domains for a campaign by adding a list of domains to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", - "operationId": "PutCampaignDomainRules", + "description": "Updates the targeted bundles for a campaign by adding a list of bundles to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "PutCampaignBundleRules", "parameters": [ { "name": "campaignId", @@ -10274,18 +10810,18 @@ } } }, - "/preview/marketing-solutions/advertisers/{advertiserId}/user-profiles/delete": { - "post": { + "/preview/campaigns/{campaignId}/targeting/domain-rules": { + "delete": { "tags": [ - "Audience" + "Campaign" ], - "description": "This endpoint will Delete User Profiles for a given Advertiser.", - "operationId": "DeleteUserProfiles", + "description": "Removes some domains from the current list of targeted domains for a given campaign.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "DeleteCampaignDomainRules", "parameters": [ { - "name": "advertiserId", + "name": "campaignId", "in": "path", - "description": "Criteo Advertiser ID of user profiles' owner", + "description": "The campaign id", "required": true, "style": "simple", "schema": { @@ -10295,58 +10831,125 @@ } ], "requestBody": { + "description": "Contains the list of items to delete from the list", "content": { "application/json-patch+json": { "schema": { - "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" } }, "application/*+json": { "schema": { - "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" } } }, - "x-bodyName": "deleteUserProfileModels" + "x-bodyName": "apiRequest" }, "responses": { "200": { "description": "Success", "content": { - "application/json": { } + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } } }, "403": { "description": "Forbidden", "content": { - "application/json": { } + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } } } } - } - }, - "/preview/marketing-solutions/advertisers/{advertiserId}/user-profiles/set": { - "post": { + }, + "get": { "tags": [ - "Audience" + "Campaign" ], - "description": "This endpoint will Set User Profiles for a given Advertiser. If a User Profile does not exist, a new one will be created. If a User Profile exists, it will be replaced.", - "operationId": "SetUserProfiles", + "description": "Returns a list of all targeted domains for a campaign.", + "operationId": "GetCampaignDomainRules", "parameters": [ { - "name": "advertiserId", + "name": "campaignId", "in": "path", - "description": "Criteo Advertiser ID of user profiles' owner", + "description": "The campaign id", "required": true, "style": "simple", "schema": { @@ -10355,452 +10958,611 @@ } } ], - "requestBody": { - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/SetUserProfileModelListRequest" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetUserProfileModelListRequest" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SetUserProfileModelListRequest" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/SetUserProfileModelListRequest" - } - } - }, - "x-bodyName": "setUserProfileModels" - }, "responses": { "200": { "description": "Success", "content": { - "application/json": { } + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { - "application/json": { } - } - } - } - } - } - }, - "components": { - "schemas": { - "ModifyAudienceResponse": { - "required": [ - "data", - "errors", - "warnings" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ContactlistOperation" + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceError" + "401": { + "description": "Unauthorized", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } } }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceWarning" + "403": { + "description": "Forbidden", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } } } - }, - "description": "Parameters to modify an audience" + } }, - "DeleteAudienceContactListResponse": { - "required": [ - "data", - "errors", - "warnings" + "post": { + "tags": [ + "Campaign" ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/BasicAudienceDefinition" + "description": "Inserts a list of targeted domains for a campaign and sets the targeting mode : blocklisting or allowlisting.
\r\nIt will replace the current list if any.", + "operationId": "PostCampaignDomainRules", + "parameters": [ + { + "name": "campaignId", + "in": "path", + "description": "The campaign id", + "required": true, + "style": "simple", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "Description of the targeting rule to setup", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + } }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceError" + "x-bodyName": "apiRequest" + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + } } }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceWarning" + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } } - } - }, - "description": "Response of a contactlist deletion" - }, - "ErrorCodeResponse": { - "required": [ - "errors" - ], - "type": "object", - "properties": { - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceError" + }, + "401": { + "description": "Unauthorized", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } } }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceWarning" - }, - "nullable": true + "403": { + "description": "Forbidden", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } } - }, - "description": "Definition of the error code" + } }, - "ContactlistWithAttributesAmendmentRequest": { - "required": [ - "data" + "put": { + "tags": [ + "Campaign" ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ContactlistWithAttributesAmendment" + "description": "Updates the targeted domains for a campaign by adding a list of domains to the current list.
\r\nThe mode of targeting (allowlist/blocklist) cannot be updated through this method.", + "operationId": "PutCampaignDomainRules", + "parameters": [ + { + "name": "campaignId", + "in": "path", + "description": "The campaign id", + "required": true, + "style": "simple", + "schema": { + "type": "integer", + "format": "int32" + } } - }, - "description": "Request for a contactlist amendment with user attributes", - "example": { - "data": { - "type": "ContactlistWithUserAttributesAmendment", - "attributes": { - "operation": "add", - "identifierType": "email", - "identifiers": [ - { - "identifier": "example1@gmail.com", - "attributes": [ - { - "key": "age", - "value": "12" - }, - { - "key": "country", - "value": "FR" - }, - { - "key": "size", - "value": "S" - } - ] - }, - { - "identifier": "example2@gmail.com", - "attributes": [ - { - "key": "age", - "value": "43" - }, - { - "key": "preferredColor", - "value": "yellow" - } - ] - } - ] - } - } - } - }, - "ContactlistAmendmentRequest": { - "required": [ - "data" ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ContactlistAmendment" - } + "requestBody": { + "description": "Contains the list of items to add to the existing list", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ApiRequestOfTargetingEntity" + } + } + }, + "x-bodyName": "apiRequest" }, - "description": "Request for a contactlist amendment" - }, - "ContactlistOperation": { - "required": [ - "attributes", - "type" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "the name of the entity type" + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponseOfTargetingEntity" + } + } + } }, - "attributes": { - "required": [ - "operation" - ], - "type": "object", - "properties": { - "contactListId": { - "type": "integer", - "description": "the affected user list id", - "nullable": true + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } }, - "operation": { - "type": "string", - "description": "The action recorded" + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } }, - "requestDate": { - "type": "string", - "description": "When the action was recorded", - "format": "date-time", - "nullable": true + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } }, - "identifierType": { - "type": "string", - "description": "The schema specified for of the identifiers", - "nullable": true + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } }, - "nbValidIdentifiers": { - "type": "integer", - "description": "How many identifiers were valid for the specified schema", - "nullable": true + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } }, - "nbInvalidIdentifiers": { - "type": "integer", - "description": "How many identifiers were invalid for the specified schema", - "nullable": true + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } }, - "sampleInvalidIdentifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A sample of invalid identifiers if there is some", - "nullable": true + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiErrorResponse" + } } - }, - "description": "the contactlist operation attributes" + } } - }, - "description": "Response definition of a contactlist operation" - }, - "AudienceError": { - "required": [ - "code", - "instance", - "type" + } + } + }, + "/preview/marketing-solutions/advertisers/{advertiserId}/user-profiles/delete": { + "post": { + "tags": [ + "Audience" ], - "type": "object", - "properties": { - "traceId": { - "type": "string", - "description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.", - "nullable": true + "description": "This endpoint will Delete User Profiles for a given Advertiser.", + "operationId": "DeleteUserProfiles", + "parameters": [ + { + "name": "advertiserId", + "in": "path", + "description": "Criteo Advertiser ID of user profiles' owner", + "required": true, + "style": "simple", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/DeleteUserProfileModelListRequest" + } + } }, - "type": { - "enum": [ - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "(REQUIRED) The classification of the error" - }, - "code": { - "type": "string", - "description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case." + "x-bodyName": "deleteUserProfileModels" + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { } + } }, - "instance": { - "type": "string", - "description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem" + "403": { + "description": "Forbidden", + "content": { + "application/json": { } + } + } + } + } + }, + "/preview/marketing-solutions/advertisers/{advertiserId}/user-profiles/set": { + "post": { + "tags": [ + "Audience" + ], + "description": "This endpoint will Set User Profiles for a given Advertiser. If a User Profile does not exist, a new one will be created. If a User Profile exists, it will be replaced.", + "operationId": "SetUserProfiles", + "parameters": [ + { + "name": "advertiserId", + "in": "path", + "description": "Criteo Advertiser ID of user profiles' owner", + "required": true, + "style": "simple", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/SetUserProfileModelListRequest" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetUserProfileModelListRequest" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SetUserProfileModelListRequest" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/SetUserProfileModelListRequest" + } + } }, - "title": { - "type": "string", - "description": "(RECOMMENDED) A short, human-readable summary of the problem type", - "nullable": true + "x-bodyName": "setUserProfileModels" + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { } + } }, - "detail": { - "type": "string", - "description": "(RECOMMENDED) A human-readable explanation specific to this occurrence of the problem", - "nullable": true + "403": { + "description": "Forbidden", + "content": { + "application/json": { } + } + } + } + } + } + }, + "components": { + "schemas": { + "ModifyAudienceResponse": { + "required": [ + "data", + "errors", + "warnings" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ContactlistOperation" }, - "source": { - "type": "object", - "description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)", - "nullable": true + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceError" + } }, - "stackTrace": { + "warnings": { "type": "array", "items": { - "type": "string" - }, - "description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology", - "nullable": true + "$ref": "#/components/schemas/AudienceWarning" + } } }, - "description": "Definition of an audience error" + "description": "Parameters to modify an audience" }, - "AudienceWarning": { + "DeleteAudienceContactListResponse": { "required": [ - "code", - "detail", - "instance", - "type" + "data", + "errors", + "warnings" ], "type": "object", "properties": { - "traceId": { - "type": "string", - "description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.", - "nullable": true - }, - "type": { - "enum": [ - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "(REQUIRED) The classification of the error" - }, - "code": { - "type": "string", - "description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case." - }, - "instance": { - "type": "string", - "description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem" - }, - "title": { - "type": "string", - "description": "(RECOMMENDED) A short, human-readable summary of the problem type", - "nullable": true - }, - "detail": { - "type": "string", - "description": "(REQUIRED) A human-readable explanation specific to this occurrence of the problem" + "data": { + "$ref": "#/components/schemas/BasicAudienceDefinition" }, - "source": { - "type": "object", - "description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)", - "nullable": true + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceError" + } }, - "stackTrace": { + "warnings": { "type": "array", "items": { - "type": "string" - }, - "description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology", - "nullable": true + "$ref": "#/components/schemas/AudienceWarning" + } } }, - "description": "Definition of the warning" + "description": "Response of a contactlist deletion" }, - "BasicAudienceDefinition": { + "ErrorCodeResponse": { "required": [ - "id", - "type" + "errors" ], "type": "object", "properties": { - "id": { - "type": "string", - "description": "the id of the entity type" - }, - "type": { - "type": "string", - "description": "the name of the entity type" + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceError" + } }, - "attributes": { - "$ref": "#/components/schemas/AudienceNameDescription" + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceWarning" + }, + "nullable": true } }, - "description": "Common definition of an audience" + "description": "Definition of the error code" }, - "ContactlistWithAttributesAmendment": { + "ContactlistWithAttributesAmendmentRequest": { "required": [ - "attributes", - "type" + "data" ], "type": "object", "properties": { - "type": { - "type": "string", - "description": "the name of the entity type", - "example": "ContactlistWithUserAttributesAmendment" - }, - "attributes": { - "required": [ - "identifiers", - "operation", - "identifierType" - ], - "type": "object", - "properties": { - "operation": { - "enum": [ - "add", - "remove" - ], - "type": "string", - "description": "Whether to add or remove users" - }, - "identifierType": { - "enum": [ - "email", - "madid", - "identityLink", - "gum", - "customerid", - "phoneNumber" - ], - "type": "string", - "description": "What type of identifiers are used", - "example": "email" - }, - "identifiers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserDef" + "data": { + "$ref": "#/components/schemas/ContactlistWithAttributesAmendment" + } + }, + "description": "Request for a contactlist amendment with user attributes", + "example": { + "data": { + "type": "ContactlistWithUserAttributesAmendment", + "attributes": { + "operation": "add", + "identifierType": "email", + "identifiers": [ + { + "identifier": "example1@gmail.com", + "attributes": [ + { + "key": "age", + "value": "12" + }, + { + "key": "country", + "value": "FR" + }, + { + "key": "size", + "value": "S" + } + ] }, - "description": "The users to add or remove, each in the schema specified, defined with attributes" - }, - "gumCallerId": { - "type": "object", - "description": "The Gum caller id of the advertiser patching identifiers of type Gum", - "nullable": true, - "readOnly": true - } - }, - "description": "the name of the entity type" + { + "identifier": "example2@gmail.com", + "attributes": [ + { + "key": "age", + "value": "43" + }, + { + "key": "preferredColor", + "value": "yellow" + } + ] + } + ] + } + } + } + }, + "ContactlistAmendmentRequest": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ContactlistAmendment" } }, - "description": "Parameters for a contactlist amendment with user attributes" + "description": "Request for a contactlist amendment" }, - "ContactlistAmendment": { + "ContactlistOperation": { "required": [ "attributes", "type" @@ -10809,160 +11571,73 @@ "properties": { "type": { "type": "string", - "description": "User List", - "example": "ContactlistAmendment" + "description": "the name of the entity type" }, "attributes": { "required": [ - "identifiers", "operation" ], "type": "object", "properties": { + "contactListId": { + "type": "integer", + "description": "the affected user list id", + "nullable": true + }, "operation": { - "enum": [ - "add", - "remove" - ], "type": "string", - "description": "Operation to add or remove users" + "description": "The action recorded" + }, + "requestDate": { + "type": "string", + "description": "When the action was recorded", + "format": "date-time", + "nullable": true }, "identifierType": { - "enum": [ - "email", - "madid", - "identityLink", - "gum", - "customerid", - "phoneNumber" - ], "type": "string", - "description": "What type of identifiers are used", + "description": "The schema specified for of the identifiers", "nullable": true }, - "identifiers": { + "nbValidIdentifiers": { + "type": "integer", + "description": "How many identifiers were valid for the specified schema", + "nullable": true + }, + "nbInvalidIdentifiers": { + "type": "integer", + "description": "How many identifiers were invalid for the specified schema", + "nullable": true + }, + "sampleInvalidIdentifiers": { "type": "array", "items": { "type": "string" }, - "description": "The users tos add or remove, each in the schema specified" - }, - "gumCallerId": { - "type": "integer", - "description": "The Gum caller id of the advertiser patching identifiers of type Gum", + "description": "A sample of invalid identifiers if there is some", "nullable": true } }, - "description": "the name of the entity type" - } - }, - "description": "Parameters for the amendment of a contactlist" - }, - "AudienceNameDescription": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name to designate the audience by", - "nullable": true - }, - "description": { - "type": "string", - "description": "The description of the audience", - "nullable": true - } - }, - "description": "Description of an audience with name and detailed description" - }, - "UserDef": { - "required": [ - "attributes", - "identifier" - ], - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attribute" - } + "description": "the contactlist operation attributes" } }, - "description": "User definition with an identifier (email, uid...) and attributes (key, value)" + "description": "Response definition of a contactlist operation" }, - "Attribute": { + "AudienceError": { "required": [ - "key", - "value" + "code", + "instance", + "type" ], - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "description": "User attribute definition under the form (key, value)" - }, - "ApplicationSummaryModelResponse": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ApplicationSummaryModelResource" - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true - } - }, - "description": "A top-level object that encapsulates a Criteo API response for a single value" - }, - "ApplicationSummaryModelResource": { - "type": "object", - "properties": { - "type": { - "type": "string", - "nullable": true - }, - "attributes": { - "$ref": "#/components/schemas/ApplicationSummaryModel" - } - }, - "description": "A top-level object that encapsulates a Criteo API response for a single value" - }, - "CommonProblem": { "type": "object", "properties": { "traceId": { "type": "string", - "description": "The request correlation ID this problem comes from.", - "nullable": true - }, - "traceIdentifier": { - "type": "string", - "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", + "description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.", "nullable": true }, "type": { "enum": [ - "unknown", "access-control", "authentication", "authorization", @@ -10972,247 +11647,297 @@ "validation" ], "type": "string", - "description": "The problem's category.", - "nullable": true + "description": "(REQUIRED) The classification of the error" }, "code": { "type": "string", - "description": "A machine-readable error code, expressed as a string value.", - "nullable": true + "description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case." }, "instance": { "type": "string", - "description": "A URI that identifies the specific occurrence of the problem.", - "nullable": true + "description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem" }, "title": { "type": "string", - "description": "A short human-readable description of the problem type", + "description": "(RECOMMENDED) A short, human-readable summary of the problem type", "nullable": true }, "detail": { "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem", + "description": "(RECOMMENDED) A human-readable explanation specific to this occurrence of the problem", "nullable": true }, "source": { "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", + "description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)", "nullable": true }, "stackTrace": { - "type": "string", - "nullable": true - } - }, - "description": "Common problem object." + "type": "array", + "items": { + "type": "string" + }, + "description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology", + "nullable": true + } + }, + "description": "Definition of an audience error" }, - "ApplicationSummaryModel": { + "AudienceWarning": { + "required": [ + "code", + "detail", + "instance", + "type" + ], "type": "object", "properties": { - "applicationId": { - "type": "integer", - "format": "int32", + "traceId": { + "type": "string", + "description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.", "nullable": true }, - "name": { + "type": { + "enum": [ + "access-control", + "authentication", + "authorization", + "availability", + "deprecation", + "quota", + "validation" + ], "type": "string", - "nullable": true + "description": "(REQUIRED) The classification of the error" }, - "organizationId": { - "type": "integer", - "format": "int32", - "nullable": true + "code": { + "type": "string", + "description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case." }, - "description": { + "instance": { "type": "string", - "nullable": true + "description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem" }, - "criteoService": { + "title": { "type": "string", + "description": "(RECOMMENDED) A short, human-readable summary of the problem type", "nullable": true - } - }, - "description": "Used for the /me endpoint. Contains information about the currently authenticated application that we accept to give to our clients" - }, - "AdSetAudienceLinkEntityV1Response": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdSetAudienceLinkEntityV1Resource" }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true + "detail": { + "type": "string", + "description": "(REQUIRED) A human-readable explanation specific to this occurrence of the problem" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true - } - }, - "description": "A top-level object that encapsulates a Criteo API response for a single entity" - }, - "AudienceSegmentEntityV1ListResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceSegmentEntityV1Resource" - }, + "source": { + "type": "object", + "description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)", "nullable": true }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true - } - }, - "description": "A top-level object that encapsulates a Criteo API response for several entities" - }, - "AudienceSegmentSizeEntityV1ListResponse": { - "type": "object", - "properties": { - "data": { + "stackTrace": { "type": "array", "items": { - "$ref": "#/components/schemas/AudienceSegmentSizeEntityV1Resource" + "type": "string" }, + "description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology", "nullable": true - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true } }, - "description": "A top-level object that encapsulates a Criteo API response for several entities" + "description": "Definition of the warning" }, - "AudienceSegmentIdEntityV1ListResponse": { + "BasicAudienceDefinition": { + "required": [ + "id", + "type" + ], "type": "object", "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceSegmentIdEntityV1Resource" - }, - "nullable": true + "id": { + "type": "string", + "description": "the id of the entity type" }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true + "type": { + "type": "string", + "description": "the name of the entity type" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true + "attributes": { + "$ref": "#/components/schemas/AudienceNameDescription" } }, - "description": "A top-level object that encapsulates a Criteo API response for several entities" + "description": "Common definition of an audience" }, - "AudienceSegmentSizeEstimationV1Response": { + "ContactlistWithAttributesAmendment": { + "required": [ + "attributes", + "type" + ], "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/AudienceSegmentSizeEstimationV1Resource" - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true + "type": { + "type": "string", + "description": "the name of the entity type", + "example": "ContactlistWithUserAttributesAmendment" }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" + "attributes": { + "required": [ + "identifiers", + "operation", + "identifierType" + ], + "type": "object", + "properties": { + "operation": { + "enum": [ + "add", + "remove" + ], + "type": "string", + "description": "Whether to add or remove users" + }, + "identifierType": { + "enum": [ + "email", + "madid", + "identityLink", + "gum", + "customerid", + "phoneNumber" + ], + "type": "string", + "description": "What type of identifiers are used", + "example": "email" + }, + "identifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserDef" + }, + "description": "The users to add or remove, each in the schema specified, defined with attributes" + }, + "gumCallerId": { + "type": "object", + "description": "The Gum caller id of the advertiser patching identifiers of type Gum", + "nullable": true, + "readOnly": true + } }, - "nullable": true, - "readOnly": true + "description": "the name of the entity type" } }, - "description": "A top-level object that encapsulates a Criteo API response for a single value" + "description": "Parameters for a contactlist amendment with user attributes" }, - "InMarketAudienceSegmentBrandEntityV1ListResponse": { + "ContactlistAmendment": { + "required": [ + "attributes", + "type" + ], "type": "object", "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InMarketAudienceSegmentBrandEntityV1Resource" - }, - "nullable": true - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" + "type": { + "type": "string", + "description": "User List", + "example": "ContactlistAmendment" + }, + "attributes": { + "required": [ + "identifiers", + "operation" + ], + "type": "object", + "properties": { + "operation": { + "enum": [ + "add", + "remove" + ], + "type": "string", + "description": "Operation to add or remove users" + }, + "identifierType": { + "enum": [ + "email", + "madid", + "identityLink", + "gum", + "customerid", + "phoneNumber" + ], + "type": "string", + "description": "What type of identifiers are used", + "nullable": true + }, + "identifiers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The users tos add or remove, each in the schema specified" + }, + "gumCallerId": { + "type": "integer", + "description": "The Gum caller id of the advertiser patching identifiers of type Gum", + "nullable": true + } }, - "nullable": true, - "readOnly": true + "description": "the name of the entity type" + } + }, + "description": "Parameters for the amendment of a contactlist" + }, + "AudienceNameDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name to designate the audience by", + "nullable": true }, - "errors": { + "description": { + "type": "string", + "description": "The description of the audience", + "nullable": true + } + }, + "description": "Description of an audience with name and detailed description" + }, + "UserDef": { + "required": [ + "attributes", + "identifier" + ], + "type": "object", + "properties": { + "identifier": { + "type": "string" + }, + "attributes": { "type": "array", "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true + "$ref": "#/components/schemas/Attribute" + } } }, - "description": "A top-level object that encapsulates a Criteo API response for several entities" + "description": "User definition with an identifier (email, uid...) and attributes (key, value)" }, - "InMarketAudienceSegmentInterestEntityV1ListResponse": { + "Attribute": { + "required": [ + "key", + "value" + ], + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "description": "User attribute definition under the form (key, value)" + }, + "ApplicationSummaryModelResponse": { "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InMarketAudienceSegmentInterestEntityV1Resource" - }, - "nullable": true + "$ref": "#/components/schemas/ApplicationSummaryModelResource" }, "warnings": { "type": "array", @@ -11231,45 +11956,117 @@ "readOnly": true } }, - "description": "A top-level object that encapsulates a Criteo API response for several entities" + "description": "A top-level object that encapsulates a Criteo API response for a single value" }, - "AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse": { + "ApplicationSummaryModelResource": { "type": "object", "properties": { - "meta": { - "$ref": "#/components/schemas/AudienceSegmentSearchMetadataV1" + "type": { + "type": "string", + "nullable": true }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AudienceSegmentEntityV1Resource" - }, + "attributes": { + "$ref": "#/components/schemas/ApplicationSummaryModel" + } + }, + "description": "A top-level object that encapsulates a Criteo API response for a single value" + }, + "CommonProblem": { + "type": "object", + "properties": { + "traceId": { + "type": "string", + "description": "The request correlation ID this problem comes from.", "nullable": true }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" - }, - "nullable": true, - "readOnly": true + "traceIdentifier": { + "type": "string", + "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", + "nullable": true }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CommonProblem" + "type": { + "enum": [ + "unknown", + "access-control", + "authentication", + "authorization", + "availability", + "deprecation", + "quota", + "validation" + ], + "type": "string", + "description": "The problem's category.", + "nullable": true + }, + "code": { + "type": "string", + "description": "A machine-readable error code, expressed as a string value.", + "nullable": true + }, + "instance": { + "type": "string", + "description": "A URI that identifies the specific occurrence of the problem.", + "nullable": true + }, + "title": { + "type": "string", + "description": "A short human-readable description of the problem type", + "nullable": true + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem", + "nullable": true + }, + "source": { + "type": "object", + "additionalProperties": { + "type": "string" }, - "nullable": true, - "readOnly": true + "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", + "nullable": true + }, + "stackTrace": { + "type": "string", + "nullable": true } }, - "description": "A top-level object that encapsulates a Criteo API response for several entities and metadata" + "description": "Common problem object." }, - "ContactListStatisticsEntityV1Response": { + "ApplicationSummaryModel": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "organizationId": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "criteoService": { + "type": "string", + "nullable": true + } + }, + "description": "Used for the /me endpoint. Contains information about the currently authenticated application that we accept to give to our clients" + }, + "AdSetAudienceLinkEntityV1Response": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ContactListStatisticsEntityV1Resource" + "$ref": "#/components/schemas/AdSetAudienceLinkEntityV1Resource" }, "warnings": { "type": "array", @@ -11290,13 +12087,13 @@ }, "description": "A top-level object that encapsulates a Criteo API response for a single entity" }, - "AudienceEntityV1ListResponse": { + "AudienceSegmentEntityV1ListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AudienceEntityV1Resource" + "$ref": "#/components/schemas/AudienceSegmentEntityV1Resource" }, "nullable": true }, @@ -11319,13 +12116,13 @@ }, "description": "A top-level object that encapsulates a Criteo API response for several entities" }, - "AudienceSizeEntityV1ListResponse": { + "AudienceSegmentSizeEntityV1ListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AudienceSizeEntityV1Resource" + "$ref": "#/components/schemas/AudienceSegmentSizeEntityV1Resource" }, "nullable": true }, @@ -11348,13 +12145,13 @@ }, "description": "A top-level object that encapsulates a Criteo API response for several entities" }, - "AudienceIdEntityV1ListResponse": { + "AudienceSegmentIdEntityV1ListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AudienceIdEntityV1Resource" + "$ref": "#/components/schemas/AudienceSegmentIdEntityV1Resource" }, "nullable": true }, @@ -11377,11 +12174,11 @@ }, "description": "A top-level object that encapsulates a Criteo API response for several entities" }, - "AudienceSizeEstimationV1Response": { + "AudienceSegmentSizeEstimationV1Response": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AudienceSizeEstimationV1Resource" + "$ref": "#/components/schemas/AudienceSegmentSizeEstimationV1Resource" }, "warnings": { "type": "array", @@ -11402,10 +12199,237 @@ }, "description": "A top-level object that encapsulates a Criteo API response for a single value" }, - "AudienceEntityV1AudienceSearchMetadataV1ListResponse": { + "InMarketAudienceSegmentBrandEntityV1ListResponse": { "type": "object", "properties": { - "meta": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InMarketAudienceSegmentBrandEntityV1Resource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for several entities" + }, + "InMarketAudienceSegmentInterestEntityV1ListResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InMarketAudienceSegmentInterestEntityV1Resource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for several entities" + }, + "AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse": { + "type": "object", + "properties": { + "meta": { + "$ref": "#/components/schemas/AudienceSegmentSearchMetadataV1" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceSegmentEntityV1Resource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for several entities and metadata" + }, + "ContactListStatisticsEntityV1Response": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ContactListStatisticsEntityV1Resource" + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for a single entity" + }, + "AudienceEntityV1ListResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceEntityV1Resource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for several entities" + }, + "AudienceSizeEntityV1ListResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceSizeEntityV1Resource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for several entities" + }, + "AudienceIdEntityV1ListResponse": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AudienceIdEntityV1Resource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for several entities" + }, + "AudienceSizeEstimationV1Response": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AudienceSizeEstimationV1Resource" + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "description": "A top-level object that encapsulates a Criteo API response for a single value" + }, + "AudienceEntityV1AudienceSearchMetadataV1ListResponse": { + "type": "object", + "properties": { + "meta": { "$ref": "#/components/schemas/AudienceSearchMetadataV1" }, "data": { @@ -16381,126 +17405,109 @@ }, "description": "Size entity containing width and height of the creative" }, - "ProblemsDetails": { + "Outcome": { "type": "object", "properties": { + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, "errors": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Errors that occured during this call.", "nullable": true, "readOnly": true } }, - "description": "Common problems object" + "additionalProperties": false, + "description": "The outcome of an API call." }, - "TransparencyReportDataMessage": { - "required": [ - "data" - ], + "TransparencyReportListResponse": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransparencyReportEntityMessage" - } - } - }, - "description": "This is the message defining the response for Transparency report" - }, - "MarketingSolutionsReportStatusResponse": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatusResource" + "$ref": "#/components/schemas/TransparencyReportResource" + }, + "nullable": true }, "warnings": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Warnings that occured during this call.", "nullable": true, "readOnly": true }, "errors": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, + "description": "Errors that occured during this call.", "nullable": true, "readOnly": true } }, - "description": "A top-level object that encapsulates a Criteo API response for a single entity" + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several value objects." }, - "ReportDataMessage": { - "required": [ - "data" - ], + "JsonReportRowsListResponse": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ReportEntityMessage" - } - } - }, - "description": "This is the message defining the json report data" - }, - "ExportResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ExportResultData" + "$ref": "#/components/schemas/JsonReportRowsResource" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Errors that occured during this call.", + "nullable": true, + "readOnly": true } }, - "description": "Result for an async report request" + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several value objects." }, - "GenerateCategoriesReportRequest": { - "required": [ - "data" - ], + "GenerateCategoriesReportRequestAttributesRequest": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GenerateCategoriesReportRequestData" + "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributesResource" } }, - "description": "Contains queries for Categories report", - "example": { - "data": { - "type": "CategoriesReport", - "attributes": { - "advertiserIds": [ - "123", - "456", - "789" - ], - "campaignId": "111", - "adsetId": "135", - "domain": "example.com", - "category": "Example", - "shouldDisplayDomainDimension": true, - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-03T00:00:00.0000000+00:00" - } - } - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for a single value objects." }, "TransparencyQueryMessage": { "required": [ - "startDate", - "endDate" + "endDate", + "startDate" ], "type": "object", "properties": { @@ -16521,320 +17528,51 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Transparency report", - "example": { - "shouldDisplayProductIds": false, - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Transparency report" }, - "PlacementsReportQueryDataMessage": { - "required": [ - "data" - ], + "PlacementsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/PlacementsReportQueryEntityMessage" - } - } - }, - "description": "Contains queries for Placements report", - "example": { - "data": [ - { - "type": "PlacementReport", - "attributes": { - "advertiserIds": "123,456,789", - "campaignIds": "111,222,333,444", - "adsetIds": "135,246,357,468", - "environment": "web", - "placement": "MyPlacement", - "dimensions": [ - "AdsetId", - "AdvertiserId", - "Placement" - ], - "metrics": [ - "clicks", - "displays", - "cost" - ], - "currency": "EUR", - "disclosed": false, - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-08-29T00:00:00.0000000+00:00" - } - } - ] - } - }, - "GenerateAudiencePerformanceReportRequest": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequestData" - } - }, - "description": "Request for async audience performance report", - "example": { - "data": { - "type": "AudiencePerformanceReport", - "attributes": { - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00", - "advertiserId": "11111", - "timezone": "Europe/Paris", - "dimension": "Top30BrandsByClicks", - "metrics": [ - "Clicks", - "Displays", - "Visits" - ], - "currency": "EUR", - "adSetIds": [ - "12345", - "54321" - ], - "audienceIds": [ - "12345", - "54321" - ], - "segmentsIds": [ - "12345", - "54321" - ] - } - } - } - }, - "GenerateStatisticsReportRequest": { - "required": [ - "data" - ], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GenerateStatisticsReportRequestData" + "$ref": "#/components/schemas/PlacementsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Request for async statistics report", - "example": { - "data": { - "type": "StatisticsReport", - "attributes": { - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00", - "advertiserIds": [ - "11111" - ], - "timezone": "Europe/Paris", - "dimensions": [ - "CampaignId", - "Campaign", - "AdSetId", - "AdSet", - "AdvertiserId", - "Advertiser", - "AdId", - "Ad", - "CouponId", - "Coupon", - "CategoryId", - "Category", - "Hour", - "Day", - "Week", - "Month", - "Year", - "Os", - "Device", - "MarketingCampaignGoal", - "MarketingObjective", - "MarketingObjectiveId", - "VideoPlacement", - "VideoPlaybackMethod", - "VideoPlayerSize", - "VideoDurationInSeconds", - "SSP" - ], - "metrics": [ - "Clicks", - "Displays", - "Cpc", - "Visits" - ], - "currency": "EUR", - "adSetIds": [ - "12345", - "54321" - ], - "adSetNames": [ - "myAdSet1", - "myAdSet2" - ], - "adSetStatus": [ - "Active" - ] - } - } - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, - "GenerateCreativesReportRequest": { - "required": [ - "data" - ], + "GenerateCreativesReportRequestAttributesRequest": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GenerateCreativesReportRequestData" + "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributesResource" } }, - "description": "Contains queries for Creatives report", - "example": { - "data": { - "type": "CreativesReport", - "attributes": { - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-06T00:00:00.0000000+00:00", - "advertiserIds": [ - "6666", - "7777" - ], - "metrics": [ - "Clicks", - "Ctr", - "Displays" - ], - "dimensions": [ - "SizeCategory", - "DisplaySize", - "AdFormat", - "Coupon", - "CouponId", - "Ad", - "AdId", - "Day", - "Hour" - ], - "timezone": "Europe/Paris", - "adFormats": [ - "Dynamic", - "Other formats" - ], - "displaySizes": [ - "LeaderBoard", - "LargeBanner" - ], - "couponNames": [ - "a coupon name" - ], - "couponIds": [ - "3333", - "5555" - ], - "adNames": [ - "Ad by Criteo team" - ], - "adIds": [ - "2222" - ], - "campaignIds": [ - "1111" - ], - "adSetIds": [ - "2222", - "3333" - ], - "adSetStatus": [ - "Active", - "NotRunning" - ] - } - } - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for a single value objects." }, - "GenerateTopProductsReportRequest": { - "required": [ - "data" - ], + "GenerateTopProductsReportRequestAttributesRequest": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GenerateTopProductsReportRequestData" + "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributesResource" } }, - "description": "Contains queries for topProducts report", - "example": { - "data": { - "type": "TopProductsReport", - "attributes": { - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-09-01T00:00:00.0000000+00:00", - "advertiserId": "1234", - "limit": 200, - "rankProductsBy": "Clicks", - "dimensions": [ - "CampaignId", - "Campaign", - "AdSetId", - "AdSet", - "ProductId", - "Product", - "ProductUrl", - "Brand", - "Category" - ], - "metrics": [ - "Clicks", - "Ctr", - "Visits", - "Sales", - "Cost", - "Revenue", - "Displays" - ], - "currency": "EUR", - "brands": [ - "Brand1", - "Brand2" - ], - "categoryIds": [ - "6666", - "7777" - ], - "campaignIds": [ - "9999" - ], - "adSetIds": [ - "11111", - "22222" - ], - "adSetStatus": [ - "Active", - "NotRunning" - ] - } - } - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for a single value objects." }, "StatisticsReportQueryMessage": { "required": [ - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -16844,7 +17582,6 @@ "nullable": true }, "adSetIds": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -16853,7 +17590,6 @@ "nullable": true }, "adSetNames": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -16862,7 +17598,6 @@ "nullable": true }, "adSetStatus": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -16871,7 +17606,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -16898,14 +17632,15 @@ "MarketingObjective", "ChannelId", "Channel", - "Goal" + "Goal", + "AdChannel", + "SocialPlatform" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -16937,337 +17672,133 @@ "format": "date-time" } }, - "description": "This is the message defining the query for Adset report", - "example": { - "advertiserIds": "123,456,789", - "adSetIds": [ - "12345", - "54321" - ], - "adSetNames": [ - "myAdSet1", - "myAdSet2" - ], - "adSetStatus": [ - "Active" - ], - "dimensions": [ - "CampaignId", - "Campaign", - "AdsetId", - "Adset", - "AdvertiserId", - "Advertiser", - "AdId", - "Ad", - "CouponId", - "Coupon", - "CategoryId", - "Category", - "Hour", - "Day", - "Week", - "Month", - "Year", - "Os", - "Device" - ], - "metrics": [ - "Clicks", - "Displays", - "Cpc", - "Visits" - ], - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2022-08-29T00:00:00.0000000+00:00", - "endDate": "2022-09-01T00:00:00.0000000+00:00" - } + "additionalProperties": false, + "description": "This is the message defining the query for Adset report" }, - "TransactionsReportQueryDataMessage": { - "required": [ - "data" - ], + "TransactionsReportQueryMessageListRequest": { "type": "object", "properties": { "data": { - "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/TransactionsReportQueryEntityMessage" - } + "$ref": "#/components/schemas/TransactionsReportQueryMessageResource" + }, + "nullable": true } }, - "description": "Contains queries for Transactions report", - "example": { - "data": [ - { - "type": "TransactionsReport", - "attributes": { - "advertiserIds": "123,456,789", - "eventType": "display", - "currency": "EUR", - "format": "csv", - "timezone": "Europe/Paris", - "startDate": "2023-04-03T00:00:00.0000000+00:00", - "endDate": "2023-04-03T00:00:00.0000000+00:00" - } - } - ] - } + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several value objects." }, - "ProblemDetails": { + "TransparencyReportResource": { "type": "object", "properties": { - "traceId": { + "type": { "type": "string", - "description": "The request correlation ID this problem comes from.", + "description": "Type of the resource.", "nullable": true }, - "traceIdentifier": { - "type": "string", - "description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)", - "nullable": true - }, - "type": { - "enum": [ - "unknown", - "access-control", - "authentication", - "authorization", - "availability", - "deprecation", - "quota", - "validation" - ], - "type": "string", - "description": "The problem's category.", - "nullable": true - }, - "code": { - "type": "string", - "description": "A machine-readable error code, expressed as a string value.", - "nullable": true - }, - "instance": { - "type": "string", - "description": "A URI that identifies the specific occurrence of the problem.", - "nullable": true - }, - "title": { - "type": "string", - "description": "A short human-readable description of the problem type", - "nullable": true - }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem", - "nullable": true - }, - "source": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "A machine-readable structure to reference to the exact location(s) causing the error(s)", - "nullable": true - }, - "stackTrace": { - "type": "string", - "nullable": true - } - }, - "description": "Common problem object." - }, - "TransparencyReportEntityMessage": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "readOnly": true - }, "attributes": { - "$ref": "#/components/schemas/TransparencyReportAttributes" + "$ref": "#/components/schemas/TransparencyReport" } }, - "description": "This is the message defining the entity response for Transparency report" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "MarketingSolutionsReportStatusResource": { + "JsonReportRowsResource": { "type": "object", "properties": { - "attributes": { - "$ref": "#/components/schemas/MarketingSolutionsReportStatus" - }, - "id": { - "type": "string", - "nullable": true - }, "type": { "type": "string", + "description": "Type of the resource.", "nullable": true - } - }, - "description": "A class that represents a domain entity exposed by an API" - }, - "ReportEntityMessage": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" }, "attributes": { "$ref": "#/components/schemas/JsonReportRows" } }, - "description": "This is the message defining the json report entity" - }, - "ExportResultData": { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/ExportMetaData" - }, - "data": { - "uniqueItems": false, - "type": "array", - "items": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "object" - } - }, - "nullable": true - } - }, - "description": "Result data for an async report request" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "GenerateCategoriesReportRequestData": { - "required": [ - "type", - "attributes" - ], + "GenerateCategoriesReportRequestAttributesResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/GenerateCategoriesReportRequestAttributes" } }, - "description": "Contains a query for Categories report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "PlacementsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], + "PlacementsReportQueryMessageResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/PlacementsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" - }, - "GenerateAudiencePerformanceReportRequestData": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/GenerateAudiencePerformanceReportRequestAttributes" - } - }, - "description": "Request data for async audience performance report" - }, - "GenerateStatisticsReportRequestData": { - "required": [ - "type", - "attributes" - ], - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/GenerateStatisticsReportRequestAttributes" - } - }, - "description": "Request data for async statistics report" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "GenerateCreativesReportRequestData": { - "required": [ - "type", - "attributes" - ], + "GenerateCreativesReportRequestAttributesResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/GenerateCreativesReportRequestAttributes" } }, - "description": "Contains a query for Creatives report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "GenerateTopProductsReportRequestData": { - "required": [ - "type", - "attributes" - ], + "GenerateTopProductsReportRequestAttributesResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/GenerateTopProductsReportRequestAttributes" } }, - "description": "Contains a query for TopProducts report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransactionsReportQueryEntityMessage": { - "required": [ - "type", - "attributes" - ], + "TransactionsReportQueryMessageResource": { "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "Type of the resource.", + "nullable": true }, "attributes": { "$ref": "#/components/schemas/TransactionsReportQueryMessage" } }, - "description": "Contains a query for Transaction report and its type" + "additionalProperties": false, + "description": "A value resource exposed by the API." }, - "TransparencyReportAttributes": { + "TransparencyReport": { "required": [ "advertiserId", - "tokenValidUntil", - "files" + "files", + "tokenValidUntil" ], "type": "object", "properties": { @@ -17279,48 +17810,19 @@ "format": "date-time" }, "files": { - "uniqueItems": false, "type": "array", "items": { "$ref": "#/components/schemas/TransparencyReportFile" } } }, + "additionalProperties": false, "description": "This is the message defining the attribute response for Transparency report" }, - "MarketingSolutionsReportStatus": { - "type": "object", - "properties": { - "status": { - "enum": [ - "Unknown", - "Pending", - "Done", - "Failure", - "Expired" - ], - "type": "string", - "nullable": true - }, - "message": { - "type": "string", - "nullable": true - }, - "id": { - "type": "string", - "nullable": true - } - }, - "description": "Object containing the status of report request and an associated message.", - "x-criteo-canonical": { - "infoType": "entity" - } - }, "JsonReportRows": { "type": "object", "properties": { "rows": { - "uniqueItems": false, "type": "array", "items": { "type": "object", @@ -17331,38 +17833,19 @@ "nullable": true } }, + "additionalProperties": false, "description": "This is the message defining the json report rows" }, - "ExportMetaData": { - "type": "object", - "properties": { - "columns": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/components/schemas/ExportColumn" - }, - "nullable": true - }, - "rows": { - "type": "integer", - "format": "int32", - "nullable": true - } - }, - "description": "Metadata for an async report request: descriptions of the columns and number of rows returned" - }, "GenerateCategoriesReportRequestAttributes": { "required": [ "advertiserIds", + "endDate", "format", - "startDate", - "endDate" + "startDate" ], "type": "object", "properties": { "advertiserIds": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -17416,17 +17899,18 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Categories report" }, "PlacementsReportQueryMessage": { "required": [ "advertiserIds", - "dimensions", - "metrics", "currency", + "dimensions", + "endDate", "format", - "startDate", - "endDate" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -17455,7 +17939,6 @@ "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ @@ -17466,14 +17949,17 @@ "AdsetName", "AdvertiserName", "CampaignId", - "CampaignName" + "CampaignName", + "AdChannel", + "SocialPlatform", + "CategoryId", + "CategoryName" ], "type": "string" }, "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -17511,15 +17997,16 @@ "format": "date-time" } }, + "additionalProperties": false, "description": "This is the message defining the query for Placements report" }, - "GenerateAudiencePerformanceReportRequestAttributes": { + "GenerateCreativesReportRequestAttributes": { "required": [ - "startDate", + "advertiserIds", + "dimensions", "endDate", - "advertiserId", - "dimension", - "metrics" + "metrics", + "startDate" ], "type": "object", "properties": { @@ -17533,90 +18020,139 @@ "description": "End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", "format": "date-time" }, - "advertiserId": { - "type": "string", - "description": "The advertiser id" - }, - "timezone": { - "type": "string", - "description": "The timezone used for the report. Timezone Database format (Tz).", - "nullable": true - }, - "dimension": { - "enum": [ - "AdvertiserId", - "Advertiser", - "Top30BrandsByDisplays", - "Top30BrandsByClicks", - "Top30BrandsBySales", - "Top30InterestsByDisplays", - "Top30InterestsByClicks", - "Top30InterestsBySales" - ], - "type": "string", - "description": "The dimension for the report." + "advertiserIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of client ids." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "enum": [ "Clicks", - "Displays", - "Visits", - "Sales", - "Revenue", - "CostPerVisit", - "ExposedUsers" + "Ctr", + "Displays" ], "type": "string" }, "description": "The list of metrics to report." }, - "currency": { + "dimensions": { + "type": "array", + "items": { + "enum": [ + "AdFormat", + "Coupon", + "CouponId", + "DisplaySize", + "SizeCategory", + "Ad", + "AdId", + "Day", + "Hour" + ], + "type": "string" + }, + "description": "The list of dimensions to report." + }, + "timezone": { "type": "string", - "description": "The currency used for the report. ISO 4217 code (three-letter capitals).", + "description": "The timezone used for the report. Timezone Database format (Tz).", "nullable": true }, - "adSetIds": { - "uniqueItems": false, + "adFormats": { "type": "array", "items": { "type": "string" }, - "description": "The list of adSets ids. If empty, all the adSets will be fetched.", + "description": "The list of adFormats.", "nullable": true }, - "audienceIds": { - "uniqueItems": false, + "displaySizes": { "type": "array", "items": { "type": "string" }, - "description": "The list of Audiences ids. If empty, all the Audiences will be fetched.", + "description": "The list of displaySizes.", "nullable": true }, - "segmentsIds": { - "uniqueItems": false, + "couponNames": { "type": "array", "items": { "type": "string" }, - "description": "The list of Segments ids. If empty, all the segments will be fetched.", + "description": "The list of coupon names.", + "nullable": true + }, + "couponIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of coupon ids.", + "nullable": true + }, + "adNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of ad names.", + "nullable": true + }, + "adIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of ad ids.", + "nullable": true + }, + "campaignIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of campaign ids (marketing campaign ids).", + "nullable": true + }, + "adSetIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of adSet ids (campaign ids).", + "nullable": true + }, + "adSetStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of adSet status (ex: 'Active','NotRunning').", "nullable": true } }, - "description": "Request attributes for async audience performance report" + "additionalProperties": false, + "description": "This is the message defining the query for Creatives report" }, - "GenerateStatisticsReportRequestAttributes": { + "GenerateTopProductsReportRequestAttributes": { "required": [ - "startDate", + "advertiserId", "endDate", - "dimensions", - "metrics" + "rankProductsBy", + "startDate" ], "type": "object", "properties": { + "timezone": { + "type": "string", + "description": "The timezone used for the report. Timezone Database format (Tz).", + "default": "UTC", + "nullable": true + }, "startDate": { "type": "string", "description": "Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", @@ -17627,387 +18163,352 @@ "description": "End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", "format": "date-time" }, - "advertiserIds": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The of advertiser ids", + "advertiserId": { + "type": "string", + "description": "The client id." + }, + "limit": { + "type": "integer", + "description": "The maximum number of top products returned.", + "format": "int32", "nullable": true }, - "timezone": { + "rankProductsBy": { + "enum": [ + "Clicks", + "Displays", + "Sales" + ], "type": "string", - "description": "The timezone used for the report. Timezone Database format (Tz).", - "nullable": true + "description": "The metric used to filter the top products." }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ - "AdvertiserId", - "Advertiser", - "CampaignId", "Campaign", - "AdSetId", + "CampaignId", "AdSet", - "ChannelId", - "Channel", - "CategoryId", + "AdSetId", + "Product", + "ProductId", "Category", - "Device", - "Os", - "AdId", - "Ad", - "CouponId", - "Coupon", - "Year", - "Month", - "Week", - "Day", - "Hour", - "MarketingCampaignGoal", - "MarketingObjective", - "MarketingObjectiveId", - "VideoPlayerSize", - "VideoPlacement", - "VideoPlaybackMethod", - "SSP", - "VideoDurationInSeconds", - "MediaType", - "AdFormat", - "DisplaySize", - "VideoPlayerRatio", - "Country", - "Region", - "PostalCode", - "UserBehavior", - "Environment", - "AdChannel", - "AdSocialNetwork" + "CategoryId", + "Advertiser", + "AdvertiserId", + "ProductUrl", + "Brand" ], "type": "string" }, - "description": "The dimensions for the report." + "description": "The dimensions for the report.", + "nullable": true }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "enum": [ "Clicks", - "Displays", - "AdvertiserCost", - "SalesPc30dClientAttribution", - "SalesAllPc30dClientAttribution", - "SalesClientAttribution", - "SalesAllClientAttribution", - "SalesPc30d", - "SalesAllPc30d", - "SalesPc1d", - "SalesAllPc1d", - "SalesPc7d", - "SalesAllPc7d", - "SalesPc7dPv24", - "SalesAllPc7dPv24", - "SalesPc7dPv24h", - "SalesAllPc7dPv24h", - "SalesPv24h", - "SalesAllPv24h", - "SalesPc30Pv24", - "SalesAllPc30Pv24", - "SalesPc30dPv24h", - "SalesAllPc30dPv24h", - "SalesPiPc", - "SalesPiPv", - "SalesPiPcPv", - "PostInstallSales", - "SalesOfflinePc", - "SalesOfflinePv", - "SalesOfflinePc30d", - "SalesOfflinePv24h", - "RevenueGeneratedPc30dClientAttribution", - "RevenueGeneratedAllPc30dClientAttribution", - "RevenueGeneratedClientAttribution", - "RevenueGeneratedAllClientAttribution", - "RevenueGeneratedPc30d", - "RevenueGeneratedAllPc30d", - "RevenueGeneratedPc1d", - "RevenueGeneratedAllPc1d", - "RevenueGeneratedPc7d", - "RevenueGeneratedAllPc7d", - "RevenueGeneratedPv24h", - "RevenueGeneratedAllPv24h", - "RevenueGeneratedPc30Pv24", - "RevenueGeneratedAllPc30Pv24", - "RevenueGeneratedPc30dPv24h", - "RevenueGeneratedAllPc30dPv24h", - "RevenueGeneratedPc7dPv24h", - "RevenueGeneratedAllPc7dPv24h", - "RevenueGeneratedPc7dPv24", - "RevenueGeneratedAllPc7dPv24", - "RevenueGeneratedOfflinePc", - "RevenueGeneratedOfflinePv", - "RevenueGeneratedOfflinePc30d", - "RevenueGeneratedOfflinePv24h", - "ConversionRatePc30dClientAttribution", - "ConversionRateAllPc30dClientAttribution", - "ConversionRateClientAttribution", - "ConversionRateAllClientAttribution", - "ConversionRatePc30d", - "ConversionRateAllPc30d", - "ConversionRatePc1d", - "ConversionRateAllPc1d", - "ConversionRatePc7d", - "ConversionRateAllPc7d", - "ConversionRatePv24h", - "ConversionRateAllPv24h", - "ConversionRatePc30Pv24", - "ConversionRateAllPc30Pv24", - "ConversionRatePc30dPv24h", - "ConversionRateAllPc30dPv24h", - "ConversionRatePc7dPv24", - "ConversionRateAllPc7dPv24", - "ConversionRatePc7dPv24h", - "ConversionRateAllPc7dPv24h", - "ConversionRatePiPcPv", - "PostInstallConversionRate", - "ECosPc30dClientAttribution", - "ECosAllPc30dClientAttribution", - "ECosClientAttribution", - "ECosAllClientAttribution", - "ECosPc30d", - "ECosAllPc30d", - "ECosPc1d", - "ECosAllPc1d", - "ECosPc7d", - "ECosAllPc7d", - "ECosPv24h", - "ECosAllPv24h", - "ECosPc30Pv24", - "ECosAllPc30Pv24", - "ECosPc30dPv24h", - "ECosAllPc30dPv24h", - "ECosPc7dPv24h", - "ECosAllPc7dPv24h", - "ECosPc7dPv24", - "ECosAllPc7dPv24", - "CostPerOrderPc30dClientAttribution", - "CostPerOrderAllPc30dClientAttribution", - "CostPerOrderClientAttribution", - "CostPerOrderAllClientAttribution", - "CostPerOrderPc30d", - "CostPerOrderAllPc30d", - "CostPerOrderPc1d", - "CostPerOrderAllPc1d", - "CostPerOrderPc7d", - "CostPerOrderAllPc7d", - "CostPerOrderPv24h", - "CostPerOrderAllPv24h", - "CostPerOrderPc30Pv24", - "CostPerOrderAllPc30Pv24", - "CostPerOrderPc30dPv24h", - "CostPerOrderAllPc30dPv24h", - "CostPerOrderPc7dPv24h", - "CostPerOrderAllPc7dPv24h", - "CostPerOrderPc7dPv24", - "CostPerOrderAllPc7dPv24", - "ExposedUsers", - "Audience", - "Reach", - "AverageCartPc30dClientAttribution", - "AverageCartAllPc30dClientAttribution", - "AverageCartClientAttribution", - "AverageCartAllClientAttribution", - "AverageCartPc30d", - "AverageCartAllPc30d", - "AverageCartPv24h", - "AverageCartAllPv24h", - "AverageCartPc1d", - "AverageCartAllPc1d", - "AverageCartPc7d", - "AverageCartAllPc7d", - "AverageCartPc30Pv24", - "AverageCartAllPc30Pv24", - "AverageCartPc30dPv24h", - "AverageCartAllPc30dPv24h", - "AverageCartPc7dPv24h", - "AverageCartAllPc7dPv24h", - "AverageCartPc7dPv24", - "AverageCartAllPc7dPv24", - "ClickThroughRate", - "ECpc", - "Cpc", - "ECpm", - "ReturnOnAdvertisingSpendingClientAttribution", - "ReturnOnAdvertisingSpendingAllClientAttribution", - "AdvertiserValue", - "AdvertiserAllValue", - "CostOfAdvertiserValue", - "CostOfAdvertiserValueAll", - "AppInstallsPcPv", - "AppInstalls", - "QualifiedVisits", + "Ctr", "Visits", - "OrderValuePi", - "PostInstallOrderValue", - "BounceRate", - "CostPerInstallPcPv", - "CostPerInstall", - "CostPerVisit", - "InstallRatePcPv", - "InstallRate", - "OmniChannelRoasPc30d", - "OmnichannelRoasAllPc30d", - "OmniChannelRevenuePc30d", - "OmnichannelRevenueAllPc30d", - "OmniChannelSalesPc30d", - "OmnichannelSalesAllPc30d", - "OmnichannelRoasAllPv24h", - "OmnichannelRoasPv24h", - "OmnichannelRevenueAllPv24h", - "OmnichannelRevenuePv24h", - "OmnichannelSalesAllPv24h", - "OmnichannelSalesPv24h", - "OmnichannelRoasClientAttribution", - "OmnichannelRevenueClientAttribution", - "OmnichannelSalesClientAttribution", - "RoasAllPc30dClientAttribution", - "RoasPc30dClientAttribution", - "RoasAllClientAttribution", - "RoasClientAttribution", - "RoasAllPc30d", - "RoasPc30d", - "RoasAllPc7d", - "RoasPc7d", - "RoasAllPc1d", - "RoasPc1d", - "RoasAllPv24h", - "RoasPv24h", - "RoasPc30Pv24", - "RoasAllPc30Pv24", - "RoasPc30dPv24h", - "RoasAllPc30dPv24h", - "RoasPc7dPv24", - "RoasAllPc7dPv24", - "RoasPc7dPv24h", - "RoasAllPc7dPv24h", - "CostOfSalePi", - "CostPerOrderPi", - "PostInstallCostOfSale", - "PostInstallCostPerOrder", - "ReturnOnAdvertiserSpendingPi", - "PostInstallRoas", - "ReturnOnAdvertiserSpendingOfflinePc", - "ReturnOnAdvertiserSpendingOfflinePv", - "RoasOfflinePc30d", - "RoasOfflinePv24h", - "PotentialDisplays", - "OverallCompetitionWin", - "ViewableDisplays", - "NonViewableDisplays", - "UntrackableDisplays", - "Frequency", - "InvalidClicks", - "InvalidDisplays", - "ResultType", - "CostPerQualifiedVisit", - "CostPerVisitPV1D", - "VisitsPV1D", - "AssistsPc30dClientAttribution", - "AssistsAllPc30dClientAttribution", - "AssistsClientAttribution", - "AssistsAllClientAttribution", - "AssistsPc30d", - "AssistsAllPc30d", - "AssistsPc1d", - "AssistsAllPc1d", - "AssistsPc7d", - "AssistsAllPc7d", - "AssistsPc7dPv24", - "AssistsAllPc7dPv24", - "AssistsPc7dPv24h", - "AssistsAllPc7dPv24h", - "AssistsPv24h", - "AssistsAllPv24h", - "AssistsPc30Pv24", - "AssistsAllPc30Pv24", - "AssistsPc30dPv24h", - "AssistsAllPc30dPv24h", - "AssistsPiPc", - "AssistsPiPv", - "AssistsPiPcPv", - "AssistsSalesRatioPc30dClientAttribution", - "AssistsSalesRatioAllPc30dClientAttribution", - "AssistsSalesRatioClientAttribution", - "AssistsSalesRatioAllClientAttribution", - "AssistsSalesRatioPc30d", - "AssistsSalesRatioAllPc30d", - "AssistsSalesRatioPc1d", - "AssistsSalesRatioAllPc1d", - "AssistsSalesRatioPc7d", - "AssistsSalesRatioAllPc7d", - "AssistsSalesRatioPc7dPv24", - "AssistsSalesRatioAllPc7dPv24", - "AssistsSalesRatioPc7dPv24h", - "AssistsSalesRatioAllPc7dPv24h", - "AssistsSalesRatioPv24h", - "AssistsSalesRatioAllPv24h", - "AssistsSalesRatioPc30Pv24", - "AssistsSalesRatioAllPc30Pv24", - "AssistsSalesRatioPc30dPv24h", - "AssistsSalesRatioAllPc30dPv24h", - "AssistsSalesRatioPiPc", - "AssistsSalesRatioPiPv", - "AssistsSalesRatioPiPcPv" + "Sales", + "Cost", + "Revenue", + "Displays" ], "type": "string" }, - "description": "The list of metrics to report." + "description": "The list of metrics to report.", + "nullable": true + }, + "currency": { + "type": "string", + "description": "The currency used for the report. ISO 4217 code (three-letter capitals).", + "default": "EUR", + "nullable": true + }, + "brands": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of brands names.", + "nullable": true + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of category ids.", + "nullable": true + }, + "campaignIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of campaign ids.", + "nullable": true + }, + "adSetIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of adSet ids.", + "nullable": true + }, + "adSetStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of adSet status (ex: 'Active','NotRunning').", + "nullable": true + } + }, + "additionalProperties": false, + "description": "This is the message defining the query for TopProducts report" + }, + "TransactionsReportQueryMessage": { + "required": [ + "currency", + "endDate", + "format", + "startDate" + ], + "type": "object", + "properties": { + "advertiserIds": { + "type": "string", + "description": "The comma-separated list of advertiser ids. If empty, all the advertisers in the portfolio will be used", + "nullable": true + }, + "eventType": { + "type": "string", + "description": "Apply a filter on Event type .", + "nullable": true + }, + "currency": { + "type": "string", + "description": "The currency used for the report. ISO 4217 code (three-letter capitals)." + }, + "format": { + "type": "string", + "description": "The file format of the generated report: csv, xml, excel or json." + }, + "timezone": { + "type": "string", + "description": "The timezone used for the report. Timezone Database format (Tz).", + "default": "UTC", + "nullable": true + }, + "startDate": { + "type": "string", + "description": "Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", + "format": "date-time" + }, + "endDate": { + "type": "string", + "description": "End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", + "format": "date-time" + } + }, + "additionalProperties": false, + "description": "This is the message defining the query for Transaction report" + }, + "TransparencyReportFile": { + "required": [ + "fileName", + "url" + ], + "type": "object", + "properties": { + "fileName": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "additionalProperties": false, + "description": "This is the message defining the file response for Transparency report" + }, + "MarketingSolutionsReportStatusResponse": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MarketingSolutionsReportStatusResource" }, - "currency": { - "type": "string", - "description": "The currency used for the report. ISO 4217 code (three-letter capitals).", - "nullable": true + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "description": "Warnings that occured during this call.", + "nullable": true, + "readOnly": true }, - "adSetIds": { - "uniqueItems": false, + "errors": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/CommonProblem" }, - "description": "The list of adSets ids. If empty, all the adSets will be fetched", + "description": "Errors that occured during this call.", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for a single entity." + }, + "ExportResult": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ExportResultData" + } + }, + "additionalProperties": false, + "description": "Result for an async report request" + }, + "GenerateAudiencePerformanceReportRequest": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReportResource" + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for a single value objects." + }, + "GenerateStatisticsReportRequest": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GenerateStatisticsReportResource" + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for a single value objects." + }, + "MarketingSolutionsReportStatusResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique id of the entity.", "nullable": true }, - "adSetNames": { - "uniqueItems": false, + "type": { + "type": "string", + "description": "Type of the resource.", + "nullable": true + }, + "attributes": { + "$ref": "#/components/schemas/MarketingSolutionsReportStatus" + } + }, + "additionalProperties": false, + "description": "A domain entity exposed by the API, identified by a unique id." + }, + "ExportResultData": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/ExportMetaData" + }, + "data": { "type": "array", "items": { - "type": "string" + "type": "array", + "items": { } }, - "description": "The list of adSets names. If empty, all the adSets will be fetched", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Result data for an async report request" + }, + "GenerateAudiencePerformanceReportResource": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource.", "nullable": true }, - "adSetStatus": { - "uniqueItems": false, + "attributes": { + "$ref": "#/components/schemas/GenerateAudiencePerformanceReport" + } + }, + "additionalProperties": false, + "description": "A value resource exposed by the API." + }, + "GenerateStatisticsReportResource": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource.", + "nullable": true + }, + "attributes": { + "$ref": "#/components/schemas/GenerateStatisticsReport" + } + }, + "additionalProperties": false, + "description": "A value resource exposed by the API." + }, + "MarketingSolutionsReportStatus": { + "type": "object", + "properties": { + "status": { + "enum": [ + "Unknown", + "Pending", + "Done", + "Failure", + "Expired" + ], + "type": "string", + "nullable": true + }, + "message": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Object containing the status of report request and an associated message." + }, + "ExportMetaData": { + "type": "object", + "properties": { + "columns": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/ExportColumn" }, - "description": "The list of adSets status. If empty, all the adSets will be fetched", + "nullable": true + }, + "rows": { + "type": "integer", + "format": "int32", "nullable": true } }, - "description": "Request attributes for async statistics report" + "additionalProperties": false, + "description": "Metadata for an async report request: descriptions of the columns and number of rows returned" }, - "GenerateCreativesReportRequestAttributes": { + "GenerateAudiencePerformanceReport": { "required": [ - "startDate", + "advertiserId", + "dimension", "endDate", - "advertiserIds", "metrics", - "dimensions" + "startDate" ], "type": "object", "properties": { @@ -18021,150 +18522,85 @@ "description": "End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", "format": "date-time" }, - "advertiserIds": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of client ids." - }, - "metrics": { - "uniqueItems": false, - "type": "array", - "items": { - "enum": [ - "Clicks", - "Ctr", - "Displays" - ], - "type": "string" - }, - "description": "The list of metrics to report." - }, - "dimensions": { - "uniqueItems": false, - "type": "array", - "items": { - "enum": [ - "AdFormat", - "Coupon", - "CouponId", - "DisplaySize", - "SizeCategory", - "Ad", - "AdId", - "Day", - "Hour" - ], - "type": "string" - }, - "description": "The list of dimensions to report." + "advertiserId": { + "type": "string", + "description": "The advertiser id" }, "timezone": { "type": "string", "description": "The timezone used for the report. Timezone Database format (Tz).", "nullable": true }, - "adFormats": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of adFormats.", - "nullable": true - }, - "displaySizes": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of displaySizes.", - "nullable": true - }, - "couponNames": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of coupon names.", - "nullable": true - }, - "couponIds": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of coupon ids.", - "nullable": true - }, - "adNames": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of ad names.", - "nullable": true + "dimension": { + "enum": [ + "Top30BrandsByDisplays", + "Top30BrandsByClicks", + "Top30BrandsBySales", + "Top30InterestsByDisplays", + "Top30InterestsByClicks", + "Top30InterestsBySales" + ], + "type": "string", + "description": "The dimension for the report." }, - "adIds": { - "uniqueItems": false, + "metrics": { "type": "array", "items": { + "enum": [ + "Clicks", + "Displays", + "Visits", + "Sales", + "Revenue", + "CostPerVisit", + "ExposedUsers" + ], "type": "string" }, - "description": "The list of ad ids.", + "description": "The list of metrics to report." + }, + "currency": { + "type": "string", + "description": "The currency used for the report. ISO 4217 code (three-letter capitals).", "nullable": true }, - "campaignIds": { - "uniqueItems": false, + "adSetIds": { "type": "array", "items": { "type": "string" }, - "description": "The list of campaign ids (marketing campaign ids).", + "description": "The list of adSets ids. If empty, all the adSets will be fetched.", "nullable": true }, - "adSetIds": { - "uniqueItems": false, + "audienceIds": { "type": "array", "items": { "type": "string" }, - "description": "The list of adSet ids (campaign ids).", + "description": "The list of Audiences ids. If empty, all the Audiences will be fetched.", "nullable": true }, - "adSetStatus": { - "uniqueItems": false, + "segmentsIds": { "type": "array", "items": { "type": "string" }, - "description": "The list of adSet status (ex: 'Active','NotRunning').", + "description": "The list of Segments ids. If empty, all the segments will be fetched.", "nullable": true } }, - "description": "This is the message defining the query for Creatives report" + "additionalProperties": false, + "description": "Request attributes for async audience performance report" }, - "GenerateTopProductsReportRequestAttributes": { + "GenerateStatisticsReport": { "required": [ - "startDate", + "dimensions", "endDate", - "advertiserId", - "rankProductsBy" + "metrics", + "startDate" ], "type": "object", "properties": { - "timezone": { - "type": "string", - "description": "The timezone used for the report. Timezone Database format (Tz).", - "default": "UTC", - "nullable": true - }, "startDate": { "type": "string", "description": "Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", @@ -18175,181 +18611,374 @@ "description": "End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", "format": "date-time" }, - "advertiserId": { - "type": "string", - "description": "The client id." - }, - "limit": { - "type": "integer", - "description": "The maximum number of top products returned.", - "format": "int32", + "advertiserIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of advertiser ids", "nullable": true }, - "rankProductsBy": { - "enum": [ - "Clicks", - "Displays", - "Sales" - ], + "timezone": { "type": "string", - "description": "The metric used to filter the top products." + "description": "The timezone used for the report. Timezone Database format (Tz).", + "nullable": true }, "dimensions": { - "uniqueItems": false, "type": "array", "items": { "enum": [ - "Campaign", + "AdvertiserId", + "Advertiser", "CampaignId", - "AdSet", + "Campaign", "AdSetId", - "Product", - "ProductId", - "Category", + "AdSet", + "ChannelId", + "Channel", "CategoryId", - "Advertiser", - "AdvertiserId", - "ProductUrl", - "Brand" + "Category", + "Device", + "Os", + "AdId", + "Ad", + "CouponId", + "Coupon", + "Year", + "Month", + "Week", + "Day", + "Hour", + "MarketingCampaignGoal", + "MarketingObjective", + "MarketingObjectiveId", + "VideoPlayerSize", + "VideoPlacement", + "VideoPlaybackMethod", + "SSP", + "VideoDurationInSeconds", + "MediaType", + "AdFormat", + "DisplaySize", + "VideoPlayerRatio", + "Country", + "Region", + "PostalCode", + "UserBehavior", + "Environment", + "AdChannel", + "SocialPlatform" ], "type": "string" }, - "description": "The dimensions for the report.", - "nullable": true + "description": "The dimensions for the report." }, "metrics": { - "uniqueItems": false, "type": "array", "items": { "enum": [ "Clicks", - "Ctr", + "Displays", + "AdvertiserCost", + "SalesPc30dClientAttribution", + "SalesAllPc30dClientAttribution", + "SalesClientAttribution", + "SalesAllClientAttribution", + "SalesPc30d", + "SalesAllPc30d", + "SalesPc1d", + "SalesAllPc1d", + "SalesPc7d", + "SalesAllPc7d", + "SalesPc7dPv24", + "SalesAllPc7dPv24", + "SalesPc7dPv24h", + "SalesAllPc7dPv24h", + "SalesPv24h", + "SalesAllPv24h", + "SalesPc30Pv24", + "SalesAllPc30Pv24", + "SalesPc30dPv24h", + "SalesAllPc30dPv24h", + "SalesPiPc", + "SalesPiPv", + "SalesPiPcPv", + "PostInstallSales", + "SalesOfflinePc", + "SalesOfflinePv", + "SalesOfflinePc30d", + "SalesOfflinePv24h", + "RevenueGeneratedPc30dClientAttribution", + "RevenueGeneratedAllPc30dClientAttribution", + "RevenueGeneratedClientAttribution", + "RevenueGeneratedAllClientAttribution", + "RevenueGeneratedPc30d", + "RevenueGeneratedAllPc30d", + "RevenueGeneratedPc1d", + "RevenueGeneratedAllPc1d", + "RevenueGeneratedPc7d", + "RevenueGeneratedAllPc7d", + "RevenueGeneratedPv24h", + "RevenueGeneratedAllPv24h", + "RevenueGeneratedPc30Pv24", + "RevenueGeneratedAllPc30Pv24", + "RevenueGeneratedPc30dPv24h", + "RevenueGeneratedAllPc30dPv24h", + "RevenueGeneratedPc7dPv24h", + "RevenueGeneratedAllPc7dPv24h", + "RevenueGeneratedPc7dPv24", + "RevenueGeneratedAllPc7dPv24", + "RevenueGeneratedOfflinePc", + "RevenueGeneratedOfflinePv", + "RevenueGeneratedOfflinePc30d", + "RevenueGeneratedOfflinePv24h", + "ConversionRatePc30dClientAttribution", + "ConversionRateAllPc30dClientAttribution", + "ConversionRateClientAttribution", + "ConversionRateAllClientAttribution", + "ConversionRatePc30d", + "ConversionRateAllPc30d", + "ConversionRatePc1d", + "ConversionRateAllPc1d", + "ConversionRatePc7d", + "ConversionRateAllPc7d", + "ConversionRatePv24h", + "ConversionRateAllPv24h", + "ConversionRatePc30Pv24", + "ConversionRateAllPc30Pv24", + "ConversionRatePc30dPv24h", + "ConversionRateAllPc30dPv24h", + "ConversionRatePc7dPv24", + "ConversionRateAllPc7dPv24", + "ConversionRatePc7dPv24h", + "ConversionRateAllPc7dPv24h", + "ConversionRatePiPcPv", + "PostInstallConversionRate", + "ECosPc30dClientAttribution", + "ECosAllPc30dClientAttribution", + "ECosClientAttribution", + "ECosAllClientAttribution", + "ECosPc30d", + "ECosAllPc30d", + "ECosPc1d", + "ECosAllPc1d", + "ECosPc7d", + "ECosAllPc7d", + "ECosPv24h", + "ECosAllPv24h", + "ECosPc30Pv24", + "ECosAllPc30Pv24", + "ECosPc30dPv24h", + "ECosAllPc30dPv24h", + "ECosPc7dPv24h", + "ECosAllPc7dPv24h", + "ECosPc7dPv24", + "ECosAllPc7dPv24", + "CostPerOrderPc30dClientAttribution", + "CostPerOrderAllPc30dClientAttribution", + "CostPerOrderClientAttribution", + "CostPerOrderAllClientAttribution", + "CostPerOrderPc30d", + "CostPerOrderAllPc30d", + "CostPerOrderPc1d", + "CostPerOrderAllPc1d", + "CostPerOrderPc7d", + "CostPerOrderAllPc7d", + "CostPerOrderPv24h", + "CostPerOrderAllPv24h", + "CostPerOrderPc30Pv24", + "CostPerOrderAllPc30Pv24", + "CostPerOrderPc30dPv24h", + "CostPerOrderAllPc30dPv24h", + "CostPerOrderPc7dPv24h", + "CostPerOrderAllPc7dPv24h", + "CostPerOrderPc7dPv24", + "CostPerOrderAllPc7dPv24", + "ExposedUsers", + "Audience", + "Reach", + "AverageCartPc30dClientAttribution", + "AverageCartAllPc30dClientAttribution", + "AverageCartClientAttribution", + "AverageCartAllClientAttribution", + "AverageCartPc30d", + "AverageCartAllPc30d", + "AverageCartPv24h", + "AverageCartAllPv24h", + "AverageCartPc1d", + "AverageCartAllPc1d", + "AverageCartPc7d", + "AverageCartAllPc7d", + "AverageCartPc30Pv24", + "AverageCartAllPc30Pv24", + "AverageCartPc30dPv24h", + "AverageCartAllPc30dPv24h", + "AverageCartPc7dPv24h", + "AverageCartAllPc7dPv24h", + "AverageCartPc7dPv24", + "AverageCartAllPc7dPv24", + "ClickThroughRate", + "ECpc", + "Cpc", + "ECpm", + "ReturnOnAdvertisingSpendingClientAttribution", + "ReturnOnAdvertisingSpendingAllClientAttribution", + "AdvertiserValue", + "AdvertiserAllValue", + "CostOfAdvertiserValue", + "CostOfAdvertiserValueAll", + "AppInstallsPcPv", + "AppInstalls", + "QualifiedVisits", "Visits", - "Sales", - "Cost", - "Revenue", - "Displays" + "OrderValuePi", + "PostInstallOrderValue", + "BounceRate", + "CostPerInstallPcPv", + "CostPerInstall", + "CostPerVisit", + "InstallRatePcPv", + "InstallRate", + "OmniChannelRoasPc30d", + "OmnichannelRoasAllPc30d", + "OmniChannelRevenuePc30d", + "OmnichannelRevenueAllPc30d", + "OmniChannelSalesPc30d", + "OmnichannelSalesAllPc30d", + "OmnichannelRoasAllPv24h", + "OmnichannelRoasPv24h", + "OmnichannelRevenueAllPv24h", + "OmnichannelRevenuePv24h", + "OmnichannelSalesAllPv24h", + "OmnichannelSalesPv24h", + "OmnichannelRoasClientAttribution", + "OmnichannelRevenueClientAttribution", + "OmnichannelSalesClientAttribution", + "RoasAllPc30dClientAttribution", + "RoasPc30dClientAttribution", + "RoasAllClientAttribution", + "RoasClientAttribution", + "RoasAllPc30d", + "RoasPc30d", + "RoasAllPc7d", + "RoasPc7d", + "RoasAllPc1d", + "RoasPc1d", + "RoasAllPv24h", + "RoasPv24h", + "RoasPc30Pv24", + "RoasAllPc30Pv24", + "RoasPc30dPv24h", + "RoasAllPc30dPv24h", + "RoasPc7dPv24", + "RoasAllPc7dPv24", + "RoasPc7dPv24h", + "RoasAllPc7dPv24h", + "CostOfSalePi", + "CostPerOrderPi", + "PostInstallCostOfSale", + "PostInstallCostPerOrder", + "ReturnOnAdvertiserSpendingPi", + "PostInstallRoas", + "ReturnOnAdvertiserSpendingOfflinePc", + "ReturnOnAdvertiserSpendingOfflinePv", + "RoasOfflinePc30d", + "RoasOfflinePv24h", + "PotentialDisplays", + "OverallCompetitionWin", + "ViewableDisplays", + "NonViewableDisplays", + "UntrackableDisplays", + "Frequency", + "InvalidClicks", + "InvalidDisplays", + "ResultType", + "CostPerQualifiedVisit", + "CostPerVisitPV1D", + "VisitsPV1D", + "AssistsPc30dClientAttribution", + "AssistsAllPc30dClientAttribution", + "AssistsClientAttribution", + "AssistsAllClientAttribution", + "AssistsPc30d", + "AssistsAllPc30d", + "AssistsPc1d", + "AssistsAllPc1d", + "AssistsPc7d", + "AssistsAllPc7d", + "AssistsPc7dPv24", + "AssistsAllPc7dPv24", + "AssistsPc7dPv24h", + "AssistsAllPc7dPv24h", + "AssistsPv24h", + "AssistsAllPv24h", + "AssistsPc30Pv24", + "AssistsAllPc30Pv24", + "AssistsPc30dPv24h", + "AssistsAllPc30dPv24h", + "AssistsPiPc", + "AssistsPiPv", + "AssistsPiPcPv", + "AssistsSalesRatioPc30dClientAttribution", + "AssistsSalesRatioAllPc30dClientAttribution", + "AssistsSalesRatioClientAttribution", + "AssistsSalesRatioAllClientAttribution", + "AssistsSalesRatioPc30d", + "AssistsSalesRatioAllPc30d", + "AssistsSalesRatioPc1d", + "AssistsSalesRatioAllPc1d", + "AssistsSalesRatioPc7d", + "AssistsSalesRatioAllPc7d", + "AssistsSalesRatioPc7dPv24", + "AssistsSalesRatioAllPc7dPv24", + "AssistsSalesRatioPc7dPv24h", + "AssistsSalesRatioAllPc7dPv24h", + "AssistsSalesRatioPv24h", + "AssistsSalesRatioAllPv24h", + "AssistsSalesRatioPc30Pv24", + "AssistsSalesRatioAllPc30Pv24", + "AssistsSalesRatioPc30dPv24h", + "AssistsSalesRatioAllPc30dPv24h", + "AssistsSalesRatioPiPc", + "AssistsSalesRatioPiPv", + "AssistsSalesRatioPiPcPv" ], "type": "string" }, - "description": "The list of metrics to report.", - "nullable": true + "description": "The list of metrics to report." }, "currency": { "type": "string", "description": "The currency used for the report. ISO 4217 code (three-letter capitals).", - "default": "EUR", - "nullable": true - }, - "brands": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of brands names.", "nullable": true }, - "categoryIds": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of category ids.", - "nullable": true - }, - "campaignIds": { - "uniqueItems": false, + "adSetIds": { "type": "array", "items": { "type": "string" }, - "description": "The list of campaign ids.", + "description": "The list of adSets ids. If empty, all the adSets will be fetched", "nullable": true }, - "adSetIds": { - "uniqueItems": false, + "adSetNames": { "type": "array", "items": { "type": "string" }, - "description": "The list of adSet ids.", + "description": "The list of adSets names. If empty, all the adSets will be fetched", "nullable": true }, "adSetStatus": { - "uniqueItems": false, "type": "array", "items": { "type": "string" }, - "description": "The list of adSet status (ex: 'Active','NotRunning').", - "nullable": true - } - }, - "description": "This is the message defining the query for TopProducts report" - }, - "TransactionsReportQueryMessage": { - "required": [ - "currency", - "format", - "startDate", - "endDate" - ], - "type": "object", - "properties": { - "advertiserIds": { - "type": "string", - "description": "The comma-separated list of advertiser ids. If empty, all the advertisers in the portfolio will be used", - "nullable": true - }, - "eventType": { - "type": "string", - "description": "Apply a filter on Event type .", - "nullable": true - }, - "currency": { - "type": "string", - "description": "The currency used for the report. ISO 4217 code (three-letter capitals)." - }, - "format": { - "type": "string", - "description": "The file format of the generated report: csv, xml, excel or json." - }, - "timezone": { - "type": "string", - "description": "The timezone used for the report. Timezone Database format (Tz).", - "default": "UTC", + "description": "The list of adSets status. If empty, all the adSets will be fetched", "nullable": true - }, - "startDate": { - "type": "string", - "description": "Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", - "format": "date-time" - }, - "endDate": { - "type": "string", - "description": "End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.", - "format": "date-time" - } - }, - "description": "This is the message defining the query for Transaction report" - }, - "TransparencyReportFile": { - "required": [ - "fileName", - "url" - ], - "type": "object", - "properties": { - "fileName": { - "type": "string" - }, - "url": { - "type": "string" } }, - "description": "This is the message defining the file response for Transparency report" + "additionalProperties": false, + "description": "Request attributes for async statistics report" }, "ExportColumn": { "type": "object", @@ -18459,6 +19088,7 @@ "nullable": true } }, + "additionalProperties": false, "description": "Description of a column from an async report request" }, "SupplyVendorListResponse": { @@ -20728,30 +21358,6 @@ }, "description": "A top-level object that encapsulates a Criteo API response for a single value." }, - "Outcome": { - "type": "object", - "properties": { - "warnings": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "nullable": true, - "readOnly": true - }, - "errors": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "nullable": true, - "readOnly": true - } - }, - "description": "A class implementing the body of a response without data of the Criteo API as described in API Guild Guidelines" - }, "ResourceOutcomeOfProductSet": { "type": "object", "properties": { @@ -20762,7 +21368,7 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, "nullable": true, "readOnly": true @@ -20771,7 +21377,7 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, "nullable": true, "readOnly": true @@ -20794,7 +21400,7 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, "nullable": true, "readOnly": true @@ -20803,7 +21409,7 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/components/schemas/ProblemDetails" + "$ref": "#/components/schemas/CommonProblem" }, "nullable": true, "readOnly": true diff --git a/api-specifications/retailmedia_2024-07.json b/api-specifications/retailmedia_2024-07.json index 09762ac..e548922 100644 --- a/api-specifications/retailmedia_2024-07.json +++ b/api-specifications/retailmedia_2024-07.json @@ -872,6 +872,302 @@ } } }, + "/2024-07/retail-media/line-items/{line-item-id}/products": { + "get": { + "tags": [ + "Campaign" + ], + "description": "Retrieve a page of promoted products for a line item", + "operationId": "FetchPromotedProducts", + "parameters": [ + { + "name": "line-item-id", + "in": "path", + "description": "ID of the line item.", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + }, + { + "name": "offset", + "in": "query", + "description": "Offset of the first item to fetch. Defaults to zero.", + "style": "form", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum page size to fetch. Defaults to 500.", + "style": "form", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "fields", + "in": "query", + "description": "A comma separated list of attribute names from the response model to compute and return.\r\n Valid values are `status` and `bidOverride` in any order. Defaults to `status`.", + "style": "form", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Promoted products associated with the line item", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotedProductResourceCollectionOutcome" + } + } + } + }, + "403": { + "description": "Invalid external line item ID", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + } + } + } + }, + "/2024-07/retail-media/line-items/{line-item-id}/products/append": { + "post": { + "tags": [ + "Campaign" + ], + "description": "Append a collection of promoted products to a line item", + "operationId": "AppendPromotedProducts", + "parameters": [ + { + "name": "line-item-id", + "in": "path", + "description": "ID of the line item", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request body whose {data} contains an array of promoted products.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotedProductResourceCollectionInput" + } + } + } + }, + "responses": { + "204": { + "description": "Promoted products appended to the line item" + }, + "400": { + "description": "Invalid request body", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + }, + "403": { + "description": "Invalid external line item ID", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + } + } + } + }, + "/2024-07/retail-media/line-items/{line-item-id}/products/delete": { + "post": { + "tags": [ + "Campaign" + ], + "description": "Remove a collection of promoted products from a line item", + "operationId": "DeletePromotedProducts", + "parameters": [ + { + "name": "line-item-id", + "in": "path", + "description": "ID of the line item", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request body whose {data} contains an array of promoted products.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotedProductResourceCollectionInput" + } + } + } + }, + "responses": { + "204": { + "description": "Promoted products removed from the line item" + }, + "400": { + "description": "Invalid request body", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + }, + "403": { + "description": "Invalid external line item ID", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + } + } + } + }, + "/2024-07/retail-media/line-items/{line-item-id}/products/pause": { + "post": { + "tags": [ + "Campaign" + ], + "description": "Pause a collection of promoted products associated with a line item", + "operationId": "PausePromotedProducts", + "parameters": [ + { + "name": "line-item-id", + "in": "path", + "description": "ID of the line item", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request body whose {data} contains an array of promoted products.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotedProductResourceCollectionInput" + } + } + } + }, + "responses": { + "204": { + "description": "Promoted products paused" + }, + "400": { + "description": "Invalid request body", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + }, + "403": { + "description": "Invalid external line item ID", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + } + } + } + }, + "/2024-07/retail-media/line-items/{line-item-id}/products/unpause": { + "post": { + "tags": [ + "Campaign" + ], + "description": "Un-pause a collection of promoted products associated with a line item", + "operationId": "UnpausePromotedProducts", + "parameters": [ + { + "name": "line-item-id", + "in": "path", + "description": "ID of the line item", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request body whose {data} contains an array of promoted products.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotedProductResourceCollectionInput" + } + } + } + }, + "responses": { + "204": { + "description": "Promoted products un-paused" + }, + "400": { + "description": "Invalid request body", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + }, + "403": { + "description": "Invalid external line item ID", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductResourceOutcome" + } + } + } + } + } + } + }, "/2024-07/retail-media/preferred-deal-line-items/{id}/proposal": { "get": { "tags": [ @@ -2579,13 +2875,13 @@ "tags": [ "Balance" ], - "description": "Get page of balances for the given accountId.", - "operationId": "Balances_GetApiV1ExternalAccountBalancesByAccountId", + "description": "Gets page of balance objects for the given account id", + "operationId": "GetApiV2ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", "in": "path", - "description": "The account to get page of balances for", + "description": "The account to get balances for", "required": true, "style": "simple", "schema": { @@ -2635,13 +2931,23 @@ "200": { "description": "Success", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/PagedResourceCollectionOutcomeOfBalanceResponseV2" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/BalanceResponsePagedListResponse" + "$ref": "#/components/schemas/PagedResourceCollectionOutcomeOfBalanceResponseV2" } - } - } - } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/PagedResourceCollectionOutcomeOfBalanceResponseV2" + } + } + } + } } }, "post": { @@ -2649,7 +2955,7 @@ "Balance" ], "description": "Create balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountBalancesByAccountId", + "operationId": "PostApiV2ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2664,13 +2970,15 @@ } ], "requestBody": { + "description": "An object that represents the available options to set when creating a Retail Media Balance", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateBalanceRequest" + "$ref": "#/components/schemas/CreateBalanceV2Request" } } }, + "required": true, "x-nullable": false, "x-bodyName": "createBalance" }, @@ -2678,9 +2986,19 @@ "201": { "description": "Success", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/BalanceResponse" + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" } } } @@ -2688,13 +3006,13 @@ } } }, - "/2024-07/retail-media/accounts/{account-id}/balances/{balanceId}": { + "/2024-07/retail-media/accounts/{account-id}/balances/{balance-id}": { "get": { "tags": [ "Balance" ], "description": "Get a balance for the given account id and balance id", - "operationId": "Balances_GetApiV1ExternalAccountByAccountIdAndBalanceId", + "operationId": "GetApiV2ExternalAccountByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -2708,7 +3026,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance id", "required": true, @@ -2723,9 +3041,19 @@ "200": { "description": "Success", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/BalanceResponse" + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" } } } @@ -2737,7 +3065,7 @@ "Balance" ], "description": "Modify a balance for the given account id", - "operationId": "Balances_PatchApiV1ExternalAccountByAccountIdAndBalanceId", + "operationId": "PatchApiV2ExternalAccountByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -2751,7 +3079,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance to change the dates", "required": true, @@ -2763,13 +3091,15 @@ } ], "requestBody": { + "description": "An object that represents the available options to modify a balance.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateBalanceModelRequest" + "$ref": "#/components/schemas/UpdateBalanceModelV2Request" } } }, + "required": true, "x-nullable": false, "x-bodyName": "updateBalanceModel" }, @@ -2777,9 +3107,19 @@ "200": { "description": "Success", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/BalanceResponse" + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" } } } @@ -2787,13 +3127,13 @@ } } }, - "/2024-07/retail-media/accounts/{account-id}/balances/{balanceId}/add-funds": { + "/2024-07/retail-media/accounts/{account-id}/balances/{balance-id}/add-funds": { "post": { "tags": [ "Balance" ], "description": "Add funds to a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountAddFundsByAccountIdAndBalanceId", + "operationId": "PostApiV2ExternalAccountAddFundsByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -2807,7 +3147,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance to add funds to", "required": true, @@ -2819,13 +3159,15 @@ } ], "requestBody": { + "description": "An object that represents the available options of adding funds to a balance.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddFundsToBalanceRequest" + "$ref": "#/components/schemas/AddFundsToBalanceV2Request" } } }, + "required": true, "x-nullable": false, "x-bodyName": "addFundsToBalance" }, @@ -2833,9 +3175,19 @@ "200": { "description": "Success", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/BalanceResponse" + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" } } } @@ -2843,13 +3195,13 @@ } } }, - "/2024-07/retail-media/accounts/{account-id}/balances/{balanceId}/change-dates": { + "/2024-07/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates": { "post": { "tags": [ "Balance" ], "description": "Change dates of a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountChangeDatesByAccountIdAndBalanceId", + "operationId": "PostApiV2ExternalAccountChangeDatesByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -2863,7 +3215,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance to change the dates", "required": true, @@ -2875,13 +3227,15 @@ } ], "requestBody": { + "description": "An object that represents the available options to modify schedule of a balance.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChangeDatesOfBalanceRequest" + "$ref": "#/components/schemas/ChangeDatesOfBalanceV2Request" } } }, + "required": true, "x-nullable": false, "x-bodyName": "changeDatesOfBalance" }, @@ -2889,9 +3243,19 @@ "200": { "description": "Success", "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/BalanceResponse" + "$ref": "#/components/schemas/BalanceResponseV2Response" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BalanceResponseV2Response" } } } @@ -3648,350 +4012,10 @@ }, "400": { "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuctionLineItemResponse" - } - } - } - } - } - } - }, - "/2024-07/retail-media/campaigns/{campaign-id}/preferred-line-items": { - "get": { - "tags": [ - "Campaign" - ], - "description": "Gets page of preferred line item objects for the given campaign id", - "operationId": "LineItemsApi_GetApi202110ExternalCampaignPreferredLineItemsByCampaignId", - "parameters": [ - { - "name": "campaign-id", - "in": "path", - "description": "The given campaign id", - "required": true, - "style": "simple", - "schema": { - "type": "string" - }, - "x-nullable": false - }, - { - "name": "limitToId", - "in": "query", - "description": "The ids that you would like to limit your result set to", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "x-nullable": false - }, - { - "name": "pageIndex", - "in": "query", - "description": "The 0 indexed page index you would like to receive given the page size", - "style": "form", - "schema": { - "type": "integer", - "format": "int32" - }, - "x-nullable": false - }, - { - "name": "pageSize", - "in": "query", - "description": "The maximum number of items you would like to receive in this request", - "style": "form", - "schema": { - "type": "integer", - "format": "int32" - }, - "x-nullable": false - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreferredLineItem202110PagedListResponse" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreferredLineItem202110PagedListResponse" - } - } - } - } - } - }, - "post": { - "tags": [ - "Campaign" - ], - "description": "Creates a new preferred line item with the specified settings", - "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", - "parameters": [ - { - "name": "campaign-id", - "in": "path", - "description": "The given campaign id", - "required": true, - "style": "simple", - "schema": { - "type": "string" - }, - "x-nullable": false - } - ], - "requestBody": { - "description": "The line item settings to create a line item with", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreferredLineItemCreateModel202110Request" - } - } - }, - "x-nullable": false, - "x-bodyName": "lineItem" - }, - "responses": { - "201": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreferredLineItem202110Response" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PreferredLineItem202110Response" - } - } - } - } - } - } - }, - "/2024-07/retail-media/campaigns/{campaignId}": { - "get": { - "tags": [ - "Campaign" - ], - "description": "Get all the editable and creatable campaign attributes including all types of budgets given the campaign id", - "operationId": "Campaigns_GetApi202301ExternalCampaignByCampaignId", - "parameters": [ - { - "name": "campaignId", - "in": "path", - "description": "Campaign Id of the campaign detail", - "required": true, - "style": "simple", - "schema": { - "type": "string" - }, - "x-nullable": false - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiSingleResponseOfCampaignV202301" - } - } - } - } - } - }, - "put": { - "tags": [ - "Campaign" - ], - "description": "Edit a campaign for the given campaign id with a given editable attributes. This will return updated creatable and editable attributes of the campaign as the result of the operation. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled.", - "operationId": "Campaigns_PutApi202301ExternalCampaignByCampaignId", - "parameters": [ - { - "name": "campaignId", - "in": "path", - "description": "Campaign Id of the updating campaign", - "required": true, - "style": "simple", - "schema": { - "type": "string" - }, - "x-nullable": false - } - ], - "requestBody": { - "description": "Editable campaign attributes", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutCampaignV202301" - } - } - }, - "x-nullable": false, - "x-bodyName": "campaign" - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiSingleResponseOfCampaignV202301" - } - } - } - } - } - } - }, - "/2024-07/retail-media/line-items/{line-item-id}": { - "get": { - "tags": [ - "Campaign" - ], - "description": "Gets the line item for the given line item id", - "operationId": "GetApiV2ExternalLineItemByLineItemId", - "parameters": [ - { - "name": "line-item-id", - "in": "path", - "description": "The given line item id", - "required": true, - "style": "simple", - "schema": { - "type": "string" - }, - "x-nullable": false - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CommonLineItemResponse" - } - } - } - } - } - } - }, - "/2024-07/retail-media/line-items/{line-item-id}/bid-multipliers": { - "get": { - "tags": [ - "Campaign" - ], - "description": "Get bid multipliers by line item", - "operationId": "LineItems_GetApi202301ExternalLineItemBidMultipliersByLineItemId", - "parameters": [ - { - "name": "line-item-id", - "in": "path", - "description": "Long external id of the associated line item", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliers" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliers" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliers" - } - } - } - } - } - }, - "put": { - "tags": [ - "Campaign" - ], - "description": "Replace bid multipliers on a line item", - "operationId": "LineItems_PutApi202301ExternalLineItemBidMultipliersByLineItemId", - "parameters": [ - { - "name": "line-item-id", - "in": "path", - "description": "Long external id of the associated line item", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LineItemBidMultipliersRequest" - } - } - }, - "x-nullable": false, - "x-bodyName": "request" - }, - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/LineItemBidMultipliersResponse" - } - }, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LineItemBidMultipliersResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/LineItemBidMultipliersResponse" + "$ref": "#/components/schemas/AuctionLineItemResponse" } } } @@ -3999,18 +4023,18 @@ } } }, - "/2024-07/retail-media/line-items/{line-item-id}/products": { + "/2024-07/retail-media/campaigns/{campaign-id}/preferred-line-items": { "get": { "tags": [ "Campaign" ], - "description": "This endpoint gets the promoted products on the specified line item.", - "operationId": "PromotedProductsApi_GetApi202110ExternalLineItemProductsByLineItemId", + "description": "Gets page of preferred line item objects for the given campaign id", + "operationId": "LineItemsApi_GetApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { - "name": "line-item-id", + "name": "campaign-id", "in": "path", - "description": "The line item to interact with", + "description": "The given campaign id", "required": true, "style": "simple", "schema": { @@ -4060,26 +4084,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedProduct202110PagedListResponse" + "$ref": "#/components/schemas/PreferredLineItem202110PagedListResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreferredLineItem202110PagedListResponse" } } } } } - } - }, - "/2024-07/retail-media/line-items/{line-item-id}/products/append": { + }, "post": { "tags": [ "Campaign" ], - "description": "This endpoint appends one or more products to promote on the specified line item. The resulting state of the line item is returned.", - "operationId": "PromotedProductsApi_PostApi202110ExternalLineItemProductsAppendByLineItemId", + "description": "Creates a new preferred line item with the specified settings", + "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { - "name": "line-item-id", + "name": "campaign-id", "in": "path", - "description": "The line item to interact with", + "description": "The given campaign id", "required": true, "style": "simple", "schema": { @@ -4089,24 +4121,34 @@ } ], "requestBody": { - "description": "the products to append to this line item", + "description": "The line item settings to create a line item with", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedProduct202110ListRequest" + "$ref": "#/components/schemas/PreferredLineItemCreateModel202110Request" } } }, "x-nullable": false, - "x-bodyName": "promotedProductsToAppend" + "x-bodyName": "lineItem" }, "responses": { - "200": { + "201": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedProduct202110PagedListResponse" + "$ref": "#/components/schemas/PreferredLineItem202110Response" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreferredLineItem202110Response" } } } @@ -4114,18 +4156,50 @@ } } }, - "/2024-07/retail-media/line-items/{line-item-id}/products/delete": { - "post": { + "/2024-07/retail-media/campaigns/{campaignId}": { + "get": { "tags": [ "Campaign" ], - "description": "This endpoint removes one or more products from promotion on the specified line item. The resulting state of the line item is returned.", - "operationId": "PromotedProductsApi_PostApi202110ExternalLineItemProductsDeleteByLineItemId", + "description": "Get all the editable and creatable campaign attributes including all types of budgets given the campaign id", + "operationId": "Campaigns_GetApi202301ExternalCampaignByCampaignId", "parameters": [ { - "name": "line-item-id", + "name": "campaignId", "in": "path", - "description": "The line item to interact with", + "description": "Campaign Id of the campaign detail", + "required": true, + "style": "simple", + "schema": { + "type": "string" + }, + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiSingleResponseOfCampaignV202301" + } + } + } + } + } + }, + "put": { + "tags": [ + "Campaign" + ], + "description": "Edit a campaign for the given campaign id with a given editable attributes. This will return updated creatable and editable attributes of the campaign as the result of the operation. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled.", + "operationId": "Campaigns_PutApi202301ExternalCampaignByCampaignId", + "parameters": [ + { + "name": "campaignId", + "in": "path", + "description": "Campaign Id of the updating campaign", "required": true, "style": "simple", "schema": { @@ -4135,16 +4209,16 @@ } ], "requestBody": { - "description": "", + "description": "Editable campaign attributes", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedProduct202110ListRequest" + "$ref": "#/components/schemas/PutCampaignV202301" } } }, "x-nullable": false, - "x-bodyName": "promotedProductsToRemove" + "x-bodyName": "campaign" }, "responses": { "200": { @@ -4152,7 +4226,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedProduct202110PagedListResponse" + "$ref": "#/components/schemas/JsonApiSingleResponseOfCampaignV202301" } } } @@ -4160,18 +4234,18 @@ } } }, - "/2024-07/retail-media/line-items/{line-item-id}/products/pause": { - "post": { + "/2024-07/retail-media/line-items/{line-item-id}": { + "get": { "tags": [ "Campaign" ], - "description": "This endpoint pauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsPauseByLineItemId", + "description": "Gets the line item for the given line item id", + "operationId": "GetApiV2ExternalLineItemByLineItemId", "parameters": [ { "name": "line-item-id", "in": "path", - "description": "The line item to interact with.", + "description": "The given line item id", "required": true, "style": "simple", "schema": { @@ -4180,60 +4254,111 @@ "x-nullable": false } ], - "requestBody": { - "description": "The products from which their IDs will be used to pause.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotedProduct202110ListRequest" - } - } - }, - "x-nullable": false, - "x-bodyName": "promotedProductsToPause" - }, "responses": { "200": { - "description": "Success" + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CommonLineItemResponse" + } + } + } } } } }, - "/2024-07/retail-media/line-items/{line-item-id}/products/unpause": { - "post": { + "/2024-07/retail-media/line-items/{line-item-id}/bid-multipliers": { + "get": { "tags": [ "Campaign" ], - "description": "This endpoint unpauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsUnpauseByLineItemId", + "description": "Get bid multipliers by line item", + "operationId": "LineItems_GetApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", "in": "path", - "description": "The line item to interact with.", + "description": "Long external id of the associated line item", "required": true, "style": "simple", "schema": { "type": "string" - }, - "x-nullable": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliers" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliers" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliers" + } + } + } + } + } + }, + "put": { + "tags": [ + "Campaign" + ], + "description": "Replace bid multipliers on a line item", + "operationId": "LineItems_PutApi202301ExternalLineItemBidMultipliersByLineItemId", + "parameters": [ + { + "name": "line-item-id", + "in": "path", + "description": "Long external id of the associated line item", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } } ], "requestBody": { - "description": "The products from which their IDs will be used to unpause.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotedProduct202110ListRequest" + "$ref": "#/components/schemas/LineItemBidMultipliersRequest" } } }, "x-nullable": false, - "x-bodyName": "promotedProductsToUnpause" + "x-bodyName": "request" }, "responses": { "200": { - "description": "Success" + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/LineItemBidMultipliersResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LineItemBidMultipliersResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/LineItemBidMultipliersResponse" + } + } + } } } } @@ -6228,6 +6353,60 @@ "additionalProperties": false, "description": "Outcome object containing errors and warnings." }, + "PromotedProductResourceCollectionOutcome": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RmcaCommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RmcaCommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "metadata": { + "$ref": "#/components/schemas/ProductMetadata" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotedProductResource" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "Outcome object containing promoted products." + }, + "ProductResourceOutcome": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RmcaCommonProblem" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RmcaCommonProblem" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "Outcome object containing errors and warnings." + }, "ProposalStatusModelResponse": { "type": "object", "properties": { @@ -6272,7 +6451,21 @@ } }, "additionalProperties": false, - "description": "Request object to set bid overrides for keywords associated with a line item" + "description": "Request object to set bid overrides for keywords associated with a line item" + }, + "PromotedProductResourceCollectionInput": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotedProductResource" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "Request object containing promoted products to be appended, deleted, paused or unpaused." }, "KeywordsModelResource": { "type": "object", @@ -6357,6 +6550,55 @@ "additionalProperties": { }, "description": "Common problem object." }, + "ProductMetadata": { + "type": "object", + "properties": { + "offset": { + "type": "integer", + "description": "Zero based offset of the first item in the response.", + "format": "int32", + "nullable": true + }, + "limit": { + "type": "integer", + "description": "Maximum number of items in the response.", + "format": "int32", + "nullable": true + }, + "count": { + "type": "integer", + "description": "Total number of items available.", + "format": "int32", + "nullable": true + }, + "responseCount": { + "type": "integer", + "description": "Number of items in the response.", + "format": "int32", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Metadata about the response. Used for pagination." + }, + "PromotedProductResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string", + "nullable": true + }, + "attributes": { + "$ref": "#/components/schemas/PromotedProduct" + } + }, + "additionalProperties": false, + "description": "Resource object containing a promoted product." + }, "ProposalStatusModelResource": { "type": "object", "properties": { @@ -6432,6 +6674,27 @@ "additionalProperties": false, "description": "The keywords associated with a line item." }, + "PromotedProduct": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A retailer defined SKU ID for the promoted product.", + "nullable": true + }, + "bidOverride": { + "type": "number", + "description": "The bid override for the promoted product for this line item. Ignored unless adding a product.", + "format": "decimal", + "nullable": true + }, + "status": { + "$ref": "#/components/schemas/LineItemProductStatus" + } + }, + "additionalProperties": false, + "description": "A promoted product." + }, "ProposalStatusModel": { "type": "object", "properties": { @@ -6521,6 +6784,15 @@ "additionalProperties": false, "description": "A single keyword and associated bid override" }, + "LineItemProductStatus": { + "enum": [ + "Unknown", + "Active", + "Paused" + ], + "type": "string", + "description": "The status of a promoted product in the context of the line item." + }, "NegotiationStateModel": { "enum": [ "Invalid", @@ -9393,7 +9665,7 @@ "additionalProperties": false, "description": "The details for a daily budget override" }, - "BalanceResponsePagedListResponse": { + "PagedResourceCollectionOutcomeOfBalanceResponseV2": { "type": "object", "properties": { "metadata": { @@ -9402,7 +9674,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ResourceOfBalanceResponse" + "$ref": "#/components/schemas/ResourceOfBalanceResponseV2" }, "x-nullable": false }, @@ -9423,14 +9695,13 @@ "x-nullable": false } }, - "description": "Data model for a paged list of response resources", - "x-nullable": false + "description": "Data model for a paged list of response resources" }, - "BalanceResponse": { + "BalanceResponseV2Response": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ResourceOfBalanceResponse" + "$ref": "#/components/schemas/ResourceOfBalanceResponseV2" }, "warnings": { "type": "array", @@ -9449,8 +9720,8 @@ "x-nullable": false } }, - "description": "Data model for response resource", - "x-nullable": false + "description": "A top-level object that encapsulates a Criteo API response for a single entity", + "x-nullable": true }, "JsonApiPageResponseOfCampaignV202301": { "required": [ @@ -9803,39 +10074,6 @@ "description": "Data model for response resource", "x-nullable": false }, - "PromotedProduct202110PagedListResponse": { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/PageMetadata" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ResourceOfPromotedProduct202110" - }, - "x-nullable": false - }, - "warnings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "readOnly": true, - "x-nullable": false - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "readOnly": true, - "x-nullable": false - } - }, - "description": "Data model for a paged list of response resources", - "x-nullable": false - }, "AddToBasketTarget202110Response": { "type": "object", "properties": { @@ -9914,45 +10152,41 @@ "description": "Data model for a value type resource outcome", "x-nullable": false }, - "CreateBalanceRequest": { + "CreateBalanceV2Request": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ResourceOfCreateBalance" + "$ref": "#/components/schemas/ResourceOfCreateBalanceV2" } }, - "description": "Data model for an input resource", - "x-nullable": false + "description": "A top-level object that encapsulates a Criteo API request for a single entity" }, - "UpdateBalanceModelRequest": { + "UpdateBalanceModelV2Request": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ResourceOfUpdateBalanceModel" + "$ref": "#/components/schemas/ResourceOfUpdateBalanceModelV2" } }, - "description": "Data model for an input resource", - "x-nullable": false + "description": "A top-level object that encapsulates a Criteo API request for a single entity" }, - "AddFundsToBalanceRequest": { + "AddFundsToBalanceV2Request": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ResourceOfAddFundsToBalance" + "$ref": "#/components/schemas/ResourceOfAddFundsToBalanceV2" } }, - "description": "Data model for an input resource", - "x-nullable": false + "description": "A top-level object that encapsulates a Criteo API request for a single entity" }, - "ChangeDatesOfBalanceRequest": { + "ChangeDatesOfBalanceV2Request": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ResourceOfChangeDatesOfBalance" + "$ref": "#/components/schemas/ResourceOfChangeDatesOfBalanceV2" } }, - "description": "Data model for an input resource", - "x-nullable": false + "description": "A top-level object that encapsulates a Criteo API request for a single entity" }, "PostCampaignV202301": { "type": "object", @@ -10038,20 +10272,6 @@ "description": "Data model for an input resource", "x-nullable": false }, - "PromotedProduct202110ListRequest": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ResourceOfPromotedProduct202110" - }, - "x-nullable": false - } - }, - "description": "Data model for a list of input resources", - "x-nullable": false - }, "PreferredLineItemUpdateModel202110Request": { "type": "object", "properties": { @@ -10122,11 +10342,11 @@ "description": "Data model for a value type input resource", "x-nullable": false }, - "ResourceOfBalanceResponse": { + "ResourceOfBalanceResponseV2": { "type": "object", "properties": { "attributes": { - "$ref": "#/components/schemas/ExternalBalanceResponse" + "$ref": "#/components/schemas/BalanceResponseV2" }, "id": { "type": "string", @@ -10139,8 +10359,7 @@ "nullable": true } }, - "description": "Data model for a Resource", - "x-nullable": false + "description": "A class that represents a domain entity exposed by an API" }, "JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301": { "required": [ @@ -10302,26 +10521,6 @@ "description": "Data model for a Resource", "x-nullable": false }, - "ResourceOfPromotedProduct202110": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the entity", - "nullable": true - }, - "type": { - "type": "string", - "description": "Canonical type name of the entity", - "nullable": true - }, - "attributes": { - "$ref": "#/components/schemas/ExternalPromotedProduct202110" - } - }, - "description": "Data model for a Resource", - "x-nullable": false - }, "ValueTypeResourceOfAddToBasketTarget202110": { "type": "object", "properties": { @@ -10364,11 +10563,11 @@ "description": "Data model for a value type resource", "x-nullable": false }, - "ResourceOfCreateBalance": { + "ResourceOfCreateBalanceV2": { "type": "object", "properties": { "attributes": { - "$ref": "#/components/schemas/ExternalCreateBalance" + "$ref": "#/components/schemas/CreateBalanceV2" }, "id": { "type": "string", @@ -10381,14 +10580,13 @@ "nullable": true } }, - "description": "Data model for a Resource", - "x-nullable": false + "description": "A class that represents a domain entity exposed by an API" }, - "ResourceOfUpdateBalanceModel": { + "ResourceOfUpdateBalanceModelV2": { "type": "object", "properties": { "attributes": { - "$ref": "#/components/schemas/ExternalUpdateBalanceModel" + "$ref": "#/components/schemas/UpdateBalanceModelV2" }, "id": { "type": "string", @@ -10401,14 +10599,13 @@ "nullable": true } }, - "description": "Data model for a Resource", - "x-nullable": false + "description": "A class that represents a domain entity exposed by an API" }, - "ResourceOfAddFundsToBalance": { + "ResourceOfAddFundsToBalanceV2": { "type": "object", "properties": { "attributes": { - "$ref": "#/components/schemas/ExternalAddFundsToBalance" + "$ref": "#/components/schemas/AddFundsToBalanceV2" }, "id": { "type": "string", @@ -10421,14 +10618,13 @@ "nullable": true } }, - "description": "Data model for a Resource", - "x-nullable": false + "description": "A class that represents a domain entity exposed by an API" }, - "ResourceOfChangeDatesOfBalance": { + "ResourceOfChangeDatesOfBalanceV2": { "type": "object", "properties": { "attributes": { - "$ref": "#/components/schemas/ExternalChangeDatesOfBalance" + "$ref": "#/components/schemas/ChangeDatesOfBalanceV2" }, "id": { "type": "string", @@ -10441,8 +10637,7 @@ "nullable": true } }, - "description": "Data model for a Resource", - "x-nullable": false + "description": "A class that represents a domain entity exposed by an API" }, "JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301": { "required": [ @@ -10594,21 +10789,11 @@ "description": "Data model for a value type resource", "x-nullable": false }, - "ExternalBalanceResponse": { + "BalanceResponseV2": { "required": [ "name", - "poNumber", - "memo", - "deposited", - "spent", - "remaining", "startDate", - "endDate", - "status", - "createdAt", - "updatedAt", "balanceType", - "salesForceId", "spendType", "privateMarketBillingType" ], @@ -10622,12 +10807,14 @@ "poNumber": { "type": "string", "description": "Purchase Order number.", - "x-nullable": false + "nullable": true, + "x-nullable": true }, "memo": { "type": "string", - "description": "Memo", - "x-nullable": false + "description": "Memo.", + "nullable": true, + "x-nullable": true }, "deposited": { "type": "number", @@ -10638,25 +10825,30 @@ }, "spent": { "type": "number", + "description": "Amount of spent funds of the balance.", "format": "decimal", "nullable": true, "x-nullable": true }, "remaining": { "type": "number", + "description": "Amount of remaining funds of the balance.", "format": "decimal", "nullable": true, "x-nullable": true }, "startDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date" + "description": "Start date of the balance in the format YYYY-MM-DD.", + "format": "date", + "x-nullable": false }, "endDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date" + "description": "End date of the balance in the format YYYY-MM-DD.", + "format": "date", + "nullable": true, + "x-nullable": true }, "status": { "enum": [ @@ -10666,15 +10858,18 @@ "ended" ], "type": "string", + "description": "Status of the balance.", "x-nullable": false }, "createdAt": { "type": "string", + "description": "Creation time of the balance.", "format": "date-time", "x-nullable": false }, "updatedAt": { "type": "string", + "description": "Update time of the balance.", "format": "date-time", "x-nullable": false }, @@ -10685,12 +10880,7 @@ "uncapped" ], "type": "string", - "description": "Type of the balance", - "x-nullable": false - }, - "salesForceId": { - "type": "string", - "description": "SalesForceId the balance is linked to.", + "description": "Type of the balance.", "x-nullable": false }, "spendType": { @@ -10711,12 +10901,11 @@ "Unknown" ], "type": "string", - "description": "Billing type for Private Market.", + "description": "Billing type for Private Market of the balance.", "x-nullable": false } }, - "description": "A Retail Media Balance used to determine the funds available for any or all campaigns in an account", - "x-nullable": false + "description": "A Retail Media Balance used to determine the funds available for any or all campaigns in an account" }, "CampaignV202301": { "required": [ @@ -11295,19 +11484,6 @@ "description": "Data model representing bid multipliers on a line item", "x-nullable": false }, - "ExternalPromotedProduct202110": { - "type": "object", - "properties": { - "bidOverride": { - "type": "number", - "format": "decimal", - "nullable": true, - "x-nullable": true - } - }, - "description": "identifies a promoted product", - "x-nullable": false - }, "ExternalAddToBasketTarget202110": { "required": [ "scope" @@ -11406,15 +11582,11 @@ "description": "Identifies store targeting for a line item", "x-nullable": false }, - "ExternalCreateBalance": { + "CreateBalanceV2": { "required": [ "name", - "deposited", "startDate", - "endDate", - "spendType", - "memo", - "salesForceId" + "spendType" ], "type": "object", "properties": { @@ -11426,24 +11598,27 @@ "poNumber": { "type": "string", "description": "Purchase Order number.", - "x-nullable": false + "nullable": true, + "x-nullable": true }, "deposited": { "type": "number", "description": "Amount of billable funds allotted to the balance.", "format": "decimal", - "nullable": true, - "x-nullable": true + "nullable": true }, "startDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date" + "description": "Start date of the balance in the format YYYY-MM-DD.", + "format": "date", + "x-nullable": false }, "endDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date" + "description": "End date of the balance in the format YYYY-MM-DD.", + "format": "date", + "nullable": true, + "x-nullable": true }, "spendType": { "enum": [ @@ -11458,109 +11633,98 @@ "memo": { "type": "string", "description": "Memo", - "x-nullable": false - }, - "salesForceId": { - "type": "string", - "description": "SalesForceId the balance is linked to.", - "x-nullable": false + "nullable": true, + "x-nullable": true } }, - "description": "An object that represents the available options to set when creating a Retail Media Balance", - "x-nullable": false + "description": "An object that represents the available options to set when creating a Retail Media Balance" }, - "ExternalUpdateBalanceModel": { + "UpdateBalanceModelV2": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the balance.", - "x-nullable": false + "nullable": true, + "x-nullable": true }, "poNumber": { "type": "string", "description": "Purchase Order number.", - "x-nullable": false - }, - "salesForceId": { - "type": "string", - "description": "SalesForceId the balance is linked to.", - "x-nullable": false + "nullable": true, + "x-nullable": true }, "startDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date", - "nullable": true + "description": "Start date of the balance in the format YYYY-MM-DD.", + "nullable": true, + "x-nullable": true }, "endDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date", - "nullable": true + "description": "End date of the balance in the format YYYY-MM-DD.", + "nullable": true, + "x-nullable": true }, "memo": { "type": "string", - "description": "Memo", - "x-nullable": false + "description": "Memo.", + "nullable": true, + "x-nullable": true } }, - "description": "An object that represents the available options to set when updating a Retail Media Balance", - "x-nullable": false + "description": "An object that represents the available options to set when updating a Retail Media Balance." }, - "ExternalAddFundsToBalance": { + "AddFundsToBalanceV2": { "required": [ - "deltaAmount", - "memo" + "deltaAmount" ], "type": "object", "properties": { "deltaAmount": { "type": "number", "description": "Amount of billable funds to be added / decreased allotted to the balance.", - "format": "double", + "format": "decimal", "x-nullable": false }, "poNumber": { "type": "string", "description": "Purchase Order number.", - "x-nullable": false + "nullable": true, + "x-nullable": true }, "memo": { "type": "string", "description": "Memo", - "x-nullable": false + "nullable": true, + "x-nullable": true } }, - "description": "An object that represents the available options of adding funds to a balance.", - "x-nullable": false + "description": "An object that represents the available options of adding funds to a balance." }, - "ExternalChangeDatesOfBalance": { - "required": [ - "startDate", - "endDate", - "memo" - ], + "ChangeDatesOfBalanceV2": { "type": "object", "properties": { "startDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date" + "description": "Start date of the balance in the format YYYY-MM-DD.", + "nullable": true, + "x-nullable": true }, "endDate": { "type": "string", - "description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD", - "format": "date" + "description": "End date of the balance in the format YYYY-MM-DD.", + "nullable": true, + "x-nullable": true }, "memo": { "type": "string", - "description": "Memo", - "x-nullable": false + "description": "Memo.", + "nullable": true, + "x-nullable": true } }, - "description": "An object that represents the available options to modify schedule of a balance.", - "x-nullable": false + "description": "An object that represents the available options to modify schedule of a balance." }, "CampaignAttributesV202301": { "required": [ diff --git a/api-specifications/retailmedia_preview.json b/api-specifications/retailmedia_preview.json index 2e40348..798a506 100644 --- a/api-specifications/retailmedia_preview.json +++ b/api-specifications/retailmedia_preview.json @@ -959,7 +959,7 @@ "tags": [ "Audience" ], - "description": "Search segments based on the provided filters.( by ids or retailer ids)", + "description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.", "operationId": "SearchV1", "parameters": [ { @@ -998,7 +998,7 @@ } ], "requestBody": { - "description": "Segment creation parameter", + "description": "Segment search filters.", "content": { "application/json-patch+json": { "schema": { @@ -1498,7 +1498,7 @@ } } }, - "/preview/retail-media/line-items/{lineItemId}/products": { + "/preview/retail-media/line-items/{line-item-id}/products": { "get": { "tags": [ "Campaign" @@ -1507,7 +1507,7 @@ "operationId": "FetchPromotedProducts", "parameters": [ { - "name": "lineItemId", + "name": "line-item-id", "in": "path", "description": "ID of the line item.", "required": true, @@ -1570,7 +1570,7 @@ } } }, - "/preview/retail-media/line-items/{lineItemId}/products/append": { + "/preview/retail-media/line-items/{line-item-id}/products/append": { "post": { "tags": [ "Campaign" @@ -1579,7 +1579,7 @@ "operationId": "AppendPromotedProducts", "parameters": [ { - "name": "lineItemId", + "name": "line-item-id", "in": "path", "description": "ID of the line item", "required": true, @@ -1626,7 +1626,7 @@ } } }, - "/preview/retail-media/line-items/{lineItemId}/products/delete": { + "/preview/retail-media/line-items/{line-item-id}/products/delete": { "post": { "tags": [ "Campaign" @@ -1635,7 +1635,7 @@ "operationId": "DeletePromotedProducts", "parameters": [ { - "name": "lineItemId", + "name": "line-item-id", "in": "path", "description": "ID of the line item", "required": true, @@ -1682,7 +1682,7 @@ } } }, - "/preview/retail-media/line-items/{lineItemId}/products/pause": { + "/preview/retail-media/line-items/{line-item-id}/products/pause": { "post": { "tags": [ "Campaign" @@ -1691,7 +1691,7 @@ "operationId": "PausePromotedProducts", "parameters": [ { - "name": "lineItemId", + "name": "line-item-id", "in": "path", "description": "ID of the line item", "required": true, @@ -1738,7 +1738,7 @@ } } }, - "/preview/retail-media/line-items/{lineItemId}/products/unpause": { + "/preview/retail-media/line-items/{line-item-id}/products/unpause": { "post": { "tags": [ "Campaign" @@ -1747,7 +1747,7 @@ "operationId": "UnpausePromotedProducts", "parameters": [ { - "name": "lineItemId", + "name": "line-item-id", "in": "path", "description": "ID of the line item", "required": true, @@ -3462,6 +3462,124 @@ } } }, + "/preview/retail-media/account-management/accounts/{accountId}/create-seller-account": { + "post": { + "tags": [ + "Accounts" + ], + "description": "Creates a new child Demand Seller Account for the provided parent private market account", + "operationId": "CreatePrivateMarketDemandSellerAccount", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "Account Id for the parent private market account", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Initial creation and configuration options for the new account", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfRetailMediaSellerAccountCreation" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfRetailMediaSellerAccountCreation" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfRetailMediaSellerAccountCreation" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceInputOfRetailMediaSellerAccountCreation" + } + } + }, + "x-bodyName": "accountDetails" + }, + "responses": { + "201": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceOutcomeOfRetailMediaAccount" + } + } + } + } + } + } + }, + "/preview/retail-media/account-management/accounts/{accountId}/sellers": { + "put": { + "tags": [ + "Accounts" + ], + "description": "replace the sellers assoiated with an account", + "operationId": "UpdateSellers", + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "the account id to update", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "sellers to associate", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionInputOfRetailMediaSeller" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionInputOfRetailMediaSeller" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionInputOfRetailMediaSeller" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionInputOfRetailMediaSeller" + } + } + }, + "x-bodyName": "sellers" + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfRetailMediaSeller" + } + } + } + } + } + } + }, "/preview/retail-media/balances/{balanceId}/history": { "get": { "tags": [ @@ -3935,7 +4053,6 @@ "name": "limitToId", "in": "query", "description": "The ids that you would like to limit your result set to", - "required": true, "style": "form", "schema": { "type": "array", @@ -3949,7 +4066,6 @@ "name": "pageIndex", "in": "query", "description": "The 0 indexed page index you would like to receive given the page size", - "required": true, "style": "form", "schema": { "type": "integer", @@ -3962,7 +4078,6 @@ "name": "pageSize", "in": "query", "description": "The maximum number of items you would like to receive in this request", - "required": true, "style": "form", "schema": { "type": "integer", @@ -7135,7 +7250,8 @@ "type": { "enum": [ "Unknown", - "ContactList" + "ContactList", + "UserBehavior" ], "type": "string", "description": "Type of segment (read-only)", @@ -7153,9 +7269,17 @@ "format": "date-time", "nullable": true }, + "createdById": { + "type": "string", + "description": "User that created the segment", + "nullable": true + }, "contactList": { "$ref": "#/components/schemas/RmContactListV1" }, + "userBehavior": { + "$ref": "#/components/schemas/RmUserBehaviorV1" + }, "channels": { "type": "array", "items": { @@ -7346,6 +7470,19 @@ }, "description": "List of retailer ids", "nullable": true + }, + "audienceSegmentTypes": { + "type": "array", + "items": { + "enum": [ + "Unknown", + "ContactList", + "UserBehavior" + ], + "type": "string" + }, + "description": "List of segment types", + "nullable": true } }, "description": "Available filters to perform a search on audience segments. If present, the filters are AND'ed together when applied." @@ -7369,10 +7506,83 @@ "type": "string", "description": "Indicates contact list type", "nullable": true + }, + "sharingStatus": { + "enum": [ + "Unknown", + "NotShared", + "SharedWithAll", + "SharedWithDemandAccounts" + ], + "type": "string", + "description": "Indicates if the contact list is shared with other accounts", + "nullable": true } }, "description": "Settings to target users with your contact lists." }, + "RmUserBehaviorV1": { + "type": "object", + "properties": { + "shopperActivity": { + "enum": [ + "Unknown", + "View", + "Buy", + "AddToCart" + ], + "type": "string", + "description": "Reach people who performed specific action", + "nullable": true + }, + "lookbackDays": { + "enum": [ + "Unknown", + "Last7Days", + "Last14Days", + "Last30Days", + "Last45Days", + "Last60Days", + "Last90Days", + "Last120Days", + "Last150Days", + "Last180Days" + ], + "type": "string", + "description": "The number of days to look back", + "nullable": true + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of category ids", + "nullable": true + }, + "brandIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of brand ids", + "nullable": true + }, + "minPrice": { + "type": "number", + "description": "Minimum price of the products", + "format": "double", + "nullable": true + }, + "maxPrice": { + "type": "number", + "description": "Maximum price of the products", + "format": "double", + "nullable": true + } + }, + "description": "Settings to target users based on their behavior" + }, "RmLegacySegmentUserBehaviorV1": { "required": [ "lookbackWindow", @@ -7613,16 +7823,18 @@ "items": { "$ref": "#/components/schemas/RmcaCommonProblem" }, - "nullable": true + "nullable": true, + "readOnly": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/RmcaCommonProblem" }, - "nullable": true + "nullable": true, + "readOnly": true }, - "meta": { + "metadata": { "$ref": "#/components/schemas/ProductMetadata" }, "data": { @@ -7935,7 +8147,7 @@ "bidOverride": { "type": "number", "description": "The bid override for the promoted product for this line item. Ignored unless adding a product.", - "format": "double", + "format": "decimal", "nullable": true }, "status": { @@ -11262,6 +11474,62 @@ }, "description": "Line Items report body request" }, + "ResourceOutcomeOfRetailMediaAccount": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ResourceOfRetailMediaAccount" + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for a single entity." + }, + "ValueResourceCollectionOutcomeOfRetailMediaSeller": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValueResourceOfRetailMediaSeller" + }, + "nullable": true + }, + "warnings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommonProblem" + }, + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for several values." + }, "PageOfBalanceHistoryChangeDataCaptureV1": { "required": [ "data", @@ -11410,6 +11678,30 @@ "additionalProperties": false, "description": "A top-level object that encapsulates a Criteo API response for a single value." }, + "ValueResourceInputOfRetailMediaSellerAccountCreation": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ValueResourceOfRetailMediaSellerAccountCreation" + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for a single value." + }, + "ValueResourceCollectionInputOfRetailMediaSeller": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValueResourceOfRetailMediaSeller" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API request for several values." + }, "ValueResourceInputOfCampaignBudgetOverrides": { "type": "object", "properties": { @@ -11443,6 +11735,39 @@ "additionalProperties": false, "description": "A top-level object that encapsulates a Criteo API request for a single value." }, + "ResourceOfRetailMediaAccount": { + "type": "object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/RetailMediaAccount" + }, + "id": { + "type": "string", + "description": "Unique identifier of this resource.", + "nullable": true + }, + "type": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false, + "description": "A class that represents a domain entity exposed by an API." + }, + "ValueResourceOfRetailMediaSeller": { + "type": "object", + "properties": { + "type": { + "type": "string", + "nullable": true + }, + "attributes": { + "$ref": "#/components/schemas/RetailMediaSeller" + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for a single value." + }, "Metadata": { "required": [ "limit", @@ -11624,6 +11949,20 @@ "additionalProperties": false, "description": "A top-level object that encapsulates a Criteo API response for a single value." }, + "ValueResourceOfRetailMediaSellerAccountCreation": { + "type": "object", + "properties": { + "type": { + "type": "string", + "nullable": true + }, + "attributes": { + "$ref": "#/components/schemas/RetailMediaSellerAccountCreation" + } + }, + "additionalProperties": false, + "description": "A top-level object that encapsulates a Criteo API response for a single value." + }, "SkuSearchRequestBody": { "required": [ "productIdType", @@ -11654,6 +11993,84 @@ "additionalProperties": false, "description": "defines the type product Id to search and list of ids to be searched for" }, + "RetailMediaAccount": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "account name", + "nullable": true + }, + "companyName": { + "type": "string", + "description": "Display name for reporting the owning entity of ads for the Digital Services Act in the European Union", + "nullable": true + }, + "type": { + "enum": [ + "Unknown", + "Supply", + "Demand" + ], + "type": "string", + "description": "Type for the account", + "nullable": true + }, + "subType": { + "enum": [ + "Unknown", + "Brand", + "Seller" + ], + "type": "string", + "description": "subtype for the account", + "nullable": true + }, + "countryIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "list of countries associated with the account", + "nullable": true + }, + "currencyId": { + "type": "string", + "description": "the currency for the account", + "nullable": true + }, + "parentAccountLabel": { + "type": "string", + "description": "parent account label for the account", + "nullable": true + }, + "timeZone": { + "type": "string", + "description": "the timezone for the account", + "nullable": true + } + }, + "additionalProperties": false, + "description": "The details for a newly created account" + }, + "RetailMediaSeller": { + "type": "object", + "properties": { + "sellerId": { + "type": "string", + "description": "the seller id", + "nullable": true + }, + "retailerId": { + "type": "integer", + "description": "the retailer id", + "format": "int32", + "nullable": true + } + }, + "additionalProperties": false, + "description": "used to define the exact seller linked with an account" + }, "ChangeDetailsV1": { "required": [ "changeValue", @@ -11865,6 +12282,31 @@ "additionalProperties": false, "description": "Line item budget overrides including Monthly and Daily budget overrides." }, + "RetailMediaSellerAccountCreation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "the name of the account, must be unique across all accounts", + "nullable": true + }, + "companyName": { + "type": "string", + "description": "Display name for reporting the owning entity of ads for the Digital Services Act in the European Union", + "nullable": true + }, + "sellers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetailMediaSeller" + }, + "description": "list of sellers to associate to the new account", + "nullable": true + } + }, + "additionalProperties": false, + "description": "the initial set up and configuration options for a new private market demand brand account" + }, "CampaignMonthlyBudgetOverride": { "required": [ "duration", @@ -12664,11 +13106,13 @@ "startDate": { "type": "string", "description": "Start date of the balance in the format YYYY-MM-DD.", + "format": "date", "x-nullable": false }, "endDate": { "type": "string", "description": "End date of the balance in the format YYYY-MM-DD.", + "format": "date", "nullable": true, "x-nullable": true }, @@ -12717,10 +13161,10 @@ }, "privateMarketBillingType": { "enum": [ - "notApplicable", - "billByRetailer", - "billByCriteo", - "unknown" + "NotApplicable", + "BillByRetailer", + "BillByCriteo", + "Unknown" ], "type": "string", "description": "Billing type for Private Market of the balance.", @@ -12973,7 +13417,8 @@ "poNumber": { "type": "string", "description": "Purchase Order number.", - "nullable": true + "nullable": true, + "x-nullable": true }, "deposited": { "type": "number", @@ -12984,12 +13429,15 @@ "startDate": { "type": "string", "description": "Start date of the balance in the format YYYY-MM-DD.", + "format": "date", "x-nullable": false }, "endDate": { "type": "string", "description": "End date of the balance in the format YYYY-MM-DD.", - "nullable": true + "format": "date", + "nullable": true, + "x-nullable": true }, "spendType": { "enum": [ @@ -13004,7 +13452,8 @@ "memo": { "type": "string", "description": "Memo", - "nullable": true + "nullable": true, + "x-nullable": true } }, "description": "An object that represents the available options to set when creating a Retail Media Balance"