Skip to content

Commit 1640052

Browse files
committed
update ad delivery specs to latest
1 parent e962c29 commit 1640052

File tree

1 file changed

+16
-61
lines changed

1 file changed

+16
-61
lines changed

specs/ad-delivery-specs.yaml

Lines changed: 16 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,21 @@ paths:
5151
schema:
5252
type: string
5353
example: '192.168.123.132'
54+
- name: Customer-Session-Id
55+
in: header
56+
description: Insert your own unique value for each user session, beginning with the first API call.
57+
Continue to pass the same value for each subsequent API call during the user's session, using a new value for every new customer session.
58+
required: false
59+
schema:
60+
type: string
61+
example: '7f9a24ea-2145-4819-a7b7-2a4cbe1165ab'
62+
- name: Customer-Id
63+
in: header
64+
description: An obfuscated unique identifier for each customer. This should not contain any personal information such as email.
65+
required: true
66+
schema:
67+
type: string
68+
example: '7f9a24ea-2145-4819-a7b7-2a4cbe1165ab'
5469
requestBody:
5570
content:
5671
application/json:
@@ -59,26 +74,12 @@ paths:
5974
responses:
6075
'200':
6176
description: OK
62-
headers:
63-
Transaction-Id:
64-
description: This is vital for deep dive investigations.
65-
schema:
66-
type: string
67-
format: uuid
68-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
6977
content:
7078
application/json:
7179
schema:
7280
$ref: '#/components/schemas/AdsResponse'
7381
'400':
7482
description: Bad Request
75-
headers:
76-
Transaction-Id:
77-
description: This is vital for deep dive investigations.
78-
schema:
79-
type: string
80-
format: uuid
81-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
8283
content:
8384
application/json:
8485
schema:
@@ -97,13 +98,6 @@ paths:
9798
type: 'request'
9899
'401':
99100
description: Unauthorized
100-
headers:
101-
Transaction-Id:
102-
description: This is vital for deep dive investigations.
103-
schema:
104-
type: string
105-
format: uuid
106-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
107101
content:
108102
application/json:
109103
schema:
@@ -127,13 +121,6 @@ paths:
127121
value: '198284729'
128122
'403':
129123
description: Forbidden
130-
headers:
131-
Transaction-Id:
132-
description: This is vital for deep dive investigations.
133-
schema:
134-
type: string
135-
format: uuid
136-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
137124
content:
138125
application/json:
139126
schema:
@@ -143,13 +130,6 @@ paths:
143130
message: 'Your request could not be authorized.'
144131
'426':
145132
description: Upgrade Required
146-
headers:
147-
Transaction-Id:
148-
description: This is vital for deep dive investigations.
149-
schema:
150-
type: string
151-
format: uuid
152-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
153133
content:
154134
application/json:
155135
schema:
@@ -159,13 +139,6 @@ paths:
159139
message: 'This service requires the use of TLS.'
160140
'429':
161141
description: Too Many Requests
162-
headers:
163-
Transaction-Id:
164-
description: This is vital for deep dive investigations.
165-
schema:
166-
type: string
167-
format: uuid
168-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
169142
content:
170143
application/json:
171144
schema:
@@ -175,13 +148,6 @@ paths:
175148
message: 'You have reached your capacity for this type of request.'
176149
'500':
177150
description: Unknown Internal Error
178-
headers:
179-
Transaction-Id:
180-
description: This is vital for deep dive investigations.
181-
schema:
182-
type: string
183-
format: uuid
184-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
185151
content:
186152
application/json:
187153
schema:
@@ -191,13 +157,6 @@ paths:
191157
message: 'An internal server error has occurred.'
192158
'503':
193159
description: Service Unavailable
194-
headers:
195-
Transaction-Id:
196-
description: This is vital for deep dive investigations.
197-
schema:
198-
type: string
199-
format: uuid
200-
example: '8946d668-673c-4e98-95b4-258801ecf20c'
201160
content:
202161
application/json:
203162
schema:
@@ -277,7 +236,7 @@ components:
277236
- checkin
278237
- checkout
279238
- occupancies
280-
- ad_candidates
239+
- property_ids
281240
properties:
282241
country_code:
283242
type: string
@@ -409,10 +368,6 @@ components:
409368
$ref: '#/components/schemas/Link'
410369
click:
411370
$ref: '#/components/schemas/Link'
412-
conversion:
413-
$ref: '#/components/schemas/Link'
414-
description: The view, render, click, and conversion beacons associated with the ad.
415-
additionalProperties: false
416371
SponsoredListing:
417372
description: The sponsored listing which advertisers a specific property.
418373
type: object

0 commit comments

Comments
 (0)