Ad Group - Experiences

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response

Field
Type
Description
idintThe id of the ad group
campaign_idintThe campaign of the ad group
advertiser_idintThe advertiser id of the ad group
namestringThe name of the ad group
start_datestringThe start date of the ad group
end_datestringThe end date of the ad group
statusstringThe ad group status
always_onboolThe always on flag
is_auto_bidboolThe bid automation flag controlled by campaign
base_bidobjectThe base bid details of the ad group
amountfloatThe base bid amount
typestringThe base bid type (CPC, CPM, CPA)
budgetobjectThe budget details of the ad group
typestringThe type of budget
amountfloatThe budget amount
targetingobjectThe targeting for this ad group
typestringThe type of targeting (right now it is only user targeting)
valuefloatThe setting value
settingsarray of objectsThe list of targeting settings
targeting_dimension_idintThe targeting dimension id
valuefloatThe targeting value
optionsarray of objectsThe targeting options
biddersarray of objectsThe array of bidders for the ad group
idbig intThe bidder id (koddi entity id)
amountfloatThe bid amount. This overrides the base bid for the ad group if set but inherits the base bid type.
attribute_key_valuesarray of stringsThe array of values used for advertiser attribute halo attribution
metadataobjectThe ad group metadata

Try it!

Path Params
int32
required

The member group id (provided by Koddi)

int32
required

Advertiser Id

int32
required

Ad group Id

Body Params
int32
required

The id of the parent campaign

string
required

The name of the ad group

string
required

The start date of the ad group

string

The end date of the ad group (required if always_on is false)

boolean
required

Indicates if the ad group is always on

string
required

The ad group status. Possible values: Active, Inactive, Pending, Ended, Paused.

boolean

If true, then in addition to the bidders given in this request, also include the list of bidders from filters; The bidders will be unique, in the order of request, filter, existing

base_bid
object

The base bid details of the ad group

budget
object

The budget details of the ad group

targeting
array of objects

The targeting for this ad group

targeting
settings
array of objects
required

The list of targeting settings

settings*
bidders
array of objects

Required if all_selected is false. The array of bidders for the ad group

bidders
filters
array of objects

The list of filter options

filters
asset_associations
array of objects

A list of assets to associate with

asset_associations
attribute_key_values
array of strings

The array of values used for advertiser attribute halo attribution

attribute_key_values
metadata
object

The ad group metadata

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json