|
1439 | 1439 | ] |
1440 | 1440 | } |
1441 | 1441 | }, |
| 1442 | + "/preview/retail-media/balances/{balanceId}": { |
| 1443 | + "get": { |
| 1444 | + "tags": [ |
| 1445 | + "Balance" |
| 1446 | + ], |
| 1447 | + "description": "Get a balance for the given balance id.", |
| 1448 | + "operationId": "GetBalanceV1", |
| 1449 | + "parameters": [ |
| 1450 | + { |
| 1451 | + "name": "balanceId", |
| 1452 | + "in": "path", |
| 1453 | + "description": "The balance id.", |
| 1454 | + "required": true, |
| 1455 | + "schema": { |
| 1456 | + "type": "string" |
| 1457 | + } |
| 1458 | + } |
| 1459 | + ], |
| 1460 | + "responses": { |
| 1461 | + "200": { |
| 1462 | + "description": "Success", |
| 1463 | + "content": { |
| 1464 | + "application/json": { |
| 1465 | + "schema": { |
| 1466 | + "$ref": "#/components/schemas/EntityResourceOutcomeBalanceV1" |
| 1467 | + } |
| 1468 | + } |
| 1469 | + } |
| 1470 | + } |
| 1471 | + }, |
| 1472 | + "security": [ |
| 1473 | + { |
| 1474 | + "oauth": [ |
| 1475 | + "RetailMedia_Balance_Read" |
| 1476 | + ] |
| 1477 | + } |
| 1478 | + ] |
| 1479 | + } |
| 1480 | + }, |
1442 | 1481 | "/preview/retail-media/balances/{balanceId}/history": { |
1443 | 1482 | "get": { |
1444 | 1483 | "tags": [ |
|
5162 | 5201 | "additionalProperties": false, |
5163 | 5202 | "description": "Data model represents the data change capture of balance history." |
5164 | 5203 | }, |
| 5204 | + "BalanceV1": { |
| 5205 | + "required": [ |
| 5206 | + "balanceType", |
| 5207 | + "createdAt", |
| 5208 | + "deposited", |
| 5209 | + "name", |
| 5210 | + "privateMarketBillingType", |
| 5211 | + "remaining", |
| 5212 | + "spendType", |
| 5213 | + "spent", |
| 5214 | + "startDate", |
| 5215 | + "status", |
| 5216 | + "updatedAt" |
| 5217 | + ], |
| 5218 | + "type": "object", |
| 5219 | + "properties": { |
| 5220 | + "balanceType": { |
| 5221 | + "enum": [ |
| 5222 | + "unknown", |
| 5223 | + "capped", |
| 5224 | + "uncapped" |
| 5225 | + ], |
| 5226 | + "type": "string", |
| 5227 | + "description": "Type of the balance." |
| 5228 | + }, |
| 5229 | + "createdAt": { |
| 5230 | + "type": "string", |
| 5231 | + "description": "Creation time of the balance.", |
| 5232 | + "format": "date-time" |
| 5233 | + }, |
| 5234 | + "criteoPoNumber": { |
| 5235 | + "type": "string", |
| 5236 | + "description": "Criteo purchase order number.", |
| 5237 | + "nullable": true |
| 5238 | + }, |
| 5239 | + "deposited": { |
| 5240 | + "type": "number", |
| 5241 | + "description": "Amount of billable funds allotted to the balance.", |
| 5242 | + "format": "double" |
| 5243 | + }, |
| 5244 | + "endDate": { |
| 5245 | + "type": "string", |
| 5246 | + "description": "End date of the balance in the format YYYY-MM-DD.", |
| 5247 | + "nullable": true |
| 5248 | + }, |
| 5249 | + "memo": { |
| 5250 | + "type": "string", |
| 5251 | + "description": "Memo.", |
| 5252 | + "nullable": true |
| 5253 | + }, |
| 5254 | + "name": { |
| 5255 | + "type": "string", |
| 5256 | + "description": "Name of the balance." |
| 5257 | + }, |
| 5258 | + "privateMarketBillingType": { |
| 5259 | + "enum": [ |
| 5260 | + "notApplicable", |
| 5261 | + "billByRetailer", |
| 5262 | + "billByCriteo", |
| 5263 | + "unknown" |
| 5264 | + ], |
| 5265 | + "type": "string", |
| 5266 | + "description": "Billing type for Private Market of the balance." |
| 5267 | + }, |
| 5268 | + "remaining": { |
| 5269 | + "type": "number", |
| 5270 | + "description": "Amount of remaining funds of the balance.", |
| 5271 | + "format": "double" |
| 5272 | + }, |
| 5273 | + "retailerId": { |
| 5274 | + "type": "string", |
| 5275 | + "description": "The billing retailer id.", |
| 5276 | + "nullable": true |
| 5277 | + }, |
| 5278 | + "retailerPoNumber": { |
| 5279 | + "type": "string", |
| 5280 | + "description": "Retailer purchase order number.", |
| 5281 | + "nullable": true |
| 5282 | + }, |
| 5283 | + "spendType": { |
| 5284 | + "enum": [ |
| 5285 | + "onsite", |
| 5286 | + "offsite", |
| 5287 | + "offsiteAwareness", |
| 5288 | + "lockout", |
| 5289 | + "unknown" |
| 5290 | + ], |
| 5291 | + "type": "string", |
| 5292 | + "description": "Spend Type of the balance." |
| 5293 | + }, |
| 5294 | + "spent": { |
| 5295 | + "type": "number", |
| 5296 | + "description": "Amount of spent funds of the balance.", |
| 5297 | + "format": "double" |
| 5298 | + }, |
| 5299 | + "startDate": { |
| 5300 | + "type": "string", |
| 5301 | + "description": "Start date of the balance in the format YYYY-MM-DD." |
| 5302 | + }, |
| 5303 | + "status": { |
| 5304 | + "enum": [ |
| 5305 | + "unknown", |
| 5306 | + "scheduled", |
| 5307 | + "active", |
| 5308 | + "ended" |
| 5309 | + ], |
| 5310 | + "type": "string", |
| 5311 | + "description": "Status of the balance." |
| 5312 | + }, |
| 5313 | + "updatedAt": { |
| 5314 | + "type": "string", |
| 5315 | + "description": "Update time of the balance.", |
| 5316 | + "format": "date-time" |
| 5317 | + } |
| 5318 | + }, |
| 5319 | + "additionalProperties": false, |
| 5320 | + "description": "A Retail Media Balance used to determine the funds available for any or all campaigns in an account.", |
| 5321 | + "nullable": true |
| 5322 | + }, |
5165 | 5323 | "BatchAcceptedResponse": { |
5166 | 5324 | "required": [ |
5167 | 5325 | "operationToken" |
|
6013 | 6171 | "description": "Represents the min bid for a pageType and creative combination.", |
6014 | 6172 | "nullable": true |
6015 | 6173 | }, |
| 6174 | + "EntityResourceBalanceV1": { |
| 6175 | + "type": "object", |
| 6176 | + "properties": { |
| 6177 | + "attributes": { |
| 6178 | + "$ref": "#/components/schemas/BalanceV1" |
| 6179 | + }, |
| 6180 | + "id": { |
| 6181 | + "type": "string", |
| 6182 | + "description": "Unique id of the entity.", |
| 6183 | + "nullable": true |
| 6184 | + }, |
| 6185 | + "type": { |
| 6186 | + "type": "string", |
| 6187 | + "description": "Type of the resource.", |
| 6188 | + "nullable": true |
| 6189 | + } |
| 6190 | + }, |
| 6191 | + "additionalProperties": false, |
| 6192 | + "description": "A domain entity exposed by the API, identified by a unique id.", |
| 6193 | + "nullable": true |
| 6194 | + }, |
6016 | 6195 | "EntityResourceBrandIdSearchResult": { |
6017 | 6196 | "type": "object", |
6018 | 6197 | "properties": { |
|
6356 | 6535 | "description": "A domain entity exposed by the API, identified by a unique id.", |
6357 | 6536 | "nullable": true |
6358 | 6537 | }, |
| 6538 | + "EntityResourceOutcomeBalanceV1": { |
| 6539 | + "type": "object", |
| 6540 | + "properties": { |
| 6541 | + "data": { |
| 6542 | + "$ref": "#/components/schemas/EntityResourceBalanceV1" |
| 6543 | + }, |
| 6544 | + "errors": { |
| 6545 | + "type": "array", |
| 6546 | + "items": { |
| 6547 | + "$ref": "#/components/schemas/SdkApiRestCommonProblem" |
| 6548 | + }, |
| 6549 | + "description": "Errors that occured during this call.", |
| 6550 | + "nullable": true, |
| 6551 | + "readOnly": true |
| 6552 | + }, |
| 6553 | + "warnings": { |
| 6554 | + "type": "array", |
| 6555 | + "items": { |
| 6556 | + "$ref": "#/components/schemas/SdkApiRestCommonProblem" |
| 6557 | + }, |
| 6558 | + "description": "Warnings that occured during this call.", |
| 6559 | + "nullable": true, |
| 6560 | + "readOnly": true |
| 6561 | + } |
| 6562 | + }, |
| 6563 | + "additionalProperties": false, |
| 6564 | + "description": "A top-level object that encapsulates a Criteo API response for a single entity." |
| 6565 | + }, |
6359 | 6566 | "EntityResourceOutcomeOfCatalogStatusV2": { |
6360 | 6567 | "type": "object", |
6361 | 6568 | "properties": { |
|
0 commit comments