Retrieve Display Ads

Retrieves ads for each of the given placements. Each placement maps to a typed response object. Banner placements return a single flattened ad; multi-banner placements return an array of ads ordered by auction rank. If no ad is available for a placement, the placement will be missing from the response. Placements are specified as repeated placements query parameters. Optionally, num_results[{id}]=N can be used to request a specific number of ads for a placement. When omitted, the placement's configured maximum is used.

Query Params
string
required

The key of the index to use.

Search query for keyword targeting.

The name of the related browse filter.

The value of the related browse filter.

num_results
object

Optional deepObject parameter to request a specific number of ads for each placement. Example: num_results[home_page]=3#_results[carousel]=1. When omitted, the placement's configured maximum is used.

placements
array of strings
required
length between 1 and 20

Placement customer IDs to fetch ads for.

Placements*
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json