The Advertiser service lets networks add, modify, and view the advertisers that interact with Xandr. Direct marketers rarely use the Advertiser service because they have only one advertiser (themselves).
Add a new advertiser:
Modify an existing advertiser:
View all of your advertisers:
View a specific advertiser:
View multiple advertisers by ID using a comma-separated list:
Search for advertisers with IDs or names containing certain characters:
Delete an advertiser:
Deleting an advertiser will also delete all of its child insertion orders, line items, campaigns, creatives, conversion pixels, and segments. The deletions are permanent and cannot be reverted. Although deleted objects continue to be available in reporting, you will no longer have visibility into their specific settings, such as revenue budget for line items, cost budget and targeting for campaigns.
Find out which fields you can filter and sort by:
Read-only. The ID of the Advertiser
PUT, in query string
A custom code for the advertiser. Xandr will assign a unique ID, but advertisers may want to use their own ID system. Either "code" or the Xandr-assigned ID will be allowed fields in other services.
The name of the advertiser.
The state of the advertiser. Possible values: "active" or "inactive".
The internal ID of the default brand for all creatives for this advertiser. The brand for each creative will be checked during the auditing process.
A segment is marked as "remarketing" for reporting and filtering purposes only. If you mark a segment as remarketing in the UI, it will show up here. Or you can add segment IDs here, and they will be marked as remarketing for reporting purposes.
You can set all of the budget parameters at the advertiser level as well as the campaign and media buy levels. Budgets at the advertiser level will apply to all traffic for your advertiser. This is a dollar (media cost) budget.
The lifetime impression budget for the advertiser. (See
The daily budget for the advertiser. (See
The daily impression budget for the advertiser. (See
An array of brand IDs. Creatives associated with the brands in this array will not serve together in
An array of category IDs. Creatives associated with the categories in this array will not serve together in
You can set an optional
The percentage of users in the control group for this advertiser. This must be expressed as a number between 0 and 1, inclusive. These users will be shown a control creative in order to gauge effectiveness of other creatives. For more information, see "Test and Control Targeting (Standard Line Item)" in the UI documentation(customer login required).
The timezone of the advertiser. See API Timezones for details and accepted values. For details on how to make the advertiser timzone "trickle down" to child objects, see Timezone for Dependent Objects below.
"EST5EDT", or the member's timezone
Timestamp of the last time this advertiser was modified.
For reference. This is a list of people (strings) who work at this advertiser.
For reference. Value may be a maximum of 50 characters.
The default currency to be used for the advertiser. This will be a three-letter code that you can retrieve from the read-only Currency Service. See "Currency Support" in the UI documentation for details about the concept (customer login required).
As a best practice, align currency to the billing currency in order to achieve the best possible local currency experience.
Member's default currency
|This feature is not functioning at this time. It will be used in future development.|
The optional labels applied to the advertiser. Currently, three labels are available for advertisers: "Salesperson", "Account Manager", and "Advertiser Type". See Labels below for more details.
You can report on advertiser labels with the Network Analytics report. For example, if you use the "Salesperson" label to specify the name of the salesperson responsible for each advertisers, you could run the Network Analytics report filtered by "salesperson_for_advertiser" to focus on the advertisers that a particular salesperson is responsible for, or grouped by "salesperson_for_advertiser" to rank the performance of your salespeople.
If true, then the use of insertion orders, which contain collections of line items, will be enabled for this advertiser. You will not be able to create insertion orders if this field is set to
Preexisting line items
If you set this field to
The format in which you would like to see times displayed in the UI. Possible values: "12-hour" or "24-hour".
Information about the default brand. See Default Brand below for more details.
|boolean||Admin-only. If true, the advertiser will not be displayed in the UI. Xandr administrators can set this field to true when the Advertiser is associated with a mediated bid.||false|
Admin-only. If true, the advertiser's status will be set to inactive. Xandr administrators will set this field to true for advertisers determined to be directing users to malicious landing pages. Users will not be able to set the advertiser's status back to active until a Xandr administrator sets the
Read-only. The number of total, active, and inactive insertion orders, line items, campaigns, and creatives under the advertiser, as well as the number of creatives with particular audit statuses. To include this object in a GET response, pass
|array||Read-only. An array of third-party pixels associated with the advertiser. You can automatically attach these pixels to all creatives owned by this advertiser using the Third-party Pixel service or attach them individually at the creative level using the Creative Service.||null|
|array||An array of partner fees applied to this advertiser. You can create, attach, view, or remove partner fees with the Partner Fee Service.|
Possible Values: 0 or 1.
Declares whether or not this advertiser conducts political advertising, which is advertising related to an election, ballot initiative, or political candidate, in the United States. If true, the
thirdparty_pixels array contains the fields in the table below. These fields are read-only. To update or create third-party pixels and/or attach third-party pixels to all creatives owned by the advertiser, use the Third-party Pixel service. To attach third-party pixels to individual creatives, use the Creative Service.
|int||Read-only. The pixel's ID.|
|string||Read-only. The full name of the pixel.|
|boolean||Read-only. The current status of the pixel (true = active).|
|string||Read-only. Audit status of the pixel.|
stats object has been deprecated (as of October 17, 2016). Use the Report Service to obtain statistical information instead.
You can use the read-only Label Service to view all possible labels for advertisers, insertion orders, line items, campaigns, and publishers. This service also allows you to view the labels that have already been applied to your objects.
The ID of the label. Possible values: 1 (Salesperson), 3 (Account Manager), or 12 (Advertiser Type).
Read-only. The name of the label. Possible values: "Salesperson", "Account Manager", or "Advertiser Type".
The value assigned to the label. For example, for the "Salesperson" label, this could be a name such as "Michael Sellers".
You can request a certain number of objects through these fields:
How many objects are in this service. E.g. 8 advertisers.
The number at which to start counting.
How many elements to return. For example start at object # 4 and return 3 objects, or # 4, 5, 6.
The brand's ID.
The name of the brand.
The ID of the brand's category.
Timezone for Dependent Objects
When you change an advertiser's timezone, you can choose whether or not to make the change "trickle down" to child objects (campaigns, line items, and creatives). To do this, you pass
set_child_timezone=true in the query string of the URL during your request to create or update the timezone.
- If true, then timezone on all child objects is set to the Advertiser's timezone. Note that any timezone settings on lower level objects (e.g., Insertion orders, Line Items, Campaigns) will be overridden with the Advertiser's timezone.
- If false, timezone is only set on the advertiser.
Add an advertiser
Update an advertiser
In this example, we update advertiser 51 with a custom code.