Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Display Ads

Retrieve Display Ads (Deprecated)

Retrieves an ad for each of the given placement IDs. If no ad is available for a placement ID, the placement ID will be missing from the response.

get/v1/display-ads

Query parameters

keystring required

The key of the index to use.

The key of the index to use.

placement_idsstring[] required

List of placement IDs.

List of placement IDs.

[
  "home_page",
  "mobile_search_results"
]
querystring nullable

Search query for keyword targeting.

Example:apple

Search query for keyword targeting.

filter_namestring nullable

The name of the related browse filter.

Example:group_id

The name of the related browse filter.

filter_valuestring nullable

The value of the related browse filter.

Example:123

The value of the related browse filter.

Response

Successful Response.

display_adsobject required

Map of placement IDs to Display Ads. If a placement ID is missing it means that there are no available ads for that placement.

Example response

{
  "display_ads": {
    "home_page": {
      "advertiser": "Advertiser Name",
      "banner_ad_id": "AD_ID",
      "image_banner": {
        "cta": "Ad CTA",
        "cta_label": "Call to action label",
        "description": "Ad Description",
        "images": [
          {
            "media": "(min-width: 1024px)",
            "srcset": [
              {
                "alt_text": "An example image",
                "pixel_density": 1,
                "src": "https://example.com/image.jpg"
              }
            ]
          }
        ],
        "srcset": [
          {
            "pixel_density": 1,
            "src": "https://example.com/image.jpg"
          }
        ],
        "target_url": "https://example.com",
        "title": "Ad Title"
      }
    }
  }
}