Follow

List External Advertisements

Lists the existing external advertisements for the given organisation and the system type. 

 

Attributes

Attribute

Value

Path

/v3/organisations/{OrganisationID}/externalAdvertisements

Support Formats

JSON, XML

HTTP Method

GET

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        200 - OK

·        400 - Bad Request

·        500 - Internal Server Error

 

Request

The following table contains the details of a typical HTTP request for this service:

Type

Value

Header

GET /v3/organisations/123/externalAdvertisements HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Query Params

?systemType={systemType}

 

Successful Response

The following table contains the details of a typical successful HTTP request for this service.

Type

Value

Header

HTTP/1.1 200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Body

[

  {

    "id": "1568-001",

    "systemType": "10",

    "advertisementStatus": 1,

    "title": "ACME Products",

    "campaignId": 66,

    "channelCode": "MA",

    "placementCode": "FS",

    "contentUrl": "http://www.acme.co.nz/....",

    "description": "...",

    "startDate": "2014-03-28",

    "endDate": "2014-08-17",

    "eventStartDateTime": "",

    "enableTimeBasedWeight": "false",

    "enableDistanceWeight": "false",

    "noCompeteGroup": "1568",

    "venueIds": [],

    "venueExternalIds": [],

    "contentTagReferenceCodes": [],

    "clickThroughUrl": "",

    "unlimitedBudget":"true",

    "maxBudget":"",

    "extendedData":"",

    "weight": ""

  }, ...

]

 

Notes:

  • if "unlimitedBudget" is true, the value of "maxBudget" is not considered. However, if "unlimitedBudget" is false, maxBudget needs to be filled with a decimal value.
  • advertisementStatus values can be one of 0 (Draft), 1 (Published), 2 (Archived)
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.