Skip to content

Commit 3358145

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

File tree

2 files changed

+838
-1029
lines changed

2 files changed

+838
-1029
lines changed

‎api-specifications/marketingsolutions_preview.json‎

Lines changed: 1 addition & 295 deletions
Original file line numberDiff line numberDiff line change
@@ -458,173 +458,6 @@
458458
]
459459
}
460460
},
461-
"/preview/advertisers": {
462-
"post": {
463-
"tags": [
464-
"Advertiser"
465-
],
466-
"description": "Create a new advertiser based on provided parameters. This could take up to 30 seconds.",
467-
"operationId": "createAdvertiser",
468-
"requestBody": {
469-
"description": "",
470-
"content": {
471-
"application/json-patch+json": {
472-
"schema": {
473-
"$ref": "#/components/schemas/AdvertiserCreationRequest"
474-
}
475-
},
476-
"application/json": {
477-
"schema": {
478-
"$ref": "#/components/schemas/AdvertiserCreationRequest"
479-
}
480-
},
481-
"text/json": {
482-
"schema": {
483-
"$ref": "#/components/schemas/AdvertiserCreationRequest"
484-
}
485-
},
486-
"application/*+json": {
487-
"schema": {
488-
"$ref": "#/components/schemas/AdvertiserCreationRequest"
489-
}
490-
}
491-
},
492-
"required": true,
493-
"x-bodyName": "advertiserCreation"
494-
},
495-
"responses": {
496-
"201": {
497-
"description": "Success",
498-
"content": {
499-
"application/json": {
500-
"schema": {
501-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
502-
},
503-
"example": {
504-
"data": {
505-
"type": "advertiser",
506-
"id": "73550"
507-
},
508-
"errors": [ ],
509-
"warnings": [ ]
510-
}
511-
},
512-
"text/plain": {
513-
"schema": {
514-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
515-
}
516-
},
517-
"text/json": {
518-
"schema": {
519-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
520-
}
521-
}
522-
}
523-
},
524-
"400": {
525-
"description": "Bad Request",
526-
"content": {
527-
"application/json": {
528-
"schema": {
529-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
530-
},
531-
"example": {
532-
"errors": [
533-
{
534-
"traceId": "cb381a21702b247f",
535-
"type": "validation",
536-
"code": "invalid",
537-
"title": "Failed to create Advertiser",
538-
"detail": "Failed to create Advertiser"
539-
}
540-
],
541-
"warnings": [ ]
542-
}
543-
},
544-
"text/plain": {
545-
"schema": {
546-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
547-
}
548-
},
549-
"text/json": {
550-
"schema": {
551-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
552-
}
553-
}
554-
}
555-
},
556-
"401": {
557-
"description": "Unauthorized",
558-
"content": {
559-
"application/json": {
560-
"schema": {
561-
"$ref": "#/components/schemas/UnauthorizedResponseV2"
562-
},
563-
"example": {
564-
"errors": [
565-
{
566-
"traceId": "cb381a21702b247f",
567-
"type": "authentication",
568-
"code": "invalid",
569-
"title": "Permission Denied; This endpoint expects a user token",
570-
"detail": "Permission Denied; This endpoint expects a user token"
571-
}
572-
],
573-
"warnings": [ ]
574-
}
575-
},
576-
"text/plain": {
577-
"schema": {
578-
"$ref": "#/components/schemas/UnauthorizedResponseV2"
579-
}
580-
},
581-
"text/json": {
582-
"schema": {
583-
"$ref": "#/components/schemas/UnauthorizedResponseV2"
584-
}
585-
}
586-
}
587-
},
588-
"500": {
589-
"description": "Server Error",
590-
"content": {
591-
"application/json": {
592-
"schema": {
593-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
594-
},
595-
"example": {
596-
"errors": [
597-
{
598-
"traceId": "cb381a21702b247f",
599-
"type": "availability",
600-
"code": "internal-error",
601-
"title": "Internal Server Error",
602-
"detail": "Internal Server Error"
603-
}
604-
],
605-
"warnings": [ ]
606-
}
607-
},
608-
"text/plain": {
609-
"schema": {
610-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
611-
}
612-
},
613-
"text/json": {
614-
"schema": {
615-
"$ref": "#/components/schemas/AdvertiserCreationResponse"
616-
}
617-
}
618-
}
619-
}
620-
},
621-
"security": [
622-
{
623-
"oauth": [ ]
624-
}
625-
]
626-
}
627-
},
628461
"/preview/advertisers/{advertiser-id}/ads": {
629462
"get": {
630463
"tags": [
@@ -12293,93 +12126,6 @@
1229312126
},
1229412127
"description": "Represents an API response message containing the usual outcome fields (warnings+errors), and a valueResource data,\r\ni.e. data is not an entity (no id). This can be used for association objects."
1229512128
},
12296-
"AdvertiserCreationInput": {
12297-
"required": [
12298-
"agencyId",
12299-
"accountName",
12300-
"websiteUrl",
12301-
"countryIsoCode",
12302-
"currencyIsoCode",
12303-
"industryId"
12304-
],
12305-
"type": "object",
12306-
"properties": {
12307-
"accountName": {
12308-
"type": "string",
12309-
"description": "The Account Name; This will not be in fact the Advertiser name"
12310-
},
12311-
"agencyId": {
12312-
"type": "string",
12313-
"description": "ID of the agency requesting the advertiser creation"
12314-
},
12315-
"countryIsoCode": {
12316-
"type": "string",
12317-
"description": "Country ISO code"
12318-
},
12319-
"currencyIsoCode": {
12320-
"type": "string",
12321-
"description": "Currency ISO code"
12322-
},
12323-
"industryId": {
12324-
"type": "string",
12325-
"description": "Industry ID"
12326-
},
12327-
"websiteUrl": {
12328-
"type": "string",
12329-
"description": "Website url"
12330-
}
12331-
},
12332-
"description": "Information for creating an advertiser"
12333-
},
12334-
"AdvertiserCreationRequest": {
12335-
"type": "object",
12336-
"properties": {
12337-
"data": {
12338-
"$ref": "#/components/schemas/ValueResourceOfAdvertiserCreationInput"
12339-
}
12340-
},
12341-
"description": "Advertiser Creation Request",
12342-
"example": {
12343-
"data": {
12344-
"type": "advertiser",
12345-
"attributes": {
12346-
"agencyId": "agencyId",
12347-
"accountName": "AdvertiserName",
12348-
"websiteUrl": "http://website_URL.com",
12349-
"countryIsoCode": "RO",
12350-
"currencyIsoCode": "EUR",
12351-
"industryId": "200006"
12352-
}
12353-
}
12354-
}
12355-
},
12356-
"AdvertiserCreationResponse": {
12357-
"type": "object",
12358-
"properties": {
12359-
"data": {
12360-
"$ref": "#/components/schemas/EntityV2OfObject"
12361-
},
12362-
"errors": {
12363-
"uniqueItems": false,
12364-
"type": "array",
12365-
"items": {
12366-
"$ref": "#/components/schemas/CommonProblem"
12367-
},
12368-
"description": "Error list returned by the Criteo API\r\nFor successful requests it is empty",
12369-
"nullable": true
12370-
},
12371-
"warnings": {
12372-
"uniqueItems": false,
12373-
"type": "array",
12374-
"items": {
12375-
"$ref": "#/components/schemas/CriteoApiWarningV2"
12376-
},
12377-
"description": "Warnings list returned by the Criteo API\r\nIn some situations the operations are successful but it may be useful to issue warnings to the API consumer.\r\nFor example the endpoint, entity or field is deprecated. Warnings are like compiler warnings, they indicate that problems may occur in the future.",
12378-
"nullable": true
12379-
}
12380-
},
12381-
"description": "Advertiser Creation Response"
12382-
},
1238312129
"AdvertiserDatasetListResponse": {
1238412130
"type": "object",
1238512131
"properties": {
@@ -15864,8 +15610,7 @@
1586415610
"example": "campaign"
1586515611
}
1586615612
},
15867-
"description": "Generic Criteo API successful data model",
15868-
"nullable": true
15613+
"description": "Generic Criteo API successful data model"
1586915614
},
1587015615
"EntityWrapperOfTargetingEntity": {
1587115616
"type": "object",
@@ -21685,33 +21430,6 @@
2168521430
"additionalProperties": false,
2168621431
"description": "A value resource exposed by the API."
2168721432
},
21688-
"UnauthorizedResponseV2": {
21689-
"type": "object",
21690-
"properties": {
21691-
"data": {
21692-
"$ref": "#/components/schemas/EntityV2OfObject"
21693-
},
21694-
"errors": {
21695-
"uniqueItems": false,
21696-
"type": "array",
21697-
"items": {
21698-
"$ref": "#/components/schemas/CommonProblem"
21699-
},
21700-
"description": "Error list returned by the Criteo API\r\nFor successful requests it is empty",
21701-
"nullable": true
21702-
},
21703-
"warnings": {
21704-
"uniqueItems": false,
21705-
"type": "array",
21706-
"items": {
21707-
"$ref": "#/components/schemas/CriteoApiWarningV2"
21708-
},
21709-
"description": "Warnings list returned by the Criteo API\r\nIn some situations the operations are successful but it may be useful to issue warnings to the API consumer.\r\nFor example the endpoint, entity or field is deprecated. Warnings are like compiler warnings, they indicate that problems may occur in the future.",
21710-
"nullable": true
21711-
}
21712-
},
21713-
"description": "Unauthorized Response"
21714-
},
2171521433
"UpdateCoupon": {
2171621434
"required": [
2171721435
"startDate"
@@ -21815,18 +21533,6 @@
2181521533
}
2181621534
}
2181721535
},
21818-
"ValueResourceOfAdvertiserCreationInput": {
21819-
"type": "object",
21820-
"properties": {
21821-
"attributes": {
21822-
"$ref": "#/components/schemas/AdvertiserCreationInput"
21823-
},
21824-
"type": {
21825-
"type": "string"
21826-
}
21827-
},
21828-
"description": "A top-level object that encapsulates a Criteo API response for a single value"
21829-
},
2183021536
"ValueResourceOfCreateProductFilterRequest": {
2183121537
"type": "object",
2183221538
"properties": {

0 commit comments

Comments
 (0)