For the complete documentation index, see llms.txt. This page is also available as Markdown.

Display Campaigns

Operations related to Display Campaigns, the activation tool to display Ads to end users through Real Time Bidding (RTB) and Ad Server diffusion channels.

get ad groups from the campaign

get
/display_campaigns/{campaign_id}/ad_groups
Path parameters
campaign_idinteger · int64Required

The organisation owning the campaign

Responses
200

Success !

application/json
totalintegerRequired
first_resultintegerRequired
statusstring · enumRequiredPossible values:
countintegerRequired
max_resultsintegerRequired
get/display_campaigns/{campaign_id}/ad_groups
GET /v1/display_campaigns/{campaign_id}/ad_groups HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "total": 1,
  "first_result": 1,
  "status": "ok",
  "count": 1,
  "data": [
    {
      "end_date": 0,
      "viewability_use_third_party_data": false,
      "total_impression_capping": 0,
      "start_date": 0,
      "viewability_min_score": 0,
      "name": "text",
      "per_day_impression_capping": 0,
      "status": "ACTIVE",
      "id": "text",
      "targeted_browser_families": "ALL",
      "ab_selection_min": 0,
      "max_budget_period": "DAY",
      "max_budget_per_period": 0,
      "visibility": "ABOVE_THE_FOLD",
      "ab_selection": false,
      "ab_selection_max": 0,
      "targeted_operating_systems": "ALL",
      "targeted_medias": "WEB",
      "total_budget": 0,
      "targeted_connection_types": "ALL",
      "technical_name": "text",
      "max_bid_price": 0,
      "campaign_id": "text",
      "targeted_devices": "ALL",
      "budget_relative_to_campaign": false
    }
  ],
  "max_results": 1
}

create an ad group

post
/display_campaigns/{campaign_id}/ad_groups
Path parameters
campaign_idinteger · int64Required

The organisation owning the campaign

Body
end_dateinteger · int64OptionalDefault: 0
viewability_use_third_party_databooleanRequiredDefault: false
total_impression_cappinginteger · int32RequiredDefault: 0
start_dateinteger · int64OptionalDefault: 0
viewability_min_scoreinteger · int32OptionalDefault: 0
namestringRequired
per_day_impression_cappinginteger · int32RequiredDefault: 0
statusstring · enumRequiredPossible values:
idstringRead-onlyRequired
targeted_browser_familiesstring · enumRequiredPossible values:
ab_selection_mininteger · int32RequiredDefault: 0
max_budget_periodstring · enumOptionalPossible values:
max_budget_per_periodnumber · floatOptionalDefault: 0
visibilitystring · enumRequiredPossible values:
ab_selectionbooleanRequiredDefault: false
ab_selection_maxinteger · int32RequiredDefault: 0
targeted_operating_systemsstring · enumRequiredPossible values:
targeted_mediasstring · enumRequiredPossible values:
total_budgetnumber · floatRequiredDefault: 0
targeted_connection_typesstring · enumRequiredPossible values:
technical_namestringRequired
max_bid_pricenumber · floatRequiredDefault: 0
campaign_idstringRequired
targeted_devicesstring · enumRequiredPossible values:
budget_relative_to_campaignbooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/display_campaigns/{campaign_id}/ad_groups
POST /v1/display_campaigns/{campaign_id}/ad_groups HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 601

{
  "end_date": 0,
  "viewability_use_third_party_data": false,
  "total_impression_capping": 0,
  "start_date": 0,
  "viewability_min_score": 0,
  "name": "text",
  "per_day_impression_capping": 0,
  "status": "ACTIVE",
  "targeted_browser_families": "ALL",
  "ab_selection_min": 0,
  "max_budget_period": "DAY",
  "max_budget_per_period": 0,
  "visibility": "ABOVE_THE_FOLD",
  "ab_selection": false,
  "ab_selection_max": 0,
  "targeted_operating_systems": "ALL",
  "targeted_medias": "WEB",
  "total_budget": 0,
  "targeted_connection_types": "ALL",
  "technical_name": "text",
  "max_bid_price": 0,
  "campaign_id": "text",
  "targeted_devices": "ALL",
  "budget_relative_to_campaign": false
}
{
  "status": "ok",
  "data": {
    "end_date": 0,
    "viewability_use_third_party_data": false,
    "total_impression_capping": 0,
    "start_date": 0,
    "viewability_min_score": 0,
    "name": "text",
    "per_day_impression_capping": 0,
    "status": "ACTIVE",
    "id": "text",
    "targeted_browser_families": "ALL",
    "ab_selection_min": 0,
    "max_budget_period": "DAY",
    "max_budget_per_period": 0,
    "visibility": "ABOVE_THE_FOLD",
    "ab_selection": false,
    "ab_selection_max": 0,
    "targeted_operating_systems": "ALL",
    "targeted_medias": "WEB",
    "total_budget": 0,
    "targeted_connection_types": "ALL",
    "technical_name": "text",
    "max_bid_price": 0,
    "campaign_id": "text",
    "targeted_devices": "ALL",
    "budget_relative_to_campaign": false
  }
}

find Geo Targetings

get
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
max_resultsintegerRequired
first_resultintegerRequired
totalintegerRequired
countintegerRequired
get/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations
GET /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "data": [
    {
      "postal_code": "text",
      "geoname_id": "text",
      "type": "POSTAL_CODE",
      "country": "text",
      "geozone_id": "text",
      "exclude": false,
      "admin1": "text",
      "admin2": "text",
      "city": "text",
      "id": "text"
    }
  ],
  "status": "ok",
  "max_results": 1,
  "first_result": 1,
  "total": 1,
  "count": 1
}

Create a Geo Targeting

post
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
Body
postal_codestringOptional
geoname_idstringOptional
typestring · enumRequiredPossible values:
countrystringOptional
geozone_idstringOptional
excludebooleanRequiredDefault: false
admin1stringOptional
admin2stringOptional
citystringOptional
idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations
POST /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "postal_code": "text",
  "geoname_id": "text",
  "type": "POSTAL_CODE",
  "country": "text",
  "geozone_id": "text",
  "exclude": false,
  "admin1": "text",
  "admin2": "text",
  "city": "text",
  "id": "text"
}
{
  "status": "ok",
  "data": {
    "postal_code": "text",
    "geoname_id": "text",
    "type": "POSTAL_CODE",
    "country": "text",
    "geozone_id": "text",
    "exclude": false,
    "admin1": "text",
    "admin2": "text",
    "city": "text",
    "id": "text"
  }
}

Search ads

get
/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads
Path parameters
campaign_idinteger · int64Required

The campaign id

group_idinteger · int64Required

The ad group id

Responses
200

Success !

application/json
totalintegerRequired
countintegerRequired
statusstring · enumRequiredPossible values:
first_resultintegerRequired
max_resultsintegerRequired
get/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads
GET /v1/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "total": 1,
  "count": 1,
  "status": "ok",
  "data": [
    {
      "id": "text",
      "status": "text",
      "creative_id": "text",
      "technical_name": "text"
    }
  ],
  "first_result": 1,
  "max_results": 1
}

create an ad

post
/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads
Path parameters
campaign_idinteger · int64Required

The campaign id

group_idinteger · int64Required

The ad group id

Body
idstringRead-onlyRequired
statusstringRequired
creative_idstringRequired
technical_namestringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads
POST /v1/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "status": "text",
  "creative_id": "text",
  "technical_name": "text"
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "status": "text",
    "creative_id": "text",
    "technical_name": "text"
  }
}

Get audience segment selection by id

get
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id}
GET /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "id": "text",
    "audience_segment_id": "text",
    "name": "text",
    "technical_name": "text",
    "exclude": false
  }
}

Update audience segment selection

put
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Body
idstringRead-onlyRequired
audience_segment_idstringRequired
namestringRead-onlyRequired
technical_namestringRead-onlyRequired
excludebooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id}
PUT /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "audience_segment_id": "text",
  "exclude": false
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "audience_segment_id": "text",
    "name": "text",
    "technical_name": "text",
    "exclude": false
  }
}

Delete audience segment selection

delete
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id}
DELETE /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Search ad groups

get
/display_campaigns.ad_groups
Query parameters
organisation_idinteger · int64Required

The organisation owning the campaign

automatedbooleanOptional

Campaign created within a scenario

campaign_idinteger · int64[]Optional
keywordsstringOptional

Word contained in the ad_group name

Responses
200

Success !

application/json
first_resultintegerRequired
statusstring · enumRequiredPossible values:
totalintegerRequired
max_resultsintegerRequired
countintegerRequired
get/display_campaigns.ad_groups
GET /v1/display_campaigns.ad_groups?organisation_id=1 HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "first_result": 1,
  "status": "ok",
  "total": 1,
  "data": [
    {
      "end_date": 0,
      "viewability_use_third_party_data": false,
      "total_impression_capping": 0,
      "start_date": 0,
      "viewability_min_score": 0,
      "name": "text",
      "per_day_impression_capping": 0,
      "status": "ACTIVE",
      "id": "text",
      "targeted_browser_families": "ALL",
      "ab_selection_min": 0,
      "max_budget_period": "DAY",
      "max_budget_per_period": 0,
      "visibility": "ABOVE_THE_FOLD",
      "ab_selection": false,
      "ab_selection_max": 0,
      "targeted_operating_systems": "ALL",
      "targeted_medias": "WEB",
      "total_budget": 0,
      "targeted_connection_types": "ALL",
      "technical_name": "text",
      "max_bid_price": 0,
      "campaign_id": "text",
      "targeted_devices": "ALL",
      "budget_relative_to_campaign": false
    }
  ],
  "max_results": 1,
  "count": 1
}

Search ad

get
/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id}
Path parameters
campaign_idinteger · int64Required

The campaign id

group_idinteger · int64Required

The ad group id

idinteger · int64Required

The ad id

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id}
GET /v1/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "id": "text",
    "status": "text",
    "creative_id": "text",
    "technical_name": "text"
  }
}

Update an ad

put
/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id}
Path parameters
campaign_idinteger · int64Required

The campaign id

group_idinteger · int64Required

The ad group id

idinteger · int64Required

The ad id

Body
idstringRead-onlyRequired
statusstringRequired
creative_idstringRequired
technical_namestringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id}
PUT /v1/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "status": "text",
  "creative_id": "text",
  "technical_name": "text"
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "status": "text",
    "creative_id": "text",
    "technical_name": "text"
  }
}

Removes an ad

delete
/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id}
Path parameters
campaign_idinteger · int64Required

The campaign id

group_idinteger · int64Required

The ad group id

idinteger · int64Required

The ad id

Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id}
DELETE /v1/display_campaigns/{campaign_id}/ad_groups/{group_id}/ads/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

get display campaigns

get
/display_campaigns
Query parameters
administration_idinteger · int64Optional

The organisation adminstrating the organisation owning the campaign

organisation_idinteger · int64Optional

The organisation owning the campaign

automatedbooleanOptional

Campaign created within a scenario

keywordsstringOptional

Word contained in the campaign name

archivedbooleanOptional

Retrieve archived campaigns

label_idinteger · int64[]Optional

Campaign in the result are labeled by all labels identified by this list

order_bystring[]Optional

Fields used to order the result

first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that shall be return by this search

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
max_resultsintegerRequired
countintegerRequired
totalintegerRequired
first_resultintegerRequired
get/display_campaigns
GET /v1/display_campaigns HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "max_results": 1,
  "count": 1,
  "total": 1,
  "first_result": 1,
  "data": [
    {
      "time_zone": "text",
      "automated": false,
      "max_budget_period": "DAY",
      "organisation_id": "text",
      "editor_version_value": "text",
      "model_version": "V2014_06",
      "total_budget": 0,
      "status": "PENDING",
      "max_bid_price": 0,
      "id": "text",
      "max_budget_per_period": 0,
      "total_impression_capping": 0,
      "per_day_impression_capping": 0,
      "currency_code": "text",
      "start_date": 0,
      "subtype": "PROGRAMMATIC",
      "name": "text",
      "editor_version_id": "text",
      "creation_ts": 0,
      "editor_group_id": "text",
      "technical_name": "text",
      "archived": false,
      "end_date": 0,
      "editor_artifact_id": "text"
    }
  ]
}

Create Display Campaign

post
/display_campaigns
Body
time_zonestringRequired
automatedbooleanRequiredDefault: false
max_budget_periodstring · enumRequiredPossible values:
organisation_idstringRequired
editor_version_valuestringRequired
model_versionstring · enumRequiredPossible values:
total_budgetnumber · floatRequiredDefault: 0
statusstring · enumRequiredPossible values:
max_bid_pricenumber · floatRequiredDefault: 0
idstringRead-onlyRequired
max_budget_per_periodnumber · floatRequiredDefault: 0
total_impression_cappinginteger · int32RequiredDefault: 0
per_day_impression_cappinginteger · int32RequiredDefault: 0
currency_codestringRequired
start_dateinteger · int64RequiredDefault: 0
subtypestring · enumRequiredPossible values:
namestringRequired
editor_version_idstringRequired
creation_tsinteger · int64RequiredDefault: 0
editor_group_idstringRequired
technical_namestringOptional
archivedbooleanRequiredDefault: false
end_dateinteger · int64RequiredDefault: 0
editor_artifact_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/display_campaigns
POST /v1/display_campaigns HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 513

{
  "time_zone": "text",
  "automated": false,
  "max_budget_period": "DAY",
  "organisation_id": "text",
  "editor_version_value": "text",
  "model_version": "V2014_06",
  "total_budget": 0,
  "status": "PENDING",
  "max_bid_price": 0,
  "max_budget_per_period": 0,
  "total_impression_capping": 0,
  "per_day_impression_capping": 0,
  "currency_code": "text",
  "start_date": 0,
  "subtype": "PROGRAMMATIC",
  "name": "text",
  "editor_version_id": "text",
  "creation_ts": 0,
  "editor_group_id": "text",
  "technical_name": "text",
  "archived": false,
  "end_date": 0,
  "editor_artifact_id": "text"
}
{
  "status": "ok",
  "data": {
    "type": "DISPLAY",
    "time_zone": "text",
    "automated": false,
    "max_budget_period": "DAY",
    "organisation_id": "text",
    "editor_version_value": "text",
    "model_version": "V2014_06",
    "total_budget": 0,
    "status": "PENDING",
    "max_bid_price": 0,
    "id": "text",
    "max_budget_per_period": 0,
    "total_impression_capping": 0,
    "per_day_impression_capping": 0,
    "currency_code": "text",
    "start_date": 0,
    "subtype": "PROGRAMMATIC",
    "name": "text",
    "editor_version_id": "text",
    "creation_ts": 0,
    "editor_group_id": "text",
    "technical_name": "text",
    "archived": false,
    "end_date": 0,
    "editor_artifact_id": "text"
  }
}

Search display network selections

get
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
Query parameters
first_resultinteger · int32Optional

Offset from which the search must be performed

max_resultsinteger · int32Optional

Number of maximum items that shall be return by this search

Responses
200

Success !

application/json
first_resultintegerRequired
max_resultsintegerRequired
statusstring · enumRequiredPossible values:
totalintegerRequired
countintegerRequired
get/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks
GET /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "first_result": 1,
  "max_results": 1,
  "status": "ok",
  "data": [
    {
      "id": "text",
      "ad_group_id": "text",
      "display_network_id": "text",
      "exclude": false
    }
  ],
  "total": 1,
  "count": 1
}

Create display network selection

post
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
Body
idstringRead-onlyRequired
ad_group_idstringRequired
display_network_idstringRequired
excludebooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks
POST /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ad_group_id": "text",
  "display_network_id": "text",
  "exclude": false
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "ad_group_id": "text",
    "display_network_id": "text",
    "exclude": false
  }
}

Search audience segment selections

get
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
Responses
200

Success !

application/json
first_resultintegerRequired
max_resultsintegerRequired
countintegerRequired
statusstring · enumRequiredPossible values:
totalintegerRequired
get/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments
GET /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "first_result": 1,
  "max_results": 1,
  "data": [
    {
      "id": "text",
      "audience_segment_id": "text",
      "name": "text",
      "technical_name": "text",
      "exclude": false
    }
  ],
  "count": 1,
  "status": "ok",
  "total": 1
}

Create audience segment selection

post
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
Body
idstringRead-onlyRequired
audience_segment_idstringRequired
namestringRead-onlyRequired
technical_namestringRead-onlyRequired
excludebooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments
POST /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/audience_segments HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "audience_segment_id": "text",
  "exclude": false
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "audience_segment_id": "text",
    "name": "text",
    "technical_name": "text",
    "exclude": false
  }
}

Get display network selection by id

get
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id}
GET /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "id": "text",
    "ad_group_id": "text",
    "display_network_id": "text",
    "exclude": false
  }
}

Update display network selection

put
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Body
idstringRead-onlyRequired
ad_group_idstringRequired
display_network_idstringRequired
excludebooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id}
PUT /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ad_group_id": "text",
  "display_network_id": "text",
  "exclude": false
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "ad_group_id": "text",
    "display_network_id": "text",
    "exclude": false
  }
}

Delete display network selection

delete
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id}
DELETE /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/display_networks/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

get an ad group from the campaign

get
/display_campaigns/{campaign_id}/ad_groups/{id}
Path parameters
campaign_idinteger · int64Required

The campaign id

idinteger · int64Required

The ad group id

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/display_campaigns/{campaign_id}/ad_groups/{id}
GET /v1/display_campaigns/{campaign_id}/ad_groups/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "end_date": 0,
    "viewability_use_third_party_data": false,
    "total_impression_capping": 0,
    "start_date": 0,
    "viewability_min_score": 0,
    "name": "text",
    "per_day_impression_capping": 0,
    "status": "ACTIVE",
    "id": "text",
    "targeted_browser_families": "ALL",
    "ab_selection_min": 0,
    "max_budget_period": "DAY",
    "max_budget_per_period": 0,
    "visibility": "ABOVE_THE_FOLD",
    "ab_selection": false,
    "ab_selection_max": 0,
    "targeted_operating_systems": "ALL",
    "targeted_medias": "WEB",
    "total_budget": 0,
    "targeted_connection_types": "ALL",
    "technical_name": "text",
    "max_bid_price": 0,
    "campaign_id": "text",
    "targeted_devices": "ALL",
    "budget_relative_to_campaign": false
  }
}

update an ad group

put
/display_campaigns/{campaign_id}/ad_groups/{id}
Path parameters
campaign_idinteger · int64Required

The campaign id

idinteger · int64Required

The ad group id

Body
end_dateinteger · int64OptionalDefault: 0
viewability_use_third_party_databooleanRequiredDefault: false
total_impression_cappinginteger · int32RequiredDefault: 0
start_dateinteger · int64OptionalDefault: 0
viewability_min_scoreinteger · int32OptionalDefault: 0
namestringRequired
per_day_impression_cappinginteger · int32RequiredDefault: 0
statusstring · enumRequiredPossible values:
idstringRead-onlyRequired
targeted_browser_familiesstring · enumRequiredPossible values:
ab_selection_mininteger · int32RequiredDefault: 0
max_budget_periodstring · enumOptionalPossible values:
max_budget_per_periodnumber · floatOptionalDefault: 0
visibilitystring · enumRequiredPossible values:
ab_selectionbooleanRequiredDefault: false
ab_selection_maxinteger · int32RequiredDefault: 0
targeted_operating_systemsstring · enumRequiredPossible values:
targeted_mediasstring · enumRequiredPossible values:
total_budgetnumber · floatRequiredDefault: 0
targeted_connection_typesstring · enumRequiredPossible values:
technical_namestringRequired
max_bid_pricenumber · floatRequiredDefault: 0
campaign_idstringRequired
targeted_devicesstring · enumRequiredPossible values:
budget_relative_to_campaignbooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/display_campaigns/{campaign_id}/ad_groups/{id}
PUT /v1/display_campaigns/{campaign_id}/ad_groups/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 601

{
  "end_date": 0,
  "viewability_use_third_party_data": false,
  "total_impression_capping": 0,
  "start_date": 0,
  "viewability_min_score": 0,
  "name": "text",
  "per_day_impression_capping": 0,
  "status": "ACTIVE",
  "targeted_browser_families": "ALL",
  "ab_selection_min": 0,
  "max_budget_period": "DAY",
  "max_budget_per_period": 0,
  "visibility": "ABOVE_THE_FOLD",
  "ab_selection": false,
  "ab_selection_max": 0,
  "targeted_operating_systems": "ALL",
  "targeted_medias": "WEB",
  "total_budget": 0,
  "targeted_connection_types": "ALL",
  "technical_name": "text",
  "max_bid_price": 0,
  "campaign_id": "text",
  "targeted_devices": "ALL",
  "budget_relative_to_campaign": false
}
{
  "status": "ok",
  "data": {
    "end_date": 0,
    "viewability_use_third_party_data": false,
    "total_impression_capping": 0,
    "start_date": 0,
    "viewability_min_score": 0,
    "name": "text",
    "per_day_impression_capping": 0,
    "status": "ACTIVE",
    "id": "text",
    "targeted_browser_families": "ALL",
    "ab_selection_min": 0,
    "max_budget_period": "DAY",
    "max_budget_per_period": 0,
    "visibility": "ABOVE_THE_FOLD",
    "ab_selection": false,
    "ab_selection_max": 0,
    "targeted_operating_systems": "ALL",
    "targeted_medias": "WEB",
    "total_budget": 0,
    "targeted_connection_types": "ALL",
    "technical_name": "text",
    "max_bid_price": 0,
    "campaign_id": "text",
    "targeted_devices": "ALL",
    "budget_relative_to_campaign": false
  }
}

update an ad group

delete
/display_campaigns/{campaign_id}/ad_groups/{id}
Path parameters
campaign_idinteger · int64Required

The campaign id

idinteger · int64Required

The ad group id

Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/display_campaigns/{campaign_id}/ad_groups/{id}
DELETE /v1/display_campaigns/{campaign_id}/ad_groups/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

update a campaign by id

put
/display_campaigns/{id}
Path parameters
idinteger · int64Required
Body
time_zonestringRequired
automatedbooleanRequiredDefault: false
max_budget_periodstring · enumRequiredPossible values:
organisation_idstringRequired
editor_version_valuestringRequired
model_versionstring · enumRequiredPossible values:
total_budgetnumber · floatRequiredDefault: 0
statusstring · enumRequiredPossible values:
max_bid_pricenumber · floatRequiredDefault: 0
idstringRead-onlyRequired
max_budget_per_periodnumber · floatRequiredDefault: 0
total_impression_cappinginteger · int32RequiredDefault: 0
per_day_impression_cappinginteger · int32RequiredDefault: 0
currency_codestringRequired
start_dateinteger · int64RequiredDefault: 0
subtypestring · enumRequiredPossible values:
namestringRequired
editor_version_idstringRequired
creation_tsinteger · int64RequiredDefault: 0
editor_group_idstringRequired
technical_namestringOptional
archivedbooleanRequiredDefault: false
end_dateinteger · int64RequiredDefault: 0
editor_artifact_idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/display_campaigns/{id}
PUT /v1/display_campaigns/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 513

{
  "time_zone": "text",
  "automated": false,
  "max_budget_period": "DAY",
  "organisation_id": "text",
  "editor_version_value": "text",
  "model_version": "V2014_06",
  "total_budget": 0,
  "status": "PENDING",
  "max_bid_price": 0,
  "max_budget_per_period": 0,
  "total_impression_capping": 0,
  "per_day_impression_capping": 0,
  "currency_code": "text",
  "start_date": 0,
  "subtype": "PROGRAMMATIC",
  "name": "text",
  "editor_version_id": "text",
  "creation_ts": 0,
  "editor_group_id": "text",
  "technical_name": "text",
  "archived": false,
  "end_date": 0,
  "editor_artifact_id": "text"
}
{
  "status": "ok",
  "data": {
    "type": "DISPLAY",
    "time_zone": "text",
    "automated": false,
    "max_budget_period": "DAY",
    "organisation_id": "text",
    "editor_version_value": "text",
    "model_version": "V2014_06",
    "total_budget": 0,
    "status": "PENDING",
    "max_bid_price": 0,
    "id": "text",
    "max_budget_per_period": 0,
    "total_impression_capping": 0,
    "per_day_impression_capping": 0,
    "currency_code": "text",
    "start_date": 0,
    "subtype": "PROGRAMMATIC",
    "name": "text",
    "editor_version_id": "text",
    "creation_ts": 0,
    "editor_group_id": "text",
    "technical_name": "text",
    "archived": false,
    "end_date": 0,
    "editor_artifact_id": "text"
  }
}

remove a campaign by id

delete
/display_campaigns/{id}
Path parameters
idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/display_campaigns/{id}
DELETE /v1/display_campaigns/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

find Geo Targeting

get
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id}
GET /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "postal_code": "text",
    "geoname_id": "text",
    "type": "POSTAL_CODE",
    "country": "text",
    "geozone_id": "text",
    "exclude": false,
    "admin1": "text",
    "admin2": "text",
    "city": "text",
    "id": "text"
  }
}

Update a Geo Targeting

put
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Body
postal_codestringOptional
geoname_idstringOptional
typestring · enumRequiredPossible values:
countrystringOptional
geozone_idstringOptional
excludebooleanRequiredDefault: false
admin1stringOptional
admin2stringOptional
citystringOptional
idstringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id}
PUT /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "postal_code": "text",
  "geoname_id": "text",
  "type": "POSTAL_CODE",
  "country": "text",
  "geozone_id": "text",
  "exclude": false,
  "admin1": "text",
  "admin2": "text",
  "city": "text",
  "id": "text"
}
{
  "status": "ok",
  "data": {
    "postal_code": "text",
    "geoname_id": "text",
    "type": "POSTAL_CODE",
    "country": "text",
    "geozone_id": "text",
    "exclude": false,
    "admin1": "text",
    "admin2": "text",
    "city": "text",
    "id": "text"
  }
}

Removes a Geo Targeting

delete
/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id}
Path parameters
campaign_idinteger · int64Required
ad_group_idinteger · int64Required
idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id}
DELETE /v1/display_campaigns/{campaign_id}/ad_groups/{ad_group_id}/locations/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Last updated

Was this helpful?