options service
Retrieves data for the specified options key. The options
service has the call GET /options/options_key
.
Option keys are sometimes included in responses from available_fields
calls to indicate that more information is available.
For example, the account_uid
field in the response for a GET /account/available_fields
request shows "url": "/options/account_options"
. When you make that call to the options service, the response includes all the account_uid
values available for your account.
Request and Response Samples
Request and response samples for GET /options/account_options
.
Request
curl -X GET http://openx_server_name/ox/4.0/options/account_options --cookie "openx3_access_token=token_string"
Response
[
{
"id": "6003be14-accf-fff1-8123-0c9a66",
"name": "advertiser_account_1",
"object": "account"
},
{
"id": "6002e785-accf-fff1-8123-0c9a66",
"name": "advertiser_account_2",
"object": "account"
},
...
{
"id": "60022e94-accf-fff1-8123-0c9a66",
"name": "regular_advertiser",
"object": "account"
}
]
Similarly, if you make a GET /options/country_options
request, the response includes a list of all the available country_of_business
values. This way, you can query the Ad Server to reference any field values you may need.
Depending on your account and permissions, available option keys may include:
account_options
account_status_options
account_type_options
acquisition_type_options
action_type_options
ad_category_options
ad_delivery_options
ad_status_options
ad_type_options
adquality_report_type_options
adunit_location_options
adunit_options
adunit_size_options
adunit_type_options
advertiser_experience_options
advertiser_user_role_options
agency_experience_options
agency_user_role_options
all_ad_category_options
all_audiencesegment_options
all_creative_type_options
all_location_options
attribution_tracker_mobile_platform_options
attribution_tracking_options
audience_segment_account_options
audience_type_options
audiencesegment_options
bid_type_options
browser_options
budget_pacing_options
budget_type_options
buyer_options
buying_model_options
click_target_window_options
comment_text_type_options
companion_fill_method_options
connection_speed_options
connection_type_options
content_attribute_options
content_topic_options
content_type_options
continent_options
conversiontag_options
country_options
creative_options
creative_type_options
currency_options
datacenter_options
days_of_week_options
deal_source_options
deal_status_options
deal_type_options
delivery_medium_options
delivery_type_options
demand_channel_options
device_options
device_type_options
email_location_options
email_size_options
email_tag_type_options
exchange_audiencesegment_options
exchange_bid_type_options
exchange_size_options
exchange_third_party_server_options
exclusivity_options
flash_background_options
flight_timezone_options
floorrule_reason_options
hours_of_day_options
inventory_audience_segment_account_options
isp_carrier_options
language_options
linear_video_allowable_options
linearvideo_duration_options
linearvideo_location_options
linearvideo_size_options
lineitem_ad_delivery_options
lineitem_delivery_medium_options
lineitem_status_options
linearvideo_presentation_format_options
list_publishers_with_segments
locale_languages
location_source_options
market_advertiser_options
market_brand_group_options
market_delivery_medium_options
market_filter_region_options
market_operators
master_content_topic_options
mediation_method_options
mediation_options
mime_type_options
mobile_adunit_tag_type_options
mobile_carrier_options
mobileapp_options
mobile_converstion_type_options
mobile_location_options
mobile_platform_options
mobile_size_options
mobileweb_adunit_tag_type_options
model_types
native_adunit_tag_type_options
native_sdk_mediation_network_options
native_size_options
network_experience_options
network_lineitem_all_delivery_medium_options
network_lineitem_deal_type_options
network_user_role_options
non_linear_ad_type_options
nonexchange_audiencesegment_options
nonlinearvideo_duration_options
nonlinearvideo_location_options
nonlinearvideo_size_options
open_auction_access_options
optimization_brand_labels_market_operator_options
optimization_brands_market_operator_options
optimization_filter_market_operator_options
order_options
order_status_options
os_options
pacing_model_options
package_status_options
pmp_deal_type_options
pricing_method_options
pricing_model_options
pricing_type_options
publisher_experience\options
publisher_user_role_options
report_range_options
sales_channel_options
screen_resolution_options
server_mediation_network_options
site_delivery_medium_options
site_options
sitesection_options
size_options
source_type_options
ssrtb_protocol_options
status_options_common
subtype_names
tag_type_options
targetable_audiencesegment_options
targetable_audiencesegment_readytogo_options
targetable_deal_lineitem_options
targetable_demand_partner_options
targetable_openaudience_custom_segment_options
targetable_package_options
targetable_publisher_options
targeting_language_options
third_party_network_options
third_party_platform_all_options
third_party_server_options
timezone_options
video_event_type_options
videocompanion_location_options
videocompanion_size_options
web_adunit_tag_type_options
web_location_options
web_size_options