Skip to content

Get an ad group

GET
/ad-groups/{id}
curl --request GET \
--url https://ads.wortise.com/api/public/v1/ad-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'x-api-key: <x-api-key>'

Reads one ad group of the organization.

Requires the campaigns:read scope.

id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Ad group UUID.

The ad group.

Media typeapplication/json
object
_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
adFormat

Restricts every creative in this ad group to a single format

string
Allowed values: banner interstitial
audience
object
appFilter
Array<string>
device
object
battery
object
plugged
required
boolean
brand
Array<string>
language
Array<string>
model
Array<string>
os
Array<string>
default: android,ios
Allowed values: android ios
osVersion
Array<string>
type
Array<string>
Allowed values: mobile desktop tv tablet ??
not

Only explicitly requested targeting exclusions.

object
appFilter
Array<string>
device
object
battery
object
plugged
required
boolean
brand
Array<string>
language
Array<string>
model
Array<string>
os
Array<string>
default: android,ios
Allowed values: android ios
osVersion
Array<string>
type
Array<string>
Allowed values: mobile desktop tv tablet ??
not
object recursive
tag
object
audiences
required
Array<object>
object
id
required
string
label
required
string
products
required
Array<object>
object
id
required
string
label
required
string
topics
required
Array<object>
object
id
required
string
label
required
string
app
object
category
Array<object>
object
id
required

E.g: “1”, “20”.

string
label
required
string
list
Array<object>
object
icon
string
id
required
string
label
required
string
platform
required
string
Allowed values: android ios web
appFilters
object
coppa
boolean
maxInstalls
number
minInstalls
number
minScore
number
<= 5
platform
Array<string>
Allowed values: android ios
cellular
object
carrier
required
Array<object>
>= 1 items
object
country
required
string
>= 1 characters
countryCode
required
string
>= 1 characters
iso
required
string
mcc
required
string
/^\d{3}$/
mnc
required
string
/^\d{2,3}$/
network
required
string
>= 1 characters
cpm
number
> 0
isPublic
boolean
location

Exact inventory locations or geographic areas to target.

Array
0
Any of:
One of:
object
countryCode
string
>= 2 characters <= 2 characters
displayName
required
string
lat
required
number
lng
required
number
placeId
required
string
source
required
string
Allowed value: google_places
type
required
string
Allowed value: place
types
required
Array<string>
time
object
day
Array<number>
hour
Array<object>
object
_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
from
required
number
<= 23
to
required
number
<= 23
traffic
object
age
object
key
additional properties
number
<= 1
category
object
key
additional properties
number
<= 1
country
object
key
additional properties
number
<= 1
device
object
key
additional properties
number
<= 1
gender
object
key
additional properties
number
<= 1
size
object
key
additional properties
number
<= 1
user

Optional demographic filters. Age codes are ranges: -18=under 18, 18=18–24, 25=25–34, 35=35–44, 45=45–54, 55=55–64, 65=65+. Adults 18+ requires all six adult ranges, not just 18. Gender ?? means unknown, not all genders; omit gender on creation or use [] on update for unrestricted gender.

object
gender
Array<string>
Allowed values: female male ??
id
Array<string>
age
Array<string>
Allowed values: -18 18 25 35 45 55 65
interest
Array<object>
object
id
required
string
label
required
string
tag
object
audiences
required
Array<object>
object
id
required
string
label
required
string
products
required
Array<object>
object
id
required
string
label
required
string
topics
required
Array<object>
object
id
required
string
label
required
string
_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
app
object
category
Array<object>
object
id
required

E.g: “1”, “20”.

string
label
required
string
list
Array<object>
object
icon
string
id
required
string
label
required
string
platform
required
string
Allowed values: android ios web
appFilters
object
coppa
boolean
maxInstalls
number
minInstalls
number
minScore
number
<= 5
platform
Array<string>
Allowed values: android ios
cellular
object
carrier
required
Array<object>
>= 1 items
object
country
required
string
>= 1 characters
countryCode
required
string
>= 1 characters
iso
required
string
mcc
required
string
/^\d{3}$/
mnc
required
string
/^\d{2,3}$/
network
required
string
>= 1 characters
cpm
number
> 0
createdAt
Any of:
string format: date-time
createdBy
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
deletedAt
Any of:
string format: date-time
isDraft
boolean
default: true
isPublic
boolean
location
required

Exact inventory locations or geographic areas to target.

Array
0
Any of:
One of:
object
countryCode
string
>= 2 characters <= 2 characters
displayName
required
string
lat
required
number
lng
required
number
placeId
required
string
source
required
string
Allowed value: google_places
type
required
string
Allowed value: place
types
required
Array<string>
time
object
day
Array<number>
hour
Array<object>
object
_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
from
required
number
<= 23
to
required
number
<= 23
traffic
object
age
object
key
additional properties
number
<= 1
category
object
key
additional properties
number
<= 1
country
object
key
additional properties
number
<= 1
device
object
key
additional properties
number
<= 1
gender
object
key
additional properties
number
<= 1
size
object
key
additional properties
number
<= 1
updatedAt
Any of:
string format: date-time
updatedBy
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
user

Optional demographic filters. Age codes are ranges: -18=under 18, 18=18–24, 25=25–34, 35=35–44, 45=45–54, 55=55–64, 65=65+. Adults 18+ requires all six adult ranges, not just 18. Gender ?? means unknown, not all genders; omit gender on creation or use [] on update for unrestricted gender.

object
gender
Array<string>
Allowed values: female male ??
id
Array<string>
age
Array<string>
Allowed values: -18 18 25 35 45 55 65
interest
Array<object>
object
id
required
string
label
required
string
budgetAllocation

Slice of the campaign budget assigned to this ad group, in local currency

number
> 0
campaign
required
Any of:

Ref to campaigns collection

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
createdAt
Any of:
string format: date-time
createdBy
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
deletedAt
Any of:
string format: date-time
frequencyCap

Impressions per user (“max”) within a rolling window (“expiration”, in seconds)

object
expiration
required
number
max
required
number
> 0
id

Ad group ID in ADS service

integer
> 0 <= 9007199254740991
name
string
objective

Impressions (CPM) or clicks (CPC) its budget allocation buys at its unit price

integer
<= 9007199254740991
order
integer
0 <= 9007199254740991
organization
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
status
string
default: enabled
Allowed values: enabled disabled archived
team
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
trackingTag
string format: uri
unitPrice

Unit price in local currency (CPM/CPC) for creatives in this ad group

number
> 0
updatedAt
Any of:
string format: date-time
updatedBy
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
url

Destination URL (redirect)

string format: uri
utm
object
campaign
string
id
string
medium
string
source
string

Example

{
"adFormat": "banner",
"audience": {
"device": {
"os": [
"android",
"ios"
],
"type": [
"mobile"
]
},
"not": {
"device": {
"os": [
"android",
"ios"
],
"type": [
"mobile"
]
},
"app": {
"list": [
{
"platform": "android"
}
]
},
"appFilters": {
"platform": [
"android"
]
},
"location": [
{
"source": "google_places",
"type": "place"
}
],
"user": {
"gender": [
"female"
],
"age": [
"-18"
]
}
},
"app": {
"list": [
{
"platform": "android"
}
]
},
"appFilters": {
"platform": [
"android"
]
},
"isDraft": true,
"location": [
{
"source": "google_places",
"type": "place"
}
],
"user": {
"gender": [
"female"
],
"age": [
"-18"
]
}
},
"campaign": {
"currency": "BRL"
},
"order": 0,
"status": "enabled"
}

The API key is missing, invalid, disabled or expired.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The API key lacks the scope, or its owner lacks the dashboard permission.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The resource does not exist in the organization of the API key.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The API key exceeded its rate limit; retry after the Retry-After seconds.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}
Retry-After
integer

Seconds to wait before retrying.

Unexpected server error.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}