Skip to main content
GET
Get a Single Catalog Zone

Authorizations

Authorization
string
header
required

API key en el header Authorization: Basic TU_API_KEY. La key va tal cual, sin codificar en base64. Las credenciales se entregan al comenzar la integración.

Path Parameters

zone_id
integer
required

Identifier of the Catalog Zone.

Query Parameters

fields
string

Restrict the fields you wish to retrieve by listing the desired fields formatted as a comma-separated list. Fields like "object", "self", and "id" are always returned.

Response

default - application/json

successful operation

name
string

The name of the catalog zone

Maximum string length: 255
Example:

"Product DB"

catalog_id
integer

The identifier (ID) of the catalog

Example:

74374

publisher
integer

The identifier (ID) of the publisher to which the zone belongs

Example:

53563

bid_floor
number<float>

The default bid floor for this zone

Example:

0

bid_floor_cpm
number<float>

Sets the bid floor for CPM in the zone

Example:

1.1

bid_floor_cpc
number<float>

Sets the bid floor for CPC in the zone

Example:

1.3

advertiser_cost_type
enum<string>

Configures the zone to charge the advertiser by either impression (CPM) or by clicks (CPC)

Available options:
CPM,
CPC
Example:

"CPC"

auction_type
enum<string>

Sets the type of auctions in this zone

Available options:
FIRST_PRICE,
SECOND_PRICE
Example:

"SECOND_PRICE"

click_cooldown_period
integer

The cooldown period for users clicking on the same advertisement

Required range: 1 <= x <= 86400
Example:

60

conversion_lookback_period
integer

The conversion lookback period

Required range: 1 <= x <= 7776000
Example:

7776000

object
string

A string denoting the current resource being requested or affected.

Example:

"catalog_zone"

self
string

The relative URL of the current resource being requested or affected.

Example:

"/v2/zones/catalog/104339"

id
integer

The current resource identifier (ID).

Example:

104339

metadata
object

An object containing any number of metadata fields and values.

Example: