Skip to content

Get targetings

POST
/targetings
curl --request POST \
--url https://gateway.staging.arago-tech.com/targetings \
--header 'Content-Type: application/json' \
--data '{ "ids": [ "63e2d42a27ad5f2b345ca123", "63e2d42a27ad5f2b345ca124" ] }'

Get targetings for given targeting IDs

The request to get targetings by their unique identifiers

Media typeapplication/json
Get targetings

The request to get targetings by their unique identifiers

object
ids
required
Targeting IDs

The unique identifiers of the targetings to list, as 24-character hexadecimal strings. Each ID must be unique; the all-zero identifier 000000000000000000000000 is rejected.

Array<string>
>= 1 items <= 1000 items unique items
Example
[
"63e2d42a27ad5f2b345ca123",
"63e2d42a27ad5f2b345ca124"
]

A successful response.

Media typeapplication/json
Get targetings response

The response containing the targetings

object
targetings
Targetings

The list of targetings

Array<object>
Targeting

The targeting information

object
id
Targeting ID

The targeting unique identifier in hexadecimal format

string
geo_area_id
Geo area ID

The geographical area unique identifier in hexadecimal format

string
distribution_channel_whitelist_urls
Distribution channel whitelist URLs

The URLs of the distribution channel whitelists for the targeting

Array<string>
distribution_channel_blacklist_urls
Distribution channel blacklist URLs

The URLs of the distribution channel blacklists for the targeting

Array<string>
frequency_cap
Frequency cap

Frequency cap targeting settings limiting the number of impressions per user within a number of days

object
max_impressions
required

Maximum number of impressions per user within the duration

integer format: integer
>= 1 <= 100
duration_days
required

Number of days over which the impression limit applies

integer format: integer
>= 1 <= 90
created_at
Created At

The creation date and time of the targeting

string format: date-time
updated_at
Updated At

The last update date and time of the targeting

string format: date-time
ifa_whitelists
IFAs whitelist entries

The IFAs whitelist entries (URL + hash format) for the targeting

Array<object>

IFAList pairs an uploaded IFA list URL with the hash format used by its entries.

object
url
string
format
string
default: IFA_FORMAT_TYPE_UNSPECIFIED
Allowed values: IFA_FORMAT_TYPE_UNSPECIFIED IFA_FORMAT_TYPE_UUID IFA_FORMAT_TYPE_SHA256 IFA_FORMAT_TYPE_MD5
ifa_blacklists
IFAs blacklist entries

The IFAs blacklist entries (URL + hash format) for the targeting

Array<object>

IFAList pairs an uploaded IFA list URL with the hash format used by its entries.

object
url
string
format
string
default: IFA_FORMAT_TYPE_UNSPECIFIED
Allowed values: IFA_FORMAT_TYPE_UNSPECIFIED IFA_FORMAT_TYPE_UUID IFA_FORMAT_TYPE_SHA256 IFA_FORMAT_TYPE_MD5
deal_ids
Deal IDs

The deal IDs for the targeting

Array<string>
device_types
Device types

The device types for the targeting

Array<string>
Allowed values: DEVICE_TYPE_UNSPECIFIED DEVICE_TYPE_MOBILE_TABLET DEVICE_TYPE_PERSONAL_COMPUTER DEVICE_TYPE_CONNECTED_TV DEVICE_TYPE_PHONE DEVICE_TYPE_TABLET DEVICE_TYPE_CONNECTED_DEVICE DEVICE_TYPE_SET_TOP_BOX DEVICE_TYPE_OOH_DEVICE
distribution_channel_types
Distribution channel types

Allowed distribution channel types (website, mobile app, DOOH)

Array<string>
Allowed values: DISTRIBUTION_CHANNEL_TYPE_UNSPECIFIED DISTRIBUTION_CHANNEL_TYPE_WEBSITE DISTRIBUTION_CHANNEL_TYPE_MOBILE_APP DISTRIBUTION_CHANNEL_TYPE_DOOH
device_languages
Device languages

The device languages for the targeting

Array<string>
Allowed values: LANGUAGE_UNSPECIFIED AA AB AE AF AK AM AN AR AS AV AY AZ BA BE BG BH BI BM BN BO BR BS CA CE CH CO CR CS CU CV CY DA DE DV DZ EE EL EN EO ES ET EU FA FF FI FJ FO FR FY GA GD GL GN GU GV HA HE HI HR HT HU HY HZ IA ID IE IG II IK IO IS IT IU JA JV KA KG KI KJ KK KL KM KN KO KR KS KU KV KW KY LA LB LG LI LN LO LT LU LV MG MH MI MK ML MN MR MS MT MY NA NB ND NE NG NL NN NO NR NV NY OC OJ OM OR OS PA PI PL PS PT QU RM RN RO RU RW SA SC SD SE SG SI SK SL SM SN SO SQ SR SS ST SU SV SW TA TE TG TH TI TK TL TN TO TR TS TT TW TY UG UK UR UZ VE VI VO WA WO XH YI YO ZA ZH ZU
brand_safety_enabled
Brand safety enabled

Enables brand safety targeting

boolean
retargeting
Retargeting

Retargeting settings allowing a bid only when the user was already reached by one of the source line items

object
line_item_ids
required
Source line item IDs

The unique identifiers of the line items whose previous delivery is retargeted

Array<string>
>= 1 items <= 3000 items unique items
event_types
Event types

The events a user must have triggered on the source line items to be retargeted, among EVENT_TYPE_IMPRESSION, EVENT_TYPE_VIEWABLE_MRC_50 and EVENT_TYPE_CLICK; any event when empty

Array<string>
<= 3 items unique items
Allowed values: EVENT_TYPE_UNSPECIFIED EVENT_TYPE_LOADED EVENT_TYPE_IMPRESSION EVENT_TYPE_VIEWABILITY_MEASURABLE EVENT_TYPE_VIEWABLE_MRC_50 EVENT_TYPE_VIEWABLE_MRC_100 EVENT_TYPE_VIEWABLE_VIDEO_50 EVENT_TYPE_CLICK
Example
{
"targetings": [
{
"id": "63e2d42a27ad5f2b345ca123",
"geo_area_id": "63e2d42a27ad5f2b345ca123",
"distribution_channel_whitelist_urls": "https://cdn.example.com/bucket/owner_user_id/<hash>/whitelist.txt",
"distribution_channel_blacklist_urls": "https://cdn.example.com/bucket/owner_user_id/<hash>/blacklist.txt",
"frequency_cap": {
"max_impressions": 10,
"duration_days": 7
},
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z",
"ifa_whitelists": [
{
"format": "IFA_FORMAT_TYPE_MD5",
"url": "https://cdn.example.com/bucket/owner_user_id/<hash>/whitelist.txt"
}
],
"ifa_blacklists": [
{
"format": "IFA_FORMAT_TYPE_MD5",
"url": "https://cdn.example.com/bucket/owner_user_id/<hash>/blacklist.txt"
}
],
"deal_ids": [
"0123456789",
"ABCDEFGHIJ"
],
"device_types": [
"DEVICE_TYPE_PERSONAL_COMPUTER",
"DEVICE_TYPE_PHONE",
"DEVICE_TYPE_TABLET"
],
"distribution_channel_types": [
"DISTRIBUTION_CHANNEL_TYPE_WEBSITE",
"DISTRIBUTION_CHANNEL_TYPE_MOBILE_APP",
"DISTRIBUTION_CHANNEL_TYPE_DOOH"
],
"device_languages": [
"LANGUAGE_EN"
],
"brand_safety_enabled": true,
"retargeting": {
"line_item_ids": [
"63e2d42a27ad5f2b345ca123",
"63e2d42a27ad5f2b345ca124"
],
"event_types": [
"EVENT_TYPE_IMPRESSION",
"EVENT_TYPE_CLICK"
]
}
}
]
}

Bad request

Media typeapplication/json
object
Example
{
"error": {
"code": "BAD_REQUEST",
"details": [
{
"code": "PATTERN",
"field": "username",
"message": "does not match regex pattern `^[a-zA-Z]*$`"
},
{
"code": "MIN_LEN",
"field": "username",
"message": "must be at least 3 characters",
"params": {
"min": "3"
}
}
],
"message": "Bad request"
}
}

Unauthorized

Media typeapplication/json
object
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}
}

Forbidden

Media typeapplication/json
object
Example
{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
}
}

Not found

Media typeapplication/json
object
Example
{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL",
"details": [
{
"code": "INTERNAL",
"field": "line_items[0]",
"message": "Couldn't upsert line item"
},
{
"code": "INTERNAL",
"field": "line_items[380]",
"message": "Couldn't upsert line item"
}
],
"message": "Internal server error"
}
}

Gateway timeout

Media typeapplication/json
object
Example
{
"error": {
"code": "TIMEOUT",
"details": [
{
"code": "TIMEOUT",
"field": "request",
"message": "Request processing time exceeded deadline",
"params": {
"duration": "30s"
}
}
],
"message": "Gateway timeout"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field.

Protobuf APIs provide utilities to interact with Any values:

  • A ‘pack’ operation accepts a message and constructs a generic Any wrapper around it.
  • An ‘unpack’ operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url.
  • An ‘is’ operation decides whether an Any contains a message of the given type, i.e. whether it can ‘unpack’ that type.

The JSON format representation of an Any follows one of these cases:

  • For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL.
  • For types with special-cased JSON encodings (typically called ‘well-known’ types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value.

The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.

object
@type

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.

Example: type.googleapis.com/google.protobuf.StringValue

This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them.

The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests.

All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected.

In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}