Skip to content

Commit 7487af5

Browse files
committed
update ad delivery specs
1 parent 1640052 commit 7487af5

File tree

1 file changed

+6
-33
lines changed

1 file changed

+6
-33
lines changed

specs/ad-delivery-specs.yaml

Lines changed: 6 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ paths:
4545
- name: Customer-Ip
4646
in: header
4747
description: IP address of the customer, as captured by your integration.
48-
Ensure your integration passes the customer's IP, not your own. This value helps determine their location for ad relevancy.
49-
Also used for fraud recovery and other important analytics.
48+
Ensure your integration passes the customer's IP, not your own. Used for fraud recovery and other important analytics.
5049
required: false
5150
schema:
5251
type: string
@@ -61,7 +60,7 @@ paths:
6160
example: '7f9a24ea-2145-4819-a7b7-2a4cbe1165ab'
6261
- name: Customer-Id
6362
in: header
64-
description: An obfuscated unique identifier for each customer. This should not contain any personal information such as email.
63+
description: An obfuscated unique identifier for each customer. This should not contain any personal information such as email, first or last name.
6564
required: true
6665
schema:
6766
type: string
@@ -104,7 +103,7 @@ paths:
104103
$ref: '#/components/schemas/Error'
105104
example:
106105
type: 'request_unauthenticated'
107-
mesage: 'Data required to authenticate your request is missing or inaccurate.
106+
message: 'Data required to authenticate your request is missing or inaccurate.
108107
Ensure that your request follows the guidelines in our documentation.'
109108
fields:
110109
- name: 'apikey'
@@ -175,20 +174,6 @@ components:
175174
- confirmation
176175
example: 'search_results'
177176
description: The type of page the ads will be rendered on.
178-
Coordinates:
179-
type: object
180-
properties:
181-
latitude:
182-
type: number
183-
example: 37.774929
184-
minimum: -90.0
185-
maximum: 90.0
186-
longitude:
187-
type: number
188-
example: -122.419418
189-
minimum: -180.0
190-
maximum: 180.0
191-
additionalProperties: false
192177
SortType:
193178
type: string
194179
enum:
@@ -228,7 +213,6 @@ components:
228213
type: object
229214
required:
230215
- sales_channel
231-
- traveler_location
232216
- language
233217
- country_code
234218
- page_type
@@ -259,8 +243,6 @@ components:
259243
$ref: '#/components/schemas/PageType'
260244
sort_type:
261245
$ref: '#/components/schemas/SortType'
262-
traveler_location:
263-
$ref: '#/components/schemas/Coordinates'
264246
search_product_lines:
265247
example: [ 'lodging', 'flight' ]
266248
description: The product lines the traveler is searching for. lodging indicates hotel_standalone. lodging and
@@ -326,25 +308,17 @@ components:
326308
Creative:
327309
type: object
328310
properties:
329-
headline:
330-
type: string
331-
description: The headline of the sponsored listing.
332-
example: 'Come see our new pool!'
333-
description:
334-
type: string
335-
description: The description of the sponsored listing.
336-
example: 'Come see our new remodeled rooms and enjoy our free buffett!'
337311
image:
338312
$ref: '#/components/schemas/Image'
339-
description: The headline, description, and image to be rendered for the sponsored listing.
313+
description: The image to be rendered for the sponsored listing.
340314
additionalProperties: false
341315
Link:
342316
type: object
343317
properties:
344318
method:
345319
type: string
346320
description: The request method used to access the link.
347-
example: 'GET'
321+
example: 'POST'
348322
href:
349323
type: string
350324
description: The URL for the link. This can be absolute or relative. Placeholders will be need to be populated by the client.
@@ -360,7 +334,6 @@ components:
360334
- view
361335
- render
362336
- click
363-
- conversion
364337
properties:
365338
view:
366339
$ref: '#/components/schemas/Link'
@@ -369,7 +342,7 @@ components:
369342
click:
370343
$ref: '#/components/schemas/Link'
371344
SponsoredListing:
372-
description: The sponsored listing which advertisers a specific property.
345+
description: The sponsored listing which advertises a specific property.
373346
type: object
374347
required:
375348
- rank

0 commit comments

Comments
 (0)