Get targeting by ID
const url = 'https://gateway.staging.arago-tech.com/targetings/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://gateway.staging.arago-tech.com/targetings/exampleReturns the targeting by its unique identifier
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The targeting unique identifier, as a 24-character hexadecimal string. The all-zero identifier 000000000000000000000000 is rejected.
Responses
Section titled “ Responses ”A successful response.
The targeting information
object
The targeting unique identifier in hexadecimal format
The geographical area unique identifier in hexadecimal format
The URLs of the distribution channel whitelists for the targeting
The URLs of the distribution channel blacklists for the targeting
Frequency cap targeting settings limiting the number of impressions per user within a number of days
object
Maximum number of impressions per user within the duration
Number of days over which the impression limit applies
The creation date and time of the targeting
The last update date and time of the targeting
The IFAs whitelist entries (URL + hash format) for the targeting
IFAList pairs an uploaded IFA list URL with the hash format used by its entries.
object
The IFAs blacklist entries (URL + hash format) for the targeting
IFAList pairs an uploaded IFA list URL with the hash format used by its entries.
object
The deal IDs for the targeting
The device types for the targeting
Allowed distribution channel types (website, mobile app, DOOH)
The device languages for the targeting
Enables brand safety targeting
Retargeting settings allowing a bid only when the user was already reached by one of the source line items
object
The unique identifiers of the line items whose previous delivery is retargeted
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
Example
{ "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
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
object
Example
{ "error": { "code": "UNAUTHORIZED", "message": "Unauthorized" }}Forbidden
object
Example
{ "error": { "code": "FORBIDDEN", "message": "Forbidden" }}Not found
object
Example
{ "error": { "code": "NOT_FOUND", "message": "Not found" }}Internal server error
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
object
Example
{ "error": { "code": "TIMEOUT", "details": [ { "code": "TIMEOUT", "field": "request", "message": "Request processing time exceeded deadline", "params": { "duration": "30s" } } ], "message": "Gateway timeout" }}default
Section titled “default”An unexpected error response.
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
Anywrapper around it. - An ‘unpack’ operation reads the content of an
Anymessage, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declaredtype_url. - An ‘is’ operation decides whether an
Anycontains 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
Anyis the same as that of the message, with an additional@typefield 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
@typewhich contains the type URL and a keyvaluewhich 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
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.
Examplegenerated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}