From e8371e362bb35a3861753d493403cf135ae8784e Mon Sep 17 00:00:00 2001 From: Nam Vu Date: Mon, 5 Aug 2024 16:22:44 +0200 Subject: [PATCH] chore: remove operation ids --- .../marketingsolutions_2023-07.json | 61 +-- .../marketingsolutions_2023-10.json | 57 +-- .../marketingsolutions_2024-01.json | 57 +-- .../marketingsolutions_2024-04.json | 57 +-- .../marketingsolutions_2024-07.json | 57 +-- .../marketingsolutions_preview.json | 110 +---- api-specifications/retailmedia_2023-07.json | 71 --- api-specifications/retailmedia_2023-10.json | 77 ---- api-specifications/retailmedia_2024-01.json | 81 ---- api-specifications/retailmedia_2024-04.json | 85 ---- api-specifications/retailmedia_2024-07.json | 429 ++++++++---------- api-specifications/retailmedia_preview.json | 96 +--- 12 files changed, 213 insertions(+), 1025 deletions(-) diff --git a/api-specifications/marketingsolutions_2023-07.json b/api-specifications/marketingsolutions_2023-07.json index 32b5e72..62bc188 100644 --- a/api-specifications/marketingsolutions_2023-07.json +++ b/api-specifications/marketingsolutions_2023-07.json @@ -17,7 +17,6 @@ "Audience" ], "description": "Get a list of all the audiences for the user or for the given advertiser_id", - "operationId": "getAudiences", "parameters": [ { "name": "advertiser-id", @@ -109,7 +108,6 @@ "Audience" ], "description": "Create an Audience for an Advertiser", - "operationId": "createAudience", "requestBody": { "content": { "application/json": { @@ -190,7 +188,6 @@ "Audience" ], "description": "Delete an audience by id", - "operationId": "removeAudience", "responses": { "200": { "description": "The audience was deleted", @@ -258,7 +255,6 @@ "Audience" ], "description": "Update user audience specified by the audience id", - "operationId": "modifyAudience", "requestBody": { "content": { "application/json": { @@ -356,7 +352,6 @@ "Audience" ], "description": "Delete all identifiers from a contact list audience-segment.", - "operationId": "deleteIdentifiers", "responses": { "200": { "description": "The contactlist was deleted", @@ -424,7 +419,6 @@ "Audience" ], "description": "Add/remove users to or from a contact list audience-segment.", - "operationId": "modifyAudienceUsers", "requestBody": { "content": { "application/json": { @@ -560,7 +554,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -587,7 +580,6 @@ "Campaign" ], "description": "Link or unlink an audience with an ad set", - "operationId": "updateAdSetAudience", "parameters": [ { "name": "ad-set-id", @@ -681,7 +673,6 @@ "Audience" ], "description": "Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudienceSegments", "requestBody": { "description": "Segment Update request", "content": { @@ -763,7 +754,6 @@ "Audience" ], "description": "Gets the size of all segments. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudienceSegmentsSizes", "requestBody": { "description": "", "content": { @@ -845,7 +835,6 @@ "Audience" ], "description": "Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudienceSegments", "requestBody": { "description": "Segment creation parameter", "content": { @@ -927,7 +916,6 @@ "Audience" ], "description": "Delete the segments associated to the given audience IDs.", - "operationId": "bulkDeleteAudienceSegments", "requestBody": { "description": "Segment delete request.", "content": { @@ -1009,7 +997,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSegmentSize", "requestBody": { "description": "", "content": { @@ -1091,7 +1078,6 @@ "Audience" ], "description": "Returns a list with all available in-market brands that can be used to define an in-market segment.", - "operationId": "getAudienceSegmentsInMarketBrands", "parameters": [ { "name": "advertiser-id", @@ -1160,7 +1146,6 @@ "Audience" ], "description": "Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.", - "operationId": "getAudienceSegmentsInMarketInterests", "parameters": [ { "name": "advertiser-id", @@ -1229,7 +1214,6 @@ "Audience" ], "description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudienceSegments", "parameters": [ { "name": "limit", @@ -1337,7 +1321,6 @@ "Audience" ], "description": "Returns the statistics of a contact list segment.", - "operationId": "getAudienceSegmentContactListStatistics", "parameters": [ { "name": "audience-segment-id", @@ -1397,7 +1380,6 @@ "Audience" ], "description": "Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudiences", "requestBody": { "description": "", "content": { @@ -1479,7 +1461,6 @@ "Audience" ], "description": "Gets the size of all audiences. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudiencesSizes", "requestBody": { "description": "", "content": { @@ -1561,7 +1542,6 @@ "Audience" ], "description": "Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudiences", "requestBody": { "description": "", "content": { @@ -1643,7 +1623,6 @@ "Audience" ], "description": "Deletes the audiences associated to the given audience IDs.", - "operationId": "bulkDeleteAudiences", "requestBody": { "description": "", "content": { @@ -1733,7 +1712,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSize", "requestBody": { "description": "", "content": { @@ -1815,7 +1793,6 @@ "Audience" ], "description": "Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudiences", "parameters": [ { "name": "limit", @@ -1923,7 +1900,6 @@ "Campaign" ], "description": "Patch a list of AdSets.", - "operationId": "PatchAdSets", "requestBody": { "description": "List of adsets to patch.", "content": { @@ -1994,7 +1970,6 @@ "Campaign" ], "description": "Create the specified ad set", - "operationId": "CreateAdSet", "requestBody": { "description": "the ad sets to create", "content": { @@ -2068,7 +2043,6 @@ "Campaign" ], "description": "Search for ad sets", - "operationId": "SearchAdSets", "requestBody": { "content": { "application/json-patch+json": { @@ -2149,7 +2123,6 @@ "Campaign" ], "description": "Start the specified list of ad sets", - "operationId": "StartAdSets", "requestBody": { "description": "All the ad sets to start", "content": { @@ -2222,7 +2195,6 @@ "Campaign" ], "description": "Stop the specified list of ad sets", - "operationId": "StopAdSets", "requestBody": { "description": "All the ad sets to stop", "content": { @@ -2295,7 +2267,6 @@ "Campaign" ], "description": "Get the Category Bids for all valid Categories associated to an Ad Set", - "operationId": "GetCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2360,7 +2331,6 @@ "Campaign" ], "description": "Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2452,7 +2422,6 @@ "Campaign" ], "description": "Get the Display Multipliers for all valid Categories associated to an Ad Set", - "operationId": "GetDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2517,7 +2486,6 @@ "Campaign" ], "description": "Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2609,7 +2577,6 @@ "Campaign" ], "description": "Get the data for the specified ad set", - "operationId": "GetAdSet", "parameters": [ { "name": "adSetId", @@ -2669,7 +2636,6 @@ "Campaign" ], "description": "Patch a list of Campaigns.", - "operationId": "PatchCampaigns", "requestBody": { "description": "List of campaigns to patch.", "content": { @@ -2740,7 +2706,6 @@ "Campaign" ], "description": "Create the specified campaign", - "operationId": "CreateCampaign", "requestBody": { "description": "the campaigns to create", "content": { @@ -2814,7 +2779,6 @@ "Campaign" ], "description": "Search for campaigns", - "operationId": "SearchCampaigns", "requestBody": { "description": "filters on campaigns", "content": { @@ -2896,7 +2860,6 @@ "Campaign" ], "description": "Get the data for the specified campaign", - "operationId": "GetCampaign", "parameters": [ { "name": "campaign-id", @@ -2956,7 +2919,6 @@ "Creative" ], "description": "Delete an Ad", - "operationId": "DeleteAd", "parameters": [ { "name": "id", @@ -2990,7 +2952,6 @@ "Creative" ], "description": "Get an Ad from its id", - "operationId": "GetAd", "parameters": [ { "name": "id", @@ -3058,7 +3019,6 @@ "Creative" ], "description": "Get the list of self-services Ads for a given advertiser", - "operationId": "GetAdvertiserAds", "parameters": [ { "name": "advertiser-id", @@ -3143,7 +3103,6 @@ "Creative" ], "description": "Create an Ad", - "operationId": "CreateAdvertiserAd", "parameters": [ { "name": "advertiser-id", @@ -3236,7 +3195,6 @@ "Creative" ], "description": "Get the list of self-services Coupons for a given advertiser", - "operationId": "GetAdvertiserCoupons", "parameters": [ { "name": "advertiser-id", @@ -3313,7 +3271,6 @@ "Creative" ], "description": "Create a Coupon", - "operationId": "CreateAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3398,7 +3355,6 @@ "Creative" ], "description": "Get the list of Coupon supported sizes", - "operationId": "GetAdvertiserCouponSupportedSizes", "parameters": [ { "name": "advertiser-id", @@ -3466,7 +3422,6 @@ "Creative" ], "description": "Delete a Coupon", - "operationId": "DeleteAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3506,7 +3461,6 @@ "Creative" ], "description": "Get a Coupon from its id", - "operationId": "GetAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3573,7 +3527,6 @@ "Creative" ], "description": "Edit a specific Coupon", - "operationId": "EditAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3660,7 +3613,6 @@ "Creative" ], "description": "Get the preview of a specific Coupon", - "operationId": "GetAdvertiserCouponPreview", "parameters": [ { "name": "advertiser-id", @@ -3749,7 +3701,6 @@ "Creative" ], "description": "Get the list of self-services Creatives for a given advertiser", - "operationId": "GetAdvertiserCreatives", "parameters": [ { "name": "advertiser-id", @@ -3834,7 +3785,6 @@ "Creative" ], "description": "Create a Creative", - "operationId": "CreateAdvertiserCreative", "parameters": [ { "name": "advertiser-id", @@ -3927,7 +3877,6 @@ "Creative" ], "description": "Delete a Creative if there are no ads binded to it", - "operationId": "DeleteCreative", "parameters": [ { "name": "id", @@ -3960,7 +3909,6 @@ "Creative" ], "description": "Get a Creative from its id", - "operationId": "GetCreative", "parameters": [ { "name": "id", @@ -4025,7 +3973,6 @@ "Creative" ], "description": "Edit a specific Creative", - "operationId": "EditCreative", "parameters": [ { "name": "id", @@ -4118,7 +4065,6 @@ "Creative" ], "description": "Generate a preview of a specific Creative", - "operationId": "GenerateCreativePreview", "parameters": [ { "name": "id", @@ -4197,7 +4143,6 @@ "Analytics" ], "description": "This Statistics endpoint provides publisher data.", - "operationId": "GetTransparencyReport", "parameters": [ { "name": "advertiser-id", @@ -4250,7 +4195,7 @@ "type": "TransparencyReport", "attributes": { "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", + "tokenValidUntil": "2021-01-31T00:00:00.0000000+01:00", "files": [ { "fileName": "report.csv", @@ -4348,7 +4293,6 @@ "Analytics" ], "description": "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.", - "operationId": "GetPlacementsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4520,7 +4464,6 @@ "Analytics" ], "description": "This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.", - "operationId": "GetAdsetReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4692,7 +4635,6 @@ "Analytics" ], "description": "This Transactions endpoint provides transactions id related data.", - "operationId": "GetTransactionsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4864,7 +4806,6 @@ "Advertiser" ], "description": "Fetch the portfolio of Advertisers for this account", - "operationId": "ApiPortfolioGet", "responses": { "200": { "description": "Success", diff --git a/api-specifications/marketingsolutions_2023-10.json b/api-specifications/marketingsolutions_2023-10.json index 396fc93..a157da9 100644 --- a/api-specifications/marketingsolutions_2023-10.json +++ b/api-specifications/marketingsolutions_2023-10.json @@ -17,7 +17,6 @@ "Audience" ], "description": "Delete all identifiers from a contact list audience-segment.", - "operationId": "deleteContactListIdentifiers", "responses": { "200": { "description": "The Contact List was emptied", @@ -85,7 +84,6 @@ "Audience" ], "description": "Add/remove identifiers to or from a contact list audience-segment.", - "operationId": "updateContactListIdentifiers", "requestBody": { "content": { "application/json": { @@ -221,7 +219,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -248,7 +245,6 @@ "Campaign" ], "description": "Link or unlink an audience with an ad set", - "operationId": "updateAdSetAudience", "parameters": [ { "name": "ad-set-id", @@ -342,7 +338,6 @@ "Audience" ], "description": "Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudienceSegments", "requestBody": { "description": "Segment Update request", "content": { @@ -424,7 +419,6 @@ "Audience" ], "description": "Gets the size of all segments. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudienceSegmentsSizes", "requestBody": { "description": "", "content": { @@ -506,7 +500,6 @@ "Audience" ], "description": "Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudienceSegments", "requestBody": { "description": "Segment creation parameter", "content": { @@ -588,7 +581,6 @@ "Audience" ], "description": "Delete the segments associated to the given audience IDs.", - "operationId": "bulkDeleteAudienceSegments", "requestBody": { "description": "Segment delete request.", "content": { @@ -670,7 +662,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSegmentSize", "requestBody": { "description": "", "content": { @@ -752,7 +743,6 @@ "Audience" ], "description": "Returns a list with all available in-market brands that can be used to define an in-market segment.", - "operationId": "getAudienceSegmentsInMarketBrands", "parameters": [ { "name": "advertiser-id", @@ -821,7 +811,6 @@ "Audience" ], "description": "Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.", - "operationId": "getAudienceSegmentsInMarketInterests", "parameters": [ { "name": "advertiser-id", @@ -890,7 +879,6 @@ "Audience" ], "description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudienceSegments", "parameters": [ { "name": "limit", @@ -998,7 +986,6 @@ "Audience" ], "description": "Returns the statistics of a contact list segment.", - "operationId": "getAudienceSegmentContactListStatistics", "parameters": [ { "name": "audience-segment-id", @@ -1058,7 +1045,6 @@ "Audience" ], "description": "Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudiences", "requestBody": { "description": "", "content": { @@ -1140,7 +1126,6 @@ "Audience" ], "description": "Gets the size of all audiences. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudiencesSizes", "requestBody": { "description": "", "content": { @@ -1222,7 +1207,6 @@ "Audience" ], "description": "Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudiences", "requestBody": { "description": "", "content": { @@ -1304,7 +1288,6 @@ "Audience" ], "description": "Deletes the audiences associated to the given audience IDs.", - "operationId": "bulkDeleteAudiences", "requestBody": { "description": "", "content": { @@ -1394,7 +1377,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSize", "requestBody": { "description": "", "content": { @@ -1476,7 +1458,6 @@ "Audience" ], "description": "Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudiences", "parameters": [ { "name": "limit", @@ -1584,7 +1565,6 @@ "Campaign" ], "description": "Patch a list of AdSets.", - "operationId": "PatchAdSets", "requestBody": { "description": "List of adsets to patch.", "content": { @@ -1655,7 +1635,6 @@ "Campaign" ], "description": "Create the specified ad set", - "operationId": "CreateAdSet", "requestBody": { "description": "the ad sets to create", "content": { @@ -1729,7 +1708,6 @@ "Campaign" ], "description": "Search for ad sets", - "operationId": "SearchAdSets", "requestBody": { "content": { "application/json-patch+json": { @@ -1810,7 +1788,6 @@ "Campaign" ], "description": "Start the specified list of ad sets", - "operationId": "StartAdSets", "requestBody": { "description": "All the ad sets to start", "content": { @@ -1883,7 +1860,6 @@ "Campaign" ], "description": "Stop the specified list of ad sets", - "operationId": "StopAdSets", "requestBody": { "description": "All the ad sets to stop", "content": { @@ -1956,7 +1932,6 @@ "Campaign" ], "description": "Get the Category Bids for all valid Categories associated to an Ad Set", - "operationId": "GetCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2021,7 +1996,6 @@ "Campaign" ], "description": "Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2113,7 +2087,6 @@ "Campaign" ], "description": "Get the Display Multipliers for all valid Categories associated to an Ad Set", - "operationId": "GetDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2178,7 +2151,6 @@ "Campaign" ], "description": "Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2270,7 +2242,6 @@ "Campaign" ], "description": "Get the data for the specified ad set", - "operationId": "GetAdSet", "parameters": [ { "name": "adSetId", @@ -2330,7 +2301,6 @@ "Campaign" ], "description": "Patch a list of Campaigns.", - "operationId": "PatchCampaigns", "requestBody": { "description": "List of campaigns to patch.", "content": { @@ -2401,7 +2371,6 @@ "Campaign" ], "description": "Create the specified campaign", - "operationId": "CreateCampaign", "requestBody": { "description": "the campaigns to create", "content": { @@ -2475,7 +2444,6 @@ "Campaign" ], "description": "Search for campaigns", - "operationId": "SearchCampaigns", "requestBody": { "description": "filters on campaigns", "content": { @@ -2557,7 +2525,6 @@ "Campaign" ], "description": "Get the data for the specified campaign", - "operationId": "GetCampaign", "parameters": [ { "name": "campaign-id", @@ -2617,7 +2584,6 @@ "Creative" ], "description": "Delete an Ad", - "operationId": "DeleteAd", "parameters": [ { "name": "id", @@ -2651,7 +2617,6 @@ "Creative" ], "description": "Get an Ad from its id", - "operationId": "GetAd", "parameters": [ { "name": "id", @@ -2719,7 +2684,6 @@ "Creative" ], "description": "Get the list of self-services Ads for a given advertiser", - "operationId": "GetAdvertiserAds", "parameters": [ { "name": "advertiser-id", @@ -2804,7 +2768,6 @@ "Creative" ], "description": "Create an Ad", - "operationId": "CreateAdvertiserAd", "parameters": [ { "name": "advertiser-id", @@ -2897,7 +2860,6 @@ "Creative" ], "description": "Get the list of self-services Coupons for a given advertiser", - "operationId": "GetAdvertiserCoupons", "parameters": [ { "name": "advertiser-id", @@ -2974,7 +2936,6 @@ "Creative" ], "description": "Create a Coupon", - "operationId": "CreateAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3059,7 +3020,6 @@ "Creative" ], "description": "Get the list of Coupon supported sizes", - "operationId": "GetAdvertiserCouponSupportedSizes", "parameters": [ { "name": "advertiser-id", @@ -3127,7 +3087,6 @@ "Creative" ], "description": "Delete a Coupon", - "operationId": "DeleteAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3167,7 +3126,6 @@ "Creative" ], "description": "Get a Coupon from its id", - "operationId": "GetAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3234,7 +3192,6 @@ "Creative" ], "description": "Edit a specific Coupon", - "operationId": "EditAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3321,7 +3278,6 @@ "Creative" ], "description": "Get the preview of a specific Coupon", - "operationId": "GetAdvertiserCouponPreview", "parameters": [ { "name": "advertiser-id", @@ -3410,7 +3366,6 @@ "Creative" ], "description": "Get the list of self-services Creatives for a given advertiser", - "operationId": "GetAdvertiserCreatives", "parameters": [ { "name": "advertiser-id", @@ -3495,7 +3450,6 @@ "Creative" ], "description": "Create a Creative", - "operationId": "CreateAdvertiserCreative", "parameters": [ { "name": "advertiser-id", @@ -3588,7 +3542,6 @@ "Creative" ], "description": "Delete a Creative if there are no ads binded to it", - "operationId": "DeleteCreative", "parameters": [ { "name": "id", @@ -3621,7 +3574,6 @@ "Creative" ], "description": "Get a Creative from its id", - "operationId": "GetCreative", "parameters": [ { "name": "id", @@ -3686,7 +3638,6 @@ "Creative" ], "description": "Edit a specific Creative", - "operationId": "EditCreative", "parameters": [ { "name": "id", @@ -3779,7 +3730,6 @@ "Creative" ], "description": "Generate a preview of a specific Creative", - "operationId": "GenerateCreativePreview", "parameters": [ { "name": "id", @@ -3858,7 +3808,6 @@ "Analytics" ], "description": "This Statistics endpoint provides publisher data.", - "operationId": "GetTransparencyReport", "parameters": [ { "name": "advertiser-id", @@ -3911,7 +3860,7 @@ "type": "TransparencyReport", "attributes": { "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", + "tokenValidUntil": "2021-01-31T00:00:00.0000000+01:00", "files": [ { "fileName": "report.csv", @@ -4009,7 +3958,6 @@ "Analytics" ], "description": "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.", - "operationId": "GetPlacementsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4181,7 +4129,6 @@ "Analytics" ], "description": "This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.", - "operationId": "GetAdsetReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4353,7 +4300,6 @@ "Analytics" ], "description": "This Transactions endpoint provides transactions id related data.", - "operationId": "GetTransactionsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4525,7 +4471,6 @@ "Advertiser" ], "description": "Fetch the portfolio of Advertisers for this account", - "operationId": "ApiPortfolioGet", "responses": { "200": { "description": "Success", diff --git a/api-specifications/marketingsolutions_2024-01.json b/api-specifications/marketingsolutions_2024-01.json index 60bcfcf..f9c9dc3 100644 --- a/api-specifications/marketingsolutions_2024-01.json +++ b/api-specifications/marketingsolutions_2024-01.json @@ -17,7 +17,6 @@ "Audience" ], "description": "Delete all identifiers from a contact list audience-segment.", - "operationId": "deleteContactListIdentifiers", "responses": { "200": { "description": "The Contact List was emptied", @@ -85,7 +84,6 @@ "Audience" ], "description": "Add/remove identifiers to or from a contact list audience-segment.", - "operationId": "updateContactListIdentifiers", "requestBody": { "content": { "application/json": { @@ -221,7 +219,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -248,7 +245,6 @@ "Campaign" ], "description": "Link or unlink an audience with an ad set", - "operationId": "updateAdSetAudience", "parameters": [ { "name": "ad-set-id", @@ -342,7 +338,6 @@ "Audience" ], "description": "Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudienceSegments", "requestBody": { "description": "Segment Update request", "content": { @@ -424,7 +419,6 @@ "Audience" ], "description": "Gets the size of all segments. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudienceSegmentsSizes", "requestBody": { "description": "", "content": { @@ -506,7 +500,6 @@ "Audience" ], "description": "Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudienceSegments", "requestBody": { "description": "Segment creation parameter", "content": { @@ -588,7 +581,6 @@ "Audience" ], "description": "Delete the segments associated to the given audience IDs.", - "operationId": "bulkDeleteAudienceSegments", "requestBody": { "description": "Segment delete request.", "content": { @@ -670,7 +662,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSegmentSize", "requestBody": { "description": "", "content": { @@ -752,7 +743,6 @@ "Audience" ], "description": "Returns a list with all available in-market brands that can be used to define an in-market segment.", - "operationId": "getAudienceSegmentsInMarketBrands", "parameters": [ { "name": "advertiser-id", @@ -821,7 +811,6 @@ "Audience" ], "description": "Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.", - "operationId": "getAudienceSegmentsInMarketInterests", "parameters": [ { "name": "advertiser-id", @@ -890,7 +879,6 @@ "Audience" ], "description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudienceSegments", "parameters": [ { "name": "limit", @@ -998,7 +986,6 @@ "Audience" ], "description": "Returns the statistics of a contact list segment.", - "operationId": "getAudienceSegmentContactListStatistics", "parameters": [ { "name": "audience-segment-id", @@ -1058,7 +1045,6 @@ "Audience" ], "description": "Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudiences", "requestBody": { "description": "", "content": { @@ -1140,7 +1126,6 @@ "Audience" ], "description": "Gets the size of all audiences. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudiencesSizes", "requestBody": { "description": "", "content": { @@ -1222,7 +1207,6 @@ "Audience" ], "description": "Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudiences", "requestBody": { "description": "", "content": { @@ -1304,7 +1288,6 @@ "Audience" ], "description": "Deletes the audiences associated to the given audience IDs.", - "operationId": "bulkDeleteAudiences", "requestBody": { "description": "", "content": { @@ -1394,7 +1377,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSize", "requestBody": { "description": "", "content": { @@ -1476,7 +1458,6 @@ "Audience" ], "description": "Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudiences", "parameters": [ { "name": "limit", @@ -1584,7 +1565,6 @@ "Campaign" ], "description": "Patch a list of AdSets.", - "operationId": "PatchAdSets", "requestBody": { "description": "List of adsets to patch.", "content": { @@ -1655,7 +1635,6 @@ "Campaign" ], "description": "Create the specified ad set", - "operationId": "CreateAdSet", "requestBody": { "description": "the ad sets to create", "content": { @@ -1729,7 +1708,6 @@ "Campaign" ], "description": "Search for ad sets", - "operationId": "SearchAdSetsV23Q1", "requestBody": { "content": { "application/json-patch+json": { @@ -1809,7 +1787,6 @@ "Campaign" ], "description": "Start the specified list of ad sets", - "operationId": "StartAdSets", "requestBody": { "description": "All the ad sets to start", "content": { @@ -1882,7 +1859,6 @@ "Campaign" ], "description": "Stop the specified list of ad sets", - "operationId": "StopAdSets", "requestBody": { "description": "All the ad sets to stop", "content": { @@ -1955,7 +1931,6 @@ "Campaign" ], "description": "Get the data for the specified ad set", - "operationId": "GetAdSetV23Q1", "parameters": [ { "name": "ad-set-id", @@ -2014,7 +1989,6 @@ "Campaign" ], "description": "Get the Category Bids for all valid Categories associated to an Ad Set", - "operationId": "GetCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2079,7 +2053,6 @@ "Campaign" ], "description": "Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2171,7 +2144,6 @@ "Campaign" ], "description": "Get the Display Multipliers for all valid Categories associated to an Ad Set", - "operationId": "GetDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2236,7 +2208,6 @@ "Campaign" ], "description": "Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2328,7 +2299,6 @@ "Campaign" ], "description": "Patch a list of Campaigns.", - "operationId": "PatchCampaigns", "requestBody": { "description": "List of campaigns to patch.", "content": { @@ -2399,7 +2369,6 @@ "Campaign" ], "description": "Create the specified campaign", - "operationId": "CreateCampaign", "requestBody": { "description": "the campaigns to create", "content": { @@ -2473,7 +2442,6 @@ "Campaign" ], "description": "Search for campaigns", - "operationId": "SearchCampaignsV23Q1", "requestBody": { "description": "filters on campaigns", "content": { @@ -2554,7 +2522,6 @@ "Campaign" ], "description": "Get the data for the specified campaign", - "operationId": "GetCampaignV23Q1", "parameters": [ { "name": "campaign-id", @@ -2613,7 +2580,6 @@ "Creative" ], "description": "Delete an Ad", - "operationId": "DeleteAd", "parameters": [ { "name": "id", @@ -2647,7 +2613,6 @@ "Creative" ], "description": "Get an Ad from its id", - "operationId": "GetAd", "parameters": [ { "name": "id", @@ -2715,7 +2680,6 @@ "Creative" ], "description": "Get the list of self-services Ads for a given advertiser", - "operationId": "GetAdvertiserAds", "parameters": [ { "name": "advertiser-id", @@ -2800,7 +2764,6 @@ "Creative" ], "description": "Create an Ad", - "operationId": "CreateAdvertiserAd", "parameters": [ { "name": "advertiser-id", @@ -2893,7 +2856,6 @@ "Creative" ], "description": "Get the list of self-services Coupons for a given advertiser", - "operationId": "GetAdvertiserCoupons", "parameters": [ { "name": "advertiser-id", @@ -2970,7 +2932,6 @@ "Creative" ], "description": "Create a Coupon", - "operationId": "CreateAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3055,7 +3016,6 @@ "Creative" ], "description": "Get the list of Coupon supported sizes", - "operationId": "GetAdvertiserCouponSupportedSizes", "parameters": [ { "name": "advertiser-id", @@ -3123,7 +3083,6 @@ "Creative" ], "description": "Delete a Coupon", - "operationId": "DeleteAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3163,7 +3122,6 @@ "Creative" ], "description": "Get a Coupon from its id", - "operationId": "GetAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3230,7 +3188,6 @@ "Creative" ], "description": "Edit a specific Coupon", - "operationId": "EditAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3317,7 +3274,6 @@ "Creative" ], "description": "Get the preview of a specific Coupon", - "operationId": "GetAdvertiserCouponPreview", "parameters": [ { "name": "advertiser-id", @@ -3406,7 +3362,6 @@ "Creative" ], "description": "Get the list of self-services Creatives for a given advertiser", - "operationId": "GetAdvertiserCreatives", "parameters": [ { "name": "advertiser-id", @@ -3491,7 +3446,6 @@ "Creative" ], "description": "Create a Creative", - "operationId": "CreateAdvertiserCreative", "parameters": [ { "name": "advertiser-id", @@ -3584,7 +3538,6 @@ "Creative" ], "description": "Delete a Creative if there are no ads binded to it", - "operationId": "DeleteCreative", "parameters": [ { "name": "id", @@ -3617,7 +3570,6 @@ "Creative" ], "description": "Get a Creative from its id", - "operationId": "GetCreative", "parameters": [ { "name": "id", @@ -3682,7 +3634,6 @@ "Creative" ], "description": "Edit a specific Creative", - "operationId": "EditCreative", "parameters": [ { "name": "id", @@ -3775,7 +3726,6 @@ "Creative" ], "description": "Generate a preview of a specific Creative", - "operationId": "GenerateCreativePreview", "parameters": [ { "name": "id", @@ -3854,7 +3804,6 @@ "Analytics" ], "description": "This Statistics endpoint provides publisher data.", - "operationId": "GetTransparencyReport", "parameters": [ { "name": "advertiser-id", @@ -3907,7 +3856,7 @@ "type": "TransparencyReport", "attributes": { "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", + "tokenValidUntil": "2021-01-31T00:00:00.0000000+01:00", "files": [ { "fileName": "report.csv", @@ -4005,7 +3954,6 @@ "Analytics" ], "description": "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.", - "operationId": "GetPlacementsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4177,7 +4125,6 @@ "Analytics" ], "description": "This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.", - "operationId": "GetAdsetReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4349,7 +4296,6 @@ "Analytics" ], "description": "This Transactions endpoint provides transactions id related data.", - "operationId": "GetTransactionsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4521,7 +4467,6 @@ "Advertiser" ], "description": "Fetch the portfolio of Advertisers for this account", - "operationId": "ApiPortfolioGet", "responses": { "200": { "description": "Success", diff --git a/api-specifications/marketingsolutions_2024-04.json b/api-specifications/marketingsolutions_2024-04.json index ff72ebb..a3f8ad9 100644 --- a/api-specifications/marketingsolutions_2024-04.json +++ b/api-specifications/marketingsolutions_2024-04.json @@ -17,7 +17,6 @@ "Audience" ], "description": "Delete all identifiers from a contact list audience-segment.", - "operationId": "deleteContactListIdentifiers", "responses": { "200": { "description": "The Contact List was emptied", @@ -85,7 +84,6 @@ "Audience" ], "description": "Add/remove identifiers to or from a contact list audience-segment.", - "operationId": "updateContactListIdentifiers", "requestBody": { "content": { "application/json": { @@ -221,7 +219,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -248,7 +245,6 @@ "Campaign" ], "description": "Link or unlink an audience with an ad set", - "operationId": "updateAdSetAudience", "parameters": [ { "name": "ad-set-id", @@ -342,7 +338,6 @@ "Audience" ], "description": "Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudienceSegments", "requestBody": { "description": "Segment Update request", "content": { @@ -424,7 +419,6 @@ "Audience" ], "description": "Gets the size of all segments. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudienceSegmentsSizes", "requestBody": { "description": "", "content": { @@ -506,7 +500,6 @@ "Audience" ], "description": "Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudienceSegments", "requestBody": { "description": "Segment creation parameter", "content": { @@ -588,7 +581,6 @@ "Audience" ], "description": "Delete the segments associated to the given audience IDs.", - "operationId": "bulkDeleteAudienceSegments", "requestBody": { "description": "Segment delete request.", "content": { @@ -670,7 +662,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSegmentSize", "requestBody": { "description": "", "content": { @@ -752,7 +743,6 @@ "Audience" ], "description": "Returns a list with all available in-market brands that can be used to define an in-market segment.", - "operationId": "getAudienceSegmentsInMarketBrands", "parameters": [ { "name": "advertiser-id", @@ -821,7 +811,6 @@ "Audience" ], "description": "Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.", - "operationId": "getAudienceSegmentsInMarketInterests", "parameters": [ { "name": "advertiser-id", @@ -890,7 +879,6 @@ "Audience" ], "description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudienceSegments", "parameters": [ { "name": "limit", @@ -998,7 +986,6 @@ "Audience" ], "description": "Returns the statistics of a contact list segment.", - "operationId": "getAudienceSegmentContactListStatistics", "parameters": [ { "name": "audience-segment-id", @@ -1058,7 +1045,6 @@ "Audience" ], "description": "Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudiences", "requestBody": { "description": "", "content": { @@ -1140,7 +1126,6 @@ "Audience" ], "description": "Gets the size of all audiences. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudiencesSizes", "requestBody": { "description": "", "content": { @@ -1222,7 +1207,6 @@ "Audience" ], "description": "Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudiences", "requestBody": { "description": "", "content": { @@ -1304,7 +1288,6 @@ "Audience" ], "description": "Deletes the audiences associated to the given audience IDs.", - "operationId": "bulkDeleteAudiences", "requestBody": { "description": "", "content": { @@ -1394,7 +1377,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSize", "requestBody": { "description": "", "content": { @@ -1476,7 +1458,6 @@ "Audience" ], "description": "Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudiences", "parameters": [ { "name": "limit", @@ -1584,7 +1565,6 @@ "Campaign" ], "description": "Patch a list of AdSets.", - "operationId": "PatchAdSets", "requestBody": { "description": "List of adsets to patch.", "content": { @@ -1655,7 +1635,6 @@ "Campaign" ], "description": "Create the specified ad set", - "operationId": "CreateAdSet", "requestBody": { "description": "the ad sets to create", "content": { @@ -1729,7 +1708,6 @@ "Campaign" ], "description": "Search for ad sets", - "operationId": "SearchAdSetsV23Q1", "requestBody": { "content": { "application/json-patch+json": { @@ -1809,7 +1787,6 @@ "Campaign" ], "description": "Start the specified list of ad sets", - "operationId": "StartAdSets", "requestBody": { "description": "All the ad sets to start", "content": { @@ -1882,7 +1859,6 @@ "Campaign" ], "description": "Stop the specified list of ad sets", - "operationId": "StopAdSets", "requestBody": { "description": "All the ad sets to stop", "content": { @@ -1955,7 +1931,6 @@ "Campaign" ], "description": "Get the data for the specified ad set", - "operationId": "GetAdSetV23Q1", "parameters": [ { "name": "ad-set-id", @@ -2014,7 +1989,6 @@ "Campaign" ], "description": "Get the Category Bids for all valid Categories associated to an Ad Set", - "operationId": "GetCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2079,7 +2053,6 @@ "Campaign" ], "description": "Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2171,7 +2144,6 @@ "Campaign" ], "description": "Get the Display Multipliers for all valid Categories associated to an Ad Set", - "operationId": "GetDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2236,7 +2208,6 @@ "Campaign" ], "description": "Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2328,7 +2299,6 @@ "Campaign" ], "description": "Patch a list of Campaigns.", - "operationId": "PatchCampaigns", "requestBody": { "description": "List of campaigns to patch.", "content": { @@ -2399,7 +2369,6 @@ "Campaign" ], "description": "Create the specified campaign", - "operationId": "CreateCampaign", "requestBody": { "description": "the campaigns to create", "content": { @@ -2473,7 +2442,6 @@ "Campaign" ], "description": "Search for campaigns", - "operationId": "SearchCampaignsV23Q1", "requestBody": { "description": "filters on campaigns", "content": { @@ -2554,7 +2522,6 @@ "Campaign" ], "description": "Get the data for the specified campaign", - "operationId": "GetCampaignV23Q1", "parameters": [ { "name": "campaign-id", @@ -2613,7 +2580,6 @@ "Creative" ], "description": "Delete an Ad", - "operationId": "DeleteAd", "parameters": [ { "name": "id", @@ -2647,7 +2613,6 @@ "Creative" ], "description": "Get an Ad from its id", - "operationId": "GetAd", "parameters": [ { "name": "id", @@ -2715,7 +2680,6 @@ "Creative" ], "description": "Get the list of self-services Ads for a given advertiser", - "operationId": "GetAdvertiserAds", "parameters": [ { "name": "advertiser-id", @@ -2800,7 +2764,6 @@ "Creative" ], "description": "Create an Ad", - "operationId": "CreateAdvertiserAd", "parameters": [ { "name": "advertiser-id", @@ -2893,7 +2856,6 @@ "Creative" ], "description": "Get the list of self-services Coupons for a given advertiser", - "operationId": "GetAdvertiserCoupons", "parameters": [ { "name": "advertiser-id", @@ -2970,7 +2932,6 @@ "Creative" ], "description": "Create a Coupon", - "operationId": "CreateAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3055,7 +3016,6 @@ "Creative" ], "description": "Get the list of Coupon supported sizes", - "operationId": "GetAdvertiserCouponSupportedSizes", "parameters": [ { "name": "advertiser-id", @@ -3123,7 +3083,6 @@ "Creative" ], "description": "Delete a Coupon", - "operationId": "DeleteAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3163,7 +3122,6 @@ "Creative" ], "description": "Get a Coupon from its id", - "operationId": "GetAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3230,7 +3188,6 @@ "Creative" ], "description": "Edit a specific Coupon", - "operationId": "EditAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3317,7 +3274,6 @@ "Creative" ], "description": "Get the preview of a specific Coupon", - "operationId": "GetAdvertiserCouponPreview", "parameters": [ { "name": "advertiser-id", @@ -3406,7 +3362,6 @@ "Creative" ], "description": "Get the list of self-services Creatives for a given advertiser", - "operationId": "GetAdvertiserCreatives", "parameters": [ { "name": "advertiser-id", @@ -3491,7 +3446,6 @@ "Creative" ], "description": "Create a Creative", - "operationId": "CreateAdvertiserCreative", "parameters": [ { "name": "advertiser-id", @@ -3584,7 +3538,6 @@ "Creative" ], "description": "Delete a Creative if there are no ads binded to it", - "operationId": "DeleteCreative", "parameters": [ { "name": "id", @@ -3617,7 +3570,6 @@ "Creative" ], "description": "Get a Creative from its id", - "operationId": "GetCreative", "parameters": [ { "name": "id", @@ -3682,7 +3634,6 @@ "Creative" ], "description": "Edit a specific Creative", - "operationId": "EditCreative", "parameters": [ { "name": "id", @@ -3775,7 +3726,6 @@ "Creative" ], "description": "Generate a preview of a specific Creative", - "operationId": "GenerateCreativePreview", "parameters": [ { "name": "id", @@ -3854,7 +3804,6 @@ "Analytics" ], "description": "This Statistics endpoint provides publisher data.", - "operationId": "GetTransparencyReport", "parameters": [ { "name": "advertiser-id", @@ -3907,7 +3856,7 @@ "type": "TransparencyReport", "attributes": { "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", + "tokenValidUntil": "2021-01-31T00:00:00.0000000+01:00", "files": [ { "fileName": "report.csv", @@ -4005,7 +3954,6 @@ "Analytics" ], "description": "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.", - "operationId": "GetPlacementsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4177,7 +4125,6 @@ "Analytics" ], "description": "This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.", - "operationId": "GetAdsetReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4349,7 +4296,6 @@ "Analytics" ], "description": "This Transactions endpoint provides transactions id related data.", - "operationId": "GetTransactionsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4521,7 +4467,6 @@ "Advertiser" ], "description": "Fetch the portfolio of Advertisers for this account", - "operationId": "ApiPortfolioGet", "responses": { "200": { "description": "Success", diff --git a/api-specifications/marketingsolutions_2024-07.json b/api-specifications/marketingsolutions_2024-07.json index b5dd610..9a17d88 100644 --- a/api-specifications/marketingsolutions_2024-07.json +++ b/api-specifications/marketingsolutions_2024-07.json @@ -17,7 +17,6 @@ "Audience" ], "description": "Delete all identifiers from a contact list audience-segment.", - "operationId": "deleteContactListIdentifiers", "responses": { "200": { "description": "The Contact List was emptied", @@ -85,7 +84,6 @@ "Audience" ], "description": "Add/remove identifiers to or from a contact list audience-segment.", - "operationId": "updateContactListIdentifiers", "requestBody": { "content": { "application/json": { @@ -221,7 +219,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -248,7 +245,6 @@ "Campaign" ], "description": "Link or unlink an audience with an ad set", - "operationId": "updateAdSetAudience", "parameters": [ { "name": "ad-set-id", @@ -342,7 +338,6 @@ "Audience" ], "description": "Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudienceSegments", "requestBody": { "description": "Segment Update request", "content": { @@ -424,7 +419,6 @@ "Audience" ], "description": "Gets the size of all segments. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudienceSegmentsSizes", "requestBody": { "description": "", "content": { @@ -506,7 +500,6 @@ "Audience" ], "description": "Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudienceSegments", "requestBody": { "description": "Segment creation parameter", "content": { @@ -588,7 +581,6 @@ "Audience" ], "description": "Delete the segments associated to the given audience IDs.", - "operationId": "bulkDeleteAudienceSegments", "requestBody": { "description": "Segment delete request.", "content": { @@ -670,7 +662,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSegmentSize", "requestBody": { "description": "", "content": { @@ -752,7 +743,6 @@ "Audience" ], "description": "Returns a list with all available in-market brands that can be used to define an in-market segment.", - "operationId": "getAudienceSegmentsInMarketBrands", "parameters": [ { "name": "advertiser-id", @@ -821,7 +811,6 @@ "Audience" ], "description": "Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.", - "operationId": "getAudienceSegmentsInMarketInterests", "parameters": [ { "name": "advertiser-id", @@ -890,7 +879,6 @@ "Audience" ], "description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudienceSegments", "parameters": [ { "name": "limit", @@ -998,7 +986,6 @@ "Audience" ], "description": "Returns the statistics of a contact list segment.", - "operationId": "getAudienceSegmentContactListStatistics", "parameters": [ { "name": "audience-segment-id", @@ -1058,7 +1045,6 @@ "Audience" ], "description": "Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudiences", "requestBody": { "description": "", "content": { @@ -1140,7 +1126,6 @@ "Audience" ], "description": "Gets the size of all audiences. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudiencesSizes", "requestBody": { "description": "", "content": { @@ -1222,7 +1207,6 @@ "Audience" ], "description": "Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudiences", "requestBody": { "description": "", "content": { @@ -1304,7 +1288,6 @@ "Audience" ], "description": "Deletes the audiences associated to the given audience IDs.", - "operationId": "bulkDeleteAudiences", "requestBody": { "description": "", "content": { @@ -1394,7 +1377,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSize", "requestBody": { "description": "", "content": { @@ -1476,7 +1458,6 @@ "Audience" ], "description": "Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudiences", "parameters": [ { "name": "limit", @@ -1584,7 +1565,6 @@ "Campaign" ], "description": "Patch a list of AdSets.", - "operationId": "PatchAdSetsV24Q1", "requestBody": { "description": "List of adsets to patch.", "content": { @@ -1655,7 +1635,6 @@ "Campaign" ], "description": "Create the specified ad set", - "operationId": "CreateAdSetV24Q1", "requestBody": { "description": "the ad sets to create", "content": { @@ -1729,7 +1708,6 @@ "Campaign" ], "description": "Search for ad sets", - "operationId": "SearchAdSetsV24Q1", "requestBody": { "content": { "application/json-patch+json": { @@ -1809,7 +1787,6 @@ "Campaign" ], "description": "Start the specified list of ad sets", - "operationId": "StartAdSets", "requestBody": { "description": "All the ad sets to start", "content": { @@ -1882,7 +1859,6 @@ "Campaign" ], "description": "Stop the specified list of ad sets", - "operationId": "StopAdSets", "requestBody": { "description": "All the ad sets to stop", "content": { @@ -1955,7 +1931,6 @@ "Campaign" ], "description": "Get the data for the specified ad set", - "operationId": "GetAdSetV24Q1", "parameters": [ { "name": "ad-set-id", @@ -2014,7 +1989,6 @@ "Campaign" ], "description": "Get the Category Bids for all valid Categories associated to an Ad Set", - "operationId": "GetCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2079,7 +2053,6 @@ "Campaign" ], "description": "Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2171,7 +2144,6 @@ "Campaign" ], "description": "Get the Display Multipliers for all valid Categories associated to an Ad Set", - "operationId": "GetDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2236,7 +2208,6 @@ "Campaign" ], "description": "Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2328,7 +2299,6 @@ "Campaign" ], "description": "Patch a list of Campaigns.", - "operationId": "PatchCampaigns", "requestBody": { "description": "List of campaigns to patch.", "content": { @@ -2399,7 +2369,6 @@ "Campaign" ], "description": "Create the specified campaign", - "operationId": "CreateCampaign", "requestBody": { "description": "the campaigns to create", "content": { @@ -2473,7 +2442,6 @@ "Campaign" ], "description": "Search for campaigns", - "operationId": "SearchCampaignsV23Q1", "requestBody": { "description": "filters on campaigns", "content": { @@ -2554,7 +2522,6 @@ "Campaign" ], "description": "Get the data for the specified campaign", - "operationId": "GetCampaignV23Q1", "parameters": [ { "name": "campaign-id", @@ -2613,7 +2580,6 @@ "Creative" ], "description": "Delete an Ad", - "operationId": "DeleteAd", "parameters": [ { "name": "id", @@ -2647,7 +2613,6 @@ "Creative" ], "description": "Get an Ad from its id", - "operationId": "GetAd", "parameters": [ { "name": "id", @@ -2715,7 +2680,6 @@ "Creative" ], "description": "Get the list of self-services Ads for a given advertiser", - "operationId": "GetAdvertiserAds", "parameters": [ { "name": "advertiser-id", @@ -2800,7 +2764,6 @@ "Creative" ], "description": "Create an Ad", - "operationId": "CreateAdvertiserAd", "parameters": [ { "name": "advertiser-id", @@ -2893,7 +2856,6 @@ "Creative" ], "description": "Get the list of self-services Coupons for a given advertiser", - "operationId": "GetAdvertiserCoupons", "parameters": [ { "name": "advertiser-id", @@ -2970,7 +2932,6 @@ "Creative" ], "description": "Create a Coupon", - "operationId": "CreateAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3055,7 +3016,6 @@ "Creative" ], "description": "Get the list of Coupon supported sizes", - "operationId": "GetAdvertiserCouponSupportedSizes", "parameters": [ { "name": "advertiser-id", @@ -3123,7 +3083,6 @@ "Creative" ], "description": "Delete a Coupon", - "operationId": "DeleteAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3163,7 +3122,6 @@ "Creative" ], "description": "Get a Coupon from its id", - "operationId": "GetAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3230,7 +3188,6 @@ "Creative" ], "description": "Edit a specific Coupon", - "operationId": "EditAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3317,7 +3274,6 @@ "Creative" ], "description": "Get the preview of a specific Coupon", - "operationId": "GetAdvertiserCouponPreview", "parameters": [ { "name": "advertiser-id", @@ -3406,7 +3362,6 @@ "Creative" ], "description": "Get the list of self-services Creatives for a given advertiser", - "operationId": "GetAdvertiserCreatives", "parameters": [ { "name": "advertiser-id", @@ -3491,7 +3446,6 @@ "Creative" ], "description": "Create a Creative", - "operationId": "CreateAdvertiserCreative", "parameters": [ { "name": "advertiser-id", @@ -3584,7 +3538,6 @@ "Creative" ], "description": "Delete a Creative if there are no ads binded to it", - "operationId": "DeleteCreative", "parameters": [ { "name": "id", @@ -3617,7 +3570,6 @@ "Creative" ], "description": "Get a Creative from its id", - "operationId": "GetCreative", "parameters": [ { "name": "id", @@ -3682,7 +3634,6 @@ "Creative" ], "description": "Edit a specific Creative", - "operationId": "EditCreative", "parameters": [ { "name": "id", @@ -3775,7 +3726,6 @@ "Creative" ], "description": "Generate a preview of a specific Creative", - "operationId": "GenerateCreativePreview", "parameters": [ { "name": "id", @@ -3854,7 +3804,6 @@ "Analytics" ], "description": "This Statistics endpoint provides publisher data.", - "operationId": "GetTransparencyReport", "parameters": [ { "name": "advertiser-id", @@ -3907,7 +3856,7 @@ "type": "TransparencyReport", "attributes": { "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", + "tokenValidUntil": "2021-01-31T00:00:00.0000000+01:00", "files": [ { "fileName": "report.csv", @@ -4005,7 +3954,6 @@ "Analytics" ], "description": "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.", - "operationId": "GetPlacementsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4177,7 +4125,6 @@ "Analytics" ], "description": "This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.", - "operationId": "GetAdsetReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4349,7 +4296,6 @@ "Analytics" ], "description": "This Transactions endpoint provides transactions id related data.", - "operationId": "GetTransactionsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4521,7 +4467,6 @@ "Advertiser" ], "description": "Fetch the portfolio of Advertisers for this account", - "operationId": "ApiPortfolioGet", "responses": { "200": { "description": "Success", diff --git a/api-specifications/marketingsolutions_preview.json b/api-specifications/marketingsolutions_preview.json index 019af53..586c5af 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": [ { @@ -17,7 +17,6 @@ "Audience" ], "description": "Add/remove identifiers to or from a contact list.", - "operationId": "modifyAudienceUsersWithAttributes", "parameters": [ { "name": "audience-id", @@ -83,7 +82,6 @@ "Audience" ], "description": "Delete all identifiers from a contact list audience-segment.", - "operationId": "deleteContactListIdentifiers", "responses": { "200": { "description": "The Contact List was emptied", @@ -151,7 +149,6 @@ "Audience" ], "description": "Add/remove identifiers to or from a contact list audience-segment.", - "operationId": "updateContactListIdentifiers", "requestBody": { "content": { "application/json": { @@ -272,7 +269,6 @@ "Audience" ], "description": "Returns the statistics of a contact list segment.", - "operationId": "getAudienceSegmentContactListStatistics", "parameters": [ { "name": "audience-segment-id", @@ -345,7 +341,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -372,7 +367,6 @@ "Campaign" ], "description": "Link or unlink an audience with an ad set", - "operationId": "updateAdSetAudience", "parameters": [ { "name": "ad-set-id", @@ -466,7 +460,6 @@ "Audience" ], "description": "Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudienceSegments", "requestBody": { "description": "Segment Update request", "content": { @@ -548,7 +541,6 @@ "Audience" ], "description": "Gets the size of all segments. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudienceSegmentsSizes", "requestBody": { "description": "", "content": { @@ -630,7 +622,6 @@ "Audience" ], "description": "Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudienceSegments", "requestBody": { "description": "Segment creation parameter", "content": { @@ -712,7 +703,6 @@ "Audience" ], "description": "Delete the segments associated to the given audience IDs.", - "operationId": "bulkDeleteAudienceSegments", "requestBody": { "description": "Segment delete request.", "content": { @@ -794,7 +784,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSegmentSize", "requestBody": { "description": "", "content": { @@ -876,7 +865,6 @@ "Audience" ], "description": "Returns a list with all available in-market brands that can be used to define an in-market segment.", - "operationId": "getAudienceSegmentsInMarketBrands", "parameters": [ { "name": "advertiser-id", @@ -945,7 +933,6 @@ "Audience" ], "description": "Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.", - "operationId": "getAudienceSegmentsInMarketInterests", "parameters": [ { "name": "advertiser-id", @@ -1014,7 +1001,6 @@ "Audience" ], "description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudienceSegments", "parameters": [ { "name": "limit", @@ -1122,7 +1108,6 @@ "Audience" ], "description": "Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "bulkUpdateAudiences", "requestBody": { "description": "", "content": { @@ -1204,7 +1189,6 @@ "Audience" ], "description": "Gets the size of all audiences. An error is returned for those whose size calculation is not supported.", - "operationId": "computeAudiencesSizes", "requestBody": { "description": "", "content": { @@ -1286,7 +1270,6 @@ "Audience" ], "description": "Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.", - "operationId": "bulkCreateAudiences", "requestBody": { "description": "", "content": { @@ -1368,7 +1351,6 @@ "Audience" ], "description": "Deletes the audiences associated to the given audience IDs.", - "operationId": "bulkDeleteAudiences", "requestBody": { "description": "", "content": { @@ -1458,7 +1440,6 @@ "Audience" ], "description": "Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.", - "operationId": "estimateAudienceSize", "requestBody": { "description": "", "content": { @@ -1540,7 +1521,6 @@ "Audience" ], "description": "Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.", - "operationId": "searchAudiences", "parameters": [ { "name": "limit", @@ -1648,7 +1628,6 @@ "Campaign" ], "description": "Patch a list of AdSets.", - "operationId": "PatchAdSetsV24Q1", "requestBody": { "description": "List of adsets to patch.", "content": { @@ -1719,7 +1698,6 @@ "Campaign" ], "description": "Create the specified ad set", - "operationId": "CreateAdSetV24Q1", "requestBody": { "description": "the ad sets to create", "content": { @@ -1793,7 +1771,6 @@ "Campaign" ], "description": "Search for ad sets", - "operationId": "SearchAdSetsV24Q1", "requestBody": { "content": { "application/json-patch+json": { @@ -1873,7 +1850,6 @@ "Campaign" ], "description": "Start the specified list of ad sets", - "operationId": "StartAdSets", "requestBody": { "description": "All the ad sets to start", "content": { @@ -1946,7 +1922,6 @@ "Campaign" ], "description": "Stop the specified list of ad sets", - "operationId": "StopAdSets", "requestBody": { "description": "All the ad sets to stop", "content": { @@ -2019,7 +1994,6 @@ "Campaign" ], "description": "Get the data for the specified ad set", - "operationId": "GetAdSetV24Q1", "parameters": [ { "name": "ad-set-id", @@ -2078,7 +2052,6 @@ "Campaign" ], "description": "Get the Category Bids for all valid Categories associated to an Ad Set", - "operationId": "GetCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2143,7 +2116,6 @@ "Campaign" ], "description": "Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchCategoryBidList", "parameters": [ { "name": "ad-set-id", @@ -2235,7 +2207,6 @@ "Campaign" ], "description": "Get the Display Multipliers for all valid Categories associated to an Ad Set", - "operationId": "GetDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2300,7 +2271,6 @@ "Campaign" ], "description": "Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.", - "operationId": "PatchDisplayMultipliers", "parameters": [ { "name": "ad-set-id", @@ -2392,7 +2362,6 @@ "Campaign" ], "description": "Patch a list of Campaigns.", - "operationId": "PatchCampaigns", "requestBody": { "description": "List of campaigns to patch.", "content": { @@ -2463,7 +2432,6 @@ "Campaign" ], "description": "Create the specified campaign", - "operationId": "CreateCampaign", "requestBody": { "description": "the campaigns to create", "content": { @@ -2537,7 +2505,6 @@ "Campaign" ], "description": "Search for campaigns", - "operationId": "SearchCampaignsV23Q1", "requestBody": { "description": "filters on campaigns", "content": { @@ -2618,7 +2585,6 @@ "Campaign" ], "description": "Get the data for the specified campaign", - "operationId": "GetCampaignV23Q1", "parameters": [ { "name": "campaign-id", @@ -2677,7 +2643,6 @@ "Creative" ], "description": "Delete an Ad", - "operationId": "DeleteAd", "parameters": [ { "name": "id", @@ -2711,7 +2676,6 @@ "Creative" ], "description": "Get an Ad from its id", - "operationId": "GetAd", "parameters": [ { "name": "id", @@ -2779,7 +2743,6 @@ "Creative" ], "description": "Get the list of self-services Ads for a given advertiser", - "operationId": "GetAdvertiserAds", "parameters": [ { "name": "advertiser-id", @@ -2864,7 +2827,6 @@ "Creative" ], "description": "Create an Ad", - "operationId": "CreateAdvertiserAd", "parameters": [ { "name": "advertiser-id", @@ -2957,7 +2919,6 @@ "Creative" ], "description": "Get the list of self-services Coupons for a given advertiser", - "operationId": "GetAdvertiserCoupons", "parameters": [ { "name": "advertiser-id", @@ -3034,7 +2995,6 @@ "Creative" ], "description": "Create a Coupon", - "operationId": "CreateAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3119,7 +3079,6 @@ "Creative" ], "description": "Get the list of Coupon supported sizes", - "operationId": "GetAdvertiserCouponSupportedSizes", "parameters": [ { "name": "advertiser-id", @@ -3187,7 +3146,6 @@ "Creative" ], "description": "Delete a Coupon", - "operationId": "DeleteAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3227,7 +3185,6 @@ "Creative" ], "description": "Get a Coupon from its id", - "operationId": "GetAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3294,7 +3251,6 @@ "Creative" ], "description": "Edit a specific Coupon", - "operationId": "EditAdvertiserCoupon", "parameters": [ { "name": "advertiser-id", @@ -3381,7 +3337,6 @@ "Creative" ], "description": "Get the preview of a specific Coupon", - "operationId": "GetAdvertiserCouponPreview", "parameters": [ { "name": "advertiser-id", @@ -3470,7 +3425,6 @@ "Creative" ], "description": "Get the list of self-services Creatives for a given advertiser", - "operationId": "GetAdvertiserCreatives", "parameters": [ { "name": "advertiser-id", @@ -3555,7 +3509,6 @@ "Creative" ], "description": "Create a Creative", - "operationId": "CreateAdvertiserCreative", "parameters": [ { "name": "advertiser-id", @@ -3648,7 +3601,6 @@ "Creative" ], "description": "Delete a Creative if there are no ads binded to it", - "operationId": "DeleteCreative", "parameters": [ { "name": "id", @@ -3681,7 +3633,6 @@ "Creative" ], "description": "Get a Creative from its id", - "operationId": "GetCreative", "parameters": [ { "name": "id", @@ -3746,7 +3697,6 @@ "Creative" ], "description": "Edit a specific Creative", - "operationId": "EditCreative", "parameters": [ { "name": "id", @@ -3839,7 +3789,6 @@ "Creative" ], "description": "Generate a preview of a specific Creative", - "operationId": "GenerateCreativePreview", "parameters": [ { "name": "id", @@ -3918,7 +3867,6 @@ "Analytics" ], "description": "With this endpoint you can analyse what are the categories of the placements' domains your ads are placed in.", - "operationId": "GetCategoriesReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4095,7 +4043,6 @@ "Analytics" ], "description": "This Statistics endpoint provides publisher data.", - "operationId": "GetTransparencyReport", "parameters": [ { "name": "advertiser-id", @@ -4148,7 +4095,7 @@ "type": "TransparencyReport", "attributes": { "advertiserId": "123", - "tokenValidUntil": "2021-01-31T00:00:00.0000000+00:00", + "tokenValidUntil": "2021-01-31T00:00:00.0000000+01:00", "files": [ { "fileName": "report.csv", @@ -4246,7 +4193,6 @@ "Analytics" ], "description": "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.", - "operationId": "GetPlacementsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4418,7 +4364,6 @@ "Analytics" ], "description": "This Statistics endpoint provides an export Id that lets you retrieve data.", - "operationId": "GetAsyncAudienceReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4544,7 +4489,6 @@ "Analytics" ], "description": "This Statistics endpoint provides an export Id that let you retrieve data.", - "operationId": "GetAsyncAdsetReport", "requestBody": { "content": { "application/json-patch+json": { @@ -4670,7 +4614,6 @@ "Analytics" ], "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": { @@ -4796,7 +4739,6 @@ "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": { @@ -4922,7 +4864,6 @@ "Analytics" ], "description": "This endpoint gives you the output of the report.", - "operationId": "GetAsyncExportOutput", "parameters": [ { "name": "report-id", @@ -4965,7 +4906,6 @@ "Analytics" ], "description": "This endpoint gives you the status of the report.", - "operationId": "GetAsyncExportStatus", "parameters": [ { "name": "report-id", @@ -5008,7 +4948,6 @@ "Analytics" ], "description": "This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.", - "operationId": "GetAdsetReport", "requestBody": { "content": { "application/json-patch+json": { @@ -5180,7 +5119,6 @@ "Analytics" ], "description": "This Transactions endpoint provides transactions id related data.", - "operationId": "GetTransactionsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -5352,7 +5290,6 @@ "Campaign" ], "description": "Fetch the list of available supply vendors for any Ad Set targetings", - "operationId": "GetSupplyVendorList", "responses": { "200": { "description": "the errors/warnings if any", @@ -5399,7 +5336,6 @@ "Campaign" ], "description": "Get the Deal Id Targeting configuration for the ad set whose id is specified", - "operationId": "GetAdSetTargetingDealIds", "parameters": [ { "name": "ad-set-id", @@ -5456,7 +5392,6 @@ "Campaign" ], "description": "Set the Deal Id Targeting configuration for the ad set whose id is specified", - "operationId": "SetAdSetTargetingDealIds", "parameters": [ { "name": "ad-set-id", @@ -5549,7 +5484,6 @@ "Campaign" ], "description": "Disable the Deal Id Targeting configuration for the ad set whose id is specified", - "operationId": "DisableAdSetTargetingDealIds", "parameters": [ { "name": "ad-set-id", @@ -5608,7 +5542,6 @@ "Campaign" ], "description": "Get the Video Positioning Targeting configuration for the ad set whose id is specified", - "operationId": "GetAdSetTargetingVideoPositioning", "parameters": [ { "name": "ad-set-id", @@ -5673,7 +5606,6 @@ "Campaign" ], "description": "Set the Video Positioning Targeting configuration for the ad set whose id is specified", - "operationId": "SetAdSetTargetingVideoPositioning", "parameters": [ { "name": "ad-set-id", @@ -5766,7 +5698,6 @@ "Campaign" ], "description": "Disable the Video Positioning Targeting configuration for the ad set whose id is specified", - "operationId": "DisableAdSetTargetingVideoPositioning", "parameters": [ { "name": "ad-set-id", @@ -5833,7 +5764,6 @@ "Advertiser" ], "description": "Create a new advertiser based on provided parameters. This could take up to 30 seconds.", - "operationId": "createAdvertiser", "requestBody": { "description": "", "content": { @@ -5995,7 +5925,6 @@ "Advertiser" ], "description": "Fetch the portfolio of Advertisers for this account", - "operationId": "ApiPortfolioGet", "responses": { "200": { "description": "Success", @@ -6073,7 +6002,6 @@ "Advertiser" ], "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": "advertiser-id", @@ -6183,7 +6111,6 @@ "Advertiser" ], "description": "Returns the list of available industries for new advertisers.", - "operationId": "listIndustries", "responses": { "200": { "description": "Success", @@ -6520,7 +6447,6 @@ "Reco" ], "description": "Disable product filtering for a given ad", - "operationId": "DisableProductFiltering", "parameters": [ { "name": "ad-id", @@ -6641,7 +6567,6 @@ "Reco" ], "description": "Fetch product filtering configuration for a given ad", - "operationId": "FetchProductFilteringConfig", "parameters": [ { "name": "ad-id", @@ -6722,7 +6647,6 @@ "Reco" ], "description": "Enable product filtering for a given ad", - "operationId": "EnableProductFiltering", "parameters": [ { "name": "ad-id", @@ -6830,7 +6754,6 @@ "Reco" ], "description": "Create a new product set", - "operationId": "CreateProductSet", "requestBody": { "content": { "application/json-patch+json": { @@ -6966,7 +6889,6 @@ "Reco" ], "description": "Fetch product sets of a given dataset", - "operationId": "FetchProductSets", "parameters": [ { "name": "dataset-id", @@ -7069,7 +6991,6 @@ "Reco" ], "description": "Remove a product set", - "operationId": "RemoveProductSet", "parameters": [ { "name": "product-set-id", @@ -7170,7 +7091,6 @@ "Reco" ], "description": "Fetch an existing product set", - "operationId": "FetchProductSet", "parameters": [ { "name": "product-set-id", @@ -7273,7 +7193,6 @@ "Reco" ], "description": "Fetch product filtering usages for a given product set", - "operationId": "FetchProductFilteringUsages", "parameters": [ { "name": "product-set-id", @@ -7356,7 +7275,6 @@ "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": { @@ -7415,7 +7333,6 @@ "Campaign" ], "description": "Delete OCI brand-safety rule.", - "operationId": "deleteOCIbrandSafetyRule", "parameters": [ { "name": "target-type", @@ -7558,7 +7475,6 @@ "Campaign" ], "description": "Get OCI brand-safety rule for the specified target", - "operationId": "getOCIbrandSafetyRule", "parameters": [ { "name": "target-type", @@ -7729,7 +7645,6 @@ "Campaign" ], "description": "Create or update a new or replace existing OCI brand-safety rule.", - "operationId": "upsertOCIbrandSafetyRule", "requestBody": { "description": "OCI brand-safety rule input", "content": { @@ -7891,7 +7806,6 @@ "Campaign" ], "description": "Delete OCI targeting rule.", - "operationId": "deleteOCItargetingRule", "parameters": [ { "name": "target-type", @@ -8034,7 +7948,6 @@ "Campaign" ], "description": "Get OCI targeting rule for specified target.", - "operationId": "getOCItargetingRule", "parameters": [ { "name": "target-type", @@ -8218,7 +8131,6 @@ "Campaign" ], "description": "Create or update new or update existing OCI targeting rule.", - "operationId": "upsertOCItargetingRule", "requestBody": { "description": "OCI targeting rule input", "content": { @@ -8388,7 +8300,6 @@ "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", "parameters": [ { "name": "advertiserId", @@ -8516,7 +8427,6 @@ "Campaign" ], "description": "Returns a list of all targeted bundles for an advertiser.", - "operationId": "GetAdvertiserBundleRules", "parameters": [ { "name": "advertiserId", @@ -8618,7 +8528,6 @@ "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", @@ -8746,7 +8655,6 @@ "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", "parameters": [ { "name": "advertiserId", @@ -8876,7 +8784,6 @@ "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", "parameters": [ { "name": "advertiserId", @@ -9004,7 +8911,6 @@ "Campaign" ], "description": "Returns a list of all targeted domains for an advertiser.", - "operationId": "GetAdvertiserDomainRules", "parameters": [ { "name": "advertiserId", @@ -9106,7 +9012,6 @@ "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", @@ -9174,7 +9079,6 @@ "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", "parameters": [ { "name": "advertiserId", @@ -9304,7 +9208,6 @@ "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", "parameters": [ { "name": "campaignId", @@ -9432,7 +9335,6 @@ "Campaign" ], "description": "Returns a list of all targeted bundles for a campaign.", - "operationId": "GetCampaignBundleRules", "parameters": [ { "name": "campaignId", @@ -9534,7 +9436,6 @@ "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", "parameters": [ { "name": "campaignId", @@ -9662,7 +9563,6 @@ "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", "parameters": [ { "name": "campaignId", @@ -9792,7 +9692,6 @@ "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", "parameters": [ { "name": "campaignId", @@ -9920,7 +9819,6 @@ "Campaign" ], "description": "Returns a list of all targeted domains for a campaign.", - "operationId": "GetCampaignDomainRules", "parameters": [ { "name": "campaignId", @@ -10022,7 +9920,6 @@ "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", "parameters": [ { "name": "campaignId", @@ -10150,7 +10047,6 @@ "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", "parameters": [ { "name": "campaignId", @@ -10280,7 +10176,6 @@ "Audience" ], "description": "This endpoint will Delete User Profiles for a given Advertiser.", - "operationId": "DeleteUserProfiles", "parameters": [ { "name": "advertiserId", @@ -10341,7 +10236,6 @@ "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", diff --git a/api-specifications/retailmedia_2023-07.json b/api-specifications/retailmedia_2023-07.json index f6fe041..ab77089 100644 --- a/api-specifications/retailmedia_2023-07.json +++ b/api-specifications/retailmedia_2023-07.json @@ -17,7 +17,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -44,7 +43,6 @@ "Accounts" ], "description": "Gets page of account objects that the current user can access", - "operationId": "AccountsApi_GetApiV1ExternalAccounts", "parameters": [ { "name": "limitToId", @@ -114,7 +112,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountBrandsByAccountId", "parameters": [ { "name": "accountId", @@ -195,7 +192,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountRetailersByAccountId", "parameters": [ { "name": "accountId", @@ -276,7 +272,6 @@ "Campaign" ], "description": "Creates an asset", - "operationId": "CreateAsset", "requestBody": { "content": { "multipart/form-data": { @@ -325,7 +320,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV1", "parameters": [ { "name": "accountId", @@ -424,7 +418,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyCreateAudienceV1", "parameters": [ { "name": "accountId", @@ -528,7 +521,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV2", "parameters": [ { "name": "accountId", @@ -627,7 +619,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyUpdateAudienceV2", "parameters": [ { "name": "accountId", @@ -731,7 +722,6 @@ "Campaign" ], "description": "Fetch keywords associated with the specified line item", - "operationId": "FetchKeywords", "parameters": [ { "name": "id", @@ -774,7 +764,6 @@ "Campaign" ], "description": "Add or Remove keywords from the line item in bulk", - "operationId": "AddRemoveKeywords", "parameters": [ { "name": "id", @@ -826,7 +815,6 @@ "Campaign" ], "description": "Set bid overrides for associated keywords to the given line item in bulk", - "operationId": "SetKeywordBids", "parameters": [ { "name": "id", @@ -878,7 +866,6 @@ "Campaign" ], "description": "Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.", - "operationId": "FetchProposal", "parameters": [ { "name": "id", @@ -931,7 +918,6 @@ "Campaign" ], "description": "Only the components of the Line Item that are in a valid state will be reviewed.", - "operationId": "SubmitProposal", "parameters": [ { "name": "id", @@ -984,7 +970,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_GetApi202110ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1016,7 +1001,6 @@ "Campaign" ], "description": "Create a creative for an account", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1062,7 +1046,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesSearchByAccountId", "parameters": [ { "name": "account-id", @@ -1109,7 +1092,6 @@ "Campaign" ], "description": "Get the specified creative", - "operationId": "CreativesApi_GetApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1152,7 +1134,6 @@ "Campaign" ], "description": "Update a creative", - "operationId": "CreativesApi_PutApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1215,7 +1196,6 @@ "Campaign" ], "description": "Create a request for a Catalog available to the indicated account.", - "operationId": "CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId", "parameters": [ { "name": "accountId", @@ -1260,7 +1240,6 @@ "Campaign" ], "description": "Output the indicated catalog. Catalogs are only available for retrieval when their associated status request\r\nis at a Success status.\r\nProduces application/x-json-stream of v2021_07 CatalogProduct json objects.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogOutputByCatalogId", "parameters": [ { "name": "catalogId", @@ -1308,7 +1287,6 @@ "Campaign" ], "description": "Check the status of a catalog request.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogStatusByCatalogId", "parameters": [ { "name": "catalogId", @@ -1342,7 +1320,6 @@ "Campaign" ], "description": "Endpoint to search categories by text and retailer.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategories", "parameters": [ { "name": "retailerId", @@ -1414,7 +1391,6 @@ "Campaign" ], "description": "Endpoint to search for a specific category by categoryId.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategorieByCategoryId", "parameters": [ { "name": "categoryId", @@ -1461,7 +1437,6 @@ "Campaign" ], "description": "Get retailer creative templates", - "operationId": "CreativesApi_GetApi202207ExternalRetailerTemplatesByRetailerId", "parameters": [ { "name": "retailer-id", @@ -1496,7 +1471,6 @@ "Campaign" ], "description": "Gets the template for the specified retailer id and template id", - "operationId": "CreativesApi_GetApi202207ExternalRetailerByRetailerId}Templates{templateId", "parameters": [ { "name": "retailer-id", @@ -1543,7 +1517,6 @@ "Campaign" ], "description": "Get the page types available for the given retailer", - "operationId": "RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId", "parameters": [ { "name": "retailerId", @@ -1578,7 +1551,6 @@ "Analytics" ], "description": "Return an asynchronous Campaigns Report", - "operationId": "GenerateAsyncCampaignsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1675,7 +1647,6 @@ "Analytics" ], "description": "Returns an asynchronous Line Items Report", - "operationId": "GenerateAsyncLineItemsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1772,7 +1743,6 @@ "Analytics" ], "description": "Returns the output of an async report", - "operationId": "GetAsyncExportOutput", "parameters": [ { "name": "reportId", @@ -1855,7 +1825,6 @@ "Analytics" ], "description": "Returns the status of an async report", - "operationId": "GetAsyncExportStatus", "parameters": [ { "name": "reportId", @@ -1938,7 +1907,6 @@ "Balance" ], "description": "Gets page of balance objects for the given account id", - "operationId": "BalancesApi_GetApi202110ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2007,7 +1975,6 @@ "Campaign" ], "description": "Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids.", - "operationId": "Campaigns_GetApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2076,7 +2043,6 @@ "Campaign" ], "description": "Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. 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_PostApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2122,7 +2088,6 @@ "Campaign" ], "description": "Gets page of line item objects for the given account id", - "operationId": "GetApiV2ExternalAccountLineItemsByAccountId", "parameters": [ { "name": "account-id", @@ -2219,7 +2184,6 @@ "Campaign" ], "description": "Gets the auction line item for the given line item id", - "operationId": "GetApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2261,7 +2225,6 @@ "Campaign" ], "description": "Updates the auction line item for the given line item id", - "operationId": "PutApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2317,7 +2280,6 @@ "Campaign" ], "description": "This endpoint gets the keyword target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalAuctionLineItemTargetingKeywordsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2361,7 +2323,6 @@ "Campaign" ], "description": "This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2417,7 +2378,6 @@ "Campaign" ], "description": "This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2473,7 +2433,6 @@ "Balance" ], "description": "Gets page of campaigns for the given balanceId", - "operationId": "BalancesApi_GetApi202110ExternalBalanceCampaignsByBalanceId", "parameters": [ { "name": "balance-id", @@ -2542,7 +2501,6 @@ "Campaign" ], "description": "appends one or more campaigns to the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsAppendByBalanceId", "parameters": [ { "name": "balance-id", @@ -2588,7 +2546,6 @@ "Campaign" ], "description": "Removes one or more campaigns on the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsDeleteByBalanceId", "parameters": [ { "name": "balance-id", @@ -2634,7 +2591,6 @@ "Campaign" ], "description": "Gets page of auction line item objects for the given campaign id", - "operationId": "GetApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -2711,7 +2667,6 @@ "Campaign" ], "description": "Creates new auction line item with the specified settings", - "operationId": "PostApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -2767,7 +2722,6 @@ "Campaign" ], "description": "Gets page of preferred line item objects for the given campaign id", - "operationId": "LineItemsApi_GetApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -2844,7 +2798,6 @@ "Campaign" ], "description": "Creates a new preferred line item with the specified settings", - "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -2900,7 +2853,6 @@ "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", @@ -2932,7 +2884,6 @@ "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", @@ -2978,7 +2929,6 @@ "Campaign" ], "description": "Gets the line item for the given line item id", - "operationId": "GetApiV2ExternalLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3012,7 +2962,6 @@ "Campaign" ], "description": "Get bid multipliers by line item", - "operationId": "LineItems_GetApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3053,7 +3002,6 @@ "Campaign" ], "description": "Replace bid multipliers on a line item", - "operationId": "LineItems_PutApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3107,7 +3055,6 @@ "Campaign" ], "description": "This endpoint gets the promoted products on the specified line item.", - "operationId": "PromotedProductsApi_GetApi202110ExternalLineItemProductsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3176,7 +3123,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -3222,7 +3168,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -3268,7 +3213,6 @@ "Campaign" ], "description": "This endpoint pauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsPauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3307,7 +3251,6 @@ "Campaign" ], "description": "This endpoint unpauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsUnpauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3346,7 +3289,6 @@ "Campaign" ], "description": "Gets the preferred line item for the given line item id", - "operationId": "LineItemsApi_GetApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3388,7 +3330,6 @@ "Campaign" ], "description": "Updates the preferred line item for the given line item id", - "operationId": "LineItemsApi_PutApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3444,7 +3385,6 @@ "Campaign" ], "description": "This endpoint gets the add to basket target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3486,7 +3426,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the add to basket target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3542,7 +3481,6 @@ "Campaign" ], "description": "This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3598,7 +3536,6 @@ "Campaign" ], "description": "This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3654,7 +3591,6 @@ "Campaign" ], "description": "This endpoint gets the audience target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3696,7 +3632,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the audience target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3752,7 +3687,6 @@ "Campaign" ], "description": "This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3808,7 +3742,6 @@ "Campaign" ], "description": "This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3864,7 +3797,6 @@ "Campaign" ], "description": "This endpoint gets the store target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3906,7 +3838,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the store target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3962,7 +3893,6 @@ "Campaign" ], "description": "This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4018,7 +3948,6 @@ "Campaign" ], "description": "This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresDeleteByLineItemId", "parameters": [ { "name": "line-item-id", diff --git a/api-specifications/retailmedia_2023-10.json b/api-specifications/retailmedia_2023-10.json index 9967924..b91bf8f 100644 --- a/api-specifications/retailmedia_2023-10.json +++ b/api-specifications/retailmedia_2023-10.json @@ -17,7 +17,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -44,7 +43,6 @@ "Accounts" ], "description": "Gets page of account objects that the current user can access", - "operationId": "AccountsApi_GetApiV1ExternalAccounts", "parameters": [ { "name": "limitToId", @@ -114,7 +112,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountBrandsByAccountId", "parameters": [ { "name": "accountId", @@ -195,7 +192,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountRetailersByAccountId", "parameters": [ { "name": "accountId", @@ -276,7 +272,6 @@ "Campaign" ], "description": "Creates an asset", - "operationId": "CreateAsset", "requestBody": { "content": { "multipart/form-data": { @@ -325,7 +320,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV1", "parameters": [ { "name": "accountId", @@ -424,7 +418,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyCreateAudienceV1", "parameters": [ { "name": "accountId", @@ -528,7 +521,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV2", "parameters": [ { "name": "accountId", @@ -627,7 +619,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyUpdateAudienceV2", "parameters": [ { "name": "accountId", @@ -731,7 +722,6 @@ "Campaign" ], "description": "Fetch keywords associated with the specified line item", - "operationId": "FetchKeywords", "parameters": [ { "name": "id", @@ -774,7 +764,6 @@ "Campaign" ], "description": "Add or Remove keywords from the line item in bulk", - "operationId": "AddRemoveKeywords", "parameters": [ { "name": "id", @@ -826,7 +815,6 @@ "Campaign" ], "description": "Set bid overrides for associated keywords to the given line item in bulk", - "operationId": "SetKeywordBids", "parameters": [ { "name": "id", @@ -878,7 +866,6 @@ "Campaign" ], "description": "Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.", - "operationId": "FetchProposal", "parameters": [ { "name": "id", @@ -931,7 +918,6 @@ "Campaign" ], "description": "Only the components of the Line Item that are in a valid state will be reviewed.", - "operationId": "SubmitProposal", "parameters": [ { "name": "id", @@ -984,7 +970,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_GetApi202110ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1016,7 +1001,6 @@ "Campaign" ], "description": "Create a creative for an account", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1062,7 +1046,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesSearchByAccountId", "parameters": [ { "name": "account-id", @@ -1109,7 +1092,6 @@ "Campaign" ], "description": "Get the specified creative", - "operationId": "CreativesApi_GetApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1152,7 +1134,6 @@ "Campaign" ], "description": "Update a creative", - "operationId": "CreativesApi_PutApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1215,7 +1196,6 @@ "Campaign" ], "description": "Create a request for a Catalog available to the indicated account.", - "operationId": "CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId", "parameters": [ { "name": "accountId", @@ -1260,7 +1240,6 @@ "Campaign" ], "description": "Output the indicated catalog. Catalogs are only available for retrieval when their associated status request\r\nis at a Success status.\r\nProduces application/x-json-stream of v2021_07 CatalogProduct json objects.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogOutputByCatalogId", "parameters": [ { "name": "catalogId", @@ -1308,7 +1287,6 @@ "Campaign" ], "description": "Check the status of a catalog request.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogStatusByCatalogId", "parameters": [ { "name": "catalogId", @@ -1342,7 +1320,6 @@ "Campaign" ], "description": "Endpoint to search categories by text and retailer.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategories", "parameters": [ { "name": "retailerId", @@ -1414,7 +1391,6 @@ "Campaign" ], "description": "Endpoint to search for a specific category by categoryId.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategorieByCategoryId", "parameters": [ { "name": "categoryId", @@ -1461,7 +1437,6 @@ "Campaign" ], "description": "Get retailer creative templates", - "operationId": "CreativesApi_GetApi202207ExternalRetailerTemplatesByRetailerId", "parameters": [ { "name": "retailer-id", @@ -1496,7 +1471,6 @@ "Campaign" ], "description": "Gets the template for the specified retailer id and template id", - "operationId": "CreativesApi_GetApi202207ExternalRetailerByRetailerId}Templates{templateId", "parameters": [ { "name": "retailer-id", @@ -1543,7 +1517,6 @@ "Campaign" ], "description": "Get the page types available for the given retailer", - "operationId": "RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId", "parameters": [ { "name": "retailerId", @@ -1578,7 +1551,6 @@ "Analytics" ], "description": "Return an asynchronous Campaigns Report", - "operationId": "GenerateAsyncCampaignsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1675,7 +1647,6 @@ "Analytics" ], "description": "Returns an asynchronous Line Items Report", - "operationId": "GenerateAsyncLineItemsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1772,7 +1743,6 @@ "Analytics" ], "description": "Returns an asynchronous Revenue Report", - "operationId": "GenerateAsyncRevenueReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1869,7 +1839,6 @@ "Analytics" ], "description": "Returns the output of an async report", - "operationId": "GetAsyncExportOutput", "parameters": [ { "name": "reportId", @@ -1952,7 +1921,6 @@ "Analytics" ], "description": "Returns the status of an async report", - "operationId": "GetAsyncExportStatus", "parameters": [ { "name": "reportId", @@ -2035,7 +2003,6 @@ "Balance" ], "description": "Get page of balances for the given accountId.", - "operationId": "Balances_GetApiV1ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2104,7 +2071,6 @@ "Balance" ], "description": "Create balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2149,7 +2115,6 @@ "Balance" ], "description": "Get a balance for the given account id and balance id", - "operationId": "Balances_GetApiV1ExternalAccountByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2192,7 +2157,6 @@ "Balance" ], "description": "Modify a balance for the given account id", - "operationId": "Balances_PatchApiV1ExternalAccountByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2248,7 +2212,6 @@ "Balance" ], "description": "Add funds to a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountAddFundsByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2304,7 +2267,6 @@ "Balance" ], "description": "Change dates of a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountChangeDatesByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2360,7 +2322,6 @@ "Campaign" ], "description": "Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids.", - "operationId": "Campaigns_GetApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2429,7 +2390,6 @@ "Campaign" ], "description": "Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. 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_PostApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2475,7 +2435,6 @@ "Campaign" ], "description": "Gets page of line item objects for the given account id", - "operationId": "GetApiV2ExternalAccountLineItemsByAccountId", "parameters": [ { "name": "account-id", @@ -2572,7 +2531,6 @@ "Campaign" ], "description": "Gets the auction line item for the given line item id", - "operationId": "GetApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2614,7 +2572,6 @@ "Campaign" ], "description": "Updates the auction line item for the given line item id", - "operationId": "PutApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2670,7 +2627,6 @@ "Campaign" ], "description": "This endpoint gets the keyword target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalAuctionLineItemTargetingKeywordsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2714,7 +2670,6 @@ "Campaign" ], "description": "This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2770,7 +2725,6 @@ "Campaign" ], "description": "This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2826,7 +2780,6 @@ "Balance" ], "description": "Gets page of campaigns for the given balanceId", - "operationId": "BalancesApi_GetApi202110ExternalBalanceCampaignsByBalanceId", "parameters": [ { "name": "balance-id", @@ -2895,7 +2848,6 @@ "Campaign" ], "description": "appends one or more campaigns to the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsAppendByBalanceId", "parameters": [ { "name": "balance-id", @@ -2941,7 +2893,6 @@ "Campaign" ], "description": "Removes one or more campaigns on the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsDeleteByBalanceId", "parameters": [ { "name": "balance-id", @@ -2987,7 +2938,6 @@ "Campaign" ], "description": "Gets page of auction line item objects for the given campaign id", - "operationId": "GetApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3064,7 +3014,6 @@ "Campaign" ], "description": "Creates new auction line item with the specified settings", - "operationId": "PostApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3120,7 +3069,6 @@ "Campaign" ], "description": "Gets page of preferred line item objects for the given campaign id", - "operationId": "LineItemsApi_GetApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3197,7 +3145,6 @@ "Campaign" ], "description": "Creates a new preferred line item with the specified settings", - "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3253,7 +3200,6 @@ "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", @@ -3285,7 +3231,6 @@ "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", @@ -3331,7 +3276,6 @@ "Campaign" ], "description": "Gets the line item for the given line item id", - "operationId": "GetApiV2ExternalLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3365,7 +3309,6 @@ "Campaign" ], "description": "Get bid multipliers by line item", - "operationId": "LineItems_GetApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3406,7 +3349,6 @@ "Campaign" ], "description": "Replace bid multipliers on a line item", - "operationId": "LineItems_PutApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3460,7 +3402,6 @@ "Campaign" ], "description": "This endpoint gets the promoted products on the specified line item.", - "operationId": "PromotedProductsApi_GetApi202110ExternalLineItemProductsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3529,7 +3470,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -3575,7 +3515,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -3621,7 +3560,6 @@ "Campaign" ], "description": "This endpoint pauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsPauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3660,7 +3598,6 @@ "Campaign" ], "description": "This endpoint unpauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsUnpauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3699,7 +3636,6 @@ "Campaign" ], "description": "Gets the preferred line item for the given line item id", - "operationId": "LineItemsApi_GetApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3741,7 +3677,6 @@ "Campaign" ], "description": "Updates the preferred line item for the given line item id", - "operationId": "LineItemsApi_PutApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3797,7 +3732,6 @@ "Campaign" ], "description": "This endpoint gets the add to basket target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3839,7 +3773,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the add to basket target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3895,7 +3828,6 @@ "Campaign" ], "description": "This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3951,7 +3883,6 @@ "Campaign" ], "description": "This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4007,7 +3938,6 @@ "Campaign" ], "description": "This endpoint gets the audience target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4049,7 +3979,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the audience target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4105,7 +4034,6 @@ "Campaign" ], "description": "This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4161,7 +4089,6 @@ "Campaign" ], "description": "This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4217,7 +4144,6 @@ "Campaign" ], "description": "This endpoint gets the store target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4259,7 +4185,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the store target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4315,7 +4240,6 @@ "Campaign" ], "description": "This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4371,7 +4295,6 @@ "Campaign" ], "description": "This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresDeleteByLineItemId", "parameters": [ { "name": "line-item-id", diff --git a/api-specifications/retailmedia_2024-01.json b/api-specifications/retailmedia_2024-01.json index 3fa40ef..445e4ef 100644 --- a/api-specifications/retailmedia_2024-01.json +++ b/api-specifications/retailmedia_2024-01.json @@ -17,7 +17,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -44,7 +43,6 @@ "Accounts" ], "description": "Gets page of account objects that the current user can access", - "operationId": "AccountsApi_GetApiV1ExternalAccounts", "parameters": [ { "name": "limitToId", @@ -114,7 +112,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountBrandsByAccountId", "parameters": [ { "name": "accountId", @@ -195,7 +192,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountRetailersByAccountId", "parameters": [ { "name": "accountId", @@ -276,7 +272,6 @@ "Campaign" ], "description": "Creates an asset", - "operationId": "CreateAsset", "requestBody": { "content": { "multipart/form-data": { @@ -325,7 +320,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV1", "parameters": [ { "name": "accountId", @@ -424,7 +418,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyCreateAudienceV1", "parameters": [ { "name": "accountId", @@ -528,7 +521,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV2", "parameters": [ { "name": "accountId", @@ -627,7 +619,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyUpdateAudienceV2", "parameters": [ { "name": "accountId", @@ -731,7 +722,6 @@ "Campaign" ], "description": "Fetch keywords associated with the specified line item", - "operationId": "FetchKeywords", "parameters": [ { "name": "id", @@ -774,7 +764,6 @@ "Campaign" ], "description": "Add or Remove keywords from the line item in bulk", - "operationId": "AddRemoveKeywords", "parameters": [ { "name": "id", @@ -826,7 +815,6 @@ "Campaign" ], "description": "Set bid overrides for associated keywords to the given line item in bulk", - "operationId": "SetKeywordBids", "parameters": [ { "name": "id", @@ -878,7 +866,6 @@ "Campaign" ], "description": "Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.", - "operationId": "FetchProposal", "parameters": [ { "name": "id", @@ -931,7 +918,6 @@ "Campaign" ], "description": "Only the components of the Line Item that are in a valid state will be reviewed.", - "operationId": "SubmitProposal", "parameters": [ { "name": "id", @@ -984,7 +970,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_GetApi202110ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1016,7 +1001,6 @@ "Campaign" ], "description": "Create a creative for an account", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1062,7 +1046,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesSearchByAccountId", "parameters": [ { "name": "account-id", @@ -1109,7 +1092,6 @@ "Campaign" ], "description": "Get the specified creative", - "operationId": "CreativesApi_GetApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1152,7 +1134,6 @@ "Campaign" ], "description": "Update a creative", - "operationId": "CreativesApi_PutApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1215,7 +1196,6 @@ "Campaign" ], "description": "Create a request for a Catalog available to the indicated account.", - "operationId": "CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId", "parameters": [ { "name": "accountId", @@ -1260,7 +1240,6 @@ "Campaign" ], "description": "Output the indicated catalog. Catalogs are only available for retrieval when their associated status request\r\nis at a Success status.\r\nProduces application/x-json-stream of v2021_07 CatalogProduct json objects.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogOutputByCatalogId", "parameters": [ { "name": "catalogId", @@ -1308,7 +1287,6 @@ "Campaign" ], "description": "Check the status of a catalog request.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogStatusByCatalogId", "parameters": [ { "name": "catalogId", @@ -1342,7 +1320,6 @@ "Campaign" ], "description": "Endpoint to search categories by text and retailer.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategories", "parameters": [ { "name": "retailerId", @@ -1414,7 +1391,6 @@ "Campaign" ], "description": "Endpoint to search for a specific category by categoryId.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategorieByCategoryId", "parameters": [ { "name": "categoryId", @@ -1461,7 +1437,6 @@ "Campaign" ], "description": "Get retailer creative templates", - "operationId": "CreativesApi_GetApi202207ExternalRetailerTemplatesByRetailerId", "parameters": [ { "name": "retailer-id", @@ -1496,7 +1471,6 @@ "Campaign" ], "description": "Gets the template for the specified retailer id and template id", - "operationId": "CreativesApi_GetApi202207ExternalRetailerByRetailerId}Templates{templateId", "parameters": [ { "name": "retailer-id", @@ -1543,7 +1517,6 @@ "Campaign" ], "description": "Get the page types available for the given retailer", - "operationId": "RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId", "parameters": [ { "name": "retailerId", @@ -1578,7 +1551,6 @@ "Analytics" ], "description": "Return an asynchronous Campaigns Report", - "operationId": "GenerateAsyncCampaignsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1675,7 +1647,6 @@ "Analytics" ], "description": "Returns an asynchronous Line Items Report", - "operationId": "GenerateAsyncLineItemsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1772,7 +1743,6 @@ "Analytics" ], "description": "Returns an asynchronous Revenue Report", - "operationId": "GenerateAsyncRevenueReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1869,7 +1839,6 @@ "Analytics" ], "description": "Returns the output of an async report", - "operationId": "GetAsyncExportOutput", "parameters": [ { "name": "reportId", @@ -1952,7 +1921,6 @@ "Analytics" ], "description": "Returns the status of an async report", - "operationId": "GetAsyncExportStatus", "parameters": [ { "name": "reportId", @@ -2035,7 +2003,6 @@ "Campaign" ], "description": "Get current campaign budget overrides by given external campaign id.", - "operationId": "GetCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -2067,7 +2034,6 @@ "Campaign" ], "description": "Update campaign budget overrides by given external campaign id and new campaign budget overrides settings.", - "operationId": "UpdateCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -2127,7 +2093,6 @@ "Campaign" ], "description": "Gets a collection of monthly and daily budget overrides for the provided line item.", - "operationId": "GetLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -2158,7 +2123,6 @@ "Campaign" ], "description": "Update line item budget overrides by given external line item id and new line item budget overrides settings.", - "operationId": "UpdateLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -2217,7 +2181,6 @@ "Balance" ], "description": "Get page of balances for the given accountId.", - "operationId": "Balances_GetApiV1ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2286,7 +2249,6 @@ "Balance" ], "description": "Create balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2331,7 +2293,6 @@ "Balance" ], "description": "Get a balance for the given account id and balance id", - "operationId": "Balances_GetApiV1ExternalAccountByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2374,7 +2335,6 @@ "Balance" ], "description": "Modify a balance for the given account id", - "operationId": "Balances_PatchApiV1ExternalAccountByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2430,7 +2390,6 @@ "Balance" ], "description": "Add funds to a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountAddFundsByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2486,7 +2445,6 @@ "Balance" ], "description": "Change dates of a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountChangeDatesByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2542,7 +2500,6 @@ "Campaign" ], "description": "Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids.", - "operationId": "Campaigns_GetApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2611,7 +2568,6 @@ "Campaign" ], "description": "Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. 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_PostApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2657,7 +2613,6 @@ "Campaign" ], "description": "Gets page of line item objects for the given account id", - "operationId": "GetApiV2ExternalAccountLineItemsByAccountId", "parameters": [ { "name": "account-id", @@ -2754,7 +2709,6 @@ "Campaign" ], "description": "Gets the auction line item for the given line item id", - "operationId": "GetApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2796,7 +2750,6 @@ "Campaign" ], "description": "Updates the auction line item for the given line item id", - "operationId": "PutApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2852,7 +2805,6 @@ "Campaign" ], "description": "This endpoint gets the keyword target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalAuctionLineItemTargetingKeywordsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2896,7 +2848,6 @@ "Campaign" ], "description": "This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -2952,7 +2903,6 @@ "Campaign" ], "description": "This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3008,7 +2958,6 @@ "Balance" ], "description": "Gets page of campaigns for the given balanceId", - "operationId": "BalancesApi_GetApi202110ExternalBalanceCampaignsByBalanceId", "parameters": [ { "name": "balance-id", @@ -3077,7 +3026,6 @@ "Campaign" ], "description": "appends one or more campaigns to the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsAppendByBalanceId", "parameters": [ { "name": "balance-id", @@ -3123,7 +3071,6 @@ "Campaign" ], "description": "Removes one or more campaigns on the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsDeleteByBalanceId", "parameters": [ { "name": "balance-id", @@ -3169,7 +3116,6 @@ "Campaign" ], "description": "Gets page of auction line item objects for the given campaign id", - "operationId": "GetApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3246,7 +3192,6 @@ "Campaign" ], "description": "Creates new auction line item with the specified settings", - "operationId": "PostApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3302,7 +3247,6 @@ "Campaign" ], "description": "Gets page of preferred line item objects for the given campaign id", - "operationId": "LineItemsApi_GetApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3379,7 +3323,6 @@ "Campaign" ], "description": "Creates a new preferred line item with the specified settings", - "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3435,7 +3378,6 @@ "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", @@ -3467,7 +3409,6 @@ "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", @@ -3513,7 +3454,6 @@ "Campaign" ], "description": "Gets the line item for the given line item id", - "operationId": "GetApiV2ExternalLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3547,7 +3487,6 @@ "Campaign" ], "description": "Get bid multipliers by line item", - "operationId": "LineItems_GetApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3588,7 +3527,6 @@ "Campaign" ], "description": "Replace bid multipliers on a line item", - "operationId": "LineItems_PutApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3642,7 +3580,6 @@ "Campaign" ], "description": "This endpoint gets the promoted products on the specified line item.", - "operationId": "PromotedProductsApi_GetApi202110ExternalLineItemProductsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3711,7 +3648,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -3757,7 +3693,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -3803,7 +3738,6 @@ "Campaign" ], "description": "This endpoint pauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsPauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3842,7 +3776,6 @@ "Campaign" ], "description": "This endpoint unpauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsUnpauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3881,7 +3814,6 @@ "Campaign" ], "description": "Gets the preferred line item for the given line item id", - "operationId": "LineItemsApi_GetApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3923,7 +3855,6 @@ "Campaign" ], "description": "Updates the preferred line item for the given line item id", - "operationId": "LineItemsApi_PutApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3979,7 +3910,6 @@ "Campaign" ], "description": "This endpoint gets the add to basket target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4021,7 +3951,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the add to basket target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4077,7 +4006,6 @@ "Campaign" ], "description": "This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4133,7 +4061,6 @@ "Campaign" ], "description": "This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4189,7 +4116,6 @@ "Campaign" ], "description": "This endpoint gets the audience target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4231,7 +4157,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the audience target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4287,7 +4212,6 @@ "Campaign" ], "description": "This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4343,7 +4267,6 @@ "Campaign" ], "description": "This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4399,7 +4322,6 @@ "Campaign" ], "description": "This endpoint gets the store target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4441,7 +4363,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the store target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4497,7 +4418,6 @@ "Campaign" ], "description": "This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4553,7 +4473,6 @@ "Campaign" ], "description": "This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresDeleteByLineItemId", "parameters": [ { "name": "line-item-id", diff --git a/api-specifications/retailmedia_2024-04.json b/api-specifications/retailmedia_2024-04.json index 393a3c5..5d0ae21 100644 --- a/api-specifications/retailmedia_2024-04.json +++ b/api-specifications/retailmedia_2024-04.json @@ -17,7 +17,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -44,7 +43,6 @@ "Accounts" ], "description": "Gets page of account objects that the current user can access", - "operationId": "AccountsApi_GetApiV1ExternalAccounts", "parameters": [ { "name": "limitToId", @@ -114,7 +112,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountBrandsByAccountId", "parameters": [ { "name": "accountId", @@ -195,7 +192,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountRetailersByAccountId", "parameters": [ { "name": "accountId", @@ -276,7 +272,6 @@ "Campaign" ], "description": "Creates an asset", - "operationId": "CreateAsset", "requestBody": { "content": { "multipart/form-data": { @@ -325,7 +320,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV1", "parameters": [ { "name": "accountId", @@ -424,7 +418,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyCreateAudienceV1", "parameters": [ { "name": "accountId", @@ -528,7 +521,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV2", "parameters": [ { "name": "accountId", @@ -627,7 +619,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyUpdateAudienceV2", "parameters": [ { "name": "accountId", @@ -731,7 +722,6 @@ "Campaign" ], "description": "Fetch keywords associated with the specified line item", - "operationId": "FetchKeywords", "parameters": [ { "name": "id", @@ -774,7 +764,6 @@ "Campaign" ], "description": "Add or Remove keywords from the line item in bulk", - "operationId": "AddRemoveKeywords", "parameters": [ { "name": "id", @@ -826,7 +815,6 @@ "Campaign" ], "description": "Set bid overrides for associated keywords to the given line item in bulk", - "operationId": "SetKeywordBids", "parameters": [ { "name": "id", @@ -878,7 +866,6 @@ "Campaign" ], "description": "Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.", - "operationId": "FetchProposal", "parameters": [ { "name": "id", @@ -931,7 +918,6 @@ "Campaign" ], "description": "Only the components of the Line Item that are in a valid state will be reviewed.", - "operationId": "SubmitProposal", "parameters": [ { "name": "id", @@ -984,7 +970,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_GetApi202110ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1016,7 +1001,6 @@ "Campaign" ], "description": "Create a creative for an account", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1062,7 +1046,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesSearchByAccountId", "parameters": [ { "name": "account-id", @@ -1109,7 +1092,6 @@ "Campaign" ], "description": "Get the specified creative", - "operationId": "CreativesApi_GetApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1152,7 +1134,6 @@ "Campaign" ], "description": "Update a creative", - "operationId": "CreativesApi_PutApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1215,7 +1196,6 @@ "Campaign" ], "description": "Create a request for a Catalog available to the indicated account.", - "operationId": "CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId", "parameters": [ { "name": "accountId", @@ -1260,7 +1240,6 @@ "Campaign" ], "description": "Output the indicated catalog. Catalogs are only available for retrieval when their associated status request\r\nis at a Success status.\r\nProduces application/x-json-stream of v2021_07 CatalogProduct json objects.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogOutputByCatalogId", "parameters": [ { "name": "catalogId", @@ -1308,7 +1287,6 @@ "Campaign" ], "description": "Check the status of a catalog request.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogStatusByCatalogId", "parameters": [ { "name": "catalogId", @@ -1342,7 +1320,6 @@ "Campaign" ], "description": "Endpoint to search categories by text and retailer.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategories", "parameters": [ { "name": "retailerId", @@ -1414,7 +1391,6 @@ "Campaign" ], "description": "Endpoint to search for a specific category by categoryId.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategorieByCategoryId", "parameters": [ { "name": "categoryId", @@ -1461,7 +1437,6 @@ "Campaign" ], "description": "Get retailer creative templates", - "operationId": "CreativesApi_GetApi202207ExternalRetailerTemplatesByRetailerId", "parameters": [ { "name": "retailer-id", @@ -1496,7 +1471,6 @@ "Campaign" ], "description": "Gets the template for the specified retailer id and template id", - "operationId": "CreativesApi_GetApi202207ExternalRetailerByRetailerId}Templates{templateId", "parameters": [ { "name": "retailer-id", @@ -1543,7 +1517,6 @@ "Campaign" ], "description": "Get the page types available for the given retailer", - "operationId": "RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId", "parameters": [ { "name": "retailerId", @@ -1578,7 +1551,6 @@ "Analytics" ], "description": "Return an asynchronous Campaigns Report", - "operationId": "GenerateAsyncCampaignsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1675,7 +1647,6 @@ "Analytics" ], "description": "Returns an asynchronous Line Items Report", - "operationId": "GenerateAsyncLineItemsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1772,7 +1743,6 @@ "Analytics" ], "description": "Returns an asynchronous Revenue Report", - "operationId": "GenerateAsyncRevenueReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1869,7 +1839,6 @@ "Analytics" ], "description": "Returns the output of an async report", - "operationId": "GetAsyncExportOutput", "parameters": [ { "name": "reportId", @@ -1952,7 +1921,6 @@ "Analytics" ], "description": "Returns the status of an async report", - "operationId": "GetAsyncExportStatus", "parameters": [ { "name": "reportId", @@ -2035,7 +2003,6 @@ "Accounts" ], "description": "Add brands to an account", - "operationId": "AddBrands", "parameters": [ { "name": "accountId", @@ -2094,7 +2061,6 @@ "Accounts" ], "description": "Remove a brand from an account", - "operationId": "RemoveBrands", "parameters": [ { "name": "accountId", @@ -2153,7 +2119,6 @@ "Accounts" ], "description": "Creates a new child Demand Brand Account for the provided parent private market account", - "operationId": "CreatePrivateMarketDemandBrandAccount", "parameters": [ { "name": "accountId", @@ -2212,7 +2177,6 @@ "Campaign" ], "description": "Get current campaign budget overrides by given external campaign id.", - "operationId": "GetCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -2244,7 +2208,6 @@ "Campaign" ], "description": "Update campaign budget overrides by given external campaign id and new campaign budget overrides settings.", - "operationId": "UpdateCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -2304,7 +2267,6 @@ "Campaign" ], "description": "Gets the balance's historical data change capture.", - "operationId": "GetInsertionOrderHistoryChangeDataCapture", "parameters": [ { "name": "insertionOrderId", @@ -2372,7 +2334,6 @@ "Campaign" ], "description": "Gets a collection of monthly and daily budget overrides for the provided line item.", - "operationId": "GetLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -2403,7 +2364,6 @@ "Campaign" ], "description": "Update line item budget overrides by given external line item id and new line item budget overrides settings.", - "operationId": "UpdateLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -2462,7 +2422,6 @@ "Balance" ], "description": "Get page of balances for the given accountId.", - "operationId": "Balances_GetApiV1ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2531,7 +2490,6 @@ "Balance" ], "description": "Create balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2576,7 +2534,6 @@ "Balance" ], "description": "Get a balance for the given account id and balance id", - "operationId": "Balances_GetApiV1ExternalAccountByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2619,7 +2576,6 @@ "Balance" ], "description": "Modify a balance for the given account id", - "operationId": "Balances_PatchApiV1ExternalAccountByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2675,7 +2631,6 @@ "Balance" ], "description": "Add funds to a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountAddFundsByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2731,7 +2686,6 @@ "Balance" ], "description": "Change dates of a balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountChangeDatesByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2787,7 +2741,6 @@ "Campaign" ], "description": "Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids.", - "operationId": "Campaigns_GetApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2856,7 +2809,6 @@ "Campaign" ], "description": "Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. 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_PostApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2902,7 +2854,6 @@ "Campaign" ], "description": "Gets page of line item objects for the given account id", - "operationId": "GetApiV2ExternalAccountLineItemsByAccountId", "parameters": [ { "name": "account-id", @@ -2999,7 +2950,6 @@ "Campaign" ], "description": "Gets the auction line item for the given line item id", - "operationId": "GetApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3041,7 +2991,6 @@ "Campaign" ], "description": "Updates the auction line item for the given line item id", - "operationId": "PutApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3097,7 +3046,6 @@ "Campaign" ], "description": "This endpoint gets the keyword target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalAuctionLineItemTargetingKeywordsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3141,7 +3089,6 @@ "Campaign" ], "description": "This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3197,7 +3144,6 @@ "Campaign" ], "description": "This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3253,7 +3199,6 @@ "Balance" ], "description": "Gets page of campaigns for the given balanceId", - "operationId": "BalancesApi_GetApi202110ExternalBalanceCampaignsByBalanceId", "parameters": [ { "name": "balance-id", @@ -3322,7 +3267,6 @@ "Campaign" ], "description": "appends one or more campaigns to the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsAppendByBalanceId", "parameters": [ { "name": "balance-id", @@ -3368,7 +3312,6 @@ "Campaign" ], "description": "Removes one or more campaigns on the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsDeleteByBalanceId", "parameters": [ { "name": "balance-id", @@ -3414,7 +3357,6 @@ "Campaign" ], "description": "Gets page of auction line item objects for the given campaign id", - "operationId": "GetApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3491,7 +3433,6 @@ "Campaign" ], "description": "Creates new auction line item with the specified settings", - "operationId": "PostApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3547,7 +3488,6 @@ "Campaign" ], "description": "Gets page of preferred line item objects for the given campaign id", - "operationId": "LineItemsApi_GetApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3624,7 +3564,6 @@ "Campaign" ], "description": "Creates a new preferred line item with the specified settings", - "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3680,7 +3619,6 @@ "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", @@ -3712,7 +3650,6 @@ "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", @@ -3758,7 +3695,6 @@ "Campaign" ], "description": "Gets the line item for the given line item id", - "operationId": "GetApiV2ExternalLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3792,7 +3728,6 @@ "Campaign" ], "description": "Get bid multipliers by line item", - "operationId": "LineItems_GetApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3833,7 +3768,6 @@ "Campaign" ], "description": "Replace bid multipliers on a line item", - "operationId": "LineItems_PutApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3887,7 +3821,6 @@ "Campaign" ], "description": "This endpoint gets the promoted products on the specified line item.", - "operationId": "PromotedProductsApi_GetApi202110ExternalLineItemProductsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3956,7 +3889,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -4002,7 +3934,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -4048,7 +3979,6 @@ "Campaign" ], "description": "This endpoint pauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsPauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4087,7 +4017,6 @@ "Campaign" ], "description": "This endpoint unpauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsUnpauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4126,7 +4055,6 @@ "Campaign" ], "description": "Gets the preferred line item for the given line item id", - "operationId": "LineItemsApi_GetApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4168,7 +4096,6 @@ "Campaign" ], "description": "Updates the preferred line item for the given line item id", - "operationId": "LineItemsApi_PutApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4224,7 +4151,6 @@ "Campaign" ], "description": "This endpoint gets the add to basket target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4266,7 +4192,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the add to basket target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4322,7 +4247,6 @@ "Campaign" ], "description": "This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4378,7 +4302,6 @@ "Campaign" ], "description": "This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4434,7 +4357,6 @@ "Campaign" ], "description": "This endpoint gets the audience target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4476,7 +4398,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the audience target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4532,7 +4453,6 @@ "Campaign" ], "description": "This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4588,7 +4508,6 @@ "Campaign" ], "description": "This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4644,7 +4563,6 @@ "Campaign" ], "description": "This endpoint gets the store target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4686,7 +4604,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the store target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4742,7 +4659,6 @@ "Campaign" ], "description": "This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4798,7 +4714,6 @@ "Campaign" ], "description": "This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresDeleteByLineItemId", "parameters": [ { "name": "line-item-id", diff --git a/api-specifications/retailmedia_2024-07.json b/api-specifications/retailmedia_2024-07.json index 09762ac..bf6416b 100644 --- a/api-specifications/retailmedia_2024-07.json +++ b/api-specifications/retailmedia_2024-07.json @@ -17,7 +17,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -44,7 +43,6 @@ "Accounts" ], "description": "Gets page of account objects that the current user can access", - "operationId": "AccountsApi_GetApiV1ExternalAccounts", "parameters": [ { "name": "limitToId", @@ -114,7 +112,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountBrandsByAccountId", "parameters": [ { "name": "accountId", @@ -195,7 +192,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountRetailersByAccountId", "parameters": [ { "name": "accountId", @@ -276,7 +272,6 @@ "Campaign" ], "description": "Creates an asset", - "operationId": "CreateAsset", "requestBody": { "content": { "multipart/form-data": { @@ -325,7 +320,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV1", "parameters": [ { "name": "accountId", @@ -424,7 +418,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyCreateAudienceV1", "parameters": [ { "name": "accountId", @@ -528,7 +521,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV2", "parameters": [ { "name": "accountId", @@ -627,7 +619,6 @@ "Audience" ], "description": "Create an Audience (deprecated Public API)", - "operationId": "LegacyUpdateAudienceV2", "parameters": [ { "name": "accountId", @@ -731,7 +722,6 @@ "Campaign" ], "description": "Fetch keywords associated with the specified line item", - "operationId": "FetchKeywords", "parameters": [ { "name": "id", @@ -774,7 +764,6 @@ "Campaign" ], "description": "Add or Remove keywords from the line item in bulk", - "operationId": "AddRemoveKeywords", "parameters": [ { "name": "id", @@ -826,7 +815,6 @@ "Campaign" ], "description": "Set bid overrides for associated keywords to the given line item in bulk", - "operationId": "SetKeywordBids", "parameters": [ { "name": "id", @@ -878,7 +866,6 @@ "Campaign" ], "description": "Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.", - "operationId": "FetchProposal", "parameters": [ { "name": "id", @@ -931,7 +918,6 @@ "Campaign" ], "description": "Only the components of the Line Item that are in a valid state will be reviewed.", - "operationId": "SubmitProposal", "parameters": [ { "name": "id", @@ -984,7 +970,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_GetApi202110ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1016,7 +1001,6 @@ "Campaign" ], "description": "Create a creative for an account", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1062,7 +1046,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "CreativesApi_PostApi202210ExternalAccountCreativesSearchByAccountId", "parameters": [ { "name": "account-id", @@ -1109,7 +1092,6 @@ "Campaign" ], "description": "Get the specified creative", - "operationId": "CreativesApi_GetApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1152,7 +1134,6 @@ "Campaign" ], "description": "Update a creative", - "operationId": "CreativesApi_PutApi202210ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -1215,7 +1196,6 @@ "Campaign" ], "description": "Create a request for a Catalog available to the indicated account.", - "operationId": "CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId", "parameters": [ { "name": "accountId", @@ -1260,7 +1240,6 @@ "Campaign" ], "description": "Output the indicated catalog. Catalogs are only available for retrieval when their associated status request\r\nis at a Success status.\r\nProduces application/x-json-stream of v2021_07 CatalogProduct json objects.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogOutputByCatalogId", "parameters": [ { "name": "catalogId", @@ -1308,7 +1287,6 @@ "Campaign" ], "description": "Check the status of a catalog request.", - "operationId": "CatalogApi_GetApiV1ExternalCatalogStatusByCatalogId", "parameters": [ { "name": "catalogId", @@ -1342,7 +1320,6 @@ "Campaign" ], "description": "Endpoint to search categories by text and retailer.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategories", "parameters": [ { "name": "retailerId", @@ -1414,7 +1391,6 @@ "Campaign" ], "description": "Endpoint to search for a specific category by categoryId.", - "operationId": "CategorySearchApi_GetApi202204ExternalCategorieByCategoryId", "parameters": [ { "name": "categoryId", @@ -1461,7 +1437,6 @@ "Campaign" ], "description": "Get retailer creative templates", - "operationId": "CreativesApi_GetApi202207ExternalRetailerTemplatesByRetailerId", "parameters": [ { "name": "retailer-id", @@ -1496,7 +1471,6 @@ "Campaign" ], "description": "Gets the template for the specified retailer id and template id", - "operationId": "CreativesApi_GetApi202207ExternalRetailerByRetailerId}Templates{templateId", "parameters": [ { "name": "retailer-id", @@ -1543,7 +1517,6 @@ "Campaign" ], "description": "Get the page types available for the given retailer", - "operationId": "RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId", "parameters": [ { "name": "retailerId", @@ -1578,7 +1551,6 @@ "Analytics" ], "description": "Return an asynchronous Campaigns Report", - "operationId": "GenerateAsyncCampaignsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1675,7 +1647,6 @@ "Analytics" ], "description": "Returns an asynchronous Line Items Report", - "operationId": "GenerateAsyncLineItemsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1772,7 +1743,6 @@ "Analytics" ], "description": "Returns an asynchronous Revenue Report", - "operationId": "GenerateAsyncRevenueReport", "requestBody": { "content": { "application/json-patch+json": { @@ -1869,7 +1839,6 @@ "Analytics" ], "description": "Returns the output of an async report", - "operationId": "GetAsyncExportOutput", "parameters": [ { "name": "reportId", @@ -1952,7 +1921,6 @@ "Analytics" ], "description": "Returns the status of an async report", - "operationId": "GetAsyncExportStatus", "parameters": [ { "name": "reportId", @@ -2035,7 +2003,6 @@ "Accounts" ], "description": "Add brands to an account", - "operationId": "AddBrands", "parameters": [ { "name": "accountId", @@ -2094,7 +2061,6 @@ "Accounts" ], "description": "Remove a brand from an account", - "operationId": "RemoveBrands", "parameters": [ { "name": "accountId", @@ -2153,7 +2119,6 @@ "Accounts" ], "description": "Creates a new child Demand Brand Account for the provided parent private market account", - "operationId": "CreatePrivateMarketDemandBrandAccount", "parameters": [ { "name": "accountId", @@ -2212,7 +2177,6 @@ "Accounts" ], "description": "Creates a new child Demand Seller Account for the provided parent private market account", - "operationId": "CreatePrivateMarketDemandSellerAccount", "parameters": [ { "name": "accountId", @@ -2271,7 +2235,6 @@ "Accounts" ], "description": "replace the sellers assoiated with an account", - "operationId": "UpdateSellers", "parameters": [ { "name": "accountId", @@ -2330,7 +2293,6 @@ "Balance" ], "description": "Gets the balance's historical change data.", - "operationId": "GetBalanceHistory", "parameters": [ { "name": "balanceId", @@ -2398,7 +2360,6 @@ "Campaign" ], "description": "Get current campaign budget overrides by given external campaign id.", - "operationId": "GetCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -2430,7 +2391,6 @@ "Campaign" ], "description": "Update campaign budget overrides by given external campaign id and new campaign budget overrides settings.", - "operationId": "UpdateCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -2490,7 +2450,6 @@ "Campaign" ], "description": "Gets a collection of monthly and daily budget overrides for the provided line item.", - "operationId": "GetLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -2521,7 +2480,6 @@ "Campaign" ], "description": "Update line item budget overrides by given external line item id and new line item budget overrides settings.", - "operationId": "UpdateLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -2579,13 +2537,12 @@ "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", "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,9 +2592,19 @@ "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" } } } @@ -2649,7 +2616,6 @@ "Balance" ], "description": "Create balance for the given account id", - "operationId": "Balances_PostApiV1ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -2664,13 +2630,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 +2646,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 +2666,12 @@ } } }, - "/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", "parameters": [ { "name": "account-id", @@ -2708,7 +2685,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance id", "required": true, @@ -2723,9 +2700,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 +2724,6 @@ "Balance" ], "description": "Modify a balance for the given account id", - "operationId": "Balances_PatchApiV1ExternalAccountByAccountIdAndBalanceId", "parameters": [ { "name": "account-id", @@ -2751,7 +2737,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance to change the dates", "required": true, @@ -2763,13 +2749,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 +2765,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 +2785,12 @@ } } }, - "/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", "parameters": [ { "name": "account-id", @@ -2807,7 +2804,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance to add funds to", "required": true, @@ -2819,13 +2816,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 +2832,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 +2852,12 @@ } } }, - "/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", "parameters": [ { "name": "account-id", @@ -2863,7 +2871,7 @@ "x-nullable": false }, { - "name": "balanceId", + "name": "balance-id", "in": "path", "description": "The balance to change the dates", "required": true, @@ -2875,13 +2883,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 +2899,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" } } } @@ -2905,7 +2925,6 @@ "Campaign" ], "description": "Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids.", - "operationId": "Campaigns_GetApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -2974,7 +2993,6 @@ "Campaign" ], "description": "Create a campaign and assign budgets for the given account id with creatable campaign attributes given in request body constrained by business validation. The validation error includes details and source of errors. 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_PostApi202301ExternalAccountCampaignsByAccountId", "parameters": [ { "name": "account-id", @@ -3020,7 +3038,6 @@ "Campaign" ], "description": "Gets page of line item objects for the given account id", - "operationId": "GetApiV2ExternalAccountLineItemsByAccountId", "parameters": [ { "name": "account-id", @@ -3117,7 +3134,6 @@ "Campaign" ], "description": "Gets the auction line item for the given line item id", - "operationId": "GetApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3159,7 +3175,6 @@ "Campaign" ], "description": "Updates the auction line item for the given line item id", - "operationId": "PutApiV2ExternalAuctionLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3215,7 +3230,6 @@ "Campaign" ], "description": "This endpoint gets the keyword target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalAuctionLineItemTargetingKeywordsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3259,7 +3273,6 @@ "Campaign" ], "description": "This endpoint appends one or more keywords to targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3315,7 +3328,6 @@ "Campaign" ], "description": "This endpoint removes one or more keywords from targeting on the specified line item. The resulting state of the keyword target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalAuctionLineItemTargetingKeywordsDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3371,7 +3383,6 @@ "Balance" ], "description": "Gets page of campaigns for the given balanceId", - "operationId": "BalancesApi_GetApi202110ExternalBalanceCampaignsByBalanceId", "parameters": [ { "name": "balance-id", @@ -3440,7 +3451,6 @@ "Campaign" ], "description": "appends one or more campaigns to the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsAppendByBalanceId", "parameters": [ { "name": "balance-id", @@ -3486,7 +3496,6 @@ "Campaign" ], "description": "Removes one or more campaigns on the specified balance", - "operationId": "BalancesApi_PostApi202110ExternalBalanceCampaignsDeleteByBalanceId", "parameters": [ { "name": "balance-id", @@ -3532,7 +3541,6 @@ "Campaign" ], "description": "Gets page of auction line item objects for the given campaign id", - "operationId": "GetApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3609,7 +3617,6 @@ "Campaign" ], "description": "Creates new auction line item with the specified settings", - "operationId": "PostApiV2ExternalCampaignAuctionLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3665,7 +3672,6 @@ "Campaign" ], "description": "Gets page of preferred line item objects for the given campaign id", - "operationId": "LineItemsApi_GetApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3742,7 +3748,6 @@ "Campaign" ], "description": "Creates a new preferred line item with the specified settings", - "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -3798,7 +3803,6 @@ "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", @@ -3830,7 +3834,6 @@ "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", @@ -3876,7 +3879,6 @@ "Campaign" ], "description": "Gets the line item for the given line item id", - "operationId": "GetApiV2ExternalLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3910,7 +3912,6 @@ "Campaign" ], "description": "Get bid multipliers by line item", - "operationId": "LineItems_GetApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -3951,7 +3952,6 @@ "Campaign" ], "description": "Replace bid multipliers on a line item", - "operationId": "LineItems_PutApi202301ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4005,7 +4005,6 @@ "Campaign" ], "description": "This endpoint gets the promoted products on the specified line item.", - "operationId": "PromotedProductsApi_GetApi202110ExternalLineItemProductsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4074,7 +4073,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -4120,7 +4118,6 @@ "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", "parameters": [ { "name": "line-item-id", @@ -4166,7 +4163,6 @@ "Campaign" ], "description": "This endpoint pauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsPauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4205,7 +4201,6 @@ "Campaign" ], "description": "This endpoint unpauses one or more promoted products on a specified line item.", - "operationId": "PromotedProducts_PostApi202110ExternalLineItemProductsUnpauseByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4244,7 +4239,6 @@ "Campaign" ], "description": "Gets the preferred line item for the given line item id", - "operationId": "LineItemsApi_GetApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4286,7 +4280,6 @@ "Campaign" ], "description": "Updates the preferred line item for the given line item id", - "operationId": "LineItemsApi_PutApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4342,7 +4335,6 @@ "Campaign" ], "description": "This endpoint gets the add to basket target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4384,7 +4376,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the add to basket target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAddToBasketByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4440,7 +4431,6 @@ "Campaign" ], "description": "This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4496,7 +4486,6 @@ "Campaign" ], "description": "This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAddToBasketDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4552,7 +4541,6 @@ "Campaign" ], "description": "This endpoint gets the audience target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4594,7 +4582,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the audience target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingAudiencesByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4650,7 +4637,6 @@ "Campaign" ], "description": "This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4706,7 +4692,6 @@ "Campaign" ], "description": "This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingAudiencesDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4762,7 +4747,6 @@ "Campaign" ], "description": "This endpoint gets the store target on the specified line item.", - "operationId": "TargetingApi_GetApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4804,7 +4788,6 @@ "Campaign" ], "description": "This endpoint sets the scope of the store target on the specified line item.", - "operationId": "TargetingApi_PutApi202110ExternalPreferredLineItemTargetingStoresByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4860,7 +4843,6 @@ "Campaign" ], "description": "This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresAppendByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4916,7 +4898,6 @@ "Campaign" ], "description": "This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned.", - "operationId": "TargetingApi_PostApi202110ExternalPreferredLineItemTargetingStoresDeleteByLineItemId", "parameters": [ { "name": "line-item-id", @@ -9393,7 +9374,7 @@ "additionalProperties": false, "description": "The details for a daily budget override" }, - "BalanceResponsePagedListResponse": { + "PagedResourceCollectionOutcomeOfBalanceResponseV2": { "type": "object", "properties": { "metadata": { @@ -9402,7 +9383,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ResourceOfBalanceResponse" + "$ref": "#/components/schemas/ResourceOfBalanceResponseV2" }, "x-nullable": false }, @@ -9423,14 +9404,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 +9429,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": [ @@ -9914,45 +9894,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", @@ -10122,11 +10098,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 +10115,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": [ @@ -10364,11 +10339,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 +10356,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 +10375,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 +10394,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 +10413,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 +10565,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 +10583,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 +10601,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 +10634,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 +10656,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 +10677,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": [ @@ -11406,15 +11371,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 +11387,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 +11422,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..6c46b1a 100644 --- a/api-specifications/retailmedia_preview.json +++ b/api-specifications/retailmedia_preview.json @@ -3,7 +3,7 @@ "info": { "title": "Criteo API", "description": "Criteo API - RetailMedia", - "version": "Preview" + "version": "preview" }, "servers": [ { @@ -18,7 +18,6 @@ ], "summary": "", "description": "Grant consent to a business application on behalf of a Private Market demand account", - "operationId": "GrantConsent", "parameters": [ { "name": "accountId", @@ -69,7 +68,6 @@ "Audience" ], "description": "Add/remove identifiers to or from a retail-media contact list audience-segment, with external audience segment id.", - "operationId": "updateContactListIdentifiers", "parameters": [ { "name": "audience-segment-id", @@ -172,7 +170,6 @@ "Audience" ], "description": "Delete all identifiers from a retail-media contact list audience-segment, with external audience segment id.", - "operationId": "DeleteContactListIdentifiers", "parameters": [ { "name": "audience-segment-id", @@ -224,7 +221,6 @@ "Gateway" ], "description": "Get information about the currently logged application", - "operationId": "GetCurrentApplication", "responses": { "200": { "description": "Success", @@ -446,7 +442,6 @@ "Accounts" ], "description": "Gets page of account objects that the current user can access", - "operationId": "AccountsApi_GetApiV1ExternalAccounts", "parameters": [ { "name": "limitToId", @@ -516,7 +511,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountBrandsByAccountId", "parameters": [ { "name": "accountId", @@ -597,7 +591,6 @@ "Campaign" ], "description": "Gets page of retailer objects that are associated with the given account", - "operationId": "AccountsApi_GetApiV1ExternalAccountRetailersByAccountId", "parameters": [ { "name": "accountId", @@ -678,7 +671,6 @@ "Audience" ], "description": "Updates the properties of all segments with a valid configuration, and returns the full segments. For those that cannot be updated, one or multiple errors are returned.", - "operationId": "BulkUpdateV1", "parameters": [ { "name": "account-id", @@ -772,7 +764,6 @@ "Audience" ], "description": "Creates all segments with a valid configuration, and returns the full segments. For those that cannot be created, one or multiple errors are returned.", - "operationId": "BulkCreateV1", "parameters": [ { "name": "account-id", @@ -866,7 +857,6 @@ "Audience" ], "description": "Delete the segments associated to the given audience IDs.", - "operationId": "BulkDeleteV1", "parameters": [ { "name": "account-id", @@ -960,7 +950,6 @@ "Audience" ], "description": "Search segments based on the provided filters.( by ids or retailer ids)", - "operationId": "SearchV1", "parameters": [ { "name": "account-id", @@ -1078,7 +1067,6 @@ "Audience" ], "description": "Returns the statistics of a contact list segment.", - "operationId": "GetContactListStatisticsV1", "parameters": [ { "name": "account-id", @@ -1155,7 +1143,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV1", "parameters": [ { "name": "accountId", @@ -1256,7 +1243,6 @@ "Audience" ], "description": "Get a page of Audiences. (deprecated Public API)", - "operationId": "LegacyGetAudienceV2", "parameters": [ { "name": "accountId", @@ -1357,7 +1343,6 @@ "Campaign" ], "description": "Fetch keywords associated with the specified line item", - "operationId": "FetchKeywords", "parameters": [ { "name": "id", @@ -1400,7 +1385,6 @@ "Campaign" ], "description": "Add or Remove keywords from the line item in bulk", - "operationId": "AddRemoveKeywords", "parameters": [ { "name": "id", @@ -1452,7 +1436,6 @@ "Campaign" ], "description": "Set bid overrides for associated keywords to the given line item in bulk", - "operationId": "SetKeywordBids", "parameters": [ { "name": "id", @@ -1504,7 +1487,6 @@ "Campaign" ], "description": "Retrieve a page of promoted products for a line item", - "operationId": "FetchPromotedProducts", "parameters": [ { "name": "lineItemId", @@ -1576,7 +1558,6 @@ "Campaign" ], "description": "Append a collection of promoted products to a line item", - "operationId": "AppendPromotedProducts", "parameters": [ { "name": "lineItemId", @@ -1632,7 +1613,6 @@ "Campaign" ], "description": "Remove a collection of promoted products from a line item", - "operationId": "DeletePromotedProducts", "parameters": [ { "name": "lineItemId", @@ -1688,7 +1668,6 @@ "Campaign" ], "description": "Pause a collection of promoted products associated with a line item", - "operationId": "PausePromotedProducts", "parameters": [ { "name": "lineItemId", @@ -1744,7 +1723,6 @@ "Campaign" ], "description": "Un-pause a collection of promoted products associated with a line item", - "operationId": "UnpausePromotedProducts", "parameters": [ { "name": "lineItemId", @@ -1800,7 +1778,6 @@ "Campaign" ], "description": "Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected.", - "operationId": "FetchProposal", "parameters": [ { "name": "id", @@ -1853,7 +1830,6 @@ "Campaign" ], "description": "Only the components of the Line Item that are in a valid state will be reviewed.", - "operationId": "SubmitProposal", "parameters": [ { "name": "id", @@ -1906,7 +1882,6 @@ "Campaign" ], "description": "Create a creative for an account", - "operationId": "PostApiV2ExternalAccountCreativesByAccountId", "parameters": [ { "name": "account-id", @@ -1961,7 +1936,6 @@ "Campaign" ], "description": "Get account creatives", - "operationId": "PostApiV2ExternalAccountCreativesSearchByAccountId", "parameters": [ { "name": "account-id", @@ -2018,7 +1992,6 @@ "Campaign" ], "description": "Get the specified creative", - "operationId": "GetApiV2ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -2071,7 +2044,6 @@ "Campaign" ], "description": "Update a creative", - "operationId": "PutApiV2ExternalAccountByAccountId}Creatives{creativeId", "parameters": [ { "name": "account-id", @@ -2145,7 +2117,6 @@ "Campaign" ], "description": "Create a request for a Catalog available to the indicated account.", - "operationId": "Catalog_PostApiV1ExternalAccountCatalogsSellersByAccountId", "parameters": [ { "name": "accountId", @@ -2219,7 +2190,6 @@ "Campaign" ], "description": "Endpoint to search skus by text, retailer and sellers/brands.", - "operationId": "SkuRetrievalApi_PostApiV1ExternalCatalogsSkuRetrieval", "parameters": [ { "name": "pageIndex", @@ -2288,7 +2258,6 @@ "Campaign" ], "description": "Endpoint to search skus by text, retailer and sellers/brands.", - "operationId": "SkuSearchApi_PostApiV1ExternalCatalogsSkuSearch", "parameters": [ { "name": "pageIndex", @@ -2351,7 +2320,6 @@ "Campaign" ], "description": "Endpoint to search skus by text, account and retailer with an option to filter by brands id's.", - "operationId": "SkuSearchApi_PostApiV1ExternalCatalogsSkuSearchAccountIdAndRetailerId", "parameters": [ { "name": "account-id", @@ -2434,7 +2402,6 @@ "Campaign" ], "description": "Endpoint to search skus by text for a retailer with an option to filter by brands id's.", - "operationId": "SkuSearchApi_PostApiV1ExternalCatalogsSkuSearchRetailerByRetailerId", "parameters": [ { "name": "X-Origin-Account", @@ -2516,7 +2483,6 @@ "Campaign" ], "description": "Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer", - "operationId": "RetailerApi_GetApiV1ExternalRetailerCategoryCpcRatesByRetailerId", "parameters": [ { "name": "retailer-id", @@ -2569,7 +2535,6 @@ "Campaign" ], "description": "Gets all placement information for the given retailer", - "operationId": "RetailerApi_GetApiV1ExternalRetailerPlacementsByRetailerId", "parameters": [ { "name": "retailer-id", @@ -2609,7 +2574,6 @@ "Campaign" ], "description": "Gets the brands for the given retailer", - "operationId": "RetailerApi_GetApiV1ExternalRetailerBrandsByRetailerId", "parameters": [ { "name": "retailerId", @@ -2674,7 +2638,6 @@ "Campaign" ], "description": "Endpoint to get market place seller id and name", - "operationId": "SellerApi_GetApiV1ExternalRetailerByRetailerIdSellerBySeller", "parameters": [ { "name": "retailerId", @@ -2720,7 +2683,6 @@ "Analytics" ], "description": "Returns an asynchronous Accounts Report", - "operationId": "GenerateAsyncAccountsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -2817,7 +2779,6 @@ "Analytics" ], "description": "Return an asynchronous Campaigns Report", - "operationId": "GenerateAsyncCampaignsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -2914,7 +2875,6 @@ "Analytics" ], "description": "Returns an asynchronous Line Items Report", - "operationId": "GenerateAsyncLineItemsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -3011,7 +2971,6 @@ "Analytics" ], "description": "Returns a synchronous Attributed Transactions Report", - "operationId": "GenerateSyncAttributedTransactionsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -3108,7 +3067,6 @@ "Analytics" ], "description": "Returns a synchronous Campaigns Report", - "operationId": "GenerateSyncCampaignsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -3205,7 +3163,6 @@ "Analytics" ], "description": "Returns a synchronous Line Items Report", - "operationId": "GenerateSyncLineItemsReport", "requestBody": { "content": { "application/json-patch+json": { @@ -3302,7 +3259,6 @@ "Analytics" ], "description": "Returns the output of an async report", - "operationId": "GetAsyncExportOutput", "parameters": [ { "name": "reportId", @@ -3385,7 +3341,6 @@ "Analytics" ], "description": "Returns the status of an async report", - "operationId": "GetAsyncExportStatus", "parameters": [ { "name": "reportId", @@ -3468,7 +3423,6 @@ "Balance" ], "description": "Gets the balance's historical change data.", - "operationId": "GetBalanceHistory", "parameters": [ { "name": "balanceId", @@ -3536,7 +3490,6 @@ "Campaign" ], "description": "Get current campaign budget overrides by given external campaign id.", - "operationId": "GetCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -3568,7 +3521,6 @@ "Campaign" ], "description": "Update campaign budget overrides by given external campaign id and new campaign budget overrides settings.", - "operationId": "UpdateCampaignBudgetOverrides", "parameters": [ { "name": "campaignId", @@ -3628,7 +3580,6 @@ "Campaign" ], "description": "Gets a list of SKUs based on a privided list of Product Ids", - "operationId": "GetSkuByProductId", "parameters": [ { "name": "accountId", @@ -3727,7 +3678,6 @@ "Campaign" ], "description": "Gets the balance's historical data change capture.", - "operationId": "GetInsertionOrderHistoryChangeDataCaptureV2", "parameters": [ { "name": "insertionOrderId", @@ -3795,7 +3745,6 @@ "Campaign" ], "description": "Retrieves a collection of recommended keywords for a line item", - "operationId": "GetRecommendedKeywords", "parameters": [ { "name": "externalLineItemId", @@ -3828,7 +3777,6 @@ "Campaign" ], "description": "Gets a collection of monthly and daily budget overrides for the provided line item.", - "operationId": "GetLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -3859,7 +3807,6 @@ "Campaign" ], "description": "Update line item budget overrides by given external line item id and new line item budget overrides settings.", - "operationId": "UpdateLineItemBudgetOverrides", "parameters": [ { "name": "lineItemId", @@ -3918,7 +3865,6 @@ "Balance" ], "description": "Gets page of balance objects for the given account id", - "operationId": "GetApiV2ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -3935,7 +3881,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 +3894,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 +3906,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", @@ -4000,7 +3943,6 @@ "Balance" ], "description": "Create balance for the given account id", - "operationId": "PostApiV2ExternalAccountBalancesByAccountId", "parameters": [ { "name": "account-id", @@ -4057,7 +3999,6 @@ "Balance" ], "description": "Get a balance for the given account id and balance id", - "operationId": "GetApiV2ExternalAccountByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -4110,7 +4051,6 @@ "Balance" ], "description": "Modify a balance for the given account id", - "operationId": "PatchApiV2ExternalAccountByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -4178,7 +4118,6 @@ "Balance" ], "description": "Add funds to a balance for the given account id", - "operationId": "PostApiV2ExternalAccountAddFundsByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -4246,7 +4185,6 @@ "Balance" ], "description": "Change dates of a balance for the given account id", - "operationId": "PostApiV2ExternalAccountChangeDatesByAccountId}Balances{balanceId", "parameters": [ { "name": "account-id", @@ -4314,7 +4252,6 @@ "Campaign" ], "description": "Gets page of preferred line item objects for the given campaign id", - "operationId": "GetApiV2ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -4391,7 +4328,6 @@ "Campaign" ], "description": "Creates a new preferred line item with the specified settings", - "operationId": "LineItemsApi_PostApi202110ExternalCampaignPreferredLineItemsByCampaignId", "parameters": [ { "name": "campaign-id", @@ -4448,7 +4384,6 @@ "Campaign" ], "description": "Fetch all bid multipliers for a given line item", - "operationId": "GetApiV2ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4490,7 +4425,6 @@ "Campaign" ], "description": "Updates the bid multipliers for a given line item", - "operationId": "PutApiV2ExternalLineItemBidMultipliersByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4545,7 +4479,6 @@ "Campaign" ], "description": "Get all the product buttons associated with a line item", - "operationId": "ProductButtons_GetApi202210ExternalLineItemProductButtonsByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4579,7 +4512,6 @@ "Campaign" ], "description": "Append new product buttons to a line item", - "operationId": "ProductButtons_PostApi202210ExternalLineItemProductButtonsCreateByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4625,7 +4557,6 @@ "Campaign" ], "description": "Delete a product button", - "operationId": "ProductButtons_DeleteApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId", "parameters": [ { "name": "line-item-id", @@ -4661,7 +4592,6 @@ "Campaign" ], "description": "Get a single product button", - "operationId": "ProductButtons_GetApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId", "parameters": [ { "name": "line-item-id", @@ -4704,7 +4634,6 @@ "Campaign" ], "description": "Update a product button", - "operationId": "ProductButtons_PutApi202210ExternalLineItemProductButtonsByLineItemIdProductButtonId", "parameters": [ { "name": "line-item-id", @@ -4761,7 +4690,6 @@ "Campaign" ], "description": "Gets the preferred line item for the given line item id", - "operationId": "GetApiV2ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -4803,7 +4731,6 @@ "Campaign" ], "description": "Updates the preferred line item for the given line item id", - "operationId": "LineItemsApi_PutApi202110ExternalPreferredLineItemByLineItemId", "parameters": [ { "name": "line-item-id", @@ -12664,11 +12591,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 +12646,10 @@ }, "privateMarketBillingType": { "enum": [ - "notApplicable", - "billByRetailer", - "billByCriteo", - "unknown" + "NotApplicable", + "BillByRetailer", + "BillByCriteo", + "Unknown" ], "type": "string", "description": "Billing type for Private Market of the balance.", @@ -12973,7 +12902,8 @@ "poNumber": { "type": "string", "description": "Purchase Order number.", - "nullable": true + "nullable": true, + "x-nullable": true }, "deposited": { "type": "number", @@ -12984,12 +12914,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 +12937,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"