Yahoo Ad Exchange SOAP API Reference

Transcription

Yahoo Ad Exchange SOAP API Reference
version 1.37
Services
Table of Contents
Services.................................................................................................................................................................................1
Adjustment Service..................................................................................................................................................1
AdvertiserDomain Service.......................................................................................................................................5
BuyingTerms Service.............................................................................................................................................10
Campaign Service.................................................................................................................................................13
Contact Service.....................................................................................................................................................20
Creative Service....................................................................................................................................................26
DemandBlocklist Service.......................................................................................................................................39
Dictionary Service..................................................................................................................................................42
Entity Service.........................................................................................................................................................54
InsertionOrder Service...........................................................................................................................................67
InventoryVisibilityControls Service.........................................................................................................................75
LineItem Service....................................................................................................................................................77
Linking Service......................................................................................................................................................86
Notification Service................................................................................................................................................92
Passback Service..................................................................................................................................................95
Pixel Service..........................................................................................................................................................97
PreferredTerms Service.......................................................................................................................................109
PublisherReservePrice Service...........................................................................................................................113
Quota Service......................................................................................................................................................115
Report Service.....................................................................................................................................................116
Rtbd Service........................................................................................................................................................119
Search Service....................................................................................................................................................121
Section Service....................................................................................................................................................123
SegmentDefinition Service..................................................................................................................................127
Segment Service.................................................................................................................................................130
Sitelist Service.....................................................................................................................................................133
Site Service..........................................................................................................................................................138
SupplyBlocklist Service........................................................................................................................................143
TargetProfile Service...........................................................................................................................................147
Data types..........................................................................................................................................................................187
ad_tag_options.....................................................................................................................................................187
adv_domain_blocklist...........................................................................................................................................189
advertiser_domain_blocklist_download................................................................................................................190
advertiser_domain_blocklist.................................................................................................................................190
advertiser_domain................................................................................................................................................190
advertiser_domain_industry_vertical....................................................................................................................192
advertiser_domain_parent....................................................................................................................................192
advertiser_domain_search_options......................................................................................................................193
advertiser_list........................................................................................................................................................193
advertiser_section_list..........................................................................................................................................194
adware_section_params.......................................................................................................................................195
beacon_search_options........................................................................................................................................196
blocklist_getall......................................................................................................................................................197
blocklist_search_options.......................................................................................................................................198
bought_segment...................................................................................................................................................199
browser.................................................................................................................................................................199
buying_terms........................................................................................................................................................200
buying_terms_managed_demand........................................................................................................................201
buying_terms_supply............................................................................................................................................202
campaign_goal.....................................................................................................................................................203
campaign..............................................................................................................................................................203
can_status............................................................................................................................................................207
ccp_creative_search_options...............................................................................................................................208
channel.................................................................................................................................................................211
Class Trees for Package soap_api-......................................................................................................................212
click_url_data........................................................................................................................................................212
click_url.................................................................................................................................................................212
comment...............................................................................................................................................................213
contact..................................................................................................................................................................214
content_buyer_contact.........................................................................................................................................217
content_seller_contact..........................................................................................................................................217
contract_history_item............................................................................................................................................218
country_group.......................................................................................................................................................218
country..................................................................................................................................................................219
creative_attachment.............................................................................................................................................219
creative_beacon_list_item....................................................................................................................................220
creative_classification_status...............................................................................................................................220
creative_comment_search_options......................................................................................................................221
creative_comments...............................................................................................................................................221
creative_content_expanded..................................................................................................................................221
creative_content...................................................................................................................................................222
creative_custom_object........................................................................................................................................223
creative_further_comment....................................................................................................................................223
Services
Table of Contents
Data types
creative.................................................................................................................................................................224
creative_lineitem...................................................................................................................................................233
creative_macro.....................................................................................................................................................234
creative_options....................................................................................................................................................234
creative_owner_data............................................................................................................................................235
creative_properties...............................................................................................................................................236
creative_publisher_comments..............................................................................................................................236
creative_reviewer..................................................................................................................................................237
creative_review_options.......................................................................................................................................237
creative_search_options.......................................................................................................................................238
creative_specs......................................................................................................................................................241
creative_tag_list_item...........................................................................................................................................243
ct_report_result.....................................................................................................................................................245
currency................................................................................................................................................................245
custom_creative....................................................................................................................................................246
custom_geo_area.................................................................................................................................................246
custom_settings....................................................................................................................................................247
data_buyer_contact..............................................................................................................................................248
data_seller_contact...............................................................................................................................................248
date_imps.............................................................................................................................................................249
daypart..................................................................................................................................................................249
deal_properties.....................................................................................................................................................250
default_target_profile............................................................................................................................................250
demand_blocklist..................................................................................................................................................251
demand.................................................................................................................................................................252
domain_url_data...................................................................................................................................................253
dxr_migration_reports...........................................................................................................................................253
Element index for package soap_api-..................................................................................................................254
e............................................................................................................................................................................254
i.............................................................................................................................................................................254
p............................................................................................................................................................................254
r.............................................................................................................................................................................254
entity_data............................................................................................................................................................254
entity.....................................................................................................................................................................255
entity_info.............................................................................................................................................................264
entity_official_contacts..........................................................................................................................................264
entity_shell............................................................................................................................................................265
exception_detail....................................................................................................................................................265
ex_entity_ids.........................................................................................................................................................266
flash_info..............................................................................................................................................................267
gender...................................................................................................................................................................267
gender_target.......................................................................................................................................................268
get_ivc_hidden_params........................................................................................................................................268
getrtbdadminqpsresp............................................................................................................................................268
getrtbdqpsresp......................................................................................................................................................269
global_template....................................................................................................................................................270
id_name................................................................................................................................................................271
insertion_order......................................................................................................................................................272
inventory_media_type...........................................................................................................................................278
inventory_type......................................................................................................................................................278
inventory_visibility_controls..................................................................................................................................279
isp.........................................................................................................................................................................280
ivc_hidden_params_details..................................................................................................................................280
ivc_hidden_params...............................................................................................................................................281
language...............................................................................................................................................................281
learn_type.............................................................................................................................................................282
line_item_adjustment............................................................................................................................................282
line_item_goal.......................................................................................................................................................284
line_item...............................................................................................................................................................284
link_data...............................................................................................................................................................292
linked_entities_info...............................................................................................................................................293
linking_profile........................................................................................................................................................294
linking_rating.........................................................................................................................................................296
YieldManager SOAP API Documentation.............................................................................................................296
login_options.........................................................................................................................................................297
macro_hidden_params.........................................................................................................................................297
managed_demand................................................................................................................................................298
managed_supply..................................................................................................................................................299
managing_entity_ids.............................................................................................................................................300
marketplace_settings............................................................................................................................................300
media_type...........................................................................................................................................................302
mg_label_mapping...............................................................................................................................................302
mime_type............................................................................................................................................................303
msa.......................................................................................................................................................................303
Services
Table of Contents
Data types
multiple_data_response........................................................................................................................................304
multiple_data_result..............................................................................................................................................304
multiple_result.......................................................................................................................................................306
netspeed...............................................................................................................................................................306
notice....................................................................................................................................................................306
offer_type..............................................................................................................................................................307
optimization_config...............................................................................................................................................308
optimization_para_name......................................................................................................................................308
passback...............................................................................................................................................................309
payment_method..................................................................................................................................................310
piggyback_pixel....................................................................................................................................................311
pixel......................................................................................................................................................................311
pixel_pair..............................................................................................................................................................314
pixel_tag_params.................................................................................................................................................315
placement_creative...............................................................................................................................................315
placement.............................................................................................................................................................324
pop_type...............................................................................................................................................................325
postal_code..........................................................................................................................................................325
preferred_terms_demand.....................................................................................................................................326
preferred_terms_getall..........................................................................................................................................327
preferred_terms....................................................................................................................................................328
preferred_terms_managed_supply.......................................................................................................................330
preferred_terms_search_options..........................................................................................................................331
private_marketplace_controls...............................................................................................................................332
private_marketplace.............................................................................................................................................333
publisher_control_data.........................................................................................................................................334
publisher_control_masks......................................................................................................................................335
publisher_data......................................................................................................................................................335
publisher_list.........................................................................................................................................................336
publisher_reserve_price_profile............................................................................................................................337
pv_section_data....................................................................................................................................................339
pvt_marketplace...................................................................................................................................................339
quicksearch_result................................................................................................................................................340
quota.....................................................................................................................................................................340
rating_options.......................................................................................................................................................341
region....................................................................................................................................................................342
reserve_price_buyer_entity..................................................................................................................................343
reserve_price_filter_options..................................................................................................................................344
richmedia_creative_attributes...............................................................................................................................344
role........................................................................................................................................................................345
rtbdadminqps........................................................................................................................................................345
rtbdbidurl...............................................................................................................................................................346
rtbdfailurereport....................................................................................................................................................347
rtbd_hidden_params.............................................................................................................................................347
rtbdqps..................................................................................................................................................................349
rtbdrecenttrafficreport...........................................................................................................................................350
rtbdsuccessreport.................................................................................................................................................351
rule_attribute.........................................................................................................................................................352
rule_attribute_ids..................................................................................................................................................353
rule_attribute_names............................................................................................................................................353
rule_dayparts........................................................................................................................................................354
rule_deal_properties.............................................................................................................................................354
rule_getall.............................................................................................................................................................355
rule_search_options.............................................................................................................................................356
rule_vurl_data.......................................................................................................................................................357
sales_region.........................................................................................................................................................357
search_data..........................................................................................................................................................358
section_custom_group..........................................................................................................................................358
section..................................................................................................................................................................359
section_urls...........................................................................................................................................................361
segment_attributes...............................................................................................................................................361
segment_contributor.............................................................................................................................................362
segment................................................................................................................................................................362
segment_public_info.............................................................................................................................................366
segment_report_visibility......................................................................................................................................366
segment_search_options......................................................................................................................................367
segment_share.....................................................................................................................................................368
segment_share_info.............................................................................................................................................369
served_domain_data............................................................................................................................................369
session..................................................................................................................................................................370
site........................................................................................................................................................................370
size_data..............................................................................................................................................................372
size.......................................................................................................................................................................372
srt_segment_attributes.........................................................................................................................................373
Services
Table of Contents
Data types
srt_segment_report...............................................................................................................................................374
srt_segment_status..............................................................................................................................................374
supply_attributes...................................................................................................................................................375
supply_blocklist.....................................................................................................................................................375
supply...................................................................................................................................................................376
supported_locale..................................................................................................................................................378
supporting_file......................................................................................................................................................378
sync_segment_response......................................................................................................................................378
tag_emails............................................................................................................................................................379
target_advertiser_entity........................................................................................................................................379
target_age.............................................................................................................................................................380
target_asl..............................................................................................................................................................380
target_browser......................................................................................................................................................380
target_buyer_entity...............................................................................................................................................381
target_buyer_line_item.........................................................................................................................................381
target_cga.............................................................................................................................................................381
target_channel......................................................................................................................................................382
target_click_url......................................................................................................................................................382
target_click_url_object..........................................................................................................................................382
target_click_url_v2................................................................................................................................................383
target_country.......................................................................................................................................................383
target_creative_beacon........................................................................................................................................383
target_creative......................................................................................................................................................384
target_creative_tag...............................................................................................................................................384
target_csl..............................................................................................................................................................384
target_daypart.......................................................................................................................................................385
target_frequency...................................................................................................................................................385
target_gender.......................................................................................................................................................385
target_geography..................................................................................................................................................386
targeting_hidden_params.....................................................................................................................................386
targetings..............................................................................................................................................................387
target_inventory_media_type...............................................................................................................................390
target_inventory_type...........................................................................................................................................390
target_isp..............................................................................................................................................................391
target_language....................................................................................................................................................391
target_mobile_carrier_data...................................................................................................................................391
target_mobile_os_data.........................................................................................................................................392
target_netspeed....................................................................................................................................................392
target_offer_type...................................................................................................................................................392
target_pixel...........................................................................................................................................................393
target_pixels.........................................................................................................................................................394
target_profile.........................................................................................................................................................394
target_publisher_entity.........................................................................................................................................399
target_pvt_marketplace........................................................................................................................................400
target_querystring.................................................................................................................................................400
target_rating..........................................................................................................................................................400
target_section.......................................................................................................................................................401
target_seller_line_item..........................................................................................................................................401
target_size............................................................................................................................................................401
target_url...............................................................................................................................................................402
target_vurl.............................................................................................................................................................402
target_vurl_tag......................................................................................................................................................403
target_woeid_cga.................................................................................................................................................403
target_woeid.........................................................................................................................................................403
techno_data..........................................................................................................................................................404
tp_billing_entity_preferences................................................................................................................................404
trading_pit_blocklist..............................................................................................................................................405
trading_pit_creative_properties............................................................................................................................406
trading_pit_demand..............................................................................................................................................406
trading_pit_supply.................................................................................................................................................407
traf_monitor_alert..................................................................................................................................................408
valid_vurl...............................................................................................................................................................411
vast_tag................................................................................................................................................................411
video_api_framework............................................................................................................................................412
video_creative.......................................................................................................................................................412
video_delivery.......................................................................................................................................................413
video_placement_type..........................................................................................................................................413
video_vast_type....................................................................................................................................................414
vurl_category........................................................................................................................................................414
vurl_data...............................................................................................................................................................414
vurl_get_data........................................................................................................................................................415
vurl........................................................................................................................................................................415
vurl_options..........................................................................................................................................................417
vurl_search_options..............................................................................................................................................418
Services
Table of Contents
Data types
vurl_tag_list...........................................................................................................................................................420
woeid....................................................................................................................................................................421
woeid_search_result.............................................................................................................................................422
Services
Adjustment Service
Adjustments allow you to change the data that the ad server recorded for a certain period of activity.
Review the Yahoo Ad Exchange Knowledge Base for additional details on adjustments.
WSDL links for this service:
• https://api.yieldmanager.com/api-1.37/adjustment.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/adjustment.php?wsdl
Sandbox vs Production WSDLs: When to use.
Requests Summary
• finalizeMonths — Finalizes all the line item adjustments made for 1 line item during a given period (minimum
1 month).
• get — Returns the corresponding adjustment object.
• getAll — The getAll method returns line_item_adjustment records for the current entity and a specified date
range.
• getAllByLineItem — Get all existing line_item_adjustment records for the given period and line item.
• getByBuyer — Use the getByBuyer method to return adjustment records from a given buyer.
• getCreatedByDates — Returns all adjustments made within a specified date range.
• getImpsByDates — Returns numbers as an array of class with fields 'date' and 'imps.'
• isMonthFinalized — Return true if month is finalized, false otherwise.
• reset — Reset adjustments to a line item.
• set — Makes adjustments to a line item.
• setDiscretionaryEcpm — Sets discretionary_cpm and ecpm_calculation_method fields in a line_item.
• submitCredit — Adds additional credit to a line item.
Requests
finalizeMonths
Use finalizeMonths to finalize all the line item adjustments made for 1 line item during a given period (minimum 1
month).
Accessible for all entity types
Input parameters:
• string $token: This variable represents your current API session token.
• int $line_item_id: The ID of the line_item to be adjusted.
• date $period_start: Beginning of period you want to finalize.
• date $period_end: End of period you want to finalize.
Output parameters:
none
get (read-only)
Given an adjustment ID, this method returns the corresponding adjustment object. Note: When retrieving credits on
line items with advertiser billing price, refer to Retrieving credits on line items that use an advertiser billing price article
for additional details.
Input parameters:
• int $adjustment_id: Use this to pass in an adjustment ID.
Output parameters:
1
Services
• line_item_adjustment $adjustment: This returns an adjustment object.
getAll (read-only)
The getAll method returns line_item_adjustment records for the current entity and a specified date range. Use the
getAll method to return an array of existing line_item_adjustment objects for a specified time period. Note: When
retrieving credits on line items with advertiser billing price, refer to Retrieving credits on line items that use an
advertiser billing price article for additional details.
Input parameters:
• date $period_start: Defines the starting date for the adjustment period.
• date $period_end: Defines the end date for the adjustment period.
• enum_adjustments_type $type: Defines the type of adjustments to return: credit, discrepancy, and
linkedcredit. Discrepancy is default.
• int $entries_on_page: A pagination parameter. Use this to get n number of results per page and break up a
larger report request into smaller chunks.
• int $page_num: A pagination parameter. Use it with $entries_on_page to determine which page should hold
n number of results.
Output parameters:
• array_of_line_item_adjustment $line_item_adjustments: An array of line_item_adjustment objects.
• int $total_count: The total number of records returned in the result set. Use this with entries_on_page and
page_num to break up a report request into smaller chunks.
getAllByLineItem (read-only)
Get all existing line_item_adjustment records for the given period and line item. Note: When retrieving credits on line
items with advertiser billing price, refer to Retrieving credits on line items that use an advertiser billing price article for
additional details.
Input parameters:
• date $period_start: Defines the starting date for the adjustment period.
• date $period_end: Defines the end date for the adjustment period.
Output parameters:
getByBuyer (read-only)
Return adjustment records from a given buyer. Note: The current entity ID will be used if $buyer_entity_id is null.
When retrieving credits on line items with advertiser billing price, refer to Retrieving credits on line items that use an
advertiser billing price article for additional details.
Input parameters:
2
Services
• int $buyer_entity_id: The ID of the specified buyer.
• date $start_date: Defines the starting date for the adjustment period.
• date $end_date: Defines the end date for the adjustment period.
Output parameters:
getCreatedByDates (read-only)
Returns all adjustments made within a specified date range. Note: When retrieving credits on line items with advertiser
billing price, refer to Retrieving credits on line items that use an advertiser billing price article for additional details.
Input parameters:
• date $start_date: Defines the starting date for the adjustment period.
• date $end_date: Defines the end date for the adjustment period.
• int $page_num: A pagination parameter. Use this with $entries_on_page to determine which page should
hold n number of results.
Output parameters:
getImpsByDates (read-only)
Returns numbers as an array of class with fields 'date' and 'imps.' Note: When retrieving credits on line items with
advertiser billing price, refer to Retrieving credits on line items that use an advertiser billing price article for additional
details.
Input parameters:
• date $range_start: Defines the starting date for the adjustment period.
• date $range_end: Defines the end date for the adjustment period.
Output parameters:
• array_of_date_imps $date_imps
isMonthFinalized (read-only)
Return true if month is finalized, false otherwise.
Input parameters:
3
Services
• date $date: This is the month to be checked. Use the format yyyy-mm-dd.
Output parameters:
• boolean $is_finalized
reset
Reset adjustments with the status complete, delete_complete, or error_reset. See also Adjustments_Troubleshooting
for additional details on resetting adjustments.
Input parameters:
• date $range_start: Defines the starting date for the adjustment period.
• date $range_end: Defines the end date for the adjustment period.
Output parameters:
none
set
Makes adjustments to a line item. The total adjustment value will be spread evenly across adjustments for each day if
any line_item_adjustment contains a date range of more than 1 day.
Use this method on line items that:
• Bill the buyer based on 3rd party numbers.
• Use discretionary pricing.
Review the following Exchange Knowledge Base articles for more information:
• Adjustments: Overview
• Discretionary adjustments: About
Input parameters:
Output parameters:
• array_of_int $adjustment_ids: Returns the adjustment IDs.
setDiscretionaryEcpm
Sets discretionary_cpm and ecpm_calculation_method fields in a line_item. Note: The ecpm_calculation_method is
read-only. It can be modified by this method only. Note: This method is accessible for line_items when the
pricing_type = 'Discretionary' only.
Input parameters:
4
Services
• enum_calculation_method $calculation_method
Output parameters:
none
submitCredit
Used to add additional credit to a line item. See Credits_Overview for more details. Use the UI to approve credits
when $auto_approve = false. Note: When submitting credits on line items with advertiser billing price, refer to
Submitting credits on line items that use an advertiser billing price article for additional details.
Input parameters:
• date $month: Month to be adjusted. Use the format yyyy-mm-dd.
• float $final_revenue: Total value of the month's revenue. For fixed-rate, this is in USD; for dynamic-rate, this
is in the currency specified by the owning entity's currency_id.
• string $comment: Comment explaining the adjustment.
• boolean $auto_approve: Automatically approve the credit. Defaults to "true," but "true" will only be accepted
if the month is complete.
Output parameters:
• int $credit_request_id: The ID of the newly created credit request.
AdvertiserDomain Service
Advertiser Domain Service lets api users to manage advertiser domains and advertiser block lists.
Seller Networks upload the advertiser domains & this list will be available for blocking at supplier seat or its managed
publisher level. Buyer Network can download blocklist to identify which supplier are blocking which advertiser
domains.
• https://api.yieldmanager.com/api-1.37/advertiser_domain.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/advertiser_domain.php?wsdl
Requests Summary
• add — Creates a one or more new advertiser domains
• delete — Deletes advertiser domains. The input object should be domain ids
• deleteByUrls — Deletes advertiser domains. The input object should be domain urls.
• downloadBlockList — Downloads the blocked advertiser domains set by publishers. This API is to used by
Advertising Networks.
• getAll — Retrieves all advertiser domains that were previously created.
• getAllSince — Return advertiser domains changed between start_date and end_date.
• getBlockList — Retrieves block list of advertiser domains that are currently set.
• getByDomainUrls — Retrieves all advertiser domains that were previously created.
• getByIds — Retrieves all advertiser domains that were previously created.
• getIndustryVerticals — Returns available list of industry verticals
• getParentBrands — Returns available list of advertiser domain parents
• listAllSince — Return advertiser domain IDs changed between start_date and end_date.
• search — Retrieves all advertiser domains matching search criteria.
• setBlockList — Sets the list of advertiser domains as the block list.
• update — Updates advertiser domains. The input object should contain either id or domain.
Requests
5
Services
add
Creates a one or more new advertiser domains
Input parameters:
• array_of_advertiser_domain $advertiser_domains
Output parameters:
• array_of_multiple_data_result $result: result of bulk operation
delete
Deletes advertiser domains. The input object should be domain ids
Input parameters:
• array_of_int $advertiser_domain_ids
Output parameters:
deleteByUrls
Deletes advertiser domains. The input object should be domain urls.
Input parameters:
• array_of_string $advertiser_domain_urls
Output parameters:
downloadBlockList (read-only)
Downloads the blocked advertiser domains set by publishers. This API is to used by Advertising Networks.
Input parameters:
• int $seller_entity_id: entity id of the seller seat or publisher
• int $buyer_entity_id: entity id of the buyer
• array_of_string $domain_urls: Optional domain list when set,retrieves blocklist for those specific domains.
If the list is empty all the domains that are blocked is retrieved.
6
Services
Output parameters:
• array_of_advertiser_domain_blocklist_download $blocklists
getAll (read-only)
Retrieves all advertiser domains that were previously created.
Input parameters:
• enum_advertiser_domain_search_status $status: See valid types in Advertiser Domain Search Status
Enum
Output parameters:
• array_of_advertiser_domain $advertiser_domains: Array of $advertiser_domains.
getAllSince (read-only)
Note: This method sets the start_date = '0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time
interval to 24 hours or less.
Input parameters:
• string $token
• dateTime $start_date
• dateTime $end_date
• int $entries_on_page
• int $page_num
Output parameters:
getBlockList (read-only)
Retrieves block list of advertiser domains that are currently set.
Input parameters:
• int $seller_entity_id: entity id of the seller seat or publisher (get by network on behalf of the publisher)
• int $buyer_entity_id: entity id of the buyer
Output parameters:
7
Services
• array_of_domain_url_data $domain_urls
getByDomainUrls (read-only)
Input parameters:
• array_of_string $domain_urls: advertiser domain urls
Output parameters:
getByIds (read-only)
Input parameters:
• array_of_int $ids: advertiser domain ids
Output parameters:
getIndustryVerticals (read-only)
Returns available list of industry verticals
Input parameters:
• string $token: This variable represents an active session token.
Output parameters:
• array_of_advertiser_domain_industry_vertical $indusry_verticals: Array of industry vertical
getParentBrands (read-only)
Returns available list of advertiser domain parents
Input parameters:
Output parameters:
8
Services
• array_of_advertiser_domain_parent $advertiser_domain_parents: Array of domain parent
listAllSince (read-only)
Input parameters:
• string $token
Output parameters:
• array_of_int $ids
search (read-only)
Retrieves all advertiser domains matching search criteria.
Input parameters:
• advertiser_domain_search_options $search_options
Output parameters:
setBlockList
Sets the list of advertiser domains as the block list.
Input parameters:
• int $seller_entity_id: entity id of the seller seat or publisher (set by network on behalf of the publisher)
• array_of_advertiser_domain_blocklist $blocklist: Array of buyer id and corresponding domains to be
blocked for that buyer. Buyer id=0 corresponds to global blocking. Example 0 => array('www.xxx.com')
means 'www.xxx.com' is globally blocked for all buyers.
Output parameters:
none
update
9
Services
Updates advertiser domains. The input object should contain either id or domain.
Input parameters:
• array_of_advertiser_domain $advertiser_domains
Output parameters:
BuyingTerms Service
This service lets you add/modify/delete/get buying terms.
Review the Buying terms section in the Yield Manager Knowledge Base for additional details.
• https://api.yieldmanager.com/api-1.37/buying_terms.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/buying_terms.php?wsdl - test version
Requests Summary
• add — Add/Create business terms on inventory on behalf of managed demand.
• delete — Deletes business terms on inventory created on behalf of managed demand.
• getAllBuyingTerms — Returns an array of all business terms on inventory created on behalf of managed
demand that you are allowed to access.
• getAllSince — Return all buying terms changed between a specified start_date and end_date.
• getByObjectId — Returns the buying_terms data object for specified id.
• listAll — Returns buying_terms data object ids that you are allowed to access.
• listAllSince — Return buying terms IDs changed between a specified start_date and end_date.
• quickSearch — Returns an array of all buying terms you are allowed to access.
• update — Modify business terms on inventory on behalf of managed demand.
Requests
add
Add a new buying_terms.
Input parameters:
• buying_terms $buying_terms: New buying_terms data object.
Output parameters:
• int $id: Id of buying terms.
delete
Removes an existing buying_terms object.
10
Services
Input parameters:
• int $buying_terms_id: Buying Terms ID.
Output parameters:
none
getAllBuyingTerms (read-only)
Returns an array of all business terms on inventory created on behalf of managed demand that you are allowed to
access.
Input parameters:
• rule_search_options $buying_terms_search_options: Search options.
Output parameters:
• array_of_rule_getall $buying_terms
• int $total_count: The total number of records returned in the result set.
Return buying terms IDs changed between a specified start_date and end_date. Note: This method sets the
start_date = '0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or less.
Input parameters:
• dateTime $start_date: Specified in yyyy-mm-dd hh:mm:ss format.
• dateTime $end_date: Specified in yyyy-mm-dd hh:mm:ss format.
Output parameters:
• array_of_buying_terms $buying_terms: An array of buying terms objects.
• int $total: The total number of records returned in the result set.
getByObjectId (read-only)
Input parameters:
• int $buying_terms_id: Id of buying_terms data object.
Output parameters:
• buying_terms $buying_terms
11
Services
listAll (read-only)
Returns buying_terms data object ids that you are allowed to access.
Input parameters:
Output parameters:
• array_of_int $buying_terms_ids
Return buying terms IDs changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
• array_of_int $ids: An array of buying terms IDs.
quickSearch (read-only)
Input parameters:
• string $pattern: search string.
• enum_active $active: search by status. By default will return 'all'.
Output parameters:
• array_of_rule_getall $buying_terms
update
Modify fields of buying_terms data object.
Input parameters:
12
Services
• buying_terms $buying_terms.: Modified buying_terms data object.
Output parameters:
none
Campaign Service
The CampaignService lets you add or modify a campaign and prepare it for trafficking.
The campaign starts trafficking only after all elements of the trafficking chain (creative, line item, insertion order, etc.)
are set active. See the Campiagn setup tutorial for additional details.
• https://api.yieldmanager.com/api-1.37/campaign.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/campaign.php?wsdl
Requests Summary
• add — This api is no more supported. Use line_item service instead.
• addCreative — This api is no more supported. Use line_item service instead.
• addCreatives — This api is no more supported. Use line_item service instead.
• addLineItem — This api is no more supported. Use line_item service instead.
• delCreative — Deletes a creative from a campaign.
• delete — Deletes a single campaign.
• deleteCampaigns — Deletes multiple campaigns.
• delLineItem — Removes the link between a line item and a campaign.
• get — Retrieves all information about the specified campaign.
• getAll — Gets the list of all campaign objects you are authorized to see.
• getAllSince — Returns campaigns changed between start_date and end_date.
• getByCreative — Returns an array of all campaign data objects for a creative.
• getByEntity — Get the list of campaign objects for the specified entity.
• getByLineItem — Returns an array of all campaign data objects for a give line item.
• listAll — Gets the list of all campaign IDs you are authorized to see.
• listAllDeletedSince — Returns campaign IDs deleted between a specified start_date and end_date.
• listAllSince — Returns the campaign IDs changed between a specified start_date and end_date.
• listByCreative — Returns an array of all campaign data objects for a creative.
• listByEntity — Gets the list of campaign IDs for the specified entity.
• listByLineItem — Returns the array of campaign IDs associated with a line item.
• lookup — Returns a list of all campaign IDs for a given integration code.
• update — Used to modify a campaign.
Requests
add
Adds a new campaign.
This api is no more supported. Use line_item service instead. Create a new campaign for the advertiser specified by
campaign::$advertiser_entity_id. Note: Set the $advertiser_entity_id property of the campaign object before passing it
to this method.
Input parameters:
• campaign $campaign: campaign data object.
Output parameters:
• int $campaign_id: Campaign ID.
13
Services
addCreative
Adds a single creative to a campaign.
This api is no more supported. Use line_item service instead. Adds a single creative to a campaign. Note: You must
have the creative ID and campaign ID already created to use this method. See the:
• CreativeService::add() method
• CampaignService::add() method
for additional details. Accessible for the following entity types:
• Self managed advertiser
• Network
Input parameters:
• int $creative_id: Creative ID.
Output parameters:
none
addCreatives
Adds multiple creatives to a campaign.
This api is no more supported. Use line_item service instead. Adds multiple creatives to a campaign. Note: You must
have the creative ID and campaign ID already created to use this method. See the:
• CreativeService::add() method
• @link CampaignService::add()} method
for additional details. Accessible for the following entity types:
• Network
• has_transaction_commit
Input parameters:
• array_of_int $creative_ids: Creative IDs.
Output parameters:
• array_of_multiple_data_result $results
addLineItem
Sets up a link between a line item and a campaign.
This api is no more supported. Use line_item service instead. Sets up a link between the line item and the campaign
specified by the line item ID and campaign ID. See LineItemService::add() and CampaignService::add().
Accessible for the following entity types:
• Network
Input parameters:
14
Services
• int $campaign_id: campaign data object.
• int $line_item_id: line_item data object.
Output parameters:
none
delCreative
Deletes a creative from the specified campaign.
• Network
Input parameters:
Output parameters:
none
delete
Used to delete an existing (single) campaign. Note: Use with care. You can delete an active or inactive campaign with
this method. Deactivate your campaign first before deleting it.
• Network
Input parameters:
• int $id: Campaign ID.
Output parameters:
none
deleteCampaigns
Deletes multiple campaigns. Note: Use with care. You can delete active or inactive campaigns with this method.
Deactivate your campaigns first before deleting them.
Input parameters:
• array_of_int $ids: Campaign IDs.
Output parameters:
• array_of_multiple_data_result $results: Returns a "successful/failed" confirmation for each campiagn.
delLineItem
15
Services
Remove the link between the line item and the campaign specified by the line item ID and campaign ID.
• Network
Input parameters:
• int $line_item_id: line_item data object.
Output parameters:
none
get (read-only)
Returns the full campaign data object.
Input parameters:
• int $id: Campaign ID.
Output parameters:
• campaign $campaign: campaign data object.
getAll (read-only)
Returns the array of campaign objects which you are allowed to see.
Input parameters:
Output parameters:
• array_of_campaign $campaigns: An array of campaigns.
Input parameters:
16
Services
Output parameters:
• array_of_campaign $campaigns: array of campaigns
getByCreative
Returns an array of all campaign data objects for a creative. Use the CampaignService::addCreative() method to link
campaigns and creatives together.
• Network
Input parameters:
Output parameters:
• array_of_campaign $campaigns: An array of the entire campaign object for each campaign returned by this
method.
getByEntity (read-only)
Return the array of campaign data objects that belong to the entity specified by entity_id.
Input parameters:
• int $entity_id: Entity ID.
Output parameters:
• array_of_campaign $campaigns: An array of campaign objects.
getByLineItem
Return an array of all campaign data objects for a line item. You can use CampaignService::addLineItem() to link
campaigns and line items together.
17
Services
• Network
Input parameters:
• int $li_id: Line item ID.
Output parameters:
• array_of_campaign $campaigns: An array of the entire campaign object for each campaign returned by this
method.
listAll (read-only)
Returns the array of campaign IDs which you are allowed to see. Use CampaignService::get() to get the whole
campaign data object by its ID.
Input parameters:
Output parameters:
• array_of_int $campaign_ids: An array of campaign IDs.
listAllDeletedSince (read-only)
Returns campaign IDs deleted between a specified start_date and end_date. Note: This method sets the start_date =
'0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or less.
Input parameters:
Output parameters:
Returns campaign IDs changed between a specified start_date and end_date. Note: This method sets the start_date =
Input parameters:
18
Services
Output parameters:
listByCreative
Return an array of all campaign data objects for a creative. Use the CampaignService::addCreative() method to link
campaigns and creatives together.
• Network
Input parameters:
Output parameters:
• array_of_int $campaigns: An array of the entire campaign object for each campaign returned by this
method.
listByEntity (read-only)
Return the array of campaign IDs which belong to the entity specified by entity_id. Use CampaignService::get() to get
the whole campaign data object by its id.
Input parameters:
Output parameters:
• array_of_int $campaign_ids: An array of campaign IDs.
listByLineItem
Returns the array of campaign IDs associated with a line item. You can use CampaignService::addLineItem() to link
campaigns and line items together. You can use then CampaignService::get() to get the whole campaign data object
by its id.
• Network
Input parameters:
• int $li_id: Line item ID.
Output parameters:
• array_of_int $campaign_ids
19
Services
lookup
Return the array of arrays of campaign IDs for a given integration code. You can use CampaignService::get() to get
the whole campaign data object by its id.
• Network
Input parameters:
• array_of_string $codes: Campaign codes.
Output parameters:
• array_of_array_of_int $campaign_ids: Campaign IDs.
update
Update modifies the fields of a campaign data object. Notes: Some fields are system generated (e.g. campaign::$id)
and can't be changed by the client.
If you're updating cpc_target field, learning position for related line_item will be re-calculated
Input parameters:
• campaign $campaign: modified campaign data object
Output parameters:
none
Contact Service
This service allows you to manage entity contacts. Also it provides an API to get a session token required to access
other API calls.
• https://api.yieldmanager.com/api-1.37/contact.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/contact.php?wsdl - test version
Requests Summary
• add — add a new contact
• changePassword — change contact password
• delete — delete a contact
• get — retrieve all contact information
• getActiveSessions — List existing sessions
• getAll — get all the contacts you are authorized to see
• getAllSince — Return contacts changed between start_date and end_date.
• getByEntity — get all the contacts you are authorized to see by entity id
• getSelf — retrieve all information about the current contact
• listAll — get all the contacts you are authorized to see
• listAllDeletedSince — Return contact IDs deleted between start_date and end_date.
• listAllSince — Return contact IDs changed between start_date and end_date.
• listByEntity — get all the contacts you are authorized to see by entity id
• login — create a session token
• logout — drop session token
• logoutAll — cancel all currently active sessions for the user
20
Services
• setPassword — set contact password
• update — modify a contact
• validateCredentials — Validate Credentials
Requests
add
Create a new contact for the entity specified by contact::$entity_id
Input parameters:
• string $token: session token
• contact $contact: new contact data object
Output parameters:
• int $contact_id: contact identifier
changePassword
Change the password on the contact.
Input parameters:
• string $new_password: new contact password
• int $contact_id: contact id
Output parameters:
none
delete
Remove an existing contact.
Input parameters:
• int $id: contact identifier
Output parameters:
none
get (read-only)
Return the full contact data object specified by its id.
Input parameters:
21
Services
Output parameters:
• contact $contact: contact data object
getActiveSessions
Input parameters:
• string $user: Yahoo Ad Exchange user name
• string $pass: Unencrypted Yahoo Ad Exchange password
Output parameters:
• array_of_session $sessions: array of session
getAll (read-only)
Return the array of contact' objects which you are allowed to see according to security model.
Input parameters:
• int $page_num
Output parameters:
• array_of_contact $contacts: array of contacts
• int $total_count: total items count
Input parameters:
• string $token
• int $page_num
Output parameters:
• array_of_contact $contacts: array of contacts
Return the array of contact' objects with the specified entity_id which you are allowed to see according to security
model.
22
Services
Input parameters:
• int $entity_id: entity identifier
• int $page_num
Output parameters:
• array_of_contact $contacts: array of contact
getSelf (read-only)
Return the full contact data object about the current contact.
Input parameters:
Output parameters:
• contact $contact: contact data object
listAll (read-only)
Return the array of contact' id which you are allowed to see according to security model. Use ContactService::get() to
get whole contact data object by its id.
Input parameters:
Output parameters:
• array_of_int $contact_ids: array of contact id
Input parameters:
• string $token
Output parameters:
23
Services
Input parameters:
• string $token
Output parameters:
Return the array of contact' id with the specified entity_id which you are allowed to see according to security model.
Use ContactService::get() to get whole contact data object by its id.
Input parameters:
Output parameters:
• array_of_int $contact_ids: array of contact id
login
Return the session token required by all other API calls. Normally you need to login at the start of your API client
program.
Accessible for restricted users:
• Creative Tester
Input parameters:
• login_options $login_options: Login options
Output parameters:
• string $token: session token for further requests
logout (read-only)
Reset session token if such exists
24
Services
• Creative Tester
Input parameters:
Output parameters:
none
logoutAll
Input parameters:
Output parameters:
none
setPassword
Set the password on the contact. The user must use this new password next time they log in.
Input parameters:
• string $password: new contact password
Output parameters:
none
update
Change the fields of a contact data object. Keep in mind that some fields are generated behind API (e.g. contact::$id)
and cannot be changed by client.
Input parameters:
• contact $contact: modified contact data object
Output parameters:
none
validateCredentials (read-only)
Input parameters:
• string $username: Username to be validated
25
Services
• string $password: Password to be validated
• int $entity_id: Entity id for which credentials need to be validated
Output parameters:
• boolean $contact_valid: Returns 'true' if valid contact exists. Returns 'false' if contact is invalid.
Creative Service
The CreativeService lets you add/modify a creative and prepare it for trafficking.
Reivew the Creatives section in the Yield Manager Knowledge Base for additonal details. Note: Creatives start serving
only after all elements of the trafficking chain (campaign, line item, insertion order, delivery rules, etc.) are completed
and made active.
• https://api.yieldmanager.com/api-1.37/creative.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/creative.php?wsdl
Requests Summary
• add — Adds a new creative.
• addAttach — Adds the new creative and attaches it to specified line item.
• addAttachCreatives — Adds the given creatives and attaches it to specified line items.
• addCreatives — Adds new creatives.
• addSupportingFiles — Used to upload a creative binary file and generate a filename for the creative.
• attachSegments — Attaches segment pixels to a creative.
• delete — Deletes a single creative.
• deleteCreatives — Deletes multiple creatives.
• deleteSupportingFiles — Deletes temporary creative files that were uploaded using addSupportingFiles() but
not associated with a creative_content object.
• detachSegments — Detach segments from creative
• get — Retrieves all information about the specified creative.
• getAll — Gets the list of all the creative objects you are allowed to see.
• getAllSince — Returns creatives changed between a specified start_date and end_date.
• getAttachedSegments — Returns a list of segment pixel objects attached to a creative.
• getByCampaign — Returns all the creative data types linked to the campaign.
• getByEntity — Returns all contact data objects by specified entity ID.
• getByIntCode — Retrieve all information about the specified creative with the code(externalCreativeId) and
advertiseId.
• getByIntCodes — Retrieve all information about the specified creatives with the codes(externalCreativeId)
and advertiseId.
• getByLineItem — Returns an array of all creative objects linked to a given line_item (indirectly via
campaigns).
• getClassificationReport — Used to get the current status of misclassified creative.
• getCreativeBeacons — Used to get a list of Creative Beacons associated with a creative.
• getCreativeComments — Used to fetch creative review comments.
• getCreativeSpecs — Used to get a list of creative_specs objects for a creative.
• getCreativeTags — Used to get a list of Creative Tags associated with a creative.
• getFullCTStack — Used to retrieve full call stack of Creative Tester for non ssl creative.
• getMGSuggestedClassification — Used to retrieve creative misclassification suggested by the Media Guard.
• getNonSslUrls — Used to retrieve creative non secure urls checked by Creative Tester.
• getReviewStatus — Returns review status for the specified creativeID
• isAudited — Checks a given creative to see if it was audited by Media Guard.
• listAll — Gets the list of all creative IDs you are authorized to see.
• listAllDeletedSince — Returns creative IDs deleted between a specified start_date and end_date.
• listAllSince — Returns creative IDs changed between a specified start_date and end_date.
• listAttachedSegments — Returns a list of segment pixel IDs attached to creative
• listByCampaign — Returns the array of creative IDs associated with a campaign.
• listByEntity — Returns all creative IDs by specified entity ID.
• listByLineItem — Returns an array of all creative IDs linked to a given line_item (indirectly via campaigns).
• lookup — Returns a list of creative IDs that correspond to the requested $code.
• lookupByDescription — Returns a list of creative IDs matching the given creative description.
• reportMisClassification — Used to reports creative misclassification by Suppliers.
• search — Returns the list of creative objects according to the given search rules.
26
Services
• setCreativeTags — Used to associate one or more Creative Tags with a creative object.
• triggerCreativeTest — Used to trigger creative testing to Creative Tester.
• update — Used to modify a creative.
Requests
add
Create a new creative for an advertiser specified by creative::$advertiser_entity_id.
Input parameters:
• creative $creative: Creative data object.
Output parameters:
addAttach
Adds the new creative and attaches it to specified line item.
Input parameters:
• creative $creative: creative Creative data object.
• int $line_item_id: Line item ID.
Output parameters:
• multiple_data_result $result: $results.
addAttachCreatives
Adds the given creatives and attaches it to specified line items.
Input parameters:
• array_of_creative_attachment $creative_attachment: Array of creative_attachement.
Output parameters:
• array_of_multiple_data_result $results: Array of $results.
addCreatives
Input parameters:
27
Services
• array_of_creative $creatives: Array of $creatives.
Output parameters:
addSupportingFiles
Used to upload a creative binary file and generate a filename for the creative on RM servers. This filename can later
be associated with a $creative_content object.
Input parameters:
• array_of_supporting_file $supporting_files: Supporting files.
Output parameters:
• array_of_string $supporting_filenames: Array of $supporting_filenames.
attachSegments
See Segment pixels_About for more information.
Input parameters:
• array_of_int $segment_ids: Array of $segment_ids.
• int $view_segment_id: creative_beacon_id. Segment pixel to which user is added on viewing
Output parameters:
none
delete
Used to delete an existing (single) creative.
Input parameters:
• int $id: Creative ID.
Output parameters:
none
deleteCreatives
Deletes multiple creatives.
28
Services
Input parameters:
• array_of_int $creatives: Array of $creatives.
Output parameters:
deleteSupportingFiles
Deletes temporary creative files that were uploaded using addSupportingFiles() but not associated with a
creative_content object.
Input parameters:
Output parameters:
none
detachSegments
Input parameters:
• int $creative_id: creative ID
• array_of_int $segment_ids: array of segment pixel IDs
Output parameters:
none
get (read-only)
Return the full creative data object.
• Creative Tester
Input parameters:
• int $id: Creative ID.
Output parameters:
getAll (read-only)
Returns an array of creative objects you are allowed to see.
29
Services
• readonly
Input parameters:
Output parameters:
Returns all creatives changed between a specified start_date and end_date. Note: This method sets the start_date =
Input parameters:
Output parameters:
• array_of_creative $creatives: array of creatives
getAttachedSegments (read-only)
See Segment pixels_About for more information.
Input parameters:
• int $creative_id: Creative ID
• int $pagenum: A pagination parameter. Use it with $perpage to determine which page should hold n number
of results.
• int $perpage: A pagination parameter. Use this to get n number of results per page and break up a larger
report request into smaller chunks.
Output parameters:
• array_of_pixel $segments: Array of $segments.
• int $total: Total count of returned $segment objects.
getByCampaign
Return the array of creative objects linked to the given campaign.
30
Services
Input parameters:
Output parameters:
• array_of_creative $creatives: Array of creatives.
getByEntity
getByEntity returns an array of creative objects that belong to a given entity.
Input parameters:
• int $entity_id: The entity ID.
Output parameters:
getByIntCode (read-only)
Retrieve all information about the specified creative with the code(externalCreativeId) and advertiseId.
Input parameters:
• int $advertiser_id: Id of the advertiser the creative belongs to.
• string $code: creativeId on the Partner system.
Output parameters:
• creative $creative: creative data object.
getByIntCodes (read-only)
Retrieve all information about the specified creatives with the codes(externalCreativeId) and advertiseId.
31
Services
Input parameters:
• int $advertiser_id: Id of the advertiser the creative belongs to.
• array_of_string $codes: Array creativeIds on the Partner system.
Output parameters:
getByLineItem
Returns an array of all creative objects linked to a given line_item (indirectly via campaigns).
Input parameters:
• int $line_item_id: line Line item ID.
Output parameters:
getClassificationReport
Used to get the current status of misclassified creative
Input parameters:
• int $supplier_id: Supplier entity ID(publisher or network) who reported misclassification.
Output parameters:
• array_of_creative_classification_status $creative_classification_status: List of
creative_classification_status
getCreativeBeacons
Compare these Beacon ID(s) to DictionaryService::getCreativeBeaconList() obtain the associated creative beacon
objects.
Input parameters:
32
Services
Output parameters:
• array_of_int $creative_beacon_list_ids: List of creative beacon identifiers.
getCreativeComments (read-only)
Used to fetch creative review comments.
Input parameters:
• array_of_int $creatives_ids: This variable takes List of Creative IDs. A maximum of 10 creatives are
allowed in a single API call
• creative_comment_search_options $creative_comment_search: This variable represents a new
creative_comment_search_options data object.
Output parameters:
• array_of_creative_publisher_comments $creative_publisher_comments: Array of creatives.
getCreativeSpecs (read-only)
Used to get a list of creative_specs objects a creative.
Input parameters:
Output parameters:
• creative_specs $creative_specs: $creative_specs objects.
getCreativeTags
Used to get a list of Creative Tags associated with a creative. Compare these tag ID(s) to
DictionaryService::getCreativeTagList() obtain the associated creative tag objects. See Creative Tagging and
Classification using API for more information on creative tags.
• Creative Tester
Input parameters:
Output parameters:
• array_of_int $creative_tag_list_ids: List of creative tag identifiers.
33
Services
getFullCTStack (read-only)
Used to retrieve full call stack of Creative Tester for non ssl creative
• readonly
Input parameters:
Output parameters:
• string $ct_stack: full ct call stack in json format.
getMGSuggestedClassification (read-only)
• readonly
Input parameters:
Output parameters:
• int $offer_type_id: offer type suggested by media guard. offer_type offer_type enum. See Offer Type Enum
for more information.
• array_of_int $creative_tag_list_ids: List of creative tag identifiers. Creative Tags.
getNonSslUrls (read-only)
Used to retrieve creative non secure urls checked by Creative Tester.
• readonly
Input parameters:
Output parameters:
• array_of_string $non_ssl_urls: List of non secure url checked by creative tester.
getReviewStatus (read-only)
Returns review status for the specified creativeID
Input parameters:
34
Services
Output parameters:
• enum_creative_status $creative_status: Creative status
• string $status_reason: Reason for creative review status. NULL if creative status 'reviewPassed'.
isAudited (read-only)
Checks a given creative to see if it was audited by Media Guard. Return boolean true if creative is currently marked as
audited, false otherwise.
Input parameters:
Output parameters:
• boolean $is_audited: Flag, can be 0 or 1.
listAll
Return the array of creative IDs which you are allowed to see.
Input parameters:
Output parameters:
• array_of_int $creative_ids: Array of $creative_ids.
Returns creative IDs deleted between a specified start_date and end_date. Note: This method sets the start_date =
Input parameters:
Output parameters:
• array_of_int $ids: Array of $ids.
35
Services
Returns creative IDs changed between a specified start_date and end_date. Note: This method sets the start_date =
Input parameters:
Output parameters:
listAttachedSegments (read-only)
Input parameters:
Output parameters:
• array_of_int $segment_ids: Array of $segment_ids.
listByCampaign
Returns the array of creative IDs associated with a campaign.
Input parameters:
Output parameters:
listByEntity
Returns an array of creative ID objects that belong to a given entity.
Input parameters:
• int $entity_id: The entity ID.
Output parameters:
listByLineItem
36
Services
Returns an array of all creative IDs linked to a given line_item (indirectly via campaigns linked to the line item).
Input parameters:
Output parameters:
lookup
Returns a list of creative IDs that correspond to the requested $code. You can pass in multiple codes in the $codes
array.
Input parameters:
• array_of_string $codes: Array of $codes.
Output parameters:
• array_of_array_of_int $creative_ids: Array of $creative_ids.
lookupByDescription
Returns an array of creative IDs matching the creative description.
Input parameters:
• string $description: Creative description.
Output parameters:
reportMisClassification
Used to reports creative misclassification by Suppliers.
Input parameters:
• int $supplier_id: Supplier entity ID(publisher or network) who is reporting misclassification.
• int $offer_type_id: Creative's offer type. See Offer Type table for additional information. See also Creative
offer types for details.
• array_of_int $creative_tag_list_ids: List of creative tag identifiers. Creative Tags
Output parameters:
37
Services
none
search
Search allows a network or a publisher (managed or self managed) to see the list of creatives that get served at the
entity (network or publisher) level or the buyer line item level of the entity filtered by some rules. Note: Search
parameters must be specified in a creative_search_options object. Only creatives that are eligible to serve will be
returned via the search function.
Input parameters:
• creative_search_options $search_options: The applied search options.
Output parameters:
• int $total_creatives_count: Total count of creatives returned.
setCreativeTags
Used to associate one or more Creative Tags with a creative object. See Creative Tagging and Classification using
API for more information on creative tags.
Input parameters:
• int $creative_id: Creative tag ID.
• array_of_int $creative_tag_list_ids: Array of $creative_tag_identifiers.
Output parameters:
none
triggerCreativeTest (read-only)
Used to trigger creative testing to Creative Tester, size of creative_ids is limited to 5, and the quota of this interface is
200 a day.
• readonly
Input parameters:
• array_of_int $creative_ids: list of Creative ID.
Output parameters:
update
38
Services
Update modifies the fields of a creative data object. Note: Some fields are system generated (e.g. campaign::$id) and
can't be changed by the client.
Input parameters:
Output parameters:
none
DemandBlocklist Service
This service lets you add/modify/delete/get demand blocklists.
Review the Demand blocklist section in the Yield Manager Knowledge Base for additional details.
• https://api.yieldmanager.com/api-1.37/demand_blocklist.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/demand_blocklist.php?wsdl - test version
Requests Summary
• add — Add/Create blocklist for demand from accessing (a slice of) managed supply of the network.
• delete — Deletes a demand blocklist
• getAllBlocklists — Returns an array of all demand blocklist you are allowed to access.
• getAllSince — Return all demand blocklist changed between a specified start_date and end_date.
• getByObjectId — Returns the demand_blocklist data object for specified id.
• listAll — Returns demand_blocklist data object ids that you are allowed to access.
• listAllSince — Return demand blocklist IDs changed between a specified start_date and end_date.
• quickSearch — Returns an array of all demand blocklist you are allowed to access.
• reviewCreatives — Add/updates the creative_visibility (approved/ban).
• searchCreatives — Returns the list of creatives according to the given search rules.
• update — Modify a demand blocklist.
Requests
add
Add a new demand_blocklist.
Input parameters:
• demand_blocklist $demand_blocklist: New demand_blocklist data object.
Output parameters:
• int $id: Id of demand blocklist.
delete
Removes an existing demand_blocklist object.
39
Services
Input parameters:
• int $demand_blocklist_id: Demand Blocklist ID.
Output parameters:
none
getAllBlocklists (read-only)
Returns an array of all demand blocklist you are allowed to access.
Input parameters:
• blocklist_search_options $blocklist_search_options: Search options.
Output parameters:
• array_of_blocklist_getall $demand_blocklists
Return demand blocklist IDs changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
• array_of_demand_blocklist $demand_blocklist: An array of demand blocklist objects.
Input parameters:
• int $demand_blocklist_id: Id of demand blocklist data object.
Output parameters:
• demand_blocklist $demand_blocklist
40
Services
listAll (read-only)
Input parameters:
Output parameters:
• array_of_int $blocklist_ids
Return demand blocklist IDs changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
• array_of_int $ids: An array of demand blocklist IDs.
Input parameters:
Output parameters:
• array_of_blocklist_getall $demand_blocklist
reviewCreatives
Add/updates the creative_visibility (approved/ban).
Input parameters:
• int $rule_id: demand_blocklist_id
• array_of_int $creatives: Array of $creatives.
• boolean $include: Set "true" to include on an existing profile. Set "false" to overwrite the existing profile.
41
Services
Output parameters:
none
searchCreatives
searchCreatives allows a network creatives that get served at the entity (network or publisher) Note: Search
parameters must be specified in a creative_search_params object. Only creatives that are eligible to serve will be
returned via the search function.
Input parameters:
• creative_review_options $search_options: The applied search options.
Output parameters:
• array_of_creative_custom_object $creative_custom_object: Array of $creative_custom_object.
• int $total_creatives_count: Total count of creative_custom_object returned.
update
Modify fields of demand_blocklist data object.
Input parameters:
• demand_blocklist $demand_blocklist.: Modified demand_blocklist data object.
Output parameters:
none
Dictionary Service
This service provides operations that let you obtain data that may be required by other API calls.
• https://api.yieldmanager.com/api-1.37/dictionary.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/dictionary.php?wsdl
Requests Summary
• getBillingStatuses — Returns the array of $billing_status strings corresponding to the billing_status enum.
• getBrowsers — Returns the array of $browser objects corresponding to the browser enum.
• getChannels — Returns the array of $channel objects corresponding to the channel enum.
• getCountries — Returns the array of $country objects corresponding to the country enum.
• getCountryGroups — Returns the array of $country_group objects corresponding to the country_group enum.
• getCreativeBeaconList — Returns the array of $creative_beacon_list objects corresponding to the
creative_beacon_list enum.
• getCreativeMacro — Returns the array of $creative_macro objects corresponding to the creative_macro
enum.
42
Services
• getCreativeTagList — Returns the array of $creative_tag_list objects corresponding to the creative_tag_list
enum.
• getCurrencies — Returns the array of $currency objects corresponding to the currency enum.
• getCurrencyConversionRate — Returns the $conversion_rate corresponding to the currency id and date
passed to the function.
• getDeliveryTypes — Returns the array of $delivery_type strings corresponding to the delivery_type enum.
• getEnumValues — Returns an array of strings for all available values for the given enum.
• getInventoryTypes — Returns the array of $inventory_type objectscorresponding to the inventory_type enum.
• getIsps — Returns the array of $isp objects corresponding to the isp enum.
• getIVCHiddenParameters — Returns array of hidden parameters available for a inventory visibility controls
profile.
• getLanguages — Returns the array of $language objects corresponding to the language enum.
• getLearnTypes — Returns the array of $learn_type objects corresponding to the learn_type enum.
• getLineItemInventoryMediaType — Returns array of Inventory Media Types.
• getMediaTypes — Returns the array of $media_type objects corresponding to the media_type enum.
• getMGLabelMappings — Returns the array of $mg_label_mappings corresponding to the
mg_label_mappings enum.
• getMobileCarriers — Returns all the available mobile carriers along with country information
• getMobileOSs — Returns all the available OS names
• getMsas — Returns the array of $msas objects corresponding to the msas enum.
• getNetspeeds — Returns the array of $netspeed objects corresponding to the netspeed enum.
• getOfferTypes — Returns the array of $offer_type objects corresponding to the offer_type enum.
• getPopTypes — Returns the array of $pop_type objects corresponding to the pop_type enum.
• getPostalCodes — Returns list of postal codes for given country iso & pattern
• getPricingTypes — Returns the array of $pricing_type objects corresponding to the pricing_type enum.
• getRatings — Returns the array of $rating objects corresponding to the rating enum.
• getRegions — Returns the array of $region objects corresponding to the region enum.
• getRoles — Returns the array of $role objects corresponding to the role enum.
• getSizes — Returns the array of $size objects corresponding to the size enum.
• getSupportedLocales — Returns the array of $supportedLocales objects
• getTechnoDimensions — Returns array of techno_data for top level dimensions.
• getTechnoIds — Returns array of techno_data which fall under the given $techno_parent_id and are at given
level below the parent.
• getVideoPlacementType — Returns array of Video Placement Types.
• getVideoVastType — Returns array of Video Vast Types.
• getVurlCategories — Returns the array of $vurl_category objects corresponding to the vurl_category enum.
• getVurlTags — Returns the array of $vurl_tag_list objects corresponding to the vurl_tag enum.
• getWoeidDetails — Returns details of given WOEID
• getWoeids — Returns list of WOEIds
• validateVurls — Returns validate vurls for given array of url.
Requests
getBillingStatuses (read-only)
Returns the array of $billing_status strings corresponding to the billing_status enum. See Billing Status Enum for more
information.
Input parameters:
Output parameters:
• array_of_string $billing_statuses: Array of $billing_statuses.
getBrowsers (read-only)
Returns the array of browser objects corresponding to the browser enum. See Browser Enum for more information.
Input parameters:
43
Services
Output parameters:
• array_of_browser $browsers: Array of $browsers.
getChannels (read-only)
Returns the array of channel objects corresponding to the channel enum. See Channel Enum and Channels: About for
more information.
Input parameters:
Output parameters:
• array_of_channel $channels: Array of $channels.
getCountries (read-only)
Returns the array of country objects corresponding to the country enum.. See Country Enum and Targeting by
Geography for more information.
Input parameters:
Output parameters:
• array_of_country $countries: Array of $countries.
getCountryGroups (read-only)
Returns the array of country_group objects corresponding to the country_group enum. See Country Group Enum for
more information.
Input parameters:
Output parameters:
• array_of_country_group $country_groups: Array of $country_groups
getCreativeBeaconList (read-only)
Returns the array of creative_beacon_list_item objects corresponding to the creative_beacon_list enum.
44
Services
Input parameters:
• beacon_search_options $search_options: Search options.
larger number of records request into smaller chunks.
Output parameters:
• array_of_creative_beacon_list_item $creative_beacon_list: Array of $creative_beacon_list.
getCreativeMacro (read-only)
Returns the array of creative_macro objects corresponding to the creative_macro enum. See Creative Macro Enum
and Macros Syntax and Descriptions for more information.
Input parameters:
Output parameters:
• array_of_creative_macro $creative_macros: Array of $creative_macros.
getCreativeTagList (read-only)
Returns the array of creative_tag_list_item objects corresponding to the creative_tag_list enum. See Creative Tag List
Enum for more information.
Input parameters:
Output parameters:
• array_of_creative_tag_list_item $creative_tag_list: Array of $creative_tag_list.
getCurrencies (read-only)
Returns the array of currency objects corresponding to the currencies enum. See Currency Enum for more
information.
Input parameters:
Output parameters:
• array_of_currency $currencies: Array of $currencies.
45
Services
getCurrencyConversionRate (read-only)
Returns the conversion rate in USD corresponding to the currency id and date passed to the function.
Input parameters:
• int $currency_id: Currency id for which currency conversion rate is required.
• date $date: Date for which currency conversion rate is required.
Output parameters:
• float $conversion_rate
getDeliveryTypes (read-only)
Returns the array of $delivery_type strings corresponding to the delivery_type enum. See Delivery Type Enum and
Delivery Pacing and Budget Cap Options for more information.
Input parameters:
Output parameters:
• array_of_string $delivery_types: Array of $delivery_types.
getEnumValues (read-only)
Returns an array of strings for all available values for the given enum.
Input parameters:
• string $enum_name: Enum name.
Output parameters:
• array_of_string $values: Array of $values.
getInventoryTypes (read-only)
Returns the array of inventory_type objects corresponding to the inventory_type enum. See Inventory Type Enum and
Inventory Types for more information.
Input parameters:
Output parameters:
• array_of_inventory_type $inventory_types: Array of $inventory_types.
46
Services
getIsps (read-only)
Returns the array of isp objects corresponding to the isp enum. See Isp Enum for more information.
Input parameters:
Output parameters:
• array_of_isp $isps: Array of $isps.
getIVCHiddenParameters (read-only)
Input parameters:
Output parameters:
• array_of_get_ivc_hidden_params $hidden_parameters: Array of objects having database name and
display name of available IVC hidden parameters for each control type.
getLanguages (read-only)
Returns the array of language objects corresponding to the language enum. See Language Enum for more
information.
Input parameters:
Output parameters:
• array_of_language $languages: Array of $languages.
getLearnTypes (read-only)
Returns the array of learn_type objects corresponding to the learn type enum. See Learn Type Enum for more
information.
Input parameters:
Output parameters:
• array_of_learn_type $learn_types: Array of learn $types.
47
Services
getLineItemInventoryMediaType (read-only)
Returns array of Inventory Media Types. See Inventory Media Type Enum for more information.
Input parameters:
Output parameters:
• array_of_inventory_media_type $response: Array of $inventory_media_type
getMediaTypes (read-only)
Returns the array of media_type objects corresponding to the media type enum. See Media Type Enum for more
information.
Input parameters:
Output parameters:
• array_of_media_type $media_types: Array of $media_types.
getMGLabelMappings (read-only)
Returns the array of Media Guard label mappings corresponding to the mg_label_mappings enum. See Media Guard:
About for more information.
Input parameters:
Output parameters:
• array_of_mg_label_mapping $mg_label_mappings: Array of $mg_label_mappings.
getMobileCarriers (read-only)
Returns all the available mobile carriers along with country information
Input parameters:
Output parameters:
• array_of_target_mobile_carrier_data $values: Array of [mobile_id,country,carrier]
48
Services
getMobileOSs (read-only)
Returns all the available OS names
Input parameters:
Output parameters:
• array_of_target_mobile_os_data $values: Array of [mobile_id,OS]
getMsas (read-only)
Returns the array of msa objects corresponding to the msas enum. See Msa Enum and Designated Marketing Areas
Input parameters:
Output parameters:
• array_of_msa $msas: Array of $msas.
getNetspeeds (read-only)
Returns the array of netspeed objects corresponding to the netspeed enum. See Netspeed Enum for more
information.
Input parameters:
Output parameters:
• array_of_netspeed $netspeeds: Array of $netspeeds.
getOfferTypes (read-only)
Returns the array of offer_type objects corresponding to the offer_type enum. See Offer Type Enum for more
information.
Input parameters:
Output parameters:
• array_of_offer_type $offer_types: Array of $offer_types.
49
Services
getPopTypes (read-only)
Returns the array of pop_type objects corresponding to the pop_type enum. See Pop Types Enum for more
information.
Input parameters:
Output parameters:
• array_of_pop_type $pop_types: Array of $pop_types.
getPostalCodes (read-only)
Input parameters:
• string $country_iso: Country ISO to which postal codes belong
• string $begins_with: String for which match needs to be searched (Example- '100%' for postal codes of
Manhattan)
Output parameters:
• array_of_string $postal_codes: Postal codes for the country iso provided
getPricingTypes (read-only)
Returns the array of $pricing_type objects corresponding to the pricing_type enum. See Pricing Type Enum and
Pricing Options for Line Items and Campaigns for more information.
Input parameters:
Output parameters:
• array_of_string $pricing_types: Array of $pricing_types.
getRatings (read-only)
Returns the array of $rating objects corresponding to the rating enum. See Rating Enum and Section Ratings for more
information.
Input parameters:
50
Services
Output parameters:
• array_of_string $ratings: Array of $ratings.
getRegions (read-only)
Returns the array of region objects corresponding to the region enum. See Region Enum for more information.
Input parameters:
Output parameters:
• array_of_region $regions: Array of $regions.
getRoles (read-only)
Returns the array of role objects corresponding to the role enum. See Role Enum and User Roles, Permissions, and
Input parameters:
Output parameters:
• array_of_role $roles: Array of $roles.
getSizes (read-only)
Returns the array of size objects corresponding to the size enum. See Size Enum and for more information.
Input parameters:
• boolean $show_all_sizes: Return all existing sizes if true, otherwise only available ones. 'False' is default.
Output parameters:
• array_of_size $sizes: Array of $sizes.
getSupportedLocales (read-only)
Returns the array of $supportedLocales objects
Input parameters:
51
Services
Output parameters:
• array_of_supported_locale $supportedLocales: Array of $supportedLocales.
getTechnoDimensions (read-only)
Returns array of techno_data for top level dimensions.
Input parameters:
Output parameters:
• array_of_techno_data $response: Array of techno_data.
getTechnoIds (read-only)
Returns array of techno_data which fall under the given $techno_parent_id and are at given level below the parent.
Input parameters:
• int $techno_parent_id: This variable represents parent techno id.
• int $level: This variable represents level of techo hierarchy, default value is 1.
Output parameters:
• array_of_techno_data $response: Array of techno_data.
getVideoPlacementType (read-only)
Returns array of Video Placement Types. See Video Placement Type Enum for more information.
Input parameters:
Output parameters:
• array_of_video_placement_type $response: Array of $video_placement_type
getVideoVastType (read-only)
Returns array of Video Vast Types. See Video Vast Type Enum for more information.
Input parameters:
52
Services
Output parameters:
• array_of_video_vast_type $response: Array of $video_vast_type
getVurlCategories (read-only)
Returns the array of vurl_category objects corresponding to the vurl_category enum. See Vurl Category Enum for
more information.
Input parameters:
Output parameters:
• array_of_vurl_category $vurl_category: Array of $vurl_category.
getVurlTags (read-only)
Returns the array of vurl_tag_list objects corresponding to the vurl_tag enum. See Vurl Tag Enum for more
information.
Input parameters:
Output parameters:
• array_of_vurl_tag_list $vurl_tag_list: Array of $vurl_tag_list.
getWoeidDetails (read-only)
Input parameters:
• int $woeid: WOEID
Output parameters:
• woeid $woeid_obj: WOEID object
getWoeids (read-only)
Input parameters:
• enum_place_type $place_type: Place type i.e. country, state, county, etc
• int $parent_woeid: Parent Woeid
53
Services
Output parameters:
• array_of_int $woeids: Array of WOEIDs
validateVurls (read-only)
Returns validate vurls for given array of url.
Input parameters:
• array_of_string $vurls: list of url. Max count is 2000.
Output parameters:
• vurl_data $vurl_data: object having information specified in data-type vurl_data
Entity Service
The EntityService lets you add, get, or modify settings for an entity. The Tutorial and Training Index contains additional
information about self-paced and instructor-led training on creating and managing entities.
• https://api.yieldmanager.com/api-1.37/entity.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/entity.php?wsdl
Requests Summary
• add — Creates a new entity.
• addEx — Creates a new entity, default site and section, an insertion order, and line item.
• addTargetProfile — Sets up a link between a target profile and an entity.
• delete — Deletes an entity.
• deleteAllPublisherControls — Deletes publisher controls for specified entity id and buyer_entity_ids.
(deprecated)
• deleteEntities — Deletes multiple entities.
• deletePublisherControls — Deletes publisher mask controls See Managing Publisher Controls Using the API
for more information on managing publisher controls. (deprecated)
• delTargetProfile — Deletes the default target profile belonging to the entity.
• get — Retrieves all information about the specified entity.
• getAdvByName — This method allows to search (contains search) all advertisers with specified name and
Retrieves all information about searched entities.
• getAll — Returns the array of all entity objects you are allowed to see.
• getAllPublisherControls — Gets publisher mask controls for specified entity. (deprecated)
• getAllSalesRegions — Gets the sales regions for an entity.
• getAllSince — Return entities changed between a specified start_date and end_date.
• getByIds — Retrieves all information about specified entities.
• getByShellId — Not available. Reserved for future development.
• getCANStatus — Returns the Network's or Publisher's CAN status object.
• getEligiblePrivateMarketPlaces — Returns Eligible Private Marketplaces
• getLanguage — Returns the entity language ID.
• getLineItemMarketPlace — Gets the line item market place options
• getMapByShellIds — Not available. Reserved for future development.
• getNetByName — This method allows to search (contains search) all networks with specified name and
Retrieves all information about searched entities.
• getOfficialContacts — Gets arrays of contacts for the given entity organized by contact role.
• getPubAdTags — Gets a list of ad tags for the specified sections.
54
Services
• getPubDefaultChannels — Gets the default channels for the given publisher.
• getPubDefaultInventoryType — Gets the default inventory type for the given publisher.
• getPublisherControls — Gets the publisher mask controls See Managing Publisher Controls Using the API
• languageFlipFinished — Checks on the status of the process that converts creative language tags to a
different language.
• listAdvertiserEntityByBroker — Returns the array of advertizer id's assigned to given broker and managed by
cuurent entity ID.
• listAll — Returns the array of entity IDs that you are allowed to see.
• listAllSince — Returns entity IDs for entities changed between a specified start_date and end_date.
• lookup — Returns a list of entity IDs for a given integration code.
• setAllPublisherControls — Sets publisher mask controls for specified advertisers. (deprecated)
• setCANStatus — Sets the CAN status for a Network or Publisher.
• setIntegrationCode — Sets the publisher's integration code.
• setLanguage — Sets the language for an entity.
• setLineItemMarketPlace — Sets the line item market place options
• setPubDefaultChannels — Sets the default channels for the given publisher.
• setPubDefaultInventoryType — Sets the default inventory type for the given publisher.
• setPublisherControls — Sets the publisher mask controls See Managing Publisher Controls Using the API for
more information on managing publisher controls. (deprecated)
• update — Modifies an entity.
Requests
add
Use the add method to create a new entity. For providing age and gender information for targeting, see
https://kb.yieldmanager.com/article.php?id=392 for more details.
• Self managed publisher
• Publisher
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• entity $entity: This variable represents the new entity data object.
• contact $contact: This variable represents the new contact data object for the entity's primary contact.
Output parameters:
• int $entity_id: Entity ID of the newly created entity.
addEx
addEx uses the values passed in to entity_data to create a new entity, site/section, insertion order and line item.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• entity_data $entity_data: New entity data object.
Output parameters:
• ex_entity_ids $ex_entity_id: Returns the IDs of the newly created data objects.
55
Services
addTargetProfile
Creates a default target profile for an entity.
Input parameters:
Output parameters:
• int $target_profile_id: Target profile ID.
delete
Used to delete an existing (single) entity.
Input parameters:
• int $entity_id: id of the entity to be deleted.
Output parameters:
none
deleteAllPublisherControls (deprecated)
See Managing Publisher Controls Using the API for more information on managing publisher controls.
This method is deprecated. Use InventoryVisibilityControls::delete()/deleteProfiles()
Input parameters:
• int $entity_id: Specifies managed pub entity_id or seat id (default) foreach params are to be deleted.
• array_of_publisher_control_masks $publisher_control_masks: Array of objects having hidden params,
type, buyer_entity_ids.
Output parameters:
• array_of_multiple_data_result $result: Result of bulk operation
deleteEntities
Used to delete multiple entities.
Input parameters:
56
Services
• array_of_int $entity_ids: entity ids that need to be deleted.
Output parameters:
• array_of_multiple_data_result $results: Returns a "successful/failed" confirmation for each entity.
deletePublisherControls (read-only) (deprecated)
Input parameters:
• int $entity_id: Specifies managed pub entity_id or seat id (default)
• enum_pub_control_type $type: Publisher control type. Values available for type are 'rtbd' and 'macro'.
Type value 'all' is not valid for this method.
• int $buyer_entity_id: Advertsiser entity id. Default value is 0. Value $buyer_entity_id=0 will delete publisher
control mask set at network level.
Output parameters:
none
delTargetProfile
Deletes a target profile and all linked targeting rules (see TargetProfileService) for the entity.
Input parameters:
Output parameters:
none
get (read-only)
Return the full entity data object.
Input parameters:
• int $id: Entity ID.
Output parameters:
• entity $entity: Entity data object.
getAdvByName (read-only)
Returns the list of entity_info data objects of all advertisers with specified name.
57
Services
• Network
• readonly
Input parameters:
• string $entity_name_search_pattern: search string
Output parameters:
• array_of_entity_info $entity_info: Array of $entity_info. See entity_info for more information.
getAll (read-only)
Returns the array of entity objects you are allowed to see.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• enum_ext_entity_type $entity_type: Entity type.
Output parameters:
• array_of_entity $entities: Array of $entities. See {@link::entity entity} data type for more information.
getAllPublisherControls (read-only) (deprecated)
This method is deprecated. Use InventoryVisibilityControls::get()/getProfiles()
Input parameters:
• int $entity_id: Specifies managed pub entity_id or seat id (default) for which publisher control masks are to
be fetched.
Output parameters:
getAllSalesRegions (read-only)
58
Services
Gets the sales regions for an entity.
Input parameters:
Output parameters:
• array_of_sales_region $sales_regions: Array of $sales_regions. See sales_region and Sales Regions for
more information.
Return entities changed between a specified start_date and end_date. Note: This method sets the start_date =
Input parameters:
Output parameters:
• array_of_entity $entities: Array of $entities. See entities for more information.
getByIds (read-only)
Return the entity_info data object.
• Network
• readonly
Input parameters:
• array_of_int $entity_ids: Entity IDs.
Output parameters:
getByShellId (read-only)
59
Services
Not available. Reserved for future development.
Input parameters:
• string $shell_id: entity::$shell_id.
Output parameters:
• entity $entity: Entity data object.
getCANStatus (read-only)
see https://kb.yieldmanager.com/article.php?id=803 for more details.
• Publisher
• Network
Input parameters:
• int $entity_id: Publisher or Network for which CAN settings are to be retrieved.
Output parameters:
• can_status $can_status: CAN Status data object.
getEligiblePrivateMarketPlaces (read-only)
Returns Eligible Private Marketplaces
• available : Advertiser or Network entity level
Input parameters:
• int $entity_id: Defines the buyer entity id.
Output parameters:
• array_of_pvt_marketplace $pvt_marketplaces: Private Marketplaces.
getLanguage (read-only)
Input parameters:
60
Services
Output parameters:
• int $language_id: Language ID.
getLineItemMarketPlace (read-only)
Input parameters:
Output parameters:
• boolean $allow_marketplace_select: Indicates if the seat allows marketplace selection
• array_of_enum_marketplace $default_marketplace: Default marketplace for advetiser lines
getMapByShellIds (read-only)
Not available. Reserved for future development.
Input parameters:
• array_of_string $shell_ids: Array of $shell_ids.
Output parameters:
• array_of_entity_shell $entity_shells: Array of data object.
getNetByName (read-only)
Returns the list of entity_info data objects of all networks with specified name.
• Network
• readonly
Input parameters:
Output parameters:
getOfficialContacts (read-only)
Gets arrays of contacts for the given entity organized by contact role. See User Roles for more information.
61
Services
Input parameters:
• enum_contact_type $contact_type: Contact type.
Output parameters:
• array_of_contact $contacts: Array of $contacts.
getPubAdTags
Return the list of strings representing separate tags, filtered by the ad_tag_options parameter and only for the
specified sections.
Input parameters:
• array_of_int $section_ids: Active section IDs of active sites owned by the current entity.
• ad_tag_options $ad_tag_options: Tag options object.
Output parameters:
• array_of_string $ad_tags: Array of $ad_tags.
getPubDefaultChannels
Return the list of default channels IDs for the given publisher.
• Publisher
• Advertiser
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $publisher_id: Publisher ID.
Output parameters:
• array_of_int $channel_ids: Array of $channel_ids.
getPubDefaultInventoryType
Returns the default inventory type for the given publisher.
62
Services
• Publisher
• Advertiser
• Network
• RMX Direct
• Simplified SMP
Input parameters:
Output parameters:
• enum_int_inventory_type $inventory_type: Inventory type.
getPublisherControls (read-only) (deprecated)
Input parameters:
• int $entity_id: Specifies managed pub entity_id or seat id (default)
• int $buyer_entity_id: Advertsiser entity id. Default value is 0. Value $buyer_entity_id=0 will get publisher
Output parameters:
• publisher_control_data $publisher_control_data: object containing mask control details
languageFlipFinished (read-only)
Checks on the status of the process that converts creative language tags to a different language. See Classifying the
Language of Your Creatives for more information.
Input parameters:
Output parameters:
• boolean $in_process: Returns 'true' if complete. Returns 'false' if still in progress.
listAdvertiserEntityByBroker (read-only)
Input parameters:
• int $broker_id: broker ID.
Output parameters:
• array_of_int $ids: List of entity ids assigned to given broker.
63
Services
listAll (read-only)
Returns the array of entity IDs that you are allowed to see. Review the entity ID data type for more information.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• enum_ext_entity_type $entity_type
Output parameters:
• array_of_int $entity_ids: Array of $entity_ids. See the entity data type ID parameter for more information.
Returns entity IDs for entities changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
lookup
Returns a list of entity IDs for a given integration code.
Input parameters:
• array_of_string $entity_codes: Entity integration codes.
Output parameters:
• array_of_array_of_int $entity_ids: Array of $entity_IDs.
setAllPublisherControls (deprecated)
This method is deprecated. Use InventoryVisibilityControls::add()/addProfiles()
64
Services
Input parameters:
• int $entity_id: Specifies managed pub entity_id or seat id (default) where the params are to be hidden.
Output parameters:
setCANStatus
see https://kb.yieldmanager.com/article.php?id=803 for more details.
• Publisher
• Network
Input parameters:
• can_status $can_status: This variable represent the new (@link can_status) data object.
Output parameters:
none
setIntegrationCode
Sets the publisher's integration code. See Macros and Integration Codes for details. Note: Before you set an
integration code, at least one insertion order should be present.
Input parameters:
• string $code: Integration code.
Output parameters:
none
setLanguage
Input parameters:
• enum_creative_tag_language $language_id: Language ID.
Output parameters:
none
setLineItemMarketPlace
Input parameters:
65
Services
• boolean $allow_marketplace_select: Indicates if the seat allows marketplace selection
• array_of_enum_marketplace $default_marketplace: Default marketplace for advertiser lines.See
Marketplace Enum for valid values.
Output parameters:
none
setPubDefaultChannels
Sets the default channels for the given publisher. See Channels: About for more information.
• Publisher
• Advertiser
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• array_of_int $channel_ids: Array of $channel_ids.
Output parameters:
none
setPubDefaultInventoryType
Set the default inventory type for the given publisher.
• Publisher
• Advertiser
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• enum_int_inventory_type $inventory_type: Inventory type.
Output parameters:
none
setPublisherControls (read-only) (deprecated)
Input parameters:
• array_of_enum_pub_control_param $hidden_params: Parameters to be masked
• int $entity_id: Specifies managed pub entity_id or seat id (default) where the params are to be hidden
66
Services
• int $buyer_entity_id: Advertsiser entity id. Default value is 0. This will set publisher control mask globally i.e.
at network level.
Output parameters:
none
update
Update modifies the fields of a entity data object. For providing age and gender information for targeting, see
https://kb.yieldmanager.com/article.php?id=392 for more details. Note: Some fields are system generated (e.g.
entity::$id) and cannot be changed by the client.
Input parameters:
• entity $entity: The modified entity data object.
Output parameters:
none
InsertionOrder Service
The InsertionOrderService lets you add, delete, get, or list settings for an entity. See Insertion orders and line items
defined for additional details.
• https://api.yieldmanager.com/api-1.37/insertion_order.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/insertion_order.php?wsdl
Requests Summary
• add — Adds a new insertion order.
• convertFromUSD — Converts USD amount into non-USD currency.
• convertToUSD — Converts non-USD amount into USD.
• delete — Deletes an insertion order.
• deleteInsertionOrders — Deletes multiple insertion orders.
• dxrMigrationStatus — Checks for the status of IO migration process, responds with new IO id if migration is
complete.
• dxrRequestMigration — Requests migration of the specified (fixed exchange rate) insertion_order to create a
new (dynamic exchange rate) insertion_order. The new IO will get the specified description. The migration
process is asynchronous; use the dxrMigrationStatus() to poll for the new insertion_order's ID.
• get — Retrieves all information about the specified insertion order.
• getAll — Gets the list of all insertion order objects you are allowed to see.
• getAllSince — Returns insertion_order objects changed between a specified start_date and end_date.
• getByBuyer — Gets the list of all insertion order objects owned by the current entity and linked to the given
buyer.
• getByBuyers — Gets the list of all insertion order objects owned by the current entity and linked to the given
buyers.
• getBySeller — Gets the list of all insertion order objects owned by the current entity and linked to the given
seller.
• getBySellers — Gets the list of all insertion order objects owned by the current entity and linked to the given
sellers.
• getInsertionOrderType — Returns insertion order type.
• getLinkedInfo — Get linked entity information.
• listAll — Gets the list of all insertion order IDs you are allowed to see.
• listAllDeletedSince — Returns IDs of insertion_orders deleted between a specified start_date and end_date.
• listAllSince — Returns IDs of insertion_orders changed between a specified start_date and end_date.
• listByBuyer — Gets the list of all insertion order IDs owned by the current entity and linked to the given buyer.
67
Services
• listBySeller — Gets the list of all insertion order IDs owned by the current entity and linked to the given seller.
• update — Modifies an insertion order.
Requests
add
Adds insertion order.
• Publisher
• Advertiser
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• insertion_order $insertion_order: The new insertion order data object.
Output parameters:
• int $insertion_order_id: Insertion order ID.
convertFromUSD (read-only)
Converts USD amount into non-USD currency. See Working with currencies in the Exchange API for assistance in
working with non-USD currency amounts.
Input parameters:
• int $id: Insertion order ID.
• float $usd_amount: USD amount
Output parameters:
• float $non_usd_amount: converted amount from USD
convertToUSD (read-only)
Converts non-USD amount into USD. See Working with currencies in the Exchange API for assistance in working with
non-USD currency amounts.
Input parameters:
• float $non_usd_amount: Non-USD amount
Output parameters:
• float $usd_amount: converted amount in USD
68
Services
delete
Removes an existing insertion_order object.
Input parameters:
• int $id: insertion order ID.
Output parameters:
none
deleteInsertionOrders
Deletes multiple insertion orders.
Input parameters:
• array_of_int $ids: Array of insertion order IDs.
Output parameters:
• array_of_multiple_data_result $result
dxrMigrationStatus (read-only)
Input parameters:
• int $id: Insertion order ID, specifying the fixed-rate insertion_order whose migration was requested via
dxrRequestMigration().
Output parameters:
• dxr_migration_reports $migration_reports: This will be false until migration is complete and the new IO
has been created.
dxrRequestMigration (read-only)
Input parameters:
• int $id: Insertion order ID, specifying the fixed-rate insertion_order that is to be migrated.
• string $new_description: Description for new DXR insertion_order
Output parameters:
none
get (read-only)
Returns the full insertion_order data object.
69
Services
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $id: Insertion order identifier.
Output parameters:
• insertion_order $insertion_order: The insertion_order data object.
getAll (read-only)
Gets the list of all insertion order IDs you are allowed to see.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• enum_entity_position $entity_position: Determines the transaction role ('All', 'Buyer', 'Seller') to search for.
Output parameters:
• array_of_insertion_order $insertion_orders: Array of insertion order IDs.
Returns insertion_orders changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
• array_of_insertion_order $insertion_orders: Array of insertion orders.
70
Services
getByBuyer (read-only)
Gets the list of all insertion order IDs owned by the current entity and linked to the given buyer. Buyers may be either
networks or advertisers. The current entity is set by your session token.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $buyer_id: Buyer Network or advertiser ID.
Output parameters:
• int $total_count: Total item count.
getByBuyers (read-only)
Gets the list of all insertion order IDs owned by the current entity and linked to the given buyers. Buyers may be either
• Network
Input parameters:
• array_of_int $buyer_ids: Buyer Network or advertiser IDs.
Output parameters:
getBySeller (read-only)
Gets the list of all insertion order objects owned by the current entity and linked to the given seller. Sellers may be
either networks or publishers. The current entity is set by your session token.
• Network
Input parameters:
• int $seller_id: seller Network or publisher ID.
71
Services
Output parameters:
• array_of_insertion_order $insertion_orders: list of insertion orders
getBySellers (read-only)
Gets the list of all insertion order IDs owned by the current entity and linked to the given sellers. sellers may be either
networks or publishers. The current entity is set by your session token.
• Network
Input parameters:
• array_of_int $seller_ids: Buyer Network or publisher IDs.
Output parameters:
getInsertionOrderType (read-only)
Returns insertion order type.
Input parameters:
• int $id: Insertion order id ID
Output parameters:
• enum_insertion_order_type $insertion_order_type: Insertion order type - Primary Linked: Linked IO
between networks, Managed: IO between a network and advertiser/publisher, Billing Linked: Brand Level
Billing IO
getLinkedInfo (read-only)
Return information about entities linked by this insertion order.
• readonly
Input parameters:
Output parameters:
72
Services
• linked_entities_info $linked_info: Linking details for linked entities.
listAll (read-only)
Gets the list of all insertion order IDs you are allowed to see.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
Output parameters:
• array_of_int $insertion_order_ids: Array of insertion order IDs.
Returns IDs of insertion_order deleted between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
Returns IDs of insertion_orders changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
• string $token
Output parameters:
listByBuyer (read-only)
73
Services
Gets the list of all insertion order IDs owned by the current entity and linked to the given buyer. Buyers may be either
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $buyer_id: Network or advertiser ID.
Output parameters:
listBySeller (read-only)
Gets the list of all insertion order IDs owned by the current entity and linked to the given seller. Sellers may be either
• Network
Input parameters:
• int $seller_id: Network or publisher ID.
Output parameters:
update
Update modifies the fields of an insertion order data object. Note: Some fields are system generated (e.g.
campaign::$id) and can't be changed by the client.
• Publisher
• Advertiser
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• insertion_order $insertion_order: Modified $insertion_order data object.
Output parameters:
none
74
Services
InventoryVisibilityControls Service
This service lets you add/modify/delete/get Inventory Visibility Controls Profiles.
Review the Managing Publisher Controls Using the API in the Yield Manager Knowledge Base for additional details.
• https://api.yieldmanager.com/api-1.37/inventory_visibility_controls.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/inventory_visibility_controls.php?wsdl - test version
Requests Summary
• add — Creates IVC profile for specified entity and buyer entity ids.
• addProfiles — Creates multiple IVC profiles for specified owner types and owner ids.
• delete — Deletes a IVC profile.
• deleteProfiles — Deletes multiple IVC profiles.
• get — Retrieves all information about the specified IVC profile id.
• getProfiles — Returns an array of all reserve price profiles you are allowed to see at network, publisher or
section level.
• update — Updates a IVC profile.
• updateProfiles — Updates multiple IVC profiles for specified profile ids and buyer entity ids.
Requests
add
Input parameters:
• inventory_visibility_controls $ivc_profile: New IVC profile data object.
Output parameters:
• int $ivc_profile_id: Id of IVC profile.
addProfiles
Method for bulk add.
Input parameters:
• array_of_inventory_visibility_controls $ivc_profiles: Array of IVC profile objects to be added.
Output parameters:
delete
Removes an existing ivc_profile object.
Input parameters:
75
Services
• int $ivc_profile_id: Id of IVC profile to be deleted.
Output parameters:
none
deleteProfiles
Input parameters:
• array_of_int $ivc_profile_ids: Array of IVC profile ids to be deleted.
Output parameters:
get (read-only)
Returns the full IVC profile data object.
Input parameters:
• int $ivc_profile_id: IVC profile ID.
Output parameters:
• inventory_visibility_controls $ivc_profile: IVC profile data object.
getProfiles (read-only)
Input parameters:
• enum_pub_control_owner_type $owner_type: Owner type of IVC profiles.
• int $owner_id: Id of IVC profile owner.
• int $entries_on_page: A pagination parameter. Use this to get n number of resul ts per page and break up a
Output parameters:
• array_of_inventory_visibility_controls $ivc_profiles
update
Input parameters:
• inventory_visibility_controls $ivc_profile.: IVC profile data object to be updated.
76
Services
Output parameters:
none
updateProfiles
Method for bulk update.
Input parameters:
• array_of_inventory_visibility_controls $ivc_profiles: Array of IVC profile objects to be updated.
Output parameters:
LineItem Service
The LineItemService lets you add, delete, or modify a line item and associated delivery rules. See Insertion orders and
line items defined for additional details.
• https://api.yieldmanager.com/api-1.37/line_item.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/line_item.php?wsdl
Requests Summary
• add — Adds a new line item.
• addCreative — Associates a creative with a line item.
• addCreatives — Associates creatives with line items.
• addSalesRegion — Adds a sales region to an entity.
• delCreative — Deletes a single creative from a line item.
• delete — Deletes a line item.
• deleteLineItems — Deletes multiple line items.
• duplicate — Duplicate existing line items
• get — Retrieves all information about the specified line item.
• getAll — Returns the list of all line items objects you are allowed to see.
• getAllSince — Returns the list of all line item data objects changed between a specified start_date and
end_date.
• getByBuyer — Gets the list of all line item objects owned by the current entity and linked to the given buyer.
• getByCampaign — Returns the list of all line item data objects for the given campaign.
• getByCreative — Returns the array of all line item objects for a specified creative.
• getByInsertionOrder — Returns the array of all line item objects for the specified insertion order.
• getBySeller — Returns the list of all line item objects owned by the current entity and linked to the given
seller.
• getSalesRegion — Returns a sales region name for the given ID.
• getSalesRegionsByEntity — Returns the list of all sales region IDs for the specified entity.
• listAll — Gets the list of all line item IDs you are allowed to see.
• listAllDeletedSince — Returns the list of all line_item IDs deleted between a specified start_date and
end_date.
• listAllSince — Returns the list of all line item IDs changed between a specified start_date and end_date.
• listByBuyer — Gets the list of all line item IDs owned by the current entity and linked to the given buyer.
• listByCampaign — Returns the array of line item IDs associated with a campaign.
• listByCreative — Returns the array of all line item IDs for the specified creative.
• listByInsertionOrder — Returns the array of all line item IDs associated with a specified insertion order.
• listBySeller — Gets the list of all line item IDs owned by the current entity and linked to the given seller.
• setBillingStatus — Sets the billing status of line items for the specified month.
• update — Modifies a line item.
77
Services
Requests
add
Use add to create a new line item. Note: When setting advertiser billing price, refer to Decouple bidding from billing:
About article for additional details.
Input parameters:
• line_item $line_item: New line item data object.
Output parameters:
• int $line_item_id: The line item ID.
addCreative
Add a creative to a line item. To use this method, you need to have the IDs of an existing creative and line item.
• Network
Input parameters:
Output parameters:
none
addCreatives
Add creatives to provided line items. To use this method, you need to have the IDs of an existing creatives and line
items.
• Network
Input parameters:
• array_of_creative_lineitem $creative_lineitem: Array of creative_lineitem.
Output parameters:
addSalesRegion
Adds a sales region to an entity.
78
Services
Input parameters:
• string $name: Sales region name.
Output parameters:
• int $sales_region_id: Sales region ID.
delCreative
Used to delete an existing (single) creative from a line item.
• Network
Input parameters:
Output parameters:
none
delete
Removes an existing line_item object.
Input parameters:
• int $id: Line item ID.
Output parameters:
none
deleteLineItems
Deletes multiple line items.
Input parameters:
• array_of_int $ids: Array of line item IDs.
Output parameters:
duplicate
79
Services
Line item name have to be original
This method can assign new line item to different insertion order under the same Advertiser then original line item
assigned to. But $insertion_order_id is optional, if you don't pass it, insertion order from original line item will be
assined
Input parameters:
• int $line_item_id: ID of line item to duplicate
• string $line_item_name: name for new line item
• int $insertion_order_id: optional
Output parameters:
• int $new_line_item_id: ID of new created line item
get (read-only)
Returns the full line item data object.
Input parameters:
• int $id: Line item ID.
Output parameters:
• line_item $line_item: The $line_item data object.
getAll (read-only)
Return the array of all line_item you are allowed to see.
Input parameters:
• enum_entity_position $entity_position: Enum: All, Buyer, Seller.
Output parameters:
• array_of_line_item $line_items: Array of $line_items.
Returns all the line item data objects changed beween a specified start_date and end_date. Note: This method sets
the start_date = '0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or
less.
80
Services
Input parameters:
Output parameters:
getByBuyer
Gets the list of all line item IDs owned by the current entity and linked to the given buyer. Buyers may be either
Input parameters:
• int $buyer_id: Buyer network or advertiser ID.
Output parameters:
• array_of_line_item $line_item: Array of $line_item.
getByCampaign
Returns the list of all line item data objects for the given campaign.
Input parameters:
Output parameters:
getByCreative (read-only)
Returns the array of all line_item objects for a specified creative.
81
Services
Input parameters:
• int $creative_id: The creative ID.
Output parameters:
getByInsertionOrder (read-only)
Returns the array of all line_item objects for the specified insertion order.
Input parameters:
• int $insertion_order_id: insertion_order_id.
Output parameters:
getBySeller
Gets the list of all line item IDs owned by the current entity and linked to the given seller. Sellers may be either
Input parameters:
• int $seller_id: seller Seller network or publisher ID.
Output parameters:
getSalesRegion (read-only)
Returns a sales region name for the given ID.
82
Services
Input parameters:
• int $sales_region_id: Sales region ID.
Output parameters:
• string $name: Sales region name.
getSalesRegionsByEntity (read-only)
Returns the lst of all sales region IDs for the specified entity.
Input parameters:
Output parameters:
• array_of_sales_region $sales_regions: Array of $sales_regions.
listAll (read-only)
Gets the list of all IDs you are allowed to see.
Input parameters:
• enum_entity_position $entity_position: Enum: All, Buyer, Seller.
Output parameters:
• array_of_int $line_item_ids: Array of $line_item_ids.
Returns the array of all line item IDs deleted between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
83
Services
Returns line item IDs changed between a specified start_date and end_date. Note: This method sets the start_date =
Input parameters:
Output parameters:
listByBuyer
Gets the list of all line_items owned by the current entity and linked to the given buyer. Buyers may be either networks
or publishers. The current entity is set by your session token.
Input parameters:
• int $buyer_id: Network or advertiser ID.
Output parameters:
• array_of_int $li_ids: Array of $li_ids.
listByCampaign
Returns the array of line_items associated with a campaign.
Input parameters:
• int $campaign_id: Campaign campaign::$id.
Output parameters:
listByCreative (read-only)
Returns the array of all line_item IDs for a specified creaative.
Input parameters:
84
Services
• int $creative_id: The creative ID.
Output parameters:
• array_of_int $line_items: Array of $line_item_ids.
listByInsertionOrder (read-only)
Returns the array of all line item IDs associated with a specified insertion order. Use LineItemService::get() to get the
whole line item data object by its ID.
Input parameters:
• int $insertion_order_id: Insertion order ID.
Output parameters:
• array_of_int $line_item_ids: Array of $line_item IDs.
listBySeller
Gets the list of all line_items owned by the current entity and linked to the given seller. Sellers may be either networks
or publishers. The current entity is set by your session token.
Input parameters:
• int $seller_id: Network or publisher ID.
Output parameters:
setBillingStatus
Sets the billing status of line items for the specified month. See Month-end certification: About for more information.
Input parameters:
• array_of_int $line_item_ids: Array of line item IDs.
• enum_string_billing_status $billing_status: Billing status enum.
• string $ym: Specified in yyyy-mm format.
Output parameters:
update
85
Services
Update modifies the fields of a line_item data object. Note: some fields are system generated (e.g. campaign::$id) and
can't be changed by the client.
Input parameters:
• line_item $line_item: Modified $line_item data object.
Output parameters:
none
Linking Service
One of the benefits of membership in the Yahoo Ad Exchange is the ability to link directly to other companies. Linking
helps increase your scale and reach by connecting you with potential business partners. Use the LinkingService to
manage your company profile and links.
See the Linking section in the Yahoo Ad Exchange Knowledge Base for additional information, sample linking
agreements, best practices, and tips on creating your company profile.
• https://api.yieldmanager.com/api-1.37/linking.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/linking.php?wsdl
Requests Summary
• acceptLink — Used to accept a link request from a potential partner.
• addProfile — Creates a linking profile.
• cancelLink — Used to cancel a proposed linking request before it has been accepted.
• getAllLinks — Return the array of link data on all entities that have an active, pending or rejected link with
your entity.
• getAppliedLinks — Returns link_data object of all entities to whom your entity has sent linking requests.
• getLinkableEntityData — Return the array of link data on all entities that can be linked with your entity.
• getLinkData — Returns the link_data object for the specified network entity which is visible or has an active
linked IO.
• getLinkedEntityData — Returns the array of link_data objects of all entities that share one or more active
links with your entity.
• getNonlinkedEntityData — Returns the array of link data objects of all entities that do not share an active
insertion order with your entity.
• getProfile — Returns the linking profile for the specified entity.
• getProposedLinks — Returns the array of link_data objects of all entities that have sent linking requests to
you.
• proposeLink — Sends a linking request.
• rejectLink — Used for rejecting a link request of a partner.
• setRating — Sets a rating for the specified entity.
• updateProfile — Updates the linking profile.
Requests
acceptLink
Used to accept a link request from a potential partner. By approving a linking request from a potential partner, you are
agreeing to work with them in the Yahoo Ad Exchange under the terms of any proposed insertion order. Only approve
a request after you have signed a contract with that company. If you do not want to work with them, reject the link. See
Approving and rejecting linking requests for additional details.
86
Services
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $entity_id: Entity ID of the entity requesting the link.
• boolean $is_seller: Set is_seller = 1 to sell inventory to the requesting entity. Set is_seller = 0 to buy
inventory from the requesting entity.Set is_seller = null to accept if there is one pending link.
• int $billing_entity_id: Entity ID of the managed advertiser under the buyer seat. Applicable when accepting
the billing links, otherwise zero. See Brand level billing for additional details.
Output parameters:
none
addProfile
Use addProfile to create a linking profile for your organization. See Creating your company profile for additional
details.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• linking_profile $profile: A linking_profile object containing your company information.
Output parameters:
none
cancelLink
Used to cancel a proposed linking request before it has been accepted.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $entity_id: Entity ID of the target entity.
• int $billing_entity_id: Entity ID of the managed advertiser under the buyer seat. Applicable when canceling
Output parameters:
none
getAllLinks (read-only)
Return the array of link data on all entities that have an active, pending or rejected link with your entity.
87
Services
• Network
• readonly
Input parameters:
• enum_link_approval_status $link_approval_status: Determines the status ('all', 'active', 'rejected',
'pending_my_approval', 'pending_partner_approval') to search for. Default value: 'all'.
• boolean $entity_name_sort_order: 0 : Ascending, 1 : Descending. Default value: 0.
Output parameters:
• array_of_link_data $link_data: Array of $link_data.
getAppliedLinks
Returns the array of link_data objects of all entities to whom your entity has sent linking requests.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
Output parameters:
• array_of_link_data $proposed_links: Array of link_data objects for proposed links.
getLinkableEntityData (read-only)
Return the array of link data on all entities that can be linked with your entity.
• Network
• readonly
Input parameters:
• boolean $entity_name_sort_order: 0 : Ascending, 1 : Descending
Output parameters:
88
Services
getLinkData
Returns the link_data object for the specified network entity which is visible or has an active linked IO.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
Output parameters:
• link_data $link_data: Link data object.
getLinkedEntityData
Return the array of link_data objects of all entities that share one or more active links with your entity.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
Output parameters:
getNonlinkedEntityData
Returns the array of link_data objects of all entities that do not share an active insertion order with your entity.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
89
Services
Output parameters:
getProfile
Returns the linking profile for the specified entity.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
Output parameters:
• linking_profile $profile: A linking_profile object containing the specified entity's profile.
getProposedLinks
Returns the array of link_data objects of all entities that have sent linking requests to you.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
Output parameters:
• array_of_link_data $proposed_links: Array of $proposed_links.
proposeLink
Sends your potential linked partner a linking request. The link will not be created until the potential partner has
accepted your request. See Sending a linking request for additional details.
90
Services
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $entity_id: Entity ID of the entity you want to link with.
• boolean $is_seller: Set is_seller = 1 to sell inventory to the target entity. Set is_seller = 0 to buy inventory
from the target entity.
• int $billing_entity_id: Entity ID of the managed advertiser under the buyer seat. Applicable when sending
Output parameters:
• int $insertion_order_id: The linking insertion order ID.
rejectLink
Used for rejecting a link request of a partner. See Approving and rejecting linking requests for additional details.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• int $entity_id: Entity ID of the entity requesting the link.
• int $billing_entity_id: Entity ID of the managed advertiser under the buyer seat. Applicable when rejecting
Output parameters:
none
setRating
Sets a rating for the specified entity.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• rating_options $rating_options: A rating_options object containing the target entity ID and a rating. Ratings
range from 1 (worst) to 5 (best).
Output parameters:
none
updateProfile
Updates the linking profile.
91
Services
• Network
• RMX Direct
• Simplified SMP
Input parameters:
• linking_profile $profile: A linking_profile object containing your company information.
Output parameters:
none
Notification Service
The NotificationService allows you to manage traffic monitor alerts and get system status information. See also
Automatic alerts and notifications for more details.
• https://api.yieldmanager.com/api-1.37/notification.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/notification.php?wsdl
Requests Summary
• addTMAlert — Adds a new traf_monitor_alert.
• deleteTMAlert — Deletes the traf_monitor_alert object.
• getAllTMAlerts — Gets the list of the traf_monitor_alert objects you are allowed to see.
• getNotices — Returns information about current API issues.
• getSystemStatus — Returns system status information.
• getTMAlert — Returns the traf_monitor_alert object.
• listAllTMAlerts — Gets the list of all traf_monitor_alert IDs you are allowed to see.
• removeTMAlertEmail — Removes recipients from traffic monitor alert emails.
• updateTMAlert — Updates an existing traf_monitor_alert.
Requests
addTMAlert
Adds a new traf_monitor_alert.
Input parameters:
• traf_monitor_alert $tm_alert: A new traf_monitor_alert data object.
Output parameters:
• int $tm_alert_id: traf_monitor_alert identifier.
deleteTMAlert
Deletes the traf_monitor_alert object.
92
Services
Input parameters:
• int $alert_id: Alert ID.
Output parameters:
none
getAllTMAlerts (read-only)
Gets the list of the traf_monitor_alert objects you are allowed to see.
Input parameters:
Output parameters:
• array_of_traf_monitor_alert $traf_monitor_alerts: Array of traf_monitor_alert objects.
getNotices (read-only)
Returns information about current issues that affect the API.
Input parameters:
Output parameters:
• array_of_notice $notices: Array of status notifications.
getSystemStatus (read-only)
Returns system status information.
Input parameters:
Output parameters:
• string $system_status: System status.
93
Services
getTMAlert (read-only)
Returns the traf_monitor_alert object.
Input parameters:
• int $alert_id: Alert ID.
Output parameters:
• traf_monitor_alert $tm_alert: traf_monitor_alert data object.
listAllTMAlerts (read-only)
Gets the list of all traf_monitor_alert IDs you are allowed to see.
Input parameters:
Output parameters:
• array_of_int $alert_ids: Array of traf_monitor_alert IDs.
removeTMAlertEmail
Removes recipients from traffic monitor alert emails.
Input parameters:
• string $email_hash: Hash of $email_address.
Output parameters:
none
updateTMAlert
Updates an existing traf_monitor_alert.
Input parameters:
• traf_monitor_alert $tm_alert: traf_monitor_alert data object.
Output parameters:
none
94
Services
Passback Service
The Passback lets publisher add, delete, or modify a passback url associated one or multipe section. See
http://kb.yieldmanager.com/article.php?id= for additional details.
• https://api.yieldmanager.com/api-1.37/passback.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/passback.php?wsdl
Requests Summary
• activatePassbacks — Activate a Passback.
• add — Add a new passback.
• deactivatePassbacks — Deactivate a Passback.
• deletePassbacks — Delete passbacks.
• get — Retrieves all information about the specified passback.
• getAll — Gets the list of all the passback objects for the logged in publisher.
• update — update a passback.
Requests
activatePassbacks
Input parameters:
• array_of_int $passback_ids: Array of $passback_ids.
Output parameters:
add
Use to create a new passback.
Input parameters:
• passback $passback: represents a new passback data object.
Output parameters:
• int $passback_id: The passback ID.
deactivatePassbacks
Input parameters:
95
Services
Output parameters:
deletePassbacks
Input parameters:
Output parameters:
get (read-only)
Returns the full passback data object.
• readonly
Input parameters:
• int $id: Passback Id
Output parameters:
• passback $passback: The $passback data object.
getAll (read-only)
Returns an array of passback you are allowed to see.
• readonly
Input parameters:
• int $seller_entity_id: Publisher entity id.
Output parameters:
• array_of_passback $passback: Array of $passback.
96
Services
update
Use add to create a new passback.
Input parameters:
• passback $passback: represents a new passback data object.
Output parameters:
• int $passback_id: The passback ID.
Pixel Service
This service lets you add/get/modify pixels.
• https://api.yieldmanager.com/api-1.37/pixel.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/pixel.php?wsdl - test version
Requests Summary
• add — Create a new pixel.
• addPiggybackPixel — Add a new piggyback pixel.
• addSegmentContributor — Creates a unique publisher tag that identifies the publisher segmenting a user.
• addSegmentShares — Create new segment shares and assign them to specified buyers.
• attachCreatives — Attach creatives to a segment pixel.
• delete — Delete a pixel.
• deletePiggybackPixel — Delete a piggyback pixel.
• deletePixels — Delete pixels.
• deleteSegmentContributor — Delete a specified segment contributor ID.
• detachCreatives — Detach previously attached creatives from a pixel.
• get — Retrieve all information about the specified pixel.
• getAll — Get all pixels which you are authorized to see.
• getAllBoughtSegments — Return an array of bought_segments that have been purchased by you.
• getAllPiggybackPixelsSince — Return piggyback pixels changed between start_date and end_date.
• getAllSince — Return pixels changed between start_date and end_date.
• getAttachedCreatives — Returns list of creative objects attached to a segment pixel.
• getAvailableContentCategoriesBuyers — Returns an array of available content buyer contacts.
• getAvailableSegmentBuyers — Returns an array of available data buyer contacts.
• getByEntity — Get the list of pixels for the specified entity.
• getByLineItem — Get the list of pixels for the specified line_item.
• getContentCategoryOwner — Get owner information for a given public segment id.
• getPiggybackPixels — Retrieve the list of piggyback pixels associated with the given pixel.
• getPixelTags — Return the list of pixel tags.
• getSegmentContributor — Returns the segment contributor object based on the segment contributor ID.
• getSegmentOwner — Get owner information for a given public segment id.
• getSegments — Return list of segment pixels that you own.
• getSegmentShares — Returns an array of segment shares that you own.
• getShareForSegments — Get segment shares for specified segments.
• listAll — Get all pixel ids you are authorized to see.
• listAllDeletedSince — Return pixel ids deleted between start_date and end_date.
• listAllPiggybackPixelsSince — Return piggyback pixel ids changed between start_date and end_date.
• listAllSegmentContributors — Returns all segment contributor IDs created by your network.
• listAllSince — Return pixel ids changed between start_date and end_date.
• listAttachedCreatives — Returns a list of creative ids attached to a segment pixel.
• listByEntity — Get the list of pixel ids for the specified entity.
• listByLineItem — Get the list of pixel ids for the specified line item.
• listSegments — Return a list of segment pixel ids that you own.
• lookup — Return the array of arrays of all pixel ids for each code.
97
Services
• removeBoughtSegments — Remove previously bought segments.
• removeSegmentShares — Remove specified segment shares owned by you.
• syncSegmentShares — Creates and removes segment shares as specified by the input.
• update — Modify a pixel.
Requests
add
Create a new pixel.
Input parameters:
• string $token: Active session token.
• pixel $pixel: New pixel data object.
Output parameters:
• int $pixel_id: Pixel id.
addPiggybackPixel
Bind the specified pixel by its pixel::$id to the given piggyback pixel.
Input parameters:
• int $pixel_id: pixel identifier
• piggyback_pixel $piggyback_pixel: piggyback pixel
Output parameters:
• int $piggyback_pixel_id: piggyback pixel identifier
addSegmentContributor
Creates a unique publisher tag that identifies the publisher segmenting a user. Available to Audience Manager sellers
only. Contact API support to enable publisher tracking.
Input parameters:
• segment_contributor $segment_contributor: segment contributor to be created.
Output parameters:
• int $id: segment contributor id.
addSegmentShares
Create new segment shares and assign them to specified buyers. Available to Audience Manager sellers and Content
Manager sellers. When adding share for segments that support a hierarchy(via parent relations) this method will throw
an exception if the parent segment of the segment in input is already shared with the same buyer.
98
Services
Input parameters:
• array_of_segment_share $segment_shares: Segment shares to be created.
Output parameters:
• array_of_int $ids: Segment share ids.
attachCreatives
Attach creatives to a segment pixel.
Input parameters:
• int $pixel_id: segment pixel id
• array_of_int $creative_ids: list of creative id
Output parameters:
none
delete
Remove an existing pixel data object. Note: Deleting any segment pixel that you have shared via Audience Share will
also remove the corresponding segment shares, and thus will deactivate any line items -- except your own -- that are
targeting this pixel and notify their owners. See Sharing or unsharing segments in the Audience marketplace for
details.
• Network
Input parameters:
• int $id: pixel identifier
Output parameters:
none
deletePiggybackPixel
Delete a piggyback pixel.
Input parameters:
• int $piggyback_pixel_id: piggyback pixel identifier
Output parameters:
none
99
Services
deletePixels
Remove existing pixel data objects. Note: Deleting any segment pixel that you have shared via Audience Share will
targeting this pixel and notify their owners. See Sharing or unsharing segments in the Audience marketplace for
details.
Input parameters:
• array_of_int $ids: pixel identifiers
Output parameters:
• array_of_multiple_data_result $results
deleteSegmentContributor
Delete a specified segment contributor ID. Available to Audience Manager sellers only.
Input parameters:
• int $id: ID of segment contributor to be deleted.
Output parameters:
none
detachCreatives
Detach previously attached creatives from a pixel.
Input parameters:
• int $segment_id: segment-pixel ID
• array_of_int $creative_ids: array of creative IDs
Output parameters:
none
get
Return the full pixel data object.
Input parameters:
• int $id: Pixel id.
Output parameters:
100
Services
• pixel $pixel: pixel data object.
getAll (read-only)
Return the array of pixel objects which you are allowed to see according to security model.
• readonly
Input parameters:
• int $page_num
Output parameters:
• array_of_pixel $pixel: list of pixels
getAllBoughtSegments (read-only)
Return an array of bought_segments that have been purchased by you. Available to Audience Manager buyers and
Content Manager buyers only.
Input parameters:
Output parameters:
• array_of_bought_segment $bought_segment: Bought segments.
getAllPiggybackPixelsSince (read-only)
Return piggyback pixels changed between start_date and end_date. Note: This method sets the start_date =
'0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or less
Input parameters:
• dateTime $start_date: Date from which list all updated piggyback pixel
• dateTime $end_date: Date till list all updated piggyback pixel
• int $entries_on_page: Number of piggyback pixels per page
• int $page_num: Page number
Output parameters:
• array_of_piggyback_pixel $piggyback_pixels: piggyback pixels
101
Services
Return pixels changed between start_date and end_date. Note: This method sets the start_date = '0000-00-00
00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or less
Input parameters:
• string $token
• int $page_num
Output parameters:
• array_of_pixel $pixels: array of pixels
getAttachedCreatives (read-only)
Returns list of creative objects attached to a segment pixel.
Input parameters:
• int $segment_id: segment id
Output parameters:
• array_of_creative $creatives
getAvailableContentCategoriesBuyers (read-only)
Returns an array of available content buyer contacts. Available to Content Category sellers only.
Input parameters:
Output parameters:
• array_of_content_buyer_contact $content_buyers: Array of potential content category buyer contacts.
getAvailableSegmentBuyers (read-only)
Returns an array of available data buyer contacts. Available to Audience Manager sellers only.
Input parameters:
Output parameters:
• array_of_data_buyer_contact $data_buyers: Array of potential data buyer contacts.
102
Services
Return the array of pixel's data objects which belong to the entity specified by entity_id.
Input parameters:
• int $page_num
Output parameters:
• array_of_pixel $pixel: array of pixel
getByLineItem (read-only)
Return the array of pixel's data objects which belong to the line_item specified by line_item_id.
Input parameters:
• int $line_item_id: line_item identifier
• int $page_num
Output parameters:
• array_of_pixel $pixel: array of pixel
getContentCategoryOwner (read-only)
Get owner information for a given public segment id. Available to Content Manager buyers only.
Input parameters:
• int $public_segment_id: Public segment id.
Output parameters:
• content_seller_contact $content_seller_contact: Content seller contact.
getPiggybackPixels
Retrieve the list of piggyback pixels associated with the given pixel.
103
Services
Input parameters:
• int $id: pixel identifier
• int $page_num
Output parameters:
• array_of_piggyback_pixel $piggyback_pixels: piggyback pixels
getPixelTags (read-only)
Return the list of pixel tags for pixels specified in $pixel_tag_params.conversion_ids. If
$pixel_tag_params.secure_pixel is true then 'http://ad.yieldmanager.com' is used for url domain.
Input parameters:
• pixel_tag_params $pixel_tag_params: params for pixel tag generation
Output parameters:
• array_of_string $pixel_tags: generated pixel tags
getSegmentContributor (read-only)
Returns the segment contributor object based on the segment contributor ID. Available to Audience Manager sellers
only.
Input parameters:
• int $id: ID of segment contributor.
Output parameters:
• segment_contributor $segment_contributor: Segment Contributor.
getSegmentOwner (read-only)
Get owner information for a given public segment id. Available to Audience Manager buyers only.
Input parameters:
• int $public_segment_id: Public segment id.
Output parameters:
• data_seller_contact $data_seller_contact: Data seller contact.
104
Services
getSegments (read-only)
Return list of segment pixels that you own.
Input parameters:
• int $entries_on_page: number of entities on page. Max entires per page will be 3000.
• int $page_num: number of page
• segment_search_options $segment_search_options: Segment search options for pixel segment name.
Leading and/or trailing wildcards (*) can be added to get results for pixel segment names matching the string
provided. Possible patterns are: 'pixel': Will match exact name 'pixel'
'*pixel': Will return results having name as 'pixel' or some words before pixel like 'New pixel'
'pixel*': Will return results having name as 'pixel' or some words after pixel like 'pixel segment'
'*pixel*': Will return results having name as 'pixel' or some words before pixel like 'New pixel' or some words
after pixel like 'pixel segment' or 'New pixel segment'
Output parameters:
• array_of_pixel $pixel
• int $count_of_pixels
getSegmentShares (read-only)
Returns an array of segment shares that you own. Available to Audience Manager sellers and Content Manager
sellers.
Input parameters:
• int $entries_on_page: A pagination parameter A pagination parameter. Use this to get n number of results
per pag. If n not provided then for large data, the memory exhaust error may come.
Output parameters:
• array_of_segment_share $segment_shares: Segment shares that you own.
getShareForSegments (read-only)
Returns an array of segment shares of specified segments. Available to Audience Manager sellers and Content
Manager sellers.
Input parameters:
• array_of_int $segments: Segment ids.
Output parameters:
• array_of_multiple_data_response $responses: list of responses
• array_of_segment_share $segment_shares: list of Segment Shares
105
Services
listAll
Return the array of pixel objects which you are allowed to see according to security model.
Input parameters:
Output parameters:
• array_of_int $pixel_ids: array of pixel id
Return pixel ids deleted between start_date and end_date. Note: This method sets the start_date = '0000-00-00
Input parameters:
• string $token
Output parameters:
listAllPiggybackPixelsSince (read-only)
Return piggyback pixel ids changed between start_date and end_date. Note: This method sets the start_date =
'0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or less
Input parameters:
• dateTime $start_date: Date from which list all updated piggyback pixel
• dateTime $end_date: Date till list all updated piggyback pixel
Output parameters:
• array_of_int $ids: Array of piggyback pixel ids
listAllSegmentContributors
Returns all segment contributor IDs created by your network. Available to Audience Manager sellers only.
Input parameters:
Output parameters:
106
Services
• array_of_int $segment_contributor_ids: array of segment contributor id
Return pixel ids changed between start_date and end_date. Note: This method sets the start_date = '0000-00-00
Input parameters:
• string $token
Output parameters:
listAttachedCreatives (read-only)
Returns a list of creative ids attached to a segment pixel.
Input parameters:
• int $segment_id: segment pixel id
Output parameters:
• array_of_int $creative_ids
Return the array of section ids which belong to the entity specified by entity_id. Use PixelService::get() to get the
whole pixel's data object by its id.
Input parameters:
Output parameters:
listByLineItem (read-only)
Return the array of ids which belong to the line item specified by line_item_id. Use PixelService::get() to get the whole
pixel's data object by its id.
107
Services
Input parameters:
• int $line_item_id: line_item identifier
Output parameters:
listSegments (read-only)
Return a list of segment pixel ids that you own.
Input parameters:
Output parameters:
• array_of_int $pixel
lookup
Return the array of arrays of all pixel ids for each code. You can use PixelService::get() to get the whole pixel data
object by its id.
Input parameters:
• string $token: Session token.
• array_of_string $codes: line_item codes.
Output parameters:
• array_of_array_of_int $pixel_ids
removeBoughtSegments (read-only)
Remove previously bought segments. Available to Audience Manager buyers only.
Input parameters:
• array_of_int $public_segment_ids: Public segment ids.
Output parameters:
none
removeSegmentShares
Remove specified segment shares owned by you. Available to Audience Manager sellers and Content Manager
sellers. When removing share for segments that support a hierarchy(via parent relations) this method will throw an
exception if the parent segment of the segment in input is already shared with the same buyer. Note: The buyer(s) of
these segment shares will be notified. Any line items -- except your own -- that are targeting these segments will be
deactivated. See http://kb.yieldmanager.com/article.php?id=746 Sharing or unsharing segments in the Audience
marketplace for details.
108
Services
Input parameters:
• array_of_int $segment_share_ids: Segment share ids to be deleted.
Output parameters:
none
syncSegmentShares
Creates and removes segment shares as specified by the input. Available to Audience Manager sellers and Content
Manager sellers. Please note that the segment share remove requests will be processed first followed by adds. In
case of syncing shares for segments that support a hierarchy(via parent relations) this method will deactivate line
items only in case where there is an actual removal of segment shares. In cases where the remove and add operation
leave a certain segment share untouched the line items will not be deactivated.
Input parameters:
• array_of_segment_share $add_objs: List of new segment shares to add
• array_of_segment_share $del_objs: List of segment shares to remove
Output parameters:
• array_of_int $ids: New segment share ids
update
Change the fields of pixel data object. Note: Some fields are generated by API (e.g. pixel::$id) and cannot be changed
by the client.
Input parameters:
• pixel $pixel: Modified pixel data object.
Output parameters:
none
PreferredTerms Service
This service lets you add/modify/delete/get preferred terms.
Review the Preferred Terms section in the Yield Manager Knowledge Base for additional details.
• https://api.yieldmanager.com/api-1.37/preferred_terms.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/preferred_terms.php?wsdl - test version
Requests Summary
• add — Add/Create preferred terms for demand from accessing (a slice of) managed supply of the network.
• delete — Deletes a preferred terms
109
Services
• getAllPreferredTerms — Returns an array of all preferred terms you are allowed to access.
• getAllSince — Return all preferred terms changed between a specified start_date and end_date.
• getByObjectId — Returns the preferred_terms data object for specified id.
• getVurls — Gets list of Vurls for specific rule id/pattern.
• listAll — Returns preferred_terms data object ids that you are allowed to access.
• listAllSince — Return preferred terms IDs changed between a specified start_date and end_date.
• quickSearch — Returns an array of all demand blocklist you are allowed to access.
• setVurls — Creates preferred terms for VURL.
• update — Modify a preferred terms.
Requests
add
Add a new preferred_terms.
Input parameters:
• preferred_terms $preferred_terms: New preferred_terms data object.
Output parameters:
• int $id: Id of preferred terms.
delete
Removes an existing preferred_terms object.
Input parameters:
• int $preferred_terms_id: Preferred Terms ID.
Output parameters:
none
getAllPreferredTerms (read-only)
Returns an array of all preferred terms you are allowed to access.
Input parameters:
• preferred_terms_search_options $preferred_terms_search_options: Search options.
Output parameters:
• array_of_preferred_terms_getall $preferred_terms
110
Services
Return preferred terms IDs changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
• array_of_preferred_terms $preferred_terms: An array of preferred terms objects.
Input parameters:
• int $preferred_terms_id: Id of preferred terms data object.
Output parameters:
• preferred_terms $preferred_terms
getVurls (read-only)
Gets list of Vurls for specific rule id/pattern.
Input parameters:
• string $pattern: Pattern for vurl.
• boolean $is_universal_search: Set to false if search is for selected vurl against preferred_terms_id else
true. Default value is false.
Output parameters:
• array_of_vurl_get_data $vurl_data
listAll (read-only)
Input parameters:
111
Services
Output parameters:
• array_of_int $preferred_terms_ids
Return preferred terms IDs changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
• array_of_int $ids: An array of preferred terms IDs.
Input parameters:
Output parameters:
• array_of_preferred_terms_getall $preferred_terms
setVurls
Creates preferred terms for VURL.
Input parameters:
• array_of_int $add_vurl_ids: VURL ids to be added.
• array_of_int $remove_vurl_ids: VURL ids to be removed.
• boolean $include: Set flag include to "true" to include or "false" to exclude the ids provided $add_vurl_ids.
By default value its true.
Output parameters:
none
update
112
Services
Modify fields of preferred_terms data object.
Input parameters:
• preferred_terms $preferred_terms.: Modified preferred_terms data object.
Output parameters:
none
PublisherReservePrice Service
This service lets you add/modify/delete/get Publisher Reserve Price Profile.
Review the Publisher Reserve Price section in the Yield Manager Knowledge Base for additional details.
• https://api.yieldmanager.com/api-1.37/publisher_reserve_price.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/publisher_reserve_price.php?wsdl - test version
Requests Summary
• add — Create a new publisher reserve price profile.
• addProfiles — Method for bulk add.
• delete — Deletes a publisher reserve price profile.
• deleteProfiles — Deletes multiple publisher reserve price profiles.
• get — Retrieves all information about the specified publisher reserve price profile.
• getAll — Returns an array of all reserve price profiles you are allowed to see at network, publisher or section
level.
• update — Modify a publisher reserve price profile.
• updateProfiles — Method for bulk update.
Requests
add
Add a new publisher_reserve_price_profile.
Input parameters:
• publisher_reserve_price_profile $publisher_reserve_price_profile: New publisher_reserve_price_profile
data object.
Output parameters:
• int $rp_profile_id: Id of Publisher reserve price profile.
addProfiles
Method for bulk add.
113
Services
Input parameters:
• array_of_publisher_reserve_price_profile $publisher_reserve_price_profiles: array of
$publisher_reserve_price_profiles objects.
Output parameters:
delete
Removes an existing publisher_reserve_price_profile object.
Input parameters:
• int $reserve_price_profile_id: Publisher Reserve Price Profile ID.
Output parameters:
none
deleteProfiles
Input parameters:
• array_of_int $reserve_price_profile_ids: Array of Publisher Reserve Price Profile IDs.
Output parameters:
get (read-only)
Returns the full publisher reserve price profile data object.
Input parameters:
• int $reserve_price_profile_id: publisher reserve price profile ID.
Output parameters:
• publisher_reserve_price_profile $publisher_reserve_price_profile: The $publisher_reserve_price_profile
data object.
getAll (read-only)
Input parameters:
114
Services
• int $entity_id: Entity id (publisher, network). For publisher entity id, reserve price profiles with section ids will
also be returned.
• reserve_price_filter_options $rp_filter_options: Filter options to get specific reserve price profiles.
Output parameters:
• array_of_publisher_reserve_price_profile $publisher_reserve_price_profiles
update
Modify fields of publisher_reserve_price_profile data object.
Input parameters:
• publisher_reserve_price_profile $publisher_reserve_price_profile.: Modified
publisher_reserve_price_profile data object.
Output parameters:
none
updateProfiles
Method for bulk update.
Input parameters:
• array_of_publisher_reserve_price_profile $publisher_reserve_price_profiles: array of
$publisher_reserve_price_profiles objects
Output parameters:
Quota Service
This service provides information about quota usage
• https://api.yieldmanager.com/api-1.37/quota.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/quota.php?wsdl - test version
Requests Summary
• getQuotaByCmdGroup — Retrieve information about daily quota assigned by command group.
• getQuotaByServiceByMethod — Retrieve information about quota usage for a given service and method.
115
Services
Requests
getQuotaByCmdGroup (read-only)
Input parameters:
• string $cmdgroup_name: service name
Output parameters:
• array_of_quota $quota: array of quota
getQuotaByServiceByMethod (read-only)
Input parameters:
• string $service_name: service name
• string $service_method: service method
Output parameters:
• array_of_quota $quota: array of quota
Report Service
The ReportService class includes methods that allow you to request, retrieve, and work with reporting data.
Use these methods to run reports against the Exchange's databases and recover data for your account.
• https://api.yieldmanager.com/api-1.37/report.php?wsdl - production version.
• https://api-test.yieldmanager.com/api-1.37/report.php?wsdl - test version.
Requests Summary
• addSegmentReportVisibility — Add the report visibility permissions for content category sellers. Only
accessible to content category buyers.
• getSegmentReportVisibility — Get the report visibility permissions for content category sellers. Only
• isMonthCertified — Checks if the numbers for a given month have been certified.
• opportunityRequestViaXML — make a xml request to generate an Opportunity Report
• requestSavedReport — generate a report using a saved request
• requestViaXML — make a xml request to generate a report
• status — get a report URL if it has been generated successfully
• updateSegmentReportVisibility — Updates the report visibility permissions for content category sellers. Only
Requests
addSegmentReportVisibility
This API adds report visibility permissions for content category sellers. The buyer_id is ignored. The seller ids should
be unique and this will be specified as the item_id in the return objects.
116
Services
Input parameters:
• string $token: Represents your current API session token.
• array_of_segment_report_visibility $visibilities: The array of segment_report_visibility objects for different
sellers.
Output parameters:
• array_of_multiple_data_result $results: Status of each request
getSegmentReportVisibility (read-only)
This API get report visibility permissions for content category sellers.
Input parameters:
• array_of_int $seller_ids: The array of seller_ids
Output parameters:
• array_of_segment_report_visibility $results: visibility permissions for each seller
isMonthCertified (read-only)
This method is a boolean datatype. It returns boolean true if numbers have been certified. It returns boolean false if
the numbers have not been certified.
Input parameters:
• string $date: Use the format YYYY-MM.
Output parameters:
• boolean $is_certified: Flag.
opportunityRequestViaXML
The opportunityRequestViaXML method is intended specifically for requesting OpportunityReports.
This method is functionally identical to requestViaXML, but opportunityRequestViaXML has a more restrictive quota
limit.
You may use either method to submit Opportunity Report requests, but both will route such requests to this method,
and thus be subject to the more restrictive limit. You will probably find it most convenient to use requestViaXML for all
your report requests, but in that case be aware that, when submitting requests for Opportunity Reports, both the quota
feedback SOAP headers and the exception message if the quota limit is reached will be specific to
opportunityRequestViaXML.
Input parameters:
• string $xml: xml Defines the rows, columns, and filters of your XML request.
117
Services
Output parameters:
• string $report_token: Represents the report location.
requestSavedReport
Use this method to generate reports from previously saved requests.
Note: The API allows only one ReportService query at a time for a given user.
Input parameters:
• int $report_id: The report ID.
Output parameters:
requestViaXML
Use the requestViaXML method to generate report data. The requestViaXML method makes code development
efficient because it allows you to form your report request in XML. Review the Reportware XML Syntax page or the
Yield Manager KB article "The requestViaXML method: About" for additional details.
Note: The API allows only one ReportService query at a time for a given user.
Input parameters:
• string $xml: xml Defines the rows, columns, and filters of your XML request.
Output parameters:
status
The status method monitors the file system to determine if your report is ready. Once it is, status returns a URL that
points to the XML block containing your report data. Review the Yield Manager article "The status method: About" for
additional details.
Input parameters:
Output parameters:
• string $url_report: This is the URL of the finished report.
updateSegmentReportVisibility
118
Services
This API updates an existing report visibility permissions for content category sellers. The buyer_id is ignored. The
seller ids should be unique and this will be specified as the item_id in the return objects.
Input parameters:
• array_of_segment_report_visibility $visibilities: The array of segment_report_visibility objects for different
sellers.
Output parameters:
• array_of_multiple_data_result $results: Status of each request
Rtbd Service
• https://api.yieldmanager.com/api-1.37/rtbd.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/rtbd.php?wsdl
Requests Summary
• getBidURL — Return current BidURL setting for RTBD advertiser in specified region.
• getFailureReport — Get traffic failure metrics. There are multiple rows returned over the reporting period, and
there are multiple rows per period as well and per bid url?, having one row per distinct failure type (eg
timeout, connect error, etc).
• getQPS — Get current qps setting for the RTBD advertiser in specified region.
• getRecentTrafficReport — Report per region for this advertiser, the traffic and statistics observed over the
last 24 hours.
• getSuccessReport — Report traffic metrics to the advertiser including the aggregates relative to success.
There will be one row per time period (default 30 mins) per bid url?, listing the total number of bids, the
number of sucessful bid responses, and the measurement of the latency over the successful responses.
• setBidURL — Set bid_url, bid_api_version, transport format for this RTBD advertiser in specified region.
• setQPS — Set max qps for the RTBD advertiser in specified region.
Requests
getBidURL
Return current rtbdbidurl BidURL setting for RTBD advertiser in specified region.
• Advertiser
• Network
Input parameters:
• int $advertiserId: This variable represnts your Yahoo Ad Exchange entity(advertiser) id.
• enum_rtbd_region $EnumRtbdRegion: region qps setting region.
Output parameters:
• rtbdbidurl $GetRtbdBidURL: RtbdBidURL object.
getFailureReport
119
Services
Get traffic failure metrics. There are multiple rows returned over the reporting period, and there are multiple rows per
period as well and per bid url?, having one row per distinct failure type (eg timeout, connect error, etc).
• Advertiser
• Network
Input parameters:
Output parameters:
• rtbdfailurereport $RtbdFaliureReport
getQPS
Get current getrtbdqpsresp QPS setting for the RTBD advertiser in specified region.
• Advertiser
• Network
Input parameters:
Output parameters:
• getrtbdqpsresp $GetRtbdQpsResp: RtbdQPS object.
getRecentTrafficReport
Report per region for this advertiser, the traffic and statistics observed over the last 24 hours.
• Advertiser
• Network
Input parameters:
Output parameters:
• rtbdrecenttrafficreport $RtbdRecentTrafficReport: recent traffic.
getSuccessReport
Report traffic metrics to the advertiser including the aggregates relative to success. There will be one row per time
period (default 30 mins) per bid url?, listing the total number of bids, the number of sucessful bid responses, and the
measurement of the latency over the successful responses.
120
Services
• Advertiser
• Network
Input parameters:
Output parameters:
• rtbdsuccessreport $RtbdSuccessReport
setBidURL
Set bid_url, bid_api_version, transport format for this RTBD advertiser in specified region.
• Advertiser
• Network
Input parameters:
• rtbdbidurl $RtbdBidURL: rtbdbidurl A RtbdBidURL object.
Output parameters:
none
setQPS
Set max qps for the RTBD advertiser in specified region.
Return none
• Advertiser
• Network
Input parameters:
• rtbdqps $rtbdQPS: rtbdqps A RtbdQPS Object.
Output parameters:
none
Search Service
This service lets you run a search
• https://api.yieldmanager.com/api-1.37/search.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/search.php?wsdl - test version
Requests Summary
121
Services
• quickSearch — Run a search for objects
• search
• searchWoeids — Returns all woe ids having their description that matches the search pattern provided by
API user
Requests
Return found objects and found objects count.
Searches entries of search_clause : entity by name field value; contact by first_name and last_name fields value;
insertion order / line item / creative / pixel / site / section by description field value.
Input parameters:
• string $search_clause: search string
• enum_quicksearch_object_type $object_type
• int $page_num
Output parameters:
• array_of_quicksearch_result $result: array or empty array
• int $total_objects_found: count of found objects or 0
search (read-only)
Input parameters:
• enum_search_object_type $object_type
• array_of_search_data $search_data_array: array of search_data
Output parameters:
• array_of_int $result: array or empty array
searchWoeids (read-only)
Input parameters:
• string $search_pattern: Search pattern for woeid description. Leading and/or trailing wildcards (*) can be
added to get results for woeid de scriptions matching the string provided. Possible patterns are:
'mexico': Will match exact string 'mexico'
'*mexico': Will return results having description as 'mexico' or some words before mexico like 'New Mexico'
'mexico*': Will return results having description as 'mexico' or some words after mexico like 'Mexico City'
'*mexico*': Will return results having description as 'mexico' or some words before mexico like 'New Mexico'
or some words after mexico lik e 'Mexico city' or 'New Mexico city'
Output parameters:
122
Services
• array_of_woeid_search_result $woeid_search_result: Array of woeids matching $search_pattern
provided by API user
Section Service
This service lets you add/modify a section.
• https://api.yieldmanager.com/api-1.37/section.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/section.php?wsdl - test version
Requests Summary
• add — add a new section
• get — retrieve all information about the specified section
• getAll — get all sections you are authorized to see
• getAllSince — Return sections changed between start_date and end_date.
• getByEntity — get the list of sections for the specified entity
• getBySite — get the list of sections available for the specified site
• listAll — get the list of all section`s ids you are authorized to see
• listAllSince — Return section IDs changed between start_date and end_date.
• listBeaconPixels — retrieve the list of beacon pixels available
• listByEntity — get the list of section's ids for the specified entity
• listBySite — get the list of all sections available for the specified site
• lookup — return the list of list of all section' ids for each given code
• update — modify a section
Requests
add
Create a new section for the site, specified by section::$site_id.
Input parameters:
• section $section: new section data object
Output parameters:
• int $section_id: section identifier
get (read-only)
Return the full section's data object.
• readonly
Input parameters:
• int $id: section identifier
Output parameters:
123
Services
• section $section: section data object
getAll (read-only)
Return the array of all section's data objects which you are allowed to see according to security model
Input parameters:
• int $page_num
Output parameters:
• array_of_section $sections: array of sections
Input parameters:
• string $token
• int $page_num
Output parameters:
Return the array of section's data objects which belong to the entity specified by entity_id.
Input parameters:
• int $page_num
Output parameters:
getBySite (read-only)
124
Services
Return the array of all section's data objects available for the site specified by site_id.
Input parameters:
• int $site_id: site identifier
• int $page_num
Output parameters:
listAll (read-only)
Return the array of section's ids which you are allowed to see according to security model Use SectionService::get() to
get the whole section data object by its id or SectionService::getAll() to get the list of all data objects.
Input parameters:
Output parameters:
• array_of_int $section_ids: array of section identifiers
Input parameters:
• string $token
Output parameters:
listBeaconPixels (read-only)
Return the list of available pixel's identifiers.
• Network
• RMX Direct
• Simplified SMP
Input parameters:
125
Services
Output parameters:
• array_of_int $pixel_ids: array of pixel identifiers
Return the array of section's ids which belong to the entity specified by entity_id. Use SectionService::get() to get the
whole section's data object by its id.
Input parameters:
Output parameters:
listBySite (read-only)
Return the array of section's ids available for the site specified by site_id. Use SectionService::get() to get the whole
section data object by its id or SectionService::getBySite() to get the list of all data objects.
Input parameters:
Output parameters:
lookup
Return the array of arrays of section' ids for each code You can use SectionService::get() to get the whole section
data object by its id.
Input parameters:
• array_of_string $codes: line_item codes
Output parameters:
• array_of_array_of_int $section_ids
update
Change the fields of section's data object. Please keep in mind that some fields are generated behind API (e.g.
section::$id) and cannot be changed by the client.
126
Services
Input parameters:
• section $section: modified section data object
Output parameters:
none
SegmentDefinition Service
Segment definition service allows users to request the creation of segments under a particular segment service
provider and manage these segment.
• https://api.yieldmanager.com/api-1.37/segment_definition.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/segment_definition.php?wsdl
Requests Summary
• add — Creates a targeting segment and shares it back to you.
• delete — Deletes the YAX segment pixel and associated segment share data from the segment service
provider entity's seat.
• get — Gets the segment attributes for a given public segment ID.
• srtKeywordsDelete — Delete keywords from a previously created segment.
• srtKeywordsGet — Get keywords from existing segment.
• srtKeywordsReport — Get a report about all keywords that comprise a previously created segment.
• srtKeywordsSet — Add keywords to a previously created segment.
• update — Update an existing segment and its attributes.
Requests
add
Creates a targeting segment under the requested target service provider and shares it back to you.
Input parameters:
• string $segment_name: Short name of the segment you are creating.
• int $segment_type_id: Segment type ID. See valid types in Segment Type Enum.
• segment_attributes $segment_attributes: Segment attributes.
• int $segment_provider_entity_id: Entity id of the segment provider you are allowed to request service from.
• int $advertiser_entity_id: Only relevant if caller == $segment_provider_entity_id. In this case, this is
assumed (and enforced) to be a managed advertiser belonging to the caller. Everyone elase should either
skip this parameter, provide a value of 0, null or the same value as the $segment_provider_entity_id. Thease
are all equivalent.
Output parameters:
• pixel_pair $pixel_pair: Pixel pair object of private and public segment ids of the pixel. Private pixel id will not
be populated if you are not the service provider.
delete
127
Services
Deletes the YAX segment pixel and associated segment share data from the segment service provider entity's seat.
This method is available for segment managers and segment service providers.
Input parameters:
• int $public_segment_id: Public segment ID.
Output parameters:
none
get (read-only)
Gets the segment attributes for a given public segment ID. This method is available for segment managers and
segment service providers.
• readonly
Input parameters:
Output parameters:
srtKeywordsDelete
Delete keywords from a previously created segment. This method is available for segment managers and segment
service providers.
Input parameters:
• array_of_string $keywords: Keywords that will be deleted from segment.
Output parameters:
none
srtKeywordsGet (read-only)
Get keywords from existing segment. This method is available for segment managers and segment service providers.
• readonly
Input parameters:
• string $keyword_status_filter: Optional filter to only get keywords of a certain status that populates this
segment. See valid types in Srt Keyword Status Enum.
128
Services
Output parameters:
• array_of_srt_segment_status $srt_segment_status: Keywords and their corresponding status.
srtKeywordsReport (read-only)
Get a report about all keywords that comprise a previously created segment. This method is available for segment
managers and segment service providers.
• readonly
Input parameters:
• string $date: Defines the date for which a report is being requested. Use the format yyyy-mm-dd.
Output parameters:
• array_of_srt_segment_report $srt_segment_report: Segment reports.
srtKeywordsSet
Add keywords to a previously created segment. This method is available for segment managers and segment service
providers.
Input parameters:
• array_of_string $keywords: Keywords that will be added to the segment.
• boolean $append: Set "true" to add keywords to existing keywords in this segment. Set "false" to overwrite
the existing keywords.
Output parameters:
none
update
Update an existing segment and its attributes. This method is available for segment managers and segment service
providers.
Input parameters:
Output parameters:
none
129
Services
Segment Service
This service lets you add/get/modify segments.
• https://api.yieldmanager.com/api-1.37/segment.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/segment.php?wsdl - test version
Requests Summary
• add — Create a new segment.
• delete — Delete a segment. (deprecated)
• get — Retrieve all information about the specified segment.
• getAll — Get all segments which you are authorized to see.
• getAncestorsInfo — Get all the ancestor list for all the segment ids (which you are authorized to view)
• getAncestorsPublicInfo — Get all the ancestor list for given public segment ids (which you are authorized to
view)
• getChildSegments — Get all the child segments of a particular type, which you are authorized to see.
• getDescendantsPublicInfo — Get the descendant list for all the given public segment ids (which you are
authorized to view)
• syncSegments — Single bulk method for doing add and update
• update — Modify a segment.
Requests
add
Create a new segment. Additionally for segments that have specified a parent, the new segment will be automatically
be shared with any segment buyers with whom the parent is already shared. Currently this works for content
segments.
Input parameters:
• segment $segment: New segment data object.
Output parameters:
• int $segment_id: segment id.
delete (deprecated)
Remove an existing segment data object. Note: Deleting any segment that you have shared via Audience Share will
targeting this segment and notify their owners. See Sharing or unsharing segments in the Audience marketplace for
details.
• Network
Input parameters:
• int $id: segment identifier
Output parameters:
none
130
Services
get
Return the full segment data object.
Input parameters:
• int $id: segment id.
Output parameters:
• segment $segment: segment data object.
getAll (read-only)
Return the array of segment objects which you are allowed to see according to security model.
• readonly
Input parameters:
• int $page_num
Output parameters:
• array_of_segment $segment: list of segments
getAncestorsInfo (read-only)
Return the array of parent segment objects of given segment ids, which you are allowed to see according to security
model.
• readonly
Input parameters:
• array_of_int $segment_ids: Array of segment ids
Output parameters:
• array_of_segment $segments: list of segments
getAncestorsPublicInfo (read-only)
Return the array of parent segment_public_info objects of given public segment ids, which you are allowed to see
according to security model.
131
Services
• readonly
Input parameters:
• array_of_int $public_segment_ids: Array of public segment ids
Output parameters:
• array_of_segment_public_info $segment_public_infos: list of segment public infos
getChildSegments (read-only)
Return the array of child segment objects of a particular type, which you are allowed to see according to security
model.
• readonly
Input parameters:
• int $parent_segment_id
• int $segment_type_id
Output parameters:
• array_of_segment $child_segments: list of child segments
getDescendantsPublicInfo (read-only)
Return the array of multiple_data_response objects and descendant segment_public_info objects of given public
segment ids, which you are allowed to see according to security model. Avaiable to content buyers only.
• readonly
Input parameters:
• array_of_int $public_segment_ids: Array of public segment ids
Output parameters:
• array_of_segment_public_info $segment_public_infos: list of segment public infos
syncSegments
Single bulk method for doing add and update. Creates new segment if id is not present in segment object. Updates
the segment if id is present and is_deleted is not present.
Input parameters:
• array_of_segment $segments: array of segment objects
132
Services
Output parameters:
• array_of_sync_segment_response $response: array of sync_segment_response
update
Change the fields of segment data object. Additionally for segments that are modifying their parent(re-parenting), the
segment shares will be adjusted(sharing removed or added) to ensure that the segment is now shared based on the
new parent segments existing shares. In case any shares are removed as a result of this operation the corresponding
line items will be deactivated. Note: Some fields are generated by API (e.g. segment::$id) and cannot be changed by
the client.
Input parameters:
• segment $segment: Modified segment data object.
Output parameters:
none
Sitelist Service
The sitelist service lets advertiser and publisher add Global Sitelist and advertiser site lists. See
http://kb.yieldmanager.com/article.php?id= for additional details.
• https://api.yieldmanager.com/api-1.37/sitelist.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/sitelist.php?wsdl
Requests Summary
• addGTSections — Add sections to given GT ID.
• createASL — Add a array of new ASL from a list of global templates and sections ids.
• createASLs — Add a array of new ASL from a list of global templates and sections ids.
• createGT — Add a new global sitelist template.
• createGTs — Add a array of new global sitelist template.
• duplicateASL — Duplicate existing ASL
• duplicateGT — Duplicate existing GT
• getAllASL — Gets the list of all the advertiser section list object for the logged in User.
• getAllGT — Gets the list of all the Global template object for the logged in User.
• getASL — Retrieves all information about the specified advertiser section list.
• getGT — Retrieves all information about the specified global template.
• removeGTSections — Remove sections from given GT ID.
• updateASL — Update a advertiser section list.
• updateASLs — Update a array of advertiser section list.
• updateGT — Update a global sitelist template.
• updateGTs — Update a array of global sitelist template.
Requests
addGTSections
Add specified sections to given GT ID.
133
Services
Input parameters:
• int $id: Global Template Id.
• array_of_int $section_ids: An array of Section Ids.
Output parameters:
none
createASL
Use to create a new advertiser_section_list.
Input parameters:
• advertiser_section_list $advertiser_section_list: represents a new advertiser_section_list data object.
Output parameters:
• int $asl_id: . Unique Id for the ASL.
createASLs
Use to create a array new advertiser_section_list.
Input parameters:
• array_of_advertiser_section_list $advertiser_section_lists: Array of $advertiser_section_list.
Output parameters:
createGT
Use to create a new section_custom_group.
Input parameters:
• global_template $global_template: represents a new global_template data object.
Output parameters:
• int $gy_id: The Global template ID.
createGTs
134
Services
Use to create a array new section_custom_group.
Input parameters:
• array_of_global_template $global_templates: Array of $global_templates.
Output parameters:
duplicateASL
Input parameters:
• int $asl_id: ID of Advertiser Section List to duplicate
Output parameters:
• int $new_asl_id: ID of new created Advertiser Section List.
duplicateGT
Input parameters:
• int $gt_id: ID of Global Template to duplicate
Output parameters:
• int $new_gt_id: ID of new created Global Template.
getAllASL (read-only)
Returns an array of advertiser_section_list you are allowed to see.
• readonly
Input parameters:
Output parameters:
• array_of_advertiser_section_list $advertiser_section_list: Array of $advertiser_section_list.
135
Services
getAllGT (read-only)
Returns an array of section_custom_group you are allowed to see.
• readonly
Input parameters:
Output parameters:
• array_of_global_template $GT: Array of $GTs.
getASL (read-only)
Returns the full advertiser data object.
• readonly
Input parameters:
• int $id: advertiser section list id
Output parameters:
• advertiser_section_list $advertiser_section_list: The $advertiser_section_list data object.
getGT (read-only)
Returns the full section_custom_group data object.
• readonly
Input parameters:
• int $id: Global Template id
Output parameters:
• global_template $global_template: The $global_template data object.
removeGTSections
136
Services
Remove specified sections from given GT ID.
Input parameters:
• int $id: Global Template Id.
• array_of_int $section_ids: An array of Section Ids.
Output parameters:
none
updateASL
Use to update a advertiser_section_list.
Input parameters:
• advertiser_section_list $advertiser_section_list: represents a new advertiser_section_list data object.
Output parameters:
• int $asl_id: The Advertiser Section List ID.
updateASLs
Use to update a array advertiser_section_list.
Input parameters:
• array_of_advertiser_section_list $advertiser_section_lists: Array of $advertiser_section_list.
Output parameters:
updateGT
Use to update a global_template.
Input parameters:
• global_template $global_template: represents a new global_template data object.
Output parameters:
• int $gy_id: The Global template ID.
137
Services
updateGTs
Use to update a array global_template.
Input parameters:
• array_of_global_template $global_templates: Array of $global_template.
Output parameters:
Site Service
This service lets you add/modify a site.
• https://api.yieldmanager.com/api-1.37/site.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/site.php?wsdl - test version
Requests Summary
• add — add a new site
• deleteAllPublisherControls — Deletes publisher controls for specified site id and buyer_entity_ids.
(deprecated)
• deletePublisherControls — Deletes publisher mask controls See Managing Publisher Controls Using the API
• get — retrieve all information about the specified site
• getAll — get all the sites you are authorized to see
• getAllPublisherControls — Gets publisher mask controls for specified site. (deprecated)
• getAllSince — Return sites changed between start_date and end_date.
• getByEntity — get the list of sites for the specified entity
• getPublisherControls — Gets the publisher mask controls See Managing Publisher Controls Using the API
• listAll — get the list of all site`s ids you are authorized to see
• listAllSince — Return site IDs changed between start_date and end_date.
• listByEntity — get the list of site's ids for the specified entity
• lookup — return the list of list of all site' ids for each given code
• setAllPublisherControls — Sets publisher mask controls for specified advertisers. (deprecated)
• setPublisherControls — Sets the publisher mask controls See Managing Publisher Controls Using the API for
more information on managing publisher controls. (deprecated)
• update — modify a site
Requests
add
Create a new site for the publisher specified by site::$publisher_entity_id.
Input parameters:
• site $site: new site data object
Output parameters:
138
Services
deleteAllPublisherControls (deprecated)
Input parameters:
• int $site_id: Specifies site id of managed pub entity_id or seat id (default) where the params are to be
hidden.
Output parameters:
deletePublisherControls (read-only) (deprecated)
Input parameters:
• int $site_id: Specifies managed pub's site
• int $buyer_entity_id: Advertiser entity id. Default value is 0. Value $buyer_entity_id=0 will delete publisher
Output parameters:
none
get (read-only)
Return the full site data object.
Input parameters:
• int $id: site identifier
Output parameters:
• site $site: site data object
getAll (read-only)
Return the array of site' objects which you are allowed to see according to security model.
139
Services
Input parameters:
• int $page_num
Output parameters:
• array_of_site $sites: array of sites
getAllPublisherControls (read-only) (deprecated)
Input parameters:
• int $site_id: Specifies site id of managed pub entity_id or seat id (default) for which publisher control masks
are to be fetched.
Output parameters:
Input parameters:
• string $token
• int $page_num
Output parameters:
• array_of_site $sites: array of sites
Return the array of site's data objects which belong to the entity specified by entity_id.
Input parameters:
140
Services
• int $page_num
Output parameters:
• array_of_site $sites: array of site
getPublisherControls (read-only) (deprecated)
Input parameters:
• int $site_id: Specifies managed pub's site
• int $buyer_entity_id: Advertiser entity id. Default value is 0. Value $buyer_entity_id=0 will get publisher
Output parameters:
• publisher_control_data $publisher_control_data: object containing mask control details
listAll (read-only)
Return the array of site' id which you are allowed to see according to security model. Use SiteService::get() to get
whole site data object by its id.
Input parameters:
Output parameters:
• array_of_int $site_ids: array of site id
Input parameters:
• string $token
Output parameters:
141
Services
Return the array of site's ids which belong to the entity specified by entity_id. Use SiteService::get() to get the whole
site's data object by its id.
Input parameters:
Output parameters:
• array_of_int $site_ids: array of site id
lookup
Return the array of arrays of site' ids for each code You can use SiteService::get() to get the whole site data object by
its id.
Input parameters:
• array_of_string $codes: line_item codes
Output parameters:
• array_of_array_of_int $site_ids
setAllPublisherControls (deprecated)
Input parameters:
• int $site_id: Specifies site id of managed pub entity_id or seat id (default) where the params are to be
hidden.
Output parameters:
setPublisherControls (read-only) (deprecated)
Input parameters:
142
Services
• array_of_enum_pub_control_param $hidden_params: Parameters to be masked
• int $site_id: Specifies managed pub's site where the params are to be hidden
• int $buyer_entity_id: Advertiser entity id. Default value is 0. This will set publisher control mask globally i.e.
at network level.
Output parameters:
none
update
Change the fields of site data object. Please keep in mind that some fields are generated behind API (e.g. site::$id)
and cannot be changed by client.
Input parameters:
• site $site: modified site data object
Output parameters:
none
SupplyBlocklist Service
This service lets you add/modify/delete/get supply blocklists.
Review the Supply blocklist section in the Yield Manager Knowledge Base for additional details.
• https://api.yieldmanager.com/api-1.37/supply_blocklist.php?wsdl - production version
• https://api-test.yieldmanager.com/api-1.37/supply_blocklist.php?wsdl - test version
Requests Summary
• add — Add/Create blocklist for supply from accessing (a slice of) managed supply of the network.
• delete — Deletes a supply blocklist
• getAllBlocklists — Returns an array of all supply blocklist you are allowed to access.
• getAllSince — Return all supply blocklist changed between a specified start_date and end_date.
• getByObjectId — Returns the supply_blocklist data object for specified id.
• getVurls — Gets list of Vurls for specific rule id/pattern.
• listAll — Returns supply_blocklist data object ids that you are allowed to access.
• listAllSince — Return supply blocklist IDs changed between a specified start_date and end_date.
• quickSearch — Returns an array of all supply blocklist you are allowed to access.
• setVurls — Creates blocklist for VURL.
• update — Modify a supply blocklist.
Requests
add
Add a new supply_blocklist.
Input parameters:
143
Services
• supply_blocklist $supply_blocklist: New supply_blocklist data object.
Output parameters:
• int $id: Id of supply blocklist.
delete
Removes an existing supply_blocklist object.
Input parameters:
• int $supply_blocklist_id: Supply Blocklist ID.
Output parameters:
none
getAllBlocklists (read-only)
Returns an array of all supply blocklist you are allowed to access.
Input parameters:
• blocklist_search_options $blocklist_search_options: Search options.
Output parameters:
• array_of_blocklist_getall $supply_blocklist
Return supply blocklist IDs changed between a specified start_date and end_date. Note: This method sets the
Input parameters:
Output parameters:
• array_of_supply_blocklist $supply_blocklist: An array of supply blocklist objects.
144
Services
Returns the supply_blocklist data object for specified id.
Input parameters:
• int $supply_blocklist_id: Id of supply blocklist data object.
Output parameters:
• supply_blocklist $supply_blocklist
getVurls (read-only)
Gets list of Vurls for specific rule id/pattern.
Input parameters:
• string $pattern: Pattern for vurl.
• boolean $is_universal_search: Set to false if search is for selected vurl against supply_blocklist_id else
true. Default value is false.
Output parameters:
• array_of_vurl_get_data $vurl_data
listAll (read-only)
Returns supply_blocklist data object ids that you are allowed to access.
Input parameters:
Output parameters:
• array_of_int $blocklist_ids
Return supply blocklist IDs changed between a specified start_date and end_date. Note: This method sets the
145
Services
Input parameters:
Output parameters:
• array_of_int $ids: An array of supply blocklist IDs.
Input parameters:
Output parameters:
• array_of_blocklist_getall $supply_blocklist
setVurls
Creates blocklist for VURL.
Input parameters:
• array_of_int $add_vurl_ids: VURL ids to be added.
• array_of_int $remove_vurl_ids: VURL ids to be removed.
• boolean $include: Set flag include to "true" to include or "false" to exclude the ids provided $add_vurl_ids.
By default value its true.
Output parameters:
none
update
Modify fields of supply_blocklist data object.
Input parameters:
• supply_blocklist $supply_blocklist.: Modified supply_blocklist data object.
Output parameters:
none
146
Services
TargetProfile Service
The TargetProfileService lets you manage targeting rules for target profiles. Use targeting rules on buyer and seller
line items to control traffic, delivery, and ensure that users see appropriate ads on appropriate inventory. See
Targeting rules defined for more information.
• https://api.yieldmanager.com/api-1.37/target_profile.php?wsdl
• https://api-test.yieldmanager.com/api-1.37/target_profile.php?wsdl
Requests Summary
• addApprovedCreatives — Adds approved creatives.
• addBannedCreatives — Adds banned creatives to a given target profile.
• addCustomGeoArea — Adds a new Custom Geographic Area under current entity. Custom Geographic Area
is a grouping of postal codes (zip bundle) within a country for targeting usage
• addMUTP — Adds a secondary target profile.
• applyDefaultTargetProfile — Applies a default target profile to the specified object.
• copyTargetProfile — Copies a target profile.
• createDefaultTargetProfile — Creates a default target profile.
• deleteDefaultTargetProfile — Deletes a specified default target profile.
• deleteMUTP — Deletes a secondary target profile.
• deleteTargetClickUrls
• deleteTargetCreatives — Delete targeted creative IDs.
• flipCreativeDefault — Changes the default creative status.
• get — Retrieves all the target profile objects for the specified target profile ID.
• getAllCustomGeoAreas — Returns all Custom Geographic Area objects for current entity
• getAllSince — Return all target profiles changed between a specified start_date and end_date.
• getAvailableTargetings — Returns an array of targeting types that apply to the given object.
• getByObject — Return target_profile and targetings objects by specified object.
• getCustomGeoArea — Returns Custom Geographic Area object for a given Custom Geographic Area id
• getDefaultTargetProfiles — Returns a list of default target profile IDs.
• getGeoTargetingVersion — Returns type of Geo targeting applied on owner
• getMUTP — Retrieve secondary target profiles
• getTargetAdvertisers — Returns an array of targeting rules by advertiser ID.
• getTargetAges — Returns an array of targeted ages.
• getTargetASLs — Returns an array of targeting ASLs.
• getTargetBrowsers — Returns an array of browser targeting IDs.
• getTargetBuyerLineItems — Returns an array of targeted advertiser line item IDs.
• getTargetBuyers — Returns an array of targeted advertiser IDs.
• getTargetChannels — Returns an array of included or excluded publisher channel IDs.
• getTargetClickUrls — Returns an array based on click URL targeting.
• getTargetClickUrlsV2 — Return an array of click URL targeting
• getTargetContentCategories — Returns an array of content categories
• getTargetCreativeBeacons — Returns an array of creative beacon IDs.
• getTargetCreatives — Returns an array of targeted creative IDs.
• getTargetCreativeSpecs — Returns an array of targeted creative specs. (deprecated)
• getTargetCreativeTags — Returns an array of creative tag IDs.
• getTargetCSL — Returns an array of targeting ASLs.
• getTargetDayparts — Returns an array of daypart targeting rules.
• getTargetDealProperties — Returns an array of targeting rules by deal properties.
• getTargetFrequency — Returns an array of frequency cap targeting settings: amount and time interval.
• getTargetGender — Returns an array of gender targeting.
• getTargetGeography — Returns an array of geographic targeting rules.
• getTargetGeographyV2 — Returns the list of targeted WOEIDs and CGA ids.
• getTargetInventoryTypes — Returns an array of targeting rules for the specified inventory type.
• getTargetIsps — Returns an array of commercial Internet Service Provider (ISP) IDs.
• getTargetLanguages — Returns an array of language IDs targeted to a browser.
• getTargetNetspeeds — Returns an array of netspeed (Internet connection speed) IDs.
• getTargetOfferTypes — Returns an array of offer type IDs.
• getTargetPixels — Returns an array of pixel targeting information.
• getTargetPrivateMarketPlace — Returns targeting rule by included or excluded Private Marketplace IDs.
• getTargetPublishers — Returns an array of entity IDs for a particular publisher or group of publishers.
• getTargetQueryString — Returns an array of query string targeting information.
• getTargetRating — Returns a maximum allowed rating.
147
Services
• getTargetSections — Returns an array of targeting rules by included or excluded section IDs.
• getTargetSellerLineItems — Returns an array of targeted publisher line item IDs.
• getTargetSizes — Returns an array of included or excluded creative size IDs.
• getTargetTechno — Returns current techno targeting for the target profile,which is an array of
segment_hierarchy_id which corresponds to Carrier/OS/Browser/Device segments.
• getTargetUrls — Returns an array based on URL targeting.
• getTargetValidatedUrls — Returns an array of targeting rules by validated URL (VURL).
• getTargetVurlTags — Returns an array of validated URL (VURLS) IDs.
• getTargetWifi — Returns true if Wifi is enabled for the target_profile. false otherwise.
• listAllSince — Return target profile IDs changed between a specified start_date and end_date.
• listDefaultTargetProfiles — Returns all target profile IDs by specified entity ID.
• moveTargetClickUrls
• overwriteDefaultTargetProfile — Overwrites a default target profile.
• resetTargeting — Resets all targeting on the specified owner.
• searchTargetClickUrlsV2 — Return an array of click URL targeting
• searchVurls — Search for VURLs based on specified category, description, or other qualities.
• setTargetAdvertisers — Limits delivery to particular advertisers based on the specified advertiser ID.
• setTargetAges — Limits delivery to particular users based on age.
• setTargetASLs — Limits delivery to particular sections on publishers' sites based on the section IDs in the
ASL.
• setTargetBrowsers — Limits delivery to particular web browsers.
• setTargetBuyerLineItems — Limits delivery by the specified advertiser line item IDs.
• setTargetBuyers — Limits delivery by advertiser ID.
• setTargetChannels — Limits delivery to particular publisher content channels.
• setTargetClickUrls — Limits delivery based on a particular click URL, groups of clickthrough URLs or click
URL patterns.
• setTargetClickUrlsV2 — Limits delivery based on a particular click URL, groups of clickthrough URLs or click
URL patterns.
• setTargetContentCategories — Limits delivery to supply matching the specified content categories.
• setTargetCreativeBeacons — Limits delivery of creatives by one or more beacons.
• setTargetCreatives — Limits delivery to creative IDs that the publisher has approved.
• setTargetCreativeSpecs — Limits delivery based on creative specs. (deprecated)
• setTargetCreativeTags — Limits delivery of creatives by one or more creative specs or themes
• setTargetCSL — Exclude delivery to particular sections on publishers' sites based on the section IDs in the
CSL.
• setTargetDayparts — Limits delivery to particular days or parts of a day (daypart targeting).
• setTargetDealProperties — Limits delivery by deal properties.
• setTargetFrequency — Limits delivery frequency.
• setTargetGender — Limits delivery to particular users based on gender.
• setTargetGeography — Limits delivery based on particular geographic areas.
• setTargetGeographyV2 — Limits delivery to particular Placetypes (i.e, countries, states, counties, metros and
cities) represented by WOEID(Where On Earth ID) and/or to particular Custom Geographic Areas(CGAs).
• setTargetInventoryTypes — Limits delivery to a specified inventory type ID.
• setTargetIsps — Limits delivery to particular commercial Internet service providers (ISPs).
• setTargetLanguages — Limits delivery to specified languages.
• setTargetNetspeeds — Limits delivery to particular Internet connection speeds (netspeed).
• setTargetOfferTypes — Limits delivery by offer type.
• setTargetPixels — Limits delivery to users who have already triggered one or more specified pixels.
• setTargetPrivateMarketPlace — Limits delivery to particular private marketplace on the exchange.
• setTargetPublishers — Limits delivery to a particular publisher or group of publishers.
• setTargetQueryString — Limits delivery by publisher query string.
• setTargetRating — Limits delivery by MPAA (publisher section) ratings.
• setTargetSections — Limits delivery to particular sections on publishers' sites based on the section ID.
• setTargetSellerLineItems — Limits delivery by the specified publisher line item IDs.
• setTargetSizes — Control delivery by creative size.
• setTargetTechno — Associates techno_ids to the target profile. techno_ids corresponds to
Carrier/OS/Browser/Device segments.
• setTargetUrls — Limits delivery to a particular URL or group of URLs.
• setTargetValidatedUrls — Limits delivery to validated URLs (VURLs).
• setTargetVurlTags — Limits delivery to particular validated URLs (VURLs) IDs.
• setTargetWifi — Associates/Deassociates Wifi for the target_profile depending upon the input
• updateTargetProfile — Updates a given target profile object.
Requests
addApprovedCreatives
Adds approved creatives to a given target profile.
148
Services
• available : entity, creative, campaign, line_item, secondary_target_profile
Input parameters:
• enum_target_profile_owner_type_ext $owner_type: Defines the object that owns the target profile. See
Using the target_profile_owner_type and target_profile_owner_id variables for more details.
• int $owner_id: Defines the owning object ID. See Using the target_profile_owner_type and
target_profile_owner_id variables for more details.
• array_of_int $creative_ids: An array of creative IDs.
Output parameters:
none
addBannedCreatives
Adds banned creatives to a given target profile.
• available : entity, creative, campaign, line_item, secondary_target_profile
Input parameters:
• array_of_int $creative_ids: An array of creative IDs.
Output parameters:
none
addCustomGeoArea
Input parameters:
• custom_geo_area $custom_geo_area: This variable represents new custom geo area data object.
Output parameters:
• int $custom_geo_area_id: ID of newly created custom geo area.
addMUTP
Adds secondary targeting to given target profile. See Multiple universal targeting profiles for more details. Note: You
must use Universal Targeting to set secondary target profiles. See Universal targeting: About for more details.
Input parameters:
• string $token: This variable represents an active session token. See Using the target_profile_owner_type
and target_profile_owner_id variables for more details.
Output parameters:
• int $target_profile_id: The created target profile ID.
149
Services
applyDefaultTargetProfile
Applies a default target profile to the specified object.
Input parameters:
• enum_target_profile_owner_type $owner_type: Defines the object that owns the target profile. See Using
the target_profile_owner_type and target_profile_owner_id variables for more details.
• int $default_tp_id: Default target profile ID.
Output parameters:
• int $id_target_profile: The created target profile ID.
copyTargetProfile
Creates a copy of a given target profile and assigns it to another target profile.
Input parameters:
• int $object_id_from: Target profile ID being copied.
• int $object_id_to: Target profile ID being overwritten.
Output parameters:
• int $id_target_profile: Newly copied target profile ID.
createDefaultTargetProfile
Copies a given target profile data to a new one, applies a given name to it, and creates a default target profile with the
copied data.
Input parameters:
• int $object_id_from
• string $default_profile_name: Default target profile name.
Output parameters:
• int $default_target_profile_id: Default target profile ID.
deleteDefaultTargetProfile
Deletes a specified default target profile.
150
Services
Input parameters:
Output parameters:
none
deleteMUTP
Deletes a secondary target profile. See Multiple universal targeting profiles (MUTP) for more details. Note: You must
use Universal Targeting to set secondary target profiles. See Universal targeting: About for more details.
Input parameters:
Output parameters:
none
deleteTargetClickUrls
Input parameters:
• enum_demand_source $demand_source: This variable represents enum('all', 'hosted', 'rtbd')
• array_of_string $urls: An array of specified clickthrough URLs to be removed.
• boolean $delete_all: Default is "false" Setting "true" Will delete all entries from current target list, parameter
'urls' will be ignored.
Output parameters:
• array_of_multiple_result $results: Array of $results.
deleteTargetCreatives
Delete targeted creative IDs.
• available : line_item, entity, secondary_target_profile
Input parameters:
• array_of_int $creative_ids: Creative ID array.
Output parameters:
151
Services
flipCreativeDefault
In Universal Targeting, used to change the default ban/approve status for creatives. See Creative Reviewer: Overview
for more details.
Input parameters:
Output parameters:
none
get
Retrieves all the target profile objects for the specified target profile ID.
Input parameters:
Output parameters:
• target_profile $target_profile: Extended target profile object.
• targetings $targetings: Returns Returns the targeting fields described at array_of_targetings.
getAllCustomGeoAreas (read-only)
Input parameters:
• boolean $return_postal_codes: Default value is "true". Setting it to "false" will exclude postal codes in
custom geographic area objects.
Output parameters:
• array_of_custom_geo_area $custom_geo_area: Custom geo area objects for current entity.
Return target profile IDs changed between a specified start_date and end_date. Note: This method sets the start_date
= '0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or less.
Input parameters:
152
Services
Output parameters:
• array_of_target_profile $target_profiles: An array of target profile objects.
getAvailableTargetings (read-only)
Return an array of strings which represent the current targeting for the given object type and object ID. For example, if
this method was called as getAvailableTargetings(token_id, 'campaign', tp_id), it would return something like this:
array('channel', 'size', 'isp'), depending on what kind of targeting had been set.
Input parameters:
Output parameters:
• array_of_string $available_targetings: An array of available targeting types.
getByObject
Return target_profile and targetings objects by specified entity, creative, campaign, or line_item.
Input parameters:
• enum_target_object_name $object_name: Object name.
• int $object_id: Object ID.
Output parameters:
• target_profile $target_profile: Extended target profile object.
• targetings $targetings: Returns Returns the targeting fields described at array_of_targetings.
getCustomGeoArea (read-only)
Input parameters:
• int $custom_geo_area_id: This variable represents custom geo area id.
Output parameters:
• custom_geo_area $custom_geo_area: Custom geo area object.
153
Services
getDefaultTargetProfiles
Returns a list of default target profile IDs.
Input parameters:
Output parameters:
• array_of_default_target_profile $default_target_profiles: An array of default target profile IDs.
getGeoTargetingVersion (read-only)
Input parameters:
• enum_target_profile_owner_type_ext $owner_type: Target profile owner type.
• int $owner_id: Target profile owner identifier.
Output parameters:
• enum_geo_targeting_version $geo_targeting_version: Type of targeting applied on owner, Geo V1:
country/region targeting, Geo V2: woeid/cga targeting. If no targeting is applied, Geo V2 will be returned.
getMUTP (read-only)
Retrieve secondary target profiles See Multiple universal targeting profiles for more details. Note: You must use
Universal Targeting to set secondary target profiles. See Universal targeting: About for more details.
• readonly
Input parameters:
• int $is_default_mutp: Returns default MUTP if this flag is set (1), and other MUTPs if not set (0)
Output parameters:
• array_of_int $mutp_id: The ids of the secondary target profiles.
getTargetAdvertisers (read-only)
Returns an array of targeting rules by advertiser ID.
• available : line_item
Input parameters:
154
Services
Output parameters:
• boolean $advertiser_default: Set "true" to exclude or "false" to include particular advertiser IDs in the
$advertisers_ids array.
• array_of_int $advertiser_ids: An array of advertiser IDs.
getTargetAges (read-only)
Returns an array of targeted ages.
• available : line_item, campaign, secondary_target_profile
Input parameters:
Output parameters:
• boolean $age_default: default age Set "true" to exclude or "false" to include particular age IDs in the
$target_age array. See Using Boolean method_name_default variables for details.
• array_of_int $target_age: An array of targeted ages.
getTargetASLs (read-only)
• available : line_item, secondary_target_profile, entity
Input parameters:
target_profile_owner_id variables for more details. See Using Boolean method_name_default variables for
details.
Output parameters:
• array_of_int $asl_id: An array of asl IDs.
getTargetBrowsers (read-only)
Returns an array of based on browser targeting. See Browser Enum for more information.
Input parameters:
155
Services
Output parameters:
• boolean $browser_default: Set "true" to exclude or "false" to include particular browser IDs in the
$browser_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $browser_ids: An array of browser IDs.
getTargetBuyerLineItems (read-only)
Returns an array of targeted advertiser line item IDs.
Input parameters:
Output parameters:
• boolean $buyer_line_item_default: Set "true" to exclude or "false" to include particular line item IDs in the
$line_items array. See Using Boolean method_name_default variables for details.
• array_of_int $line_items: An array of line item IDs.
getTargetBuyers (read-only)
Returns an array of targeted advertiser IDs.
Input parameters:
• int $owner_id: target Defines the owning object ID. See Using the target_profile_owner_type and
Output parameters:
• boolean $buyer_entity_default: Set "true" to exclude or "false" to include particular advertiser IDs in the
$buyer_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $buyer_ids: An array of buyer IDs.
getTargetChannels (read-only)
Returns an array of included or excluded publisher channel IDs. Channels are categories that describe the content of
publisher inventory, such as Entertainment, Real Estate, Gaming, Search and Shopping.
If $channel_default is set to:
• True: Exclude the specified channels and include all others.
• False: Include the specified channels and exclude all others.
156
Services
See Channel Enum for more information. Accessible for all entity types
• available : line_item, secondary_target_profile, creative, campaign
Input parameters:
Output parameters:
• boolean $channel_default: Set "true" to exclude or "false" to include particular publisher channel IDs in the
arrays. See Using Boolean method_name_default variables for details.
• array_of_int $include_channel_ids: An array of included channel IDs.
• array_of_int $exclude_channel_ids: An array of excluded channel IDs.
getTargetClickUrls (read-only)
Returns an array based on click URL targeting.
Input parameters:
Output parameters:
• boolean $click_url_default: Set to "true" to exclude or "false" to include particular click URLs in the $urls
array. See Using Boolean method_name_default variables for details.
• array_of_string $urls: An array of click URLs or click URL search patterns.
getTargetClickUrlsV2 (read-only)
Return an array of click URL targeting
Input parameters:
• int $owner_id: Defines the owning object ID. See http://kb.yieldmanager.com/article.php?id=581
• enum_demand_source $demand_source: Defines value of the demand source
• int $entries_on_page: Defines the entries on page.
• int $page_num: Defines the page number. Using the target_profile_owner_type and target_profile_owner_id
variables} for more details.
Output parameters:
• enum_click_url_default $click_url_default: Available values are 'Whitelist', 'Blocklist', 'NoTargeting' See
Using Boolean method_name_default variables for details.
• int $total_count: Defines the count of result set
157
Services
getTargetContentCategories (read-only)
Returns an array of content categories. API signature is similar to TargetProfileService::getTargetPixels()
• available : line_item, campaign, creative
Input parameters:
Output parameters:
• boolean $require_all: Passes in simple Boolean "and" "or" expressions to include or exclude pixel IDs in the
$target_pixels array.
• array_of_target_pixel $target_pixels: An array of targeted pixel objects.
• string $logical_expression: This variable represents complex Boolean operators used to include or exclude
pixel IDs in the $target_pixels array.
getTargetCreativeBeacons (read-only)
See Targeting Creative Beacons Using the API for more information on targeting creative beacons.
• Creative beacons targeting is available on owner_type 'entity' if the current entity is not enabled for Multiple
Universal target profile (STPs), and there are no default STP.
• available : entity, line_item, secondary_target_profile
Input parameters:
Output parameters:
• boolean $creative_beacon_default: Set "true" to exclude or "false" to include particular beacon IDs in the
$creative_beacons_id_list array.
• array_of_int $creative_beacons_id_list: An array of creative beacon IDs.
getTargetCreatives (read-only)
Returns an array of targeted creative IDs.
Input parameters:
158
Services
Output parameters:
• boolean $creative_default: Set "true" to exclude or "false" to include particular creative IDs in the
$creative_ids array. See Using Boolean method_name_default variables for details.
getTargetCreativeSpecs (read-only) (deprecated)
Returns an array of targeted creative specs.
This method is deprecated. Use TargetProfileService::getTargetCreativeTags().
• available : line_item, secondary_target_profile
Input parameters:
Output parameters:
• creative_specs $creative_specs: Returns creative specs IDs.
getTargetCreativeTags (read-only)
Returns an array of creative tag IDs that limit the delivery of creatives by one or more creative specs or themes. For
more details:
• Banning creatives using the API
• Creative specs
• Creative themes
• Creative tags targeting is available on owner_type 'entity' if the current entity is not enabled for Multiple
Universal target profile (STPs), and there are no STPs.
Input parameters:
Output parameters:
• array_of_int $creative_tags_id_list: An array of creative tag IDs.
getTargetCSL (read-only)
159
Services
Input parameters:
target_profile_owner_id variables for more details. See Using Boolean method_name_default variables for
details.
Output parameters:
• array_of_int $csl_id: An array of csl IDs.
getTargetDayparts (read-only)
Returns an array of daypart targeting rules.
• available : campaign, line_item, creative
Input parameters:
Output parameters:
• int $relative_time_region_id: ID of a region targeting is relative to (0 - relative to user's time, otherwise
relative to the region specified by this ID).
• array_of_daypart $dayparts: An array containing daypart targeting information.
getTargetDealProperties (read-only)
Returns an array of targeting rules by deal properties. A deal property is a type of pricing available for a campaign or
line item. Setting targeting by deal property will limit delivery of the targeted object to targets using the desired pricing.
For example, if you want to deliver to targets using CPC (cost-per-click) pricing, set the $allow_cpc property of
$deal_properties to true. See Pricing options for line items and campaigns for more details.
• available : line_item, entity
Input parameters:
Output parameters:
• deal_properties $deal_properties: Defines the desired deal property targets.
160
Services
getTargetFrequency (read-only)
Returns an array of frequency cap targeting settings: amount and time interval. See Frequency capping for line items
for more details.
Input parameters:
Output parameters:
• int $frequency: Maximum count.
• int $period: The display time interval in seconds.
getTargetGender (read-only)
Returns an array of gender targeting.
Input parameters:
Output parameters:
• gender_target $gender_target: This variable defines the gender target.
getTargetGeography
Limits delivery to particular geographic areas (country, region, state, province, etc.) or from particular Designated
Marketing Area (DMA). Note: Selecting all DMAs is the same as targeting to the US only. See tutorial:
• Country Enum
• Region Enum
• Msa Enum
This function is used only for any existing targeting profile with some old geo targeting already selected otherwise
setTargetGeographyV2 function will be used in all other cases which uses woeid and cga targeting. To shift from old
geo targeting to new woeid and cga targeting one just need to delete any existing old targeting and set the targeting
"show to all".
Input parameters:
161
Services
Output parameters:
• array_of_int $country_ids: An array of country IDs.
• boolean $use_regions: Set "true" to target by entire countries, regions, or both. Set "false" to target by
DMA. See Using Boolean method_name_default variables for details.
• array_of_int $region_ids: An array of region IDs.
• array_of_int $dma_ids: An array of DMA IDs.
getTargetGeographyV2
Returns the list of targeted WOEIDs and CGA ids.
Input parameters:
Output parameters:
• array_of_int $woeids: An array of WOEIDs.
• array_of_int $custom_geo_area_ids: An array of CGA IDs.
getTargetInventoryTypes (read-only)
Returns an array of targeting rules for the specified inventory type. See Inventory Type Enum for more information.
Input parameters:
Output parameters:
• boolean $inventory_type_default: Set to "true" to exclude or "false" to include particular inventory type IDs
in the $inventory_type_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $inventory_type_ids: Arry of inventory type IDs.
getTargetIsps (read-only)
Returns an array of commercial Internet Service Provider (ISP) IDs. See Isp Enum for more information.
Input parameters:
162
Services
Output parameters:
• boolean $isp_default: Set "true" to exclude or "false" to include particular ISP IDs in the $isp_ids array. See
• array_of_int $isp_ids: An array of ISP IDs.
getTargetLanguages (read-only)
Returns an array of language IDs targeted to a browser. See Language Enum for more information.
Input parameters:
Output parameters:
• boolean $language_default: Set "true" to exclude or "false" to include particular language IDs in the
$language_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $language_ids: An array of language IDs.
getTargetNetspeeds (read-only)
Returns an array of netspeed (Internet connection speed) IDs. See Netspeed Enum for more information.
Input parameters:
Output parameters:
• boolean $netspeed_default: Set "true" to exclude or "false" to include particular netspeeds in the
$netspeed_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $netspeed_ids: An array of netspeed IDs.
getTargetOfferTypes (read-only)
Returns an array of offer type IDs.
• Offer type targeting is available on owner_type 'entity' if the current entity is not enabled for Multiple Universal
target profile (STPs), and there are no STPs.
163
Services
Input parameters:
Output parameters:
• boolean $offer_type_default: Set "true" to exclude or "false" to include particular offer type IDs in the
$offery_type_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $offer_type_ids: An array of offer type IDs.
getTargetPixels (read-only)
Returns an array of pixel targeting information. Use the PixelService::setCreatives() function to bind a pixel to a group
of creatives. Note: This method uses Boolean expressions to determine the pixel combination included or excluded in
the $require_all variable. See Using logical expressions with select TargetProfileService methods for details. This call
can work in two modes: simple and advanced. The former mode requires only the first four parameters to be defined,
the latter - all but $query_string_option. $query_strings array defines strings to be used with either
$query_string_option (simple mode) or $query_string_logical_expression (advanced mode).
It is allowed to use the following logical operations in logical expressions:
• conjunction: *, &, and
• disjunction: +, |, or
• negation: /, ~, not
• exclusive disjunction: @, xor
• equality: =, equ
Since some combinations of AND, OR and NOT can lead to ambiguous cases, it is permitted to use parentheses to
clarify the order of operations.
Input parameters:
Output parameters:
• boolean $require_all: Passes in simple Boolean "and" "or" expressions to include or exclude pixel IDs in the
• string $logical_expression: This variable represents complex Boolean operators used to include or exclude
pixel IDs in the $target_pixels array.
getTargetPrivateMarketPlace (read-only)
Returns targeting rule by included or excluded Private Marketplace IDs.
• available : Advertiser line_item
Input parameters:
164
Services
• enum_target_profile_owner_type_pvt_marketplace $owner_type: Defines the object that owns the target
profile. See Using the target_profile_owner_type and target_profile_owner_id variables for more details.
Output parameters:
• boolean $pvt_marketplace_default: Set "true" to exclude or "false" to include particular pvt_marketplace Id.
See Using Boolean method_name_default variables for details.
• array_of_int $pvt_marketplace_ids: An array of Private Marketplace IDs.
getTargetPublishers (read-only)
Returns an array of entity IDs for a particular publisher or group of publishers.
Input parameters:
Output parameters:
• boolean $publisher_default: Set "true" to exclude or "false" to include particular publishers in the
$publisher_entity_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $publisher_entity_ids: An array of publisher entity IDs.
getTargetQueryString (read-only)
Return the query strings targeting information. $query_strings array defines strings to be used with either
$query_string_option (simple mode) or $query_string_logical_expression (advanced mode).
See Using logical expressions with select TargetProfileService methods for more details.
Input parameters:
• enum_target_profile_owner_type_ext $owner_type: target profile owner type
Output parameters:
• enum_query_string_option $query_string_option: This variable represents simple Boolean "and" "or"
expressions.
• array_of_string $query_strings: Defines strings to be used with either $query_string_option or
$query_string_logical_expression.
• string $query_string_logical_expression: This variable represents complex Boolean operators used to
include or exclude query string IDs.
getTargetRating (read-only)
Returns a maximum allowed rating. See Rating Enum for more information.
165
Services
Input parameters:
Output parameters:
• string $rating: Most restrictive settings permitted by the target profile.
getTargetSections (read-only)
Returns an array of targeting rules by included or excluded section IDs.
Input parameters:
Output parameters:
• boolean $section_default: Set "true" to exclude or "false" to include particular section IDs in the
$section_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $section_ids: An array of section IDs.
getTargetSellerLineItems (read-only)
Returns an array of targeted publisher line item IDs.
Input parameters:
Output parameters:
• boolean $seller_line_item_default: Set "true" to exclude or "false" to include particular publisher line item
IDs in the $line_items array. See Using Boolean method_name_default variables for details.
• array_of_int $line_items: An array of of line item IDs.
getTargetSizes (read-only)
Returns an array of included or excluded creative size IDs. See Size Enum for more information.
166
Services
• available : campaign, line_item
Input parameters:
Output parameters:
• boolean $size_default: Set "true" to exclude or "false" to include particular size IDs in the $size_ids array.
See Using Boolean method_name_default variables for details.
• array_of_int $size_ids: An array of size IDs.
getTargetTechno (read-only)
• available : line_item, creative
Input parameters:
Output parameters:
• array_of_int $included_techno_ids: techno_ids of segment_hierarchy_id which corresponds to
Carrier/OS/Browser/Device segments and are deonted as include in the targeting information.
• array_of_int $excluded_techno_ids: techno_ids of segment_hierarchy_id which corresponds to
Carrier/OS/Browser/Device segments and are deonted as excluded in the targeting information.
getTargetUrls (read-only)
Returns an array based on URL targeting.
Input parameters:
Output parameters:
• boolean $url_default: Set to "true" to exclude or "false" to include particular URLs in the $urls array. See
• array_of_string $urls: An array of URLs or URL search patterns.
getTargetValidatedUrls (read-only)
Returns an array of targeting rules by validated URL (VURL).
167
Services
• available : campaign, line_item, secondary_target_profile, entity
Input parameters:
Output parameters:
• vurl_options $options: Set "true" to exclude or "false" to include particular VURL categories in the VURL
IDs array.
• array_of_int $vurl_ids: An array of VURL IDs.
getTargetVurlTags (read-only)
Returns an aray of validated URLs (VURLS) IDs.
• available : campaign, line_item, secondary_target_profile
Input parameters:
Output parameters:
• array_of_int $vurl_tag_ids: Array of VURL tag IDs.
getTargetWifi (read-only)
Input parameters:
Output parameters:
• boolean $is_wifi: returns whether wifi targeting is set or not.
• boolean $is_excluded: returns if true wifi is excluded, returns false is wifi users are included.
Return target profile IDs changed between a specified start_date and end_date. Note: This method sets the start_date
= '0000-00-00 00:00:00' and end_date = now by default. Restrict your date/time interval to 24 hours or less.
168
Services
Input parameters:
Output parameters:
• array_of_int $ids: An array of IDs.
listDefaultTargetProfiles
Returns all target profile IDs by specified entity ID.
Input parameters:
Output parameters:
• array_of_int $tp_ids: An array of default target profile IDs.
moveTargetClickUrls
Input parameters:
• enum_move_targeting $from_list: This variable represents enum('all', 'hosted-rtbd').
• enum_move_targeting $to_list: This variable represents enum('all', 'hosted-rtbd').
• enum_move_click_url_default $click_url_default: Available values are 'Whitelist', 'Blocklist', 'Default'.
Output parameters:
• boolean $result: True - Success. False - Failure
overwriteDefaultTargetProfile
overwriteDefaultTargetProfile:
• Copies values from a given target profile to an existing default target profile.
• Sets the target profile name.
Input parameters:
• int $object_id_from: Target profile ID being copied.
• int $default_tp_id_to,: Target profile ID being overwritten.
• string $default_profile_name,: The newly overwritten target profile name.
169
Services
Output parameters:
none
resetTargeting
Resets all targeting on the specified owner. Note: When the owner is a line item, this method can only be used to
delete target profiles on non-linked line items.
Input parameters:
Output parameters:
none
searchTargetClickUrlsV2 (read-only)
Return an array of click URL targeting
Input parameters:
• int $owner_id: Defines the owning object ID. See http://kb.yieldmanager.com/article.php?id=581
• enum_demand_source $demand_source: Defines value of the demand source
• string $search_option: Defines search pattern for the url.
• int $entries_on_page: Defines the entries on page.
• int $page_num: Defines the page number. Using the target_profile_owner_type and target_profile_owner_id
variables} for more details.
Output parameters:
• enum_click_url_default $click_url_default: Available values are 'Whitelist', 'Blocklist', 'NoTargeting' See
• int $total_count: Defines the count of result set
searchVurls (read-only)
Returns a list of VURLs filtered by vurl search options. To use this method:
• Create a VURL search options object with the constraints of your search.
• Pass it to the searchVurls method.
• readonly
Input parameters:
• vurl_search_options $search_options: Search parameters.
Output parameters:
170
Services
• array_of_vurl $vurls: An array of VURLs.
setTargetAdvertisers
Limits delivery to particular advertisers based on the specified advertiser ID. Use setTargetAdvertisers to exclude any
advertiser in the Exchange that you never want to run through your inventory, such as a competing advertiser or an
advertiser that your company doesn't want to do business with.
Input parameters:
• boolean $advertiser_default: Set "true" to exclude or "false" to include particular advertiser IDs in the
$advertiser_ids array. See Using Boolean method_name_default variables for more details.
• array_of_int $advertiser_ids: An array of advertiser IDs.
• boolean $append: Set "true" to add target size settings on an existing profile. Set "false" to overwrite the
existing profile.
Output parameters:
none
setTargetAges
Limits delivery to particular users based on age.
Input parameters:
• boolean $age_default: default age Set "true" to exclude or "false" to include particular age IDs in the
$target_age array. See Using Boolean method_name_default variables for details.
• array_of_int $target_age: target ages An array of targeted ages.
existing profile.
Output parameters:
none
setTargetASLs
• available : line_item,
Input parameters:
171
Services
• array_of_int $asl_ids: An array of ASL IDs.
existing profile.
Output parameters:
none
setTargetBrowsers
Limits to particular web browsers. See Browser Enum for more information.
Input parameters:
• boolean $browser_default: Set "true" to exclude or "false" to include particular browser IDs in your
targeting. See Using Boolean method_name_default variables for details.
• array_of_int $browser_ids: A list of browser IDs.
existing profile.
Output parameters:
none
setTargetBuyerLineItems
Limits delivery by the specified advertiser line item IDs.
Input parameters:
• boolean $buyer_line_item_default: Set to "true" to exclude or "false" to include particular line item IDs in
the $line_items array. See Using Boolean method_name_default variables for details.
existing profile.
Output parameters:
none
setTargetBuyers
Limits delivery by advertiser ID.
Input parameters:
172
Services
• boolean $buyer_entity_default: Set "true" to exclude or "false" to include particular advertiser IDs in your
• array_of_int $buyer_ids: An array of advertiser IDs.
existing profile.
Output parameters:
none
setTargetChannels
Limits delivery to particular publisher content channels. Channels are categories that describe the content of publisher
inventory, such as Entertainment, Real Estate, Gaming, Search and Shopping.
If $channel_default is set to:
• True: Exclude the specified channels and include all others.
• False: Include the specified channels and exclude all others.
Specify channel default treatment and one or two channel ID arrays:
• An array of channel ids included in the default behavior.
• An array of channel ids that are excluded from the default behavior.
Option: Use the 2nd array to define exceptions to the default behavior set by $channel_default. For example, if
$channel_default is "false" channels specified in the 2nd array will always be excluded. Note: The that array always
overrides $channel_default treatment. See Channel Enum for more information. Accessible for all entity types
Input parameters:
• boolean $channel_default: Set "true" to exclude or "false" to include particular channel IDs in your
• array_of_int $include_channels: An array of included channel IDs.
• array_of_int $exclude_channels: An array of excluded channel IDs.
existing profile.
Output parameters:
none
setTargetClickUrls
Limits delivery based on a particular click URL, groups of clickthrough URLs or clickthrough URL patterns (e.g.,
acme.com, "*cnn.com*").
Note:
• Setting $click_url_default = false restricts delivery to creatives using the specified clickthrough URL only (not
recommended).
• Limit patterns to 50 characters (max) and do not include any slashes after the domain.
• Using * limits matching to "cnn.com" and "test.cnn.com", but not "cnn.com.org".
Input parameters:
173
Services
• boolean $click_url_default: Set to "true" to exclude or "false" to include particular clickthrough URLs in your
• array_of_string $urls: An array of specified clickthrough URLs or clickthrough URL patterns.
• boolean $append: Set "true" to add target clickthrough URL settings on an existing profile. Set "false" to
overwrite the existing profile.
Output parameters:
none
setTargetClickUrlsV2
Limits delivery based on a particular click URL, groups of clickthrough URLs or clickthrough URL patterns (e.g.,
acme.com, "*cnn.com*").
Note:
• Setting $click_url_default = false restricts delivery to creatives using the specified clickthrough URL only (not
recommended).
• Setting $click_url_default = true restricts delivery to creatives except the specified clickthrough URL.
• Limit patterns to 50 characters (max) and do not include any slashes after the domain.
• Using * limits matching to "cnn.com", "*cnn*" and "test.cnn.com", but not "cnn.com.org" and "cnn.com/".
Input parameters:
• enum_demand_source $demand_source: This variable represents enum('all', 'hosted', 'rtbd')
• enum_click_url_default $click_url_default: Available values are 'Whitelist', 'Blocklist', 'NoTargeting'. In
case of 'NoTargeting' $urls and $append flags will be ignored and current click url targeting for specified
$demand_source will get erased.
• array_of_string $urls: An array of specified clickthrough URLs or clickthrough URL patterns.
• boolean $append: Set "true" to add target clickthrough URL settings on an existing profile. Set "false" to
overwrite the existing profile.
Output parameters:
• boolean $status: Overall status.
setTargetContentCategories
Limits delivery to supply matching the specified content categories. API signature is similar to
TargetProfileService::setTargetPixels(), content categories have to be used like public_segment_ids.
Input parameters:
174
Services
• boolean $require_all: Passes in simple Boolean "and" "or" expressions to include or exclude pixels in the
• string $logical_expression: Passes in complex Boolean operators to include or exclude pixel IDs in the
$target_pixels array. Logical Expressions may contain up to 28 unique pixel ids.
existing profile.
Output parameters:
none
setTargetCreativeBeacons
See Targeting Creative Beacons Using the API for more information on targeting creative beacons.
• Creative beacons targeting is available on owner_type 'entity' if the current entity is not enabled for Multiple
Universal target profile (STPs), and there are no default STP.
Input parameters:
• boolean $creative_beacon_default: Set "true" to exclude or "false" to include particular beacon IDs in the
$creative_beacons_id_list array. As of now, only "true" is supported (only exclude targeting is supported) See
• array_of_int $creative_beacons_id_list: An array of creative beacon IDs. See
4_enum_creative_beacon_list.pkg.
• boolean $append: Set "true" to add target settings on an existing profile. Set "false" to overwrite the existing
profile.
Output parameters:
none
setTargetCreatives
Limits delivery to creative IDs that the publisher has approved.
Input parameters:
• boolean $creative_default: Set "true" to exclude or "false" to include particular creatives in the $creative_ids
array. See Using Boolean method_name_default variables for details.
existing profile.
Output parameters:
none
setTargetCreativeSpecs (deprecated)
175
Services
Limits by creative specs such as ActiveX, suggestive content, or third party tags.
This method is deprecated. Use TargetProfileService::setTargetCreativeTags().
• available : line_item, secondary_target_profile
Input parameters:
• creative_specs $creative_specs: The creative specs object.
Output parameters:
none
setTargetCreativeTags
Limits delivery of creatives by one or more creative specs or themes. For more details:
• Banning creatives using the API
• Creative specs
• Creative themes
• Creative tags targeting is available on owner_type 'entity' if the current entity is not enabled for Multiple
Universal target profile (STPs), and there are no STPs.
Input parameters:
• array_of_int $creative_tags_id_list: An array of creative tag IDs corresponding to 'Creative Specs' and
'Creative Themes' used in targeting. See Creative Tag List Enum.
existing profile.
Output parameters:
none
setTargetCSL
• available : line_item,
Input parameters:
• array_of_int $section_ids: An array of section ids
existing profile.
176
Services
Output parameters:
none
setTargetDayparts
Limits delivery to particular days or parts of a day (daypart targeting). For example:
• An advertiser can daypart target to show ads only during the hours that its call center is open.
• A publisher can daypart target to set different pricing based on traffic patterns throughout the day, such as
morning, afternoon, and evening inventory.
Note: All daypart times are in the Eastern Time Zone (US), regardless of your network's default time zone. You will
need to convert the daypart time to EST to account for the difference. See Daypart targeting for more details.
• available : campaign, line_item, creative
Input parameters:
• int $relative_time_region_id: ID of a region targeting is relative to (0 - relative to user's time, otherwise
relative to the region specified by this ID)
• array_of_daypart $dayparts: An array containing daypart targeting information.
existing profile.
Output parameters:
none
setTargetDealProperties
Limits delivery by deal properties. A deal property is a type of pricing available for a campaign or line item. Setting
targeting by deal property will limit delivery of the targeted object to targets using the desired pricing. For example, if
you want to deliver to targets using CPC (cost-per-click) pricing, set the $allow_cpc property of $deal_properties to
true. See Pricing options for line items and campaigns for more details.
• available : line_item, entity
Input parameters:
• deal_properties $deal_properties: Defines the desired deal property targets.
Output parameters:
none
setTargetFrequency
Limits frequency to x ads in y minutes/hours/12 hours/days per user. See Frequency capping for line items for more
details.
Input parameters:
177
Services
• int $frequency: Sets the maximum display amount.
• int $period: Sets the display time interval in seconds.
Output parameters:
none
setTargetGender
Limits delivery to particular users based on gender.
Input parameters:
• gender_target $gender_target: This variable defines the gender target.
Output parameters:
none
setTargetGeography
Limits delivery to particular geographic areas (country, region, state, province, etc.) or from particular Designated
Marketing Area (DMA). Note: Selecting all DMAs is the same as targeting to the US only. See tutorial:
• Country Enum
• Region Enum
• Msa Enum
This function is used only for any existing targeting profile with some old geo targeting already selected otherwise
setTargetGeographyV2 function will be used in all other cases which uses woeid and cga targeting. To shift from old
geo targeting to new woeid and cga targeting one just need to delete any existing old targeting and set the targeting
"show to all".
Input parameters:
• boolean $use_regions: Set "true" to target by entire countries, regions, or both. Set "false" to target by
DMA. See Using Boolean method_name_default variables for details.
• array_of_int $country_ids: An array of country IDs.
• array_of_int $region_ids: An array of region IDs.
• array_of_int $dma_ids: An array of DMA IDs.
existing profile.
Output parameters:
178
Services
none
setTargetGeographyV2
Limits delivery to particular Placetypes (i.e, countries, states, counties, metros and cities) represented by
WOEID(Where On Earth ID) and/or to particular Custom Geographic Areas(CGAs).
Input parameters:
• array_of_int $woeids: An array of WOEIDs.
• array_of_int $custom_geo_area_ids: An array of CGA IDs.
existing profile.
Output parameters:
none
setTargetInventoryTypes
Limits delivery to a specified inventory type ID. See Inventory Type Enum for more information.
Input parameters:
• boolean $inventory_type_default: Set "true" to exclude or "false" to include particular inventory type IDs in
your targeting. See Using Boolean method_name_default variables for details.
• array_of_int $inventory_type_ids: An array of inventory type IDs.
existing profile.
Output parameters:
none
setTargetIsps
Limits delivery to particular commercial Internet service providers (ISPs). See Isp Enum for more information.
Input parameters:
• boolean $isp_default: Set "true" to exclude or "false" to include particular ISP IDs in your targeting. See
• array_of_int $isp_ids: An array of ISP IDs.
179
Services
existing profile.
Output parameters:
none
setTargetLanguages
Limits delivery to specified languages. User browser settings determine the user's language. For example, to target
English speaking users in Germany, set targeting rules with Germany as the geographic target and English as the
language. See Language Enum for more information.
Input parameters:
• boolean $language_default: Set "true" to exclude or "false" to include particular language IDs in your
• array_of_int $language_ids: An array of language IDs.
existing profile.
Output parameters:
none
setTargetNetspeeds
Limits delivery to particular Internet connection speeds (netspeed). See Netspeed Enum for more information.
Input parameters:
• boolean $netspeed_default: Set "true" to exclude or "false" to include particular netspeed IDs in your
• array_of_int $netspeed_ids: An array of netspeed IDs.
existing profile.
Output parameters:
none
setTargetOfferTypes
Limits delivery by offer types such as business, dating, giveaway, or shopping. Offer types describe the actual type of
offering that the advertised product or service represents. Offer types are distinct from and can be completely
unrelated to creative specs, which describe a creative's graphical content and details about its delivery. One or more
child offer types can be targeted. Targeting of parent offer type is not allowed. See Banning creatives using API for
more details.
• Offer type targeting is available on owner_type 'entity' if the current entity is not enabled for Multiple Universal
target profile (STPs), and there are no STPs.
180
Services
Input parameters:
• string $token:: session token
• boolean $offer_type_default: Set "true" to exclude or "false" to include particular offer type IDs in the
$offer_type_ids array. See Using Boolean method_name_default variables for details.
• array_of_int $offer_type_ids: An array of offer type IDs.
existing profile.
Output parameters:
none
setTargetPixels
Limits delivery to users who have already triggered one or more specified pixels. Use the PixelService::setCreatives()
function to bind a pixel to a group of creatives. See also Targeting users by pixels for more details. Note: This method
uses Boolean expressions to determine the pixel combination included or excluded in the $require_all variable. See
Using logical expressions with select TargetProfileService methods for details. This call can work in two modes:
simple and advanced. The former mode requires only four first parameters to be defined, the latter - all but
$require_all.
$require_all parameter defines an operation which will be applied to all array_of_target_pixel elements in simple
mode:
• $require_all=true - AND
• $require_all=false - OR
Much more sophisticated cases can be built using advanced mode.
It is allowed to use the following logical operations:
• conjunction: *, &, and
• disjunction: +, |, or
• negation: /, ~, not
• exclusive disjunction: @, xor
• equality: =, equ
Logical operations serve to connect terms into expressions, where terms are defined in the following way:
id=pixel_idnN, where
• pixel_id - pixel id
• N - negation (0 or 1)
Since some combinations of AND, OR and NOT can lead to ambiguous cases, it is permitted to use parentheses to
clarify the order of operations.
Use id to denote the use of private segment id and pid for the use of public segment id.
Here is a couple of logical expression examples:
• (id=12n0 + pid=23n1) * (id=34n1 + id=21n0)
• (id=1n0 * pid=2n0 + id=1n0) * id=3n1
Input parameters:
181
Services
• boolean $require_all: Passes in simple Boolean "and" "or" expressions to include or exclude pixels in the
• string $logical_expression: Passes in complex Boolean operators to include or exclude pixel IDs in the
$target_pixels array. Logical Expressions may contain up to 28 unique pixel ids.
existing profile.
Output parameters:
none
setTargetPrivateMarketPlace
Limits delivery to particular private marketplace on the exchange
Input parameters:
• enum_target_profile_owner_type_pvt_marketplace $owner_type: Defines the object that owns the target
profile. See Using the target_profile_owner_type and target_profile_owner_id variables for more details.
• boolean $pvt_marketplace_default: Set "true" to exclude or "false" to include particular pvt_marketplace ID
in your targeting. See Using Boolean method_name_default variables for details.
• array_of_int $pvt_marketplace_ids: An array of Private Marketplave Ids.
existing profile.
Output parameters:
none
setTargetPublishers
Limits delivery to a particular publisher or group of publishers.
Input parameters:
• boolean $publisher_default: Set "true" to exclude or "false" to include particular publisher IDs in your
• array_of_int $publisher_entity_ids: An array of publisher entity IDs.
existing profile.
Output parameters:
none
setTargetQueryString
Tailors delivery according to criteria that the publisher passes in through query strings. These can be values like
gender, age, or other user characteristics. See Targeting users by query strings and Using logical expressions with
select TargetProfileService methods for more details.
Sets a targeting rule to limit delivery by the array of query string values. This call uses two modes: simple and
advanced. Simple mode requires only the first 5 parameters to be defined. Advanced mode requires all parameters
182
Services
except $query_string_option. $query_strings array defines strings to be used with either $query_string_option
operation (simple mode) or $query_string_logical_expression (advanced mode).
Input parameters:
• enum_query_string_option $query_string_option: This variable represents simple Boolean "and" "or"
expressions.
• array_of_string $query_strings: Defines strings to be used with either $query_string_option or
$query_string_logical_expression.
• string $query_string_logical_expression: This variable represents complex Boolean operators used to
include or exclude query string IDs in the $query_strings array.
existing profile.
Output parameters:
none
setTargetRating
Limits delivery by MPAA (publisher section) ratings. Section ratings describe the sensitivity of a publisher's content.
Specify maximum allowable $rating. See Rating Enum for more information.
Input parameters:
• string $rating: Most restrictive settings permitted by the target profile.
Output parameters:
none
setTargetSections
Limits delivery to particular sections on publishers' sites based on the section ID.
Input parameters:
• boolean $section_default: Set "true" to exclude or "false" to include particular section IDs in your
targeting.For owner_type = 'entity' only exclude is allowed. See Using Boolean method_name_default
variables for details.
• array_of_int $section_ids: An array of section IDs.
existing profile.
183
Services
Output parameters:
none
setTargetSellerLineItems
Limits delivery by the specified publisher line item IDs.
Input parameters:
• boolean $seller_line_item_default: Set "true" to exclude or "false" to include particular publisher line item
IDs in your targeting. See Using Boolean method_name_default variables for details.
existing profile.
Output parameters:
none
setTargetSizes
Set a targeting rule to limit delivery by creative size. $size_default flag let you specify how to treat the elements of
$size_ids array. If it is set to:
• true means: exclude the specified sizes, all others are included
• false means: include the specified sizes, all others are excluded
See Size Enum for more information. Accessible for all entity types
• available : campaign, line_item
Input parameters:
• enum_target_profile_owner_type_ext $owner_type: target profile owner type
• int $owner_id: target profile owner identifier
• boolean $size_default: default treatment flag
• array_of_int $size_ids: list of creative size's ids
• boolean $append: Append flag, causes method to append existing data with provided if specified
Output parameters:
none
setTargetTechno
Logical expression from techno attribute will be -> OR with in the category, AND across the categories, exclude
means NEGATE.
Input parameters:
184
Services
• array_of_int $included_techno_ids: techno_ids of segment_hierarchy_id which corresponds to
Carrier/OS/Browser/Device segmentsand are deonted as include in the targeting information.
• array_of_int $excluded_techno_ids: techno_ids of segment_hierarchy_id which corresponds to
Carrier/OS/Browser/Device segments and are deonted as exclude in the targeting information.
Output parameters:
none
setTargetUrls
Limits delivery to particular URL addresses, such as acme.com or yourisp.net, or URL patterns, such as "*cnn.com*".
For example, targeting to "*cnn.com*" will limit matches to "cnn.com" and "test.cnn.com", but not "cnn.com.org".
Patterns cannot be longer than 50 characters and you should not include any slashes after the domain.
Input parameters:
• boolean $url_default: Set to "true" to exclude or "false" to include particular URLs in your targeting. See
• array_of_string $urls: An array of specified URLs or URL search strings.
• boolean $append: Set "true" to add target url settings on an existing profile. Set "false" to overwrite the
existing profile.
Output parameters:
none
setTargetValidatedUrls
Limits delivery to URLs verified and classified by the Yahoo Ad Exchange Media Guard program. Validated URLs can
belong to a category (e.g. 'Social Networking'), but only to one category. VURLs also have 4 other properties: 'is
adware', 'is click fraud','is in RMX Top 100', and 'is in RMX Top 250'. See
http://kb.yieldmanager.com/article.php?id=412 for more details.
• available : campaign, line_item, secondary_target_profile, entity
Input parameters:
• vurl_options $vurl_options: Set "true" to exclude or "false" to include particular VURL category IDs. in your
targeting.
• array_of_int $vurl_ids: An array of VURL IDs.
existing profile.
Output parameters:
none
setTargetVurlTags
Limits delivery to particular validated URLs (VURLs) IDs. VURL targeting allows you to restrict the inventory where
your campaigns serve, based on their actual URLs or the content of their sites (as classified by the Exchange's Media
185
Services
Guard program). Use VURL targeting in universal targeting to exclude VURLs across all your campaigns. You can
also include/exclude VURLs for individual campaigns in line item targeting. See VURL and URL targeting for more
details.
• available : campaign, line_item, secondary_target_profile
Input parameters:
• array_of_int $vurl_tag_ids: An array of VURL tag IDs.
existing profile.
Output parameters:
none
setTargetWifi
Input parameters:
• boolean $is_wifi: if set true, wifi users are targeted.
• boolean $is_excluded: if set true, excludes wifi users. if set to false, wifi users are included. default is false.
Output parameters:
none
updateTargetProfile
Updates a given target profile object.
Input parameters:
• target_profile $target_profile: The target profile object.
Output parameters:
none
186
Data types
ad_tag_options
Used by the following call(s) and/or data type(s):
• EntityService
♦ getPubAdTags()
Fields Summary
• $tag_type — Ad tag type
• $banners_size_ids — Contains banners size IDs, see Size Table for additional information.
• $ban_flash_ads
• $do_not_bypass_blockers
• $pub_query_string
• $pub_redirect
• $pub_redirect_encoded — If this field is true then ad_tag_options::$pub_redirect field should be urlencoded.
• $click_url
• $click_url_encoded — If this field is true then ad_tag_options::$click_url field should be urlencoded.
• $pop_type — if pop creative then what type
• $pop_freq_times — frequency cap for pops only, pop x times over y span of z units (example, only show pop
5 times every 2 hours)
• $pop_freq_span — frequency cap for pops only, pop x times over y span of z units (example, only show pop
5 times every 2 hours)
• $pop_freq_unit — frequency cap for pops only, pop x times over y span of z units (example, only show pop 5
times every 2 hours)
• $pop_freq_suppress
• $ad_resize
• $ad_fixed
• $pre_width
• $pre_height
• $interstitial_logo
• $interstitial_title
• $interstitial_bgcolor
• $interstitial_textcolor
• $interstitial_linkcolor
• $interstitial_disappears
• $secure_ad — Set this to 1 if the Ad to be served, needs to be secured. A secure Ad is the one which uses
HTTPS protocol.
• $vast_tag — Complex data type to represent vast tag attributes.
Fields
enum_ad_tag_type $tag_type
Ad tag type
• nillable
array_of_int $banners_size_ids
Contains banners size IDs, see Size Table for additional information.
• nillable
boolean $ban_flash_ads
• nillable
boolean $do_not_bypass_blockers
• nillable
string $pub_query_string
• nillable
187
Services
string $pub_redirect
• nillable
boolean $pub_redirect_encoded
If this field is true then ad_tag_options::$pub_redirect field should be urlencoded.
• nillable
string $click_url
• nillable
boolean $click_url_encoded
If this field is true then ad_tag_options::$click_url field should be urlencoded.
• nillable
enum_ad_pop_type $pop_type
if pop creative then what type
• nillable
int $pop_freq_times
Default value: '1'
frequency cap for pops only, pop x times over y span of z units (example, only show pop 5 times every 2 hours)
int $pop_freq_span
Default value: '1'
enum_ad_pop_freq_unit $pop_freq_unit
Default value: 'day(s)'
boolean $pop_freq_suppress
Default value: '0'
boolean $ad_resize
• nillable
boolean $ad_fixed
• nillable
int $pre_width
• nillable
int $pre_height
• nillable
string $interstitial_logo
• nillable
string $interstitial_title
188
Services
• nillable
string $interstitial_bgcolor
Default value: 'white'
string $interstitial_textcolor
Default value: 'black'
string $interstitial_linkcolor
Default value: 'blue'
int $interstitial_disappears
Default value: '20'
boolean $secure_ad
Default value: '0'
Set this to 1 if the Ad to be served, needs to be secured. A secure Ad is the one which uses HTTPS protocol.
• nillable
vast_tag $vast_tag
Complex data type to represent vast tag attributes.
Vast tag options
adv_domain_blocklist
advertiser_domain data type
Fields Summary
• $supplier_entity_id — network/publisher ID
• $buyer_entity_id — network/advertiser ID
• $adv_domain_id — Domain id
• $visibility — Set "true" for public. Set "false" for private.
• $lastupd
Fields
int $supplier_entity_id
network/publisher ID
• size : 10
• primary
int $buyer_entity_id
network/advertiser ID
• size : 10
• primary
int $adv_domain_id
Domain id
• size : 10
• primary
boolean $visibility
Default value: '0'
189
Services
Set "true" for public. Set "false" for private.
dateTime $lastupd
Ignored on add and update.
advertiser_domain_blocklist_download
• AdvertiserDomainService
♦ downloadBlockList()
Fields Summary
• $domain — domain
• $abids — list of ABIDs (Advertiser Blocklist IDs).
Fields
string $domain
domain
array_of_string $abids
list of ABIDs (Advertiser Blocklist IDs).
advertiser_domain_blocklist
♦ setBlockList()
Fields Summary
• $buyer_entity_id — Buyer entity id
• $domain_urls — List of domain urls that are blocked for specific buyer.
• $append — Set "true" to append to existing blocklist. Set "false" to overwrite the existing blocklist.
Fields
Buyer entity id
array_of_domain_url_data $domain_urls
List of domain urls that are blocked for specific buyer.
boolean $append
Set "true" to append to existing blocklist. Set "false" to overwrite the existing blocklist.
advertiser_domain
advertiser_domain data type
190
Services
♦ add()
♦ getAll()
♦ getAllSince()
♦ getByDomainUrls()
♦ getByIds()
♦ search()
♦ update()
Fields Summary
• $industry_vertical_name — Industry vertical name
• $adv_domain_parent_brand_name — advertiser domain parent brand name
• $id — advertiser domain ID
• $name — advertiser domain display name
• $domain_url — advertiser domain url
• $industry_vertical_id — Industry vertical id.
• $is_active — status of advertiser domain.
• $adv_domain_parent_brand_id — advertiser domain parent brand id.
• $lastupd — last updated time
Fields
string $industry_vertical_name
Industry vertical name
• nillable
string $adv_domain_parent_brand_name
advertiser domain parent brand name
int $id
advertiser domain ID
• size : 10
• primary
string $name
Default value: ''
advertiser domain display name
• size : 100
• nillable
string $domain_url
advertiser domain url
• size : 120
int $industry_vertical_id
Default value: '0'
Industry vertical id.
Industry vertical id. List of industry vertical ids can be obtained using AdvertiserDomainService::getIndustryVerticals().
To create a new industrial vertical name, send empty industry_vertical_id and industry_vertical_name that needs to be
created. In case both industry_vertical_id & industry_vertical_name are submitted, industry_vertical_name is ignored.
• size : 8
• nillable
boolean $is_active
Default value: '1'
status of advertiser domain.
status of advertiser domain (active or inactive).
191
Services
int $adv_domain_parent_brand_id
Default value: '0'
advertiser domain parent brand id.
advertiser domain parent brand id. List of advertiser domain parent ids can be obtained using
AdvertiserDomainService::getParentBrands(). To create a new advertiser domain parent, send empty
adv_domain_parent_brand_id and adv_domain_parent_brand_name that needs to be created. In case both
adv_domain_parent_brand_id & adv_domain_parent_brand_name are submitted, adv_domain_parent_brand_name
is ignored.
• size : 8
• nillable
dateTime $lastupd
last updated time
advertiser_domain_industry_vertical
advertiser_domain_industry_vertical data type
♦ getIndustryVerticals()
Fields Summary
• $id — id
• $name — name
Fields
int $id
id
• size : 8
• primary
string $name
name
• size : 100
advertiser_domain_parent
advertiser_domain_parent data type
♦ getParentBrands()
Fields Summary
• $id — id
• $name — name
Fields
192
Services
int $id
id
• size : 8
• primary
string $name
name
• size : 100
advertiser_domain_search_options
♦ search()
Fields Summary
• $name_pattern — name pattern
• $domain_url_pattern — domain url pattern
• $parent_brand_pattern — parent pattern
• $industry_vertical_pattern — industry_vericals
• $status — status.
Fields
string $name_pattern
name pattern
• nillable
string $domain_url_pattern
domain url pattern
• nillable
string $parent_brand_pattern
parent pattern
• nillable
string $industry_vertical_pattern
industry_vericals
• nillable
enum_advertiser_domain_search_status $status
status.
status can be one of ('active','inactive' or 'all'). See valid types in Advertiser Domain Search Status Enum
advertiser_list
advertiser data type
193
Services
• buying_terms_managed_demand
♦ $managed_advertisers
• demand
♦ $advertisers
• managed_demand
♦ $managed_advertisers
• preferred_terms_demand
♦ $advertisers
Fields Summary
• $advertisers — Advertisers.
• $advertiser_custom_groups — Custom groups of advertisers.
• $include — Flag include is set "true" to include or "false" to exclude particular publishers in the $publishers
and $advertiser_custom_groups arrays.
Fields
array_of_id_name $advertisers
Advertisers.
array_of_id_name $advertiser_custom_groups
Custom groups of advertisers.
boolean $include
Flag include is set "true" to include or "false" to exclude particular publishers in the $publishers and
$advertiser_custom_groups arrays.
advertiser_section_list
• SitelistService
♦ createASL()
♦ createASLs()
♦ getASL()
♦ getAllASL()
♦ updateASL()
♦ updateASLs()
Fields Summary
• $id — ID. Autoset on Sitelist creation.
• $name — Description of Sitelist.
• $owner_id — Sitelist owner id
• $gt_ids — array of global templates associated with the ASL
• $sections — array of sections
• $locked — locked status of the ASL
• $active — Sitelist active flag.
• $created_on — Sitelist creation time.
• $type — Sitelist owner type
• $notes — additional information
• $lastupd — Sitelist last updated time.
• $category — Sitelist category
• $remove_sections — array of sections to remove
Fields
int $id
ID. Autoset on Sitelist creation.
• size : 10
• primary
194
Services
string $name
Description of Sitelist.
• size : 255
int $owner_id
Sitelist owner id
• size : 10
array_of_int $gt_ids
array of global templates associated with the ASL
array_of_int $sections
array of sections
boolean $locked
locked status of the ASL
boolean $active
Default value: '1'
Sitelist active flag.
dateTime $created_on
Sitelist creation time.
enum_sitelist_type $type
Ignored on update.
Sitelist owner type
string $notes
additional information
• size : 1000
dateTime $lastupd
Sitelist last updated time.
enum_sitelist_category $category
Ignored on update.
Default value: 'display'
Sitelist category
array_of_int $remove_sections
array of sections to remove
adware_section_params
adware_section_params data type.
Fields Summary
• $section_id
• $section_code
• $site_id
• $site_code
195
Services
• $entity_id
• $entity_code
• $network_entity_id
Fields
int $section_id
string $section_code
int $site_id
string $site_code
int $entity_id
string $entity_code
int $network_entity_id
beacon_search_options
• DictionaryService
♦ getCreativeBeaconList()
Fields Summary
• $beacon_ids — Beacon ID array
• $vendor_name_pattern — Vendor name pattern
• $is_unresolved_domain — To filter unresolved vendor domains
• $starts_with_non_alphabetic — To filter vendor names starting with numeric/other
Fields
array_of_int $beacon_ids
Beacon ID array
Beacon ID array. Search for beacons by providing array of IDs.
• nillable
string $vendor_name_pattern
Vendor name pattern
Vendor name pattern - search pattern. Leading and/or trailing wild cards (*) can be added to get results for vendor
names matching the string provided. Possible patterns are:
'Adtegrity': matches exact vendor 'Adtegrity'
'Ad*': matches vendors starting with 'Ad'. Example - Adtegrity, !AdReactor, !AdReady, !AdBrite etc.
• nillable
boolean $is_unresolved_domain
To filter unresolved vendor domains
Filter vendor's based on resolution of the beacon domain.
'1': matches beacon vendors who domain is not resolved
'0': matches beacon vendors who domain is resolved
196
Services
• nillable
boolean $starts_with_non_alphabetic
To filter vendor names starting with numeric/other
Filter vendor names starting with numeric or other special characters.
'1': matches beacon vendors who names start with numeric/special characters. Example - [x+1]
'0': matches beacon vendors who names does not start wit numeric/special characters.
• nillable
blocklist_getall
blocklist data type
• DemandBlocklistService
♦ getAllBlocklists()
♦ quickSearch()
• SupplyBlocklistService
♦ quickSearch()
Fields Summary
• $id — Blocklist id.
• $name — Blocklist name.
• $description — Blocklist description.
• $entity_id — Owner entity ID
• $entity_name — Name of owner entity.
• $creative_control — creative_control 'block','block_till_review' or 'allow_till_review'. Available only for demand
blocklist service.
• $created_by_contact_id — Contact id who created blocklist.
• $created_by_contact_name — Name of contact who created blocklist.
• $modified_by_contact_id — Contact id who modified blocklist.
• $modified_by_contact_name — Name of contact who modified blocklist.
• $active — Blocklist activity flag.
• $created_on — Blocklist created on date/time.
• $lastupd — Blocklist last updated date/time.
Fields
int $id
Blocklist id.
string $name
Blocklist name.
string $description
Blocklist description.
int $entity_id
Owner entity ID
string $entity_name
Name of owner entity.
enum_creative_control $creative_control
creative_control 'block','block_till_review' or 'allow_till_review'. Available only for demand blocklist service.
197
Services
int $created_by_contact_id
Contact id who created blocklist.
string $created_by_contact_name
Name of contact who created blocklist.
int $modified_by_contact_id
Contact id who modified blocklist.
string $modified_by_contact_name
Name of contact who modified blocklist.
boolean $active
Default value: '0'
Blocklist activity flag.
Blocklist created on date/time.
dateTime $lastupd
Blocklist last updated date/time.
blocklist_search_options
blocklist data type
Fields Summary
• $ids — Array of demand/supply blocklist ids.
• $names — Array of demand/supply blocklist names.
• $descriptions — Array of demand/supply blocklist descriptions.
• $creative_control — Parameter to search by creative_control 'block_till_review' or 'allow_till_review'.
Available only for demand blocklist service.
• $contact_ids — Array of contact ids.
• $advertiser_ids — Array of advertiser ids.
• $publisher_ids — Array of publisher ids.
• $is_active — Parameter to search by status.By default will return both 'active' and 'inactive'.
Fields
array_of_int $ids
Array of demand/supply blocklist ids.
array_of_string $names
Array of demand/supply blocklist names.
array_of_string $descriptions
Array of demand/supply blocklist descriptions.
198
Services
Parameter to search by creative_control 'block_till_review' or 'allow_till_review'. Available only for demand blocklist
service.
array_of_int $contact_ids
Array of contact ids.
array_of_int $advertiser_ids
Array of advertiser ids.
array_of_int $publisher_ids
Array of publisher ids.
int $is_active
Parameter to search by status.By default will return both 'active' and 'inactive'.
bought_segment
• PixelService
♦ getAllBoughtSegments()
Fields Summary
• $public_segment_id — Public segment id.
• $name — Name of the segment.
• $owner_id — Id of the entity sharing the segment.
• $owner_name — Name of the entity sharing the segment.
• $network_ids — List of network ids that segment share seller has chosen to limit targeting to. If empty, buyer
is allowed to target the segment share to any network.
Fields
int $public_segment_id
Public segment id.
string $name
Name of the segment.
int $owner_id
Id of the entity sharing the segment.
string $owner_name
Name of the entity sharing the segment.
array_of_int $network_ids
List of network ids that segment share seller has chosen to limit targeting to. If empty, buyer is allowed to target the
segment share to any network.
browser
See Browser Enum for more information.
♦ getBrowsers()
199
Services
Fields Summary
• $id — browser ID
• $name — browser name
Fields
int $id
browser ID
• size : 3
• primary
string $name
browser name
• size : 50
buying_terms
buying_terms data type
• BuyingTermsService
♦ add()
♦ getAllSince()
♦ getByObjectId()
♦ update()
Fields Summary
• $id — Buying terms ID.
• $name — Buying terms name.
• $description — Buying terms description.
• $entity_id — Owner entity ID.
• $buying_terms_managed_demand — Complex data type to represent managed advertiser attributes.
• $buying_terms_supply — Complex data type to represent supply attributes.
• $revenue_share — Revenue that the buyer seat is willing to pass to the seller.
• $bid_multiplier — Bid multiplier. It can have values between 0 and 2. Value 1 is invalid for this field. Fields
revenue_share and bid_multiplier are mutually exclusive.
• $created_by_contact_id — Contact id who created buying terms.
• $modified_by_contact_id — Contact id who modified buying terms.
• $active — Buying terms activity flag.
• $created_on — Buying terms created on date/time.
• $lastupd — Buying terms last updated date/time.
Fields
int $id
Ignored on update.
Buying terms ID.
• primary
string $name
Buying terms name.
string $description
Buying terms description.
int $entity_id
200
Services
Owner entity ID.
buying_terms_managed_demand $buying_terms_managed_demand
Complex data type to represent managed advertiser attributes.
buying_terms_supply $buying_terms_supply
Complex data type to represent supply attributes.
float $revenue_share
Revenue that the buyer seat is willing to pass to the seller.
float $bid_multiplier
Bid multiplier. It can have values between 0 and 2. Value 1 is invalid for this field. Fields revenue_share and
bid_multiplier are mutually exclusive.
Contact id who created buying terms.
Contact id who modified buying terms.
boolean $active
Default value: '0'
Buying terms activity flag.
Buying terms created on date/time.
dateTime $lastupd
Buying terms last updated date/time.
buying_terms_managed_demand
buying data type
• buying_terms
♦ $buying_terms_managed_demand
Fields Summary
• $buying_technology — Array of buying technology RTBD, Hosted.
• $managed_advertisers — Managed advertisers.
• $line_items — Line items.
• $deal_properties — Deal properties.
• $creative_size_ids — Creative size ids.
Fields
array_of_enum_buying_technology $buying_technology
Array of buying technology RTBD, Hosted.
advertiser_list $managed_advertisers
Managed advertisers.
201
Services
rule_attribute $line_items
Line items.
rule_deal_properties $deal_properties
Deal properties.
rule_attribute $creative_size_ids
Creative size ids.
buying_terms_supply
buying data type
• buying_terms
♦ $buying_terms_supply
Fields Summary
• $marketplace — Revenue share rule is applicable only on Trading pit marketplace. Bid multiplier rule can be
added on any combination of Trading Pit, Network of network, Intra Network(Managed).
• $selling_technology — Array of selling technology. Allowed values are 'RTBS','Hosted'. See Selling
Technology Enum for valid values.
• $publishers — Publishers.
• $woeids — Woeids.
• $cga_ids — Custom geo area ids.
• $channels — Channels.
• $private_marketplace — Private Marketplace.
• $sections — Managed publisher sections can be added on bid multiplier rule.
Fields
array_of_enum_buying_selling_marketplace $marketplace
Revenue share rule is applicable only on Trading pit marketplace. Bid multiplier rule can be added on any combination
of Trading Pit, Network of network, Intra Network(Managed).
array_of_enum_selling_technology $selling_technology
Array of selling technology. Allowed values are 'RTBS','Hosted'. See Selling Technology Enum for valid values.
publisher_list $publishers
Publishers.
rule_attribute $woeids
Woeids.
rule_attribute $cga_ids
Custom geo area ids.
rule_attribute $channels
Channels.
rule_attribute $private_marketplace
Private Marketplace.
rule_attribute $sections
Managed publisher sections can be added on bid multiplier rule.
202
Services
campaign_goal
• campaign
♦ $campaign_goals
Fields Summary
• $conversion_id
• $goal_amount — Goal amount. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency
specified by the owning entity's currency_id.
Fields
int $conversion_id
• size : 8
• primary
float $goal_amount
Goal amount. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency specified by the owning entity's
currency_id.
• size : 15,4
• nillable
campaign
• CampaignService
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByCreative()
♦ getByEntity()
♦ getByLineItem()
♦ update()
• line_item
♦ $campaign
Fields Summary
• $id — Campaign ID. Autoset on campaign creation by CampaignService::add().
• $advertiser_entity_id — ID of advertiser, campaign belongs to.
• $target_profile_id — ID of target profile, attached to campaign. Can be set by
CampaignService::addTargetProfile().
• $description — Client's description of campaign.
• $active — Campaign activity flag.
• $delivery_rules_id — Delivery rules ID. Autoset by the server when creating a new campaign.
• $exchange_rate
• $cpc_target — Goal towards an effective CPC or click-through rate.
• $campaign_goals — Note: If $cpc_target and $campaign_goals are null, $learn_budget is set to NULL.
• $learn_imps_per_creative_per_section
• $learn_actions_per_creative_per_section
• $learn_spend_per_creative_per_section
• $code — Code of campaign specified by client
• $click_url_override — Default click URL: this URL will only be used if creative is set to use default click URL
(i.e., by setting use_campaign_click_url)
• $priority — Campaign priority.
• $start_time — Start date and time (UTC) for campaign. If not set, current time is assumed.
• $end_time — End date and time (UTC) for line item, campaign or creative. If not set, object isn't trafficking.
• $budget — Budget by currency. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency
specified by the owning entity's currency_id. If not set, unlimited budget is assumed.
203
Services
• $delivery_type — Delivery method, may be set to ASAP, Even, hourly/daily/monthly cap. Valid types are
listed in Delivery Type Enum.
• $delivery_cap — Max value for currency-capped delivery methods. For fixed-rate, this is in USD; for
dynamic-rate, this is in the currency specified by the owning entity's currency_id.
• $imp_budget — Budget by impressions
• $imp_delivery_type — Delivery method, may be set to ASAP, Even, hourly/daily/monthly cap. Valid types are
• $imp_delivery_cap — Max value for impression capped delivery methods
• $learn_budget
• $learn_delivery_type — The complete list of enum values you can see at learn_delivery_type enum page, at
run time you can get all of them using DictionaryService.getEnumValues(token, 'learn_delivery_type').
• $learn_delivery_cap
• $smooth — When set to true, delivers budget/imps evenly over remainder of campaign or within caps
(hourly/daily/weekly).
• $tz_to_show — Specifies the time zone to use for start and end flight dates. See Flight dates for more
details.
• $first_ran_date
• $last_ran_date
• $lastupd
Fields
int $id
Campaign ID. Autoset on campaign creation by CampaignService::add().
• size : 10
• primary
int $advertiser_entity_id
Ignored on update.
ID of advertiser, campaign belongs to.
• size : 10
int $target_profile_id
ID of target profile, attached to campaign. Can be set by CampaignService::addTargetProfile().
• size : 8
• nillable
string $description
Default value: 'default description'
Client's description of campaign.
• size : 255
boolean $active
Default value: '0'
Campaign activity flag.
int $delivery_rules_id
Delivery rules ID. Autoset by the server when creating a new campaign.
• size : 10
• nillable
float $exchange_rate
• size : 10,4
float $cpc_target
204
Services
Goal towards an effective CPC or click-through rate.
Note: If $cpc_target and $campaign_goals are null, $learn_budget is set to NULL. See Pricing options for advertiser
line items and campaigns for details.
• size : 15,4
• nillable
array_of_campaign_goal $campaign_goals
Note: If $cpc_target and $campaign_goals are null, $learn_budget is set to NULL.
See Pricing options for advertiser line items and campaigns for details.
• nillable
int $learn_imps_per_creative_per_section
Default value: '2000'
• size : 10
float $learn_actions_per_creative_per_section
Default value: '5'
float $learn_spend_per_creative_per_section
Default value: '5'
string $code
Code of campaign specified by client
• size : 255
• nillable
string $click_url_override
Default click URL: this URL will only be used if creative is set to use default click URL (i.e., by setting
use_campaign_click_url)
• size : 500
• nillable
enum_priority $priority
Default value: 'Normal'
Campaign priority.
dateTime $start_time
Start date and time (UTC) for campaign. If not set, current time is assumed.
• nillable
• object : delivery_rules
dateTime $end_time
End date and time (UTC) for line item, campaign or creative. If not set, object isn't trafficking.
• nillable
float $budget
Budget by currency. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency specified by the owning
entity's currency_id. If not set, unlimited budget is assumed.
• nillable
205
Services
string $delivery_type
Default value: 'ASAP'
Delivery method, may be set to ASAP, Even, hourly/daily/monthly cap. Valid types are listed in Delivery Type Enum.
The complete list of enum values you can see at delivery_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'delivery_type').
• enum : delivery_type
float $delivery_cap
Max value for currency-capped delivery methods. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency
• nillable
int $imp_budget
Budget by impressions
• nillable
string $imp_delivery_type
The complete list of enum values you can see at imp_delivery_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'imp_delivery_type').
• enum : imp_delivery_type
float $imp_delivery_cap
Max value for impression capped delivery methods
• nillable
int $learn_budget
• nillable
string $learn_delivery_type
The complete list of enum values you can see at learn_delivery_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'learn_delivery_type').
• enum : learn_delivery_type
float $learn_delivery_cap
• nillable
boolean $smooth
Default value: '1'
When set to true, delivers budget/imps evenly over remainder of campaign or within caps (hourly/daily/weekly).
206
Services
string $tz_to_show
Default value: 'America/New_York'
Specifies the time zone to use for start and end flight dates. See Flight dates for more details.
dateTime $first_ran_date
dateTime $last_ran_date
dateTime $lastupd
can_status
• EntityService
♦ getCANStatus()
♦ setCANStatus()
Fields Summary
• $entity_id — Network or Publisher id
• $can_status_flag — CAN status flag to set your CAN status here. Default is Opting out of CAN.
• $can_privacy_page_link — Link to the Network's Privacy Policy page. To be set only if can_status_flag is
opt_in__ngd_overlay_notice or opt_in__ngd_non_overlay_notice
• $can_text_id — Language ID for the CAN marker The complete list of enum values you can see at
can_text_id enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'can_text_id').
Fields
int $entity_id
Network or Publisher id
• size : 10
• primary
string $can_status_flag
CAN status flag to set your CAN status here. Default is Opting out of CAN.
The complete list of enum values you can see at can_status_flag enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'can_status_flag').
• enum : can_status_flag
string $can_privacy_page_link
Link to the Network's Privacy Policy page. To be set only if can_status_flag is opt_in__ngd_overlay_notice or
opt_in__ngd_non_overlay_notice
• size : 80
• nillable
int $can_text_id
Language ID for the CAN marker The complete list of enum values you can see at can_text_id enum page, at run time
you can get all of them using DictionaryService.getEnumValues(token, 'can_text_id').
• size : 5
• enum : can_text_id
207
Services
ccp_creative_search_options
Fields Summary
• $size_ids — show only creatives which sizes listed in the array
• $advertiser_ids — show only creatives which belongs to the advertisers listed in the array
• $region_ids — show only creatives with the following region IDs
• $creatives_visibility — show either 'all', 'approved' or 'banned' creatives.
• $recent_days_number — show only creatives which were added in the last few days
• $filtered_creative_ids — the list of creative IDs that are going to be removed from a search result
• $url_pattern — Show only creatives whose $media_url elements match $url_pattern.
• $offer_type_ids — show only creatives which offer_type_ids are listed in the array
• $creative_ids — the list of creative IDs that are going to be added to a search result
• $include_creative_options — all the creatives which do not match this creative specs will not be included in a
search result
• $exclude_creative_options — all the creatives which match this creative specs will not be included in a
search result
• $target_profile_id — current target profile id
• $entity_id — entity id (default is currently logged in entity) for which the list of creatives will be returned
• $line_item_id — line item id; instead of specifying an entity id you can fill this field and get the list of creatives
that are served at that corresponding level
• $is_reviewed — Show reviewed creatives
• $is_unreviewed — Show un-reviewed creatives
• $needs_further_review — Show creatives that require further review
• $reviewer_contact_ids — If searching creative is_reviewed and/or need_further_review then also filter by
reviewer contact
• $review_start — Review start time
• $review_end — Review end time
• $media_types — Media type of content
• $third_party_types — Third paty type
• $include_tags — all the creatives which do not match these creative tags will not be included in a search
result
• $exclude_tags — all the creatives which match these creative tags will not be included in a search result
• $include_beacons — all the creatives which do not match these creative beacons will not be included in a
search result
• $exclude_beacons — all the creatives which match these creative beacons will not be included in a search
result
• $source_type — show either 'all', 'rtb' or 'non_rtb' creatives.
• $creative_codes — all the creatives which do not belong to any of these code strings will not be included in a
search result
• $create_date_start — Start date of creation date range
• $create_date_end — End date of creation date range
• $sort_order — Sort order by date specifying "ascending" or "descending".
Fields
array_of_int $size_ids
show only creatives which sizes listed in the array
• nillable
show only creatives which belongs to the advertisers listed in the array
• nillable
array_of_int $region_ids
show only creatives with the following region IDs
• nillable
enum_visibility_scope $creatives_visibility
Default value: 'all'
show either 'all', 'approved' or 'banned' creatives.
208
Services
int $recent_days_number
show only creatives which were added in the last few days
• nillable
array_of_int $filtered_creative_ids
the list of creative IDs that are going to be removed from a search result
• nillable
string $url_pattern
Show only creatives whose $media_url elements match $url_pattern.
$url_pattern should be a valid URL of the form http://content.yieldmanager.com/$path, where $path is what is actually
matched against the creative_content, specifically the $media_url. Note that $path is matched as a substring of
$media_url (i.e., the matching pattern is created by adding wildcards to the head and tail of $path). For example, the
$url_pattern 'http://content.yieldmanager.com/atoms/12' would find all creatives whose $media_url matches
'%atoms/12%'.
• nillable
array_of_int $offer_type_ids
show only creatives which offer_type_ids are listed in the array
• nillable
array_of_int $creative_ids
the list of creative IDs that are going to be added to a search result
• nillable
creative_options $include_creative_options
all the creatives which do not match this creative specs will not be included in a search result
• nillable
creative_options $exclude_creative_options
all the creatives which match this creative specs will not be included in a search result
• nillable
current target profile id
• nillable
int $entity_id
entity id (default is currently logged in entity) for which the list of creatives will be returned
• nillable
int $line_item_id
line item id; instead of specifying an entity id you can fill this field and get the list of creatives that are served at that
corresponding level
• nillable
boolean $is_reviewed
Default value: '1'
Show reviewed creatives
209
Services
boolean $is_unreviewed
Default value: '1'
Show un-reviewed creatives
boolean $needs_further_review
Default value: '1'
Show creatives that require further review
array_of_int $reviewer_contact_ids
If searching creative is_reviewed and/or need_further_review then also filter by reviewer contact
• nillable
string $review_start
Review start time
If searching creative is_reviewed and/or need_further_review then also filter by review datetime
• nillable
string $review_end
Review end time
• nillable
array_of_enum_creative_search_media_type $media_types
Media type of content
• nillable
array_of_enum_creative_search_third_party_type $third_party_types
Third paty type
• nillable
array_of_int $include_tags
all the creatives which do not match these creative tags will not be included in a search result
• nillable
array_of_int $exclude_tags
all the creatives which match these creative tags will not be included in a search result
• nillable
array_of_int $include_beacons
all the creatives which do not match these creative beacons will not be included in a search result
• nillable
array_of_int $exclude_beacons
all the creatives which match these creative beacons will not be included in a search result
• nillable
enum_creative_search_source_type $source_type
show either 'all', 'rtb' or 'non_rtb' creatives.
210
Services
array_of_string $creative_codes
all the creatives which do not belong to any of these code strings will not be included in a search result
• nillable
string $create_date_start
Start date of creation date range
• nillable
string $create_date_end
End date of creation date range
• nillable
string $sort_order
Sort order by date specifying "ascending" or "descending".
• nillable
channel
See Channel Enum for more information.
♦ getChannels()
Fields Summary
• $id — channel ID
• $name — channel name
• $long_description — channel description
• $media_guard_only
Fields
int $id
channel ID
• size : 10
• primary
string $name
channel name
• size : 255
string $long_description
channel description
• size : 255
boolean $media_guard_only
211
Services
Class Trees for Package soap_apiRoot class richmedia_creative_attributes
• richmedia_creative_attributes
click_url_data
Fields Summary
• $id
• $tests_number
• $url
Fields
int $id
int $tests_number
string $url
click_url
Fields Summary
• $id — click_url ID. Autoset on click_url creation.
• $is_creative_click_url — is creative click url
• $is_tracker_url — is piggyback url
• $is_campaign_override_url — is campaign click url
• $is_banned — is banned
• $is_discovered — is discovered
• $domain — domain for the url
• $url_md5 — md5 of url
• $risk_score — risk score
• $review_state — Review state The complete list of enum values you can see at review_state enum page, at
run time you can get all of them using DictionaryService.getEnumValues(token, 'review_state').
• $created_on — url creation time. Autoset
• $last_review_completed_on — last review completion time. Autoset
• $url — click url
• $lastupd
Fields
int $id
click_url ID. Autoset on click_url creation.
• size : 10
• primary
boolean $is_creative_click_url
Default value: '0'
is creative click url
boolean $is_tracker_url
Default value: '0'
is piggyback url
212
Services
boolean $is_campaign_override_url
Default value: '0'
is campaign click url
boolean $is_banned
Default value: '0'
is banned
boolean $is_discovered
Default value: '0'
is discovered
string $domain
Ignored on update.
domain for the url
• size : 255
• nillable
string $url_md5
Ignored on update.
md5 of url
• nillable
int $risk_score
Default value: 0
risk score
• size : 10
string $review_state
Review state The complete list of enum values you can see at review_state enum page, at run time you can get all of
them using DictionaryService.getEnumValues(token, 'review_state').
• enum : review_state
url creation time. Autoset
dateTime $last_review_completed_on
last review completion time. Autoset
string $url
click url
dateTime $lastupd
• nillable
comment
• creative_comments
♦ $comments
213
Services
Fields Summary
• $comment — Comment.
• $created_on — Creative comment date specified in yyyy-mm-dd hh:mm:ss format.
Fields
string $comment
Comment.
string $created_on
Creative comment date specified in yyyy-mm-dd hh:mm:ss format.
contact
• ContactService
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByEntity()
♦ getSelf()
♦ update()
• EntityService
♦ add()
♦ getOfficialContacts()
• entity_data
♦ $contact
• entity_official_contacts
♦ $account_managers
♦ $business_contacts
♦ $finance_contacts
♦ $operations_contacts
♦ $sales_persons
♦ $technical_contacts
♦ $trafficker_persons
• publisher_data
♦ $contact
Fields Summary
• $id — Contact ID.
• $prefix — Should be one of these values: Mr or Ms.
• $first_name — The first name for the account
• $last_name — The last name for the account
• $title — The title for the account
• $department — The name of the department, the account belongs to
• $company — The name of the company, the account belongs to
• $phone_main — The contact phone number
• $phone_mobile — The contact mobile phone number
• $fax — The contact fax number
• $address_id — Address ID
• $active — Contact activity flag
• $email_notifications — The email notification flag
• $email — The email of the company, the account belongs to
• $entity_id — The ID of the entity, the account belongs to
• $role_id — The role ID.
• $username — The username for the account
• $api_user — Defines whether a user has access to API.
• $is_support_contact
• $lastupd
• $can_manage_contacts — User able to edit contact info
• $relationship_type_id — For internal use only.
• $ycrm_contact_id — For internal use only.
• $locale_id — The locale ID.
214
Services
Fields
int $id
Contact ID.
• size : 10
• primary
string $prefix
Should be one of these values: Mr or Ms.
• size : 50
string $first_name
The first name for the account
• size : 50
• nillable
string $last_name
The last name for the account
• size : 50
• nillable
string $title
The title for the account
• size : 50
string $department
The name of the department, the account belongs to
• size : 50
string $company
The name of the company, the account belongs to
• size : 100
string $phone_main
The contact phone number
• size : 20
string $phone_mobile
The contact mobile phone number
• size : 20
string $fax
The contact fax number
• size : 20
int $address_id
Address ID
• size : 10
215
Services
int $active
Contact activity flag
• size : 1
int $email_notifications
The email notification flag
• size : 4
string $email
The email of the company, the account belongs to
• size : 255
int $entity_id
Ignored on update.
The ID of the entity, the account belongs to
• size : 10
int $role_id
The role ID.
The complete list of enum values you can see at role enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'role').
• size : 10
• enum : role
string $username
The username for the account
• size : 50
boolean $api_user
Default value: '1'
Defines whether a user has access to API.
This field can be altered only by trusted users.
boolean $is_support_contact
Default value: '0'
dateTime $lastupd
boolean $can_manage_contacts
User able to edit contact info
string $relationship_type_id
Default value: 1
For internal use only.
• size : 3
• nillable
string $ycrm_contact_id
Default value: NULL
216
Services
• size : 15
• nillable
int $locale_id
The locale ID.
• size : 5
• nillable
content_buyer_contact
• PixelService
♦ getAvailableContentCategoriesBuyers()
Fields Summary
• $entity_id — Entity id of content category buyer.
• $company_name — Company name of content category buyer.
• $company_website — Company website of content category buyer.
• $contact_email — Contact email of content category buyer.
Fields
int $entity_id
Entity id of content category buyer.
string $company_name
Company name of content category buyer.
string $company_website
Company website of content category buyer.
string $contact_email
Contact email of content category buyer.
content_seller_contact
• PixelService
♦ getContentCategoryOwner()
Fields Summary
• $entity_id — Content seller's entity id
• $company_name — Content seller's company name
• $contact_email — Content seller's contact email
• $content_category_name — Name of the segment
Fields
int $entity_id
Content seller's entity id
Content seller's company name
217
Services
Content seller's contact email
string $content_category_name
Name of the segment
contract_history_item
Fields Summary
• $insertion_order — Contract history insertion order
• $line_items — Contract history line items corresponding to the insertion order
Fields
insertion_order $insertion_order
Contract history insertion order
The point of the contract history is to be able to see if a network rejects a publisher in the past.
array_of_line_item $line_items
Contract history line items corresponding to the insertion order
country_group
See Country Group Enum for more information.
♦ getCountryGroups()
Fields Summary
• $id — country group ID
• $name — country group name
• $daily_volume — country daily volume
• $daily_revenue — country daily revenue, in USD
Fields
int $id
country group ID
• size : 10
• primary
string $name
country group name
• size : 50
int $daily_volume
country daily volume
• size : 20
218
Services
float $daily_revenue
country daily revenue, in USD
country
See Country Enum for more information.
♦ getCountries()
Fields Summary
• $id — country ID
• $name — country name
• $code — country code
• $continent_id — country continent ID
• $country_group_id — country group ID
Fields
int $id
country ID
• size : 5
• primary
string $name
country name
• size : 50
string $code
country code
• size : 2
int $continent_id
country continent ID
• size : 10
int $country_group_id
country group ID
• size : 10
creative_attachment
• CreativeService
♦ addAttachCreatives()
Fields Summary
• $creative — Contains the creative object.
• $line_item_id — Line item ID.
Fields
219
Services
creative $creative
Contains the creative object.
int $line_item_id
Line item ID.
creative_beacon_list_item
♦ getCreativeBeaconList()
Fields Summary
• $id — Creative beacon ID
• $vendor — Creative beacon vendor
• $description — Description
• $unresolved_beacon_domain — Unresolved beacon domain - Flag that indicates if the beacon's domain
resolved to a vendor
Fields
int $id
Creative beacon ID
• size : 5
• primary
string $vendor
Creative beacon vendor
string $description
Description
boolean $unresolved_beacon_domain
Default value: '0'
Unresolved beacon domain - Flag that indicates if the beacon's domain resolved to a vendor
creative_classification_status
• CreativeService
♦ getClassificationReport()
Fields Summary
• $creative_id — creative id.
• $classification_review_status — Creative classification review status.
Fields
int $creative_id
creative id.
string $classification_review_status
Creative classification review status.
220
Services
creative_comment_search_options
• CreativeService
♦ getCreativeComments()
Fields Summary
• $entity_id — Entity ID of the Reviewer.
• $start_date — Creative review Start date specified in yyyy-mm-dd hh:mm:ss format.
• $end_date — Creative review End date Specified in yyyy-mm-dd hh:mm:ss format
Fields
int $entity_id
Entity ID of the Reviewer.
dateTime $start_date
Creative review Start date specified in yyyy-mm-dd hh:mm:ss format.
dateTime $end_date
Creative review End date Specified in yyyy-mm-dd hh:mm:ss format
creative_comments
• creative_publisher_comments
♦ $all_comments
Fields Summary
• $entity_id — The Entity ID of the network who has provided the comment.
• $comments — The array of comments object containing each comment along with the timestamp sorted from
latest to oldest.
• $total_count — The total number of comments from the publisher against the given creative ID.
Fields
int $entity_id
The Entity ID of the network who has provided the comment.
array_of_comment $comments
Default value: NULL
The array of comments object containing each comment along with the timestamp sorted from latest to oldest.
int $total_count
Default value: 0
The total number of comments from the publisher against the given creative ID.
creative_content_expanded
Macro-substituted contents of a creative.
Fields Summary
221
Services
• $media_type_id — content media type.
• $expanded_content — creative expanded content
Fields
int $media_type_id
content media type.
• size : 10
• primary
string $expanded_content
creative expanded content
creative_content
Content may be either written in content field or client may be redirected to media_url to get content.
• creative
♦ $contents
• placement_creative
♦ $contents
Fields Summary
• $media_type — content media type. See Media Type Enum for more information.
• $media_url — redirect URL to get the content
• $content — creative content
• $hash — the hash of the content
• $file_size — the size of the content
• $atom_id — the id of the atom
• $view_tracker
Fields
string $media_type
content media type. See Media Type Enum for more information.
The complete list of enum values you can see at media_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'media_type').
• enum : media_type
• primary
string $media_url
redirect URL to get the content
• size : 10000
string $content
creative content
string $hash
the hash of the content
int $file_size
the size of the content
• size : 10
• nillable
222
Services
int $atom_id
the id of the atom
• size : 10
string $view_tracker
• nillable
creative_custom_object
♦ searchCreatives()
Fields Summary
• $id — Creative ID.
• $description — Creative Description.
• $advertisers — Advertiser Id and Name
• $beacons — Beacon id and Name
• $reviewer — Name of reviewer
• $created_date — Creative creation time.
Fields
int $id
Creative ID.
• primary
string $description
Creative Description.
id_name $advertisers
Advertiser Id and Name
array_of_id_name $beacons
Beacon id and Name
string $reviewer
Name of reviewer
dateTime $created_date
Creative creation time.
creative_further_comment
Fields Summary
• $creative_id — Creative_ID
• $contact_id — Entity ID
• $comment — Comments message
• $created_on — Created on Date
223
Services
• $contact_name — Contact name of the Reviewer
• $comment_type — Comment type Advertiser/Internal
Fields
int $creative_id
Creative_ID
int $contact_id
Entity ID
string $comment
Comments message
string $created_on
Created on Date
string $contact_name
Contact name of the Reviewer
string $comment_type
Comment type Advertiser/Internal
creative
• CreativeService
♦ add()
♦ addAttach()
♦ addCreatives()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByCampaign()
♦ getByEntity()
♦ getByIntCode()
♦ getByIntCodes()
♦ getByLineItem()
♦ search()
♦ update()
• PixelService
♦ getAttachedCreatives()
• ccp_creative_search_options
♦ $exclude_creative_options
♦ $include_creative_options
• creative_attachment
♦ $creative
• creative_publisher_comments
♦ $all_comments
• creative_search_options
• demand
♦ $creative_tags
• placement
♦ $creative
224
Services
♦ $contents
♦ $creative_tags
• targetings
♦ $CreativeSpecs
Fields Summary
• $richmedia_creative_attribute — Rich media creative attributes. Special attributes for rich media creatives
like expandable, floating, polite download and others.
• $exclude_from_can — Clear Add Notice (CAN) Buyer (Advertiser) control at creative level. Only valid if the
creative type is 'file' This will exclude the creative from CAN, overriding the entity level setting. This is only
relevant if the entity has opted in for the CAN.
• $self_classification_tags — Creative Specs and Themes provided by advertiser.
• $id — Creative ID. Autoset on creative creation by CreativeService::add() or CreativeService::addCreatives().
• $code
• $advertiser_entity_id — ID of advertiser the creative belongs to.
• $active — Creative activity flag.
• $is_audited — Shows if object has been audited by Media Guard.
• $description — Client's description of creative.
• $adapt_media_hex
• $adapt_click_hex
• $pop_types — Type of pop, see Pop Types Enum for valid values.
• $size_id — ID of creative (width, length) pair, see Size Enum for valid values.
• $is_pending
• $created_on — Creative creation time. Autoset by CampaignService::addCreative().
• $height — Creative height, required for pop (size_id = 0); must be > 0 and <= 10000.
• $width — Creative width, required for pop (size_id = 0); must be > 0 and <= 10000.
• $beacon_conversion_id — ID of beacon switched by this creative. See Yahoo Ad Exchange Knowledge
Base for details.
• $original_tag
• $can_track_clicks — This is a Boolean that must be true in order for click tracking to function.
• $menubar — If TRUE, pop window for creative has title
• $resizable — If TRUE, pop window for creative is resizable
• $scrollbars — If TRUE, pop window for creative has scrollbars
• $status
• $toolbar — If TRUE, pop window for creative has toolbar
• $flash_loop — If TRUE, flash creative loops
• $flash_bgcolor — Background color for flash
• $flash_clicktag
• $is_third_party — If TRUE, the creative is treated as third party one
• $third_party_type — Third party tag type. value is set depending on creative_content.content value, checked
at insert & update
• $is_ssl — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_distracting — Creative theme. See Creative themes for details.
• $is_suggestive — Creative theme. See Creative themes for details.
• $is_violent — Creative theme. See Creative themes for details.
• $is_textlink — Creative spec. See Creative specs for details.
• $has_active_x — Creative spec. See Creative specs for details.
• $has_exit_pop — Creative spec. See Creative specs for details.
• $pop_window_title — Title of pop window for the creative.
• $banner_opens_pop — Creative spec. See Creative specs for details.
• $flash_has_embedded_url
• $offer_type_id — Creative's offer type. See Offer Type table for additional information. See also Creative
• $click_url — Creative's click url. Creative must be clickable to use it. See Yahoo Ad Exchange Knowledge
Base for details.
• $has_video_or_rich_media — Creative spec. See Creative specs for details.
• $is_deceptive — Creative theme. See Creative themes for details.
• $is_political — Creative theme. See Creative themes for details.
• $audio_type — Creative spec. See Creative specs for details.
• $target_profile_id — ID of target profile, attached to creative. Can be set by
CreativeService::addTargetProfile().
• $delivery_rules_id — Delivery rules ID. Autoset by the server when creating a new creative.
• $initiates_pop — If TRUE, YAX server initiates pop window at the client' side before pop creative delivery.
See Yahoo Ad Exchange Knowledge Base for details.
• $is_web_site_pop — Creative spec. See Creative specs for details.
• $no_iframes — If TRUE, tag code doesn't create IFRAME
• $is_pre_audited
• $last_audited_by_contact_id
• $last_human_audit
• $last_automated_audit
225
Services
• $creative_type — Creative type.
• $pop_expand_to_full_window
• $use_campaign_click_url
• $contents
• $custom_settings
• $imp_delivery_cap — Max value for impression-capped delivery methods.
• $is_bcm_upload
• $view_tracker — Allows clients to run agency deals by trafficking image and flash creative directly along with
a 3rd-party impression-tracking (view tracker) pixel. We store the URL of the impression-tracking pixel in
view_tracker field.
• $first_ran_date
• $last_ran_date
• $needs_arbitration
• $addressbar — If TRUE, pop window for creative has address bar
• $ad_size_in_bytes
• $lastupd
• $language_id — Id of language creative_tag
• $ad_vendor_id — Ad vendor ID. For internal use only. Do not use.
• $is_rtb — For RTB creative
• $is_3pi
• $classification_review_status — Creative classification review status, see valid types in Creative
Classification Review Status Enum.
• $video_creative — Complex data type to represent video creative attributes.
Fields
richmedia_creative_attributes $richmedia_creative_attribute
Rich media creative attributes. Special attributes for rich media creatives like expandable, floating, polite download
and others.
This field is deprecated. Use Creative Tag IDs in creative::$self_classification_tags to associate rich media attributes.
• deprecated
boolean $exclude_from_can
Default value: '0'
Clear Add Notice (CAN) Buyer (Advertiser) control at creative level. Only valid if the creative type is 'file' This will
exclude the creative from CAN, overriding the entity level setting. This is only relevant if the entity has opted in for the
CAN.
array_of_int $self_classification_tags
Creative Specs and Themes provided by advertiser.
• Creative specs describe the physical and behavioral aspects of the creative, such as audio, active x, or
popups.
• Creative theme is related to the content of a creative, such as political, religious, or violent.
Creative specs and themes are represented using Creative Tags.
Use self_classification_tags array to pass the list of Tag IDs to classify creative.
• Self Classification tags are the ones which have primary_category as 'Self Classification' and
secondary_category as 'Creative Specs' or 'Creative Themes'. For example, Tag 229 (Flashing images - 15
secs or less) is a self classification tag.
• A tertiary_category is a logical grouping of creative specs or themes, which along with 'enable_multiselect'
determine if one or more tags from the same group can be set.
See Creative Tagging and Classification using API for more information on creative tags.
int $id
Creative ID. Autoset on creative creation by CreativeService::add() or CreativeService::addCreatives().
• size : 10
• primary
226
Services
string $code
• size : 100
• nillable
Ignored on update.
ID of advertiser the creative belongs to.
Can be set by CampaignService::addCreative() or CreativeService::update(). Please note that (advertiser_entity_id,
description) should be a unique tuple.
• size : 10
boolean $active
Default value: '1'
Creative activity flag.
boolean $is_audited
Default value: '0'
Shows if object has been audited by Media Guard.
This field is deprecated. Media Guard will not audit creatives to associate creative specs/themes. Refer Creative
specs, Creative themes for more details
• deprecated
string $description
Client's description of creative.
Please note that (advertiser_entity_id, description) should be a unique tuple.
• size : 255
string $adapt_media_hex
• size : 255
• nillable
string $adapt_click_hex
• size : 255
• nillable
enum_pop_types $pop_types
Default value: '0'
Type of pop, see Pop Types Enum for valid values.
int $size_id
Default value: '0'
ID of creative (width, length) pair, see Size Enum for valid values.
Please note that size id provided in Linear Video creative will be ignored.
The complete list of enum values you can see at size enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'size').
• size : 10
• enum : size
boolean $is_pending
227
Services
Creative creation time. Autoset by CampaignService::addCreative().
int $height
Creative height, required for pop (size_id = 0); must be > 0 and <= 10000.
int $width
Creative width, required for pop (size_id = 0); must be > 0 and <= 10000.
int $beacon_conversion_id
ID of beacon switched by this creative. See Yahoo Ad Exchange Knowledge Base for details.
• size : 8
string $original_tag
boolean $can_track_clicks
Default value: '0'
This is a Boolean that must be true in order for click tracking to function.
When you use the My Yieldmanager UI to add clickable creatives, the UI asks you to manually test the creative to be
sure that click tracking is working properly. Once that testing has been completed successfully, the UI automatically
sets the $can_track_clicks on the creative. However, this testing mechanism is not available via the API, so you must
set this flag manually. Keep in mind that setting this flag will affect the way your ads are served; we strongly
recommend that, before setting $can_track_clicks, you have used the UI to test the clickability of a creative that is
representative of your creative object.
boolean $menubar
If TRUE, pop window for creative has title
boolean $resizable
If TRUE, pop window for creative is resizable
boolean $scrollbars
If TRUE, pop window for creative has scrollbars
boolean $status
boolean $toolbar
If TRUE, pop window for creative has toolbar
boolean $flash_loop
If TRUE, flash creative loops
string $flash_bgcolor
Background color for flash
• size : 10
string $flash_clicktag
• size : 30
boolean $is_third_party
If TRUE, the creative is treated as third party one
This field is readonly to the API user, updated by Creative Tester. Use CreativeService::getCreativeTags() to get all
the tags associated with creative by 'Creative Tester' and 'Self classification'.
228
Services
enum_creative_third_party_types $third_party_type
Third party tag type. value is set depending on creative_content.content value, checked at insert & update
• nillable
boolean $is_ssl
Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
This flag is = 0 when creative is not CT tested or when it is non ssl.
boolean $is_distracting
Creative theme. See Creative themes for details.
This field is deprecated. Use corresponding Creative Tag ID (ID: 229) in creative::$self_classification_tags to
associate creative themes for creative
• deprecated
boolean $is_suggestive
• deprecated
boolean $is_violent
• deprecated
boolean $is_textlink
Creative spec. See Creative specs for details.
• deprecated
boolean $has_active_x
the tags associated with creative by 'Creative Tester' and 'Self classification'
• deprecated
boolean $has_exit_pop
• deprecated
string $pop_window_title
Title of pop window for the creative.
• size : 100
229
Services
boolean $banner_opens_pop
boolean $flash_has_embedded_url
int $offer_type_id
Creative's offer type. See Offer Type table for additional information. See also Creative offer types for details.
The complete list of enum values you can see at offer_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'offer_type').
• size : 10
• enum : offer_type
string $click_url
Creative's click url. Creative must be clickable to use it. See Yahoo Ad Exchange Knowledge Base for details.
• nillable
boolean $has_video_or_rich_media
associate creative specs for creative
• deprecated
boolean $is_deceptive
• deprecated
boolean $is_political
• deprecated
string $audio_type
Default value: 'none'
This field is deprecated. Use corresponding Creative Tag ID (IDs: 241, 242) in creative::$self_classification_tags to
The complete list of enum values you can see at audio_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'audio_type').
• deprecated
• enum : audio_type
ID of target profile, attached to creative. Can be set by CreativeService::addTargetProfile().
• size : 8
• nillable
230
Services
Delivery rules ID. Autoset by the server when creating a new creative.
• size : 10
• nillable
boolean $initiates_pop
If TRUE, YAX server initiates pop window at the client' side before pop creative delivery. See Yahoo Ad Exchange
Knowledge Base for details.
boolean $is_web_site_pop
• deprecated
boolean $no_iframes
If TRUE, tag code doesn't create IFRAME
int $is_pre_audited
• size : 1
• nillable
int $last_audited_by_contact_id
• size : 10
• nillable
dateTime $last_human_audit
• nillable
dateTime $last_automated_audit
• nillable
enum_creative_type $creative_type
Ignored on update.
Creative type.
int $pop_expand_to_full_window
Default value: '0'
• size : 1
int $use_campaign_click_url
Default value: '0'
• size : 1
Campaign priority.
231
Services
array_of_creative_content $contents
custom_settings $custom_settings
• nillable
int $imp_budget
• nillable
Max value for impression-capped delivery methods.
• nillable
int $is_bcm_upload
Default value: '0'
• size : 1
Allows clients to run agency deals by trafficking image and flash creative directly along with a 3rd-party
impression-tracking (view tracker) pixel. We store the URL of the impression-tracking pixel in view_tracker field.
• size : 255
• nillable
boolean $needs_arbitration
boolean $addressbar
If TRUE, pop window for creative has address bar
int $ad_size_in_bytes
• size : 11
• nillable
dateTime $lastupd
232
Services
• nillable
int $language_id
Id of language creative_tag
The complete list of enum values you can see at creative_tag_language enum page, at run time you can get all of
them using DictionaryService.getEnumValues(token, 'creative_tag_language').
• enum : creative_tag_language
int $ad_vendor_id
Ad vendor ID. For internal use only. Do not use.
• field : ad_vendor_id
• object : db_creative_ad_vendor
• nillable
boolean $is_rtb
Default value: '0'
For RTB creative
boolean $is_3pi
Default value: '0'
Default value: 'not-reviewed'
Creative classification review status, see valid types in Creative Classification Review Status Enum.
The complete list of enum values you can see at creative_classification_review_status enum page, at run time you
can get all of them using DictionaryService.getEnumValues(token, 'creative_classification_review_status').
• nillable
• enum : creative_classification_review_status
video_creative $video_creative
Complex data type to represent video creative attributes.
creative_lineitem
• LineItemService
♦ addCreatives()
Fields Summary
• $creative_id — Creative ID.
• $line_item_id — Line item ID.
Fields
int $creative_id
Creative ID.
int $line_item_id
Line item ID.
233
Services
creative_macro
See Creative Macro Enum for more information.
♦ getCreativeMacro()
Fields Summary
• $id
• $macro
• $description
Fields
int $id
• size : 10
• primary
string $macro
• size : 100
string $description
• size : 255
• nillable
creative_options
• ccp_creative_search_options
• creative_search_options
Fields Summary
• $is_distracting — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $has_active_x — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_suggestive — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_violent — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_deceptive — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $has_video_or_rich_media — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_political — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $audio_type — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_web_site_pop — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_textlink — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $banner_opens_pop
• $has_exit_pop — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
Fields
234
Services
boolean $is_violent
string $audio_type
creative_owner_data
Fields Summary
• $id
• $advertiser_entity_id
• $tests_number
• $is_rtb
Fields
int $id
int $tests_number
235
Services
int $is_rtb
creative_properties
properties data type
• demand
♦ $creative_tags
♦ $creative_tags
Fields Summary
• $creative_specs — Creative specs.
• $creative_themes — Creative themes.
• $creative_languages — Creative languages.
• $creative_beacons — Creative beacons.
• $include — Include is set "true" to include or "false" to exclude particular segments specified in
$creative_specs, $creative_themes, $creative_beacons, $creative_languages arrays.
Fields
array_of_id_name $creative_specs
Creative specs.
array_of_id_name $creative_themes
Creative themes.
array_of_id_name $creative_languages
Creative languages.
array_of_id_name $creative_beacons
Creative beacons.
boolean $include
Include is set "true" to include or "false" to exclude particular segments specified in $creative_specs,
$creative_themes, $creative_beacons, $creative_languages arrays.
creative_publisher_comments
• CreativeService
♦ getCreativeComments()
Fields Summary
• $creative_id — Creative ID for which the comments are fetched.
• $all_comments — Comments from each publisher for the queried creative ID
Fields
int $creative_id
Creative ID for which the comments are fetched.
array_of_creative_comments $all_comments
Comments from each publisher for the queried creative ID
236
Services
creative_reviewer
Fields Summary
• $contact_id — Contact_ID
• $reviewer_name — Reviewer Name
Fields
int $contact_id
Contact_ID
string $reviewer_name
Reviewer Name
creative_review_options
This file defines creative_review_options data type
♦ searchCreatives()
Fields Summary
• $demand_blocklist_id — Parameter to filter by demand blocklist id.
• $creative_ids — array of creative ids.
• $review_status — Parameter to filter by creative status 'unreviewed', 'review-further', 'approved', 'banned' .
• $start_date — Creative review Start date specified in yyyy-mm-dd hh:mm:ss format.
• $end_date — Creative review End date Specified in yyyy-mm-dd hh:mm:ss format
Fields
int $demand_blocklist_id
Parameter to filter by demand blocklist id.
array of creative ids.
enum_review_status $review_status
Default value: 'unreviewed'
Parameter to filter by creative status 'unreviewed', 'review-further', 'approved', 'banned' .
dateTime $start_date
Creative review Start date specified in yyyy-mm-dd hh:mm:ss format.
dateTime $end_date
Creative review End date Specified in yyyy-mm-dd hh:mm:ss format
237
Services
creative_search_options
• CreativeService
♦ search()
Fields Summary
• $size_ids — show only creatives which sizes listed in the array
• $advertiser_ids — show only creatives which belongs to the advertisers listed in the array
• $region_ids — show only creatives with the following region IDs
• $creatives_visibility — show either 'all', 'approved' or 'banned' creatives.
• $recent_days_number — show only creatives which were added in the last few days
• $filtered_creative_ids — the list of creative IDs that are going to be removed from a search result
• $url_pattern — Show only creatives whose $media_url elements match $url_pattern.
• $offer_type_ids — show only creatives which offer_type_ids are listed in the array
• $creative_ids — the list of creative IDs that are going to be added to a search result
• $include_creative_options — all the creatives which do not match this creative specs will not be included in a
search result
• $exclude_creative_options — all the creatives which match this creative specs will not be included in a
search result
• $target_profile_id — current target profile id
• $entity_id — entity id (default is currently logged in entity) for which the list of creatives will be returned
• $line_item_id — line item id; instead of specifying an entity id you can fill this field and get the list of creatives
that are served at that corresponding level
• $is_reviewed — Show reviewed creatives
• $is_unreviewed — Show un-reviewed creatives
• $needs_further_review — Show creatives that require further review
• $reviewer_contact_ids — If searching creative is_reviewed and/or need_further_review then also filter by
reviewer contact
• $review_start — Review start time
• $review_end — Review end time
• $media_types — Media type of content
• $third_party_types — Third paty type
• $include_tags — all the creatives which do not match these creative tags will not be included in a search
result
• $exclude_tags — all the creatives which match these creative tags will not be included in a search result
• $include_beacons — all the creatives which do not match these creative beacons will not be included in a
search result
• $exclude_beacons — all the creatives which match these creative beacons will not be included in a search
result
• $source_type — show either 'all', 'rtb' or 'non_rtb' creatives.
• $creative_codes — all the creatives which do not belong to any of these code strings will not be included in a
search result
Fields
show only creatives which sizes listed in the array
• nillable
show only creatives which belongs to the advertisers listed in the array
• nillable
show only creatives with the following region IDs
• nillable
enum_visibility_scope $creatives_visibility
show either 'all', 'approved' or 'banned' creatives.
238
Services
int $recent_days_number
show only creatives which were added in the last few days
• nillable
array_of_int $filtered_creative_ids
the list of creative IDs that are going to be removed from a search result
• nillable
string $url_pattern
Show only creatives whose $media_url elements match $url_pattern.
$url_pattern should be a valid URL of the form http://content.yieldmanager.com/$path, where $path is what is actually
matched against the creative_content, specifically the $media_url. Note that $path is matched as a substring of
$media_url (i.e., the matching pattern is created by adding wildcards to the head and tail of $path). For example, the
$url_pattern 'http://content.yieldmanager.com/atoms/12' would find all creatives whose $media_url matches
'%atoms/12%'.
• nillable
show only creatives which offer_type_ids are listed in the array
• nillable
the list of creative IDs that are going to be added to a search result
• nillable
creative_options $include_creative_options
all the creatives which do not match this creative specs will not be included in a search result
• nillable
creative_options $exclude_creative_options
all the creatives which match this creative specs will not be included in a search result
• nillable
current target profile id
• nillable
int $entity_id
entity id (default is currently logged in entity) for which the list of creatives will be returned
• nillable
int $line_item_id
line item id; instead of specifying an entity id you can fill this field and get the list of creatives that are served at that
corresponding level
• nillable
boolean $is_reviewed
Default value: '1'
Show reviewed creatives
239
Services
boolean $is_unreviewed
Default value: '1'
Show un-reviewed creatives
boolean $needs_further_review
Default value: '1'
Show creatives that require further review
array_of_int $reviewer_contact_ids
If searching creative is_reviewed and/or need_further_review then also filter by reviewer contact
• nillable
string $review_start
Review start time
• nillable
string $review_end
Review end time
• nillable
array_of_enum_creative_search_media_type $media_types
Media type of content
• nillable
array_of_enum_creative_search_third_party_type $third_party_types
Third paty type
• nillable
array_of_int $include_tags
all the creatives which do not match these creative tags will not be included in a search result
• nillable
array_of_int $exclude_tags
all the creatives which match these creative tags will not be included in a search result
• nillable
array_of_int $include_beacons
all the creatives which do not match these creative beacons will not be included in a search result
• nillable
array_of_int $exclude_beacons
all the creatives which match these creative beacons will not be included in a search result
• nillable
enum_creative_search_source_type $source_type
show either 'all', 'rtb' or 'non_rtb' creatives.
240
Services
array_of_string $creative_codes
all the creatives which do not belong to any of these code strings will not be included in a search result
• nillable
creative_specs
• CreativeService
♦ getCreativeSpecs()
• TargetProfileService
♦ getTargetCreativeSpecs()
♦ setTargetCreativeSpecs()
• targetings
♦ $CreativeSpecs
Fields Summary
• $id — creative spec ID
• $allow_third_party_tags — third party tags flag
• $allow_distracting — distracting flag
• $allow_active_x — active x flag
• $allow_cpc — cpc flag
• $allow_cpa — cpa flag
• $allow_discretionary — discretionary flag
• $allow_third_party_numbers — third party numbers flag
• $max_days_since_adjustment — max days since adjustment flag
• $allow_suggestive — suggestive flag
• $allow_violent — violent flag
• $allow_cpm — cpm flag
• $allow_roi_target — roi target flag
• $allow_deceptive — deceptive flag
• $allow_video_and_rich_media — video and rich media flag
• $allow_political — political flag
• $allow_audio_type — audio type flag
• $allow_web_site_pop — web site pop flag
• $allow_textlink — textlink flag
• $allow_unaudited — unaudited flag
• $allow_banner_opens_pop — banner opens pop flag
• $allow_exit_pop — exit pop flag
• $allow_meets_msn_specs — meets msn specs flag
• $allow_meets_yahoo_specs — meets yahoo specs flag
Fields
int $id
creative spec ID
• size : 10
• primary
boolean $allow_third_party_tags
Default value: 1
third party tags flag
boolean $allow_distracting
Default value: 1
distracting flag
boolean $allow_active_x
Default value: 1
active x flag
241
Services
boolean $allow_cpc
Default value: 1
cpc flag
boolean $allow_cpa
Default value: 1
cpa flag
boolean $allow_discretionary
Default value: 1
discretionary flag
boolean $allow_third_party_numbers
Default value: 1
third party numbers flag
int $max_days_since_adjustment
Default value: 7
max days since adjustment flag
• size : 11
int $allow_suggestive
Default value: 1
suggestive flag
• size : 4
int $allow_violent
Default value: 1
violent flag
• size : 4
boolean $allow_cpm
Default value: 1
cpm flag
boolean $allow_roi_target
Default value: 1
roi target flag
boolean $allow_deceptive
Default value: 1
deceptive flag
boolean $allow_video_and_rich_media
Default value: 1
video and rich media flag
boolean $allow_political
Default value: 1
political flag
string $allow_audio_type
Default value: 'any'
audio type flag
The complete list of enum values you can see at spec_audio_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'spec_audio_type').
242
Services
• enum : spec_audio_type
boolean $allow_web_site_pop
Default value: 1
web site pop flag
boolean $allow_textlink
Default value: 1
textlink flag
boolean $allow_unaudited
Default value: 1
unaudited flag
boolean $allow_banner_opens_pop
Default value: 1
banner opens pop flag
boolean $allow_exit_pop
Default value: 1
exit pop flag
boolean $allow_meets_msn_specs
Default value: 1
meets msn specs flag
boolean $allow_meets_yahoo_specs
Default value: 1
meets yahoo specs flag
creative_tag_list_item
See Creative Tag List Enum for more information.
♦ getCreativeTagList()
Fields Summary
• $id
• $primary_category — Primary category: This represents the source of the tag. Creative tags with
primary_category "Self Classification" are provided by advertiser on creative upload or edit, while "Creative
Tester" tags are assigned by automated 'Creative Tester'.
• $secondary_category — Secondary category: This designates a tag as a creative spec or theme. Creative
specs describe the physical and behavioral aspects of the creative, such as audio, active x, or popups.
Creative themes is related to the content of a creative such as political, religious or violent.
• $tertiary_category — Tertiary category: This is a logical grouping of creative specs or themes.
• $tag
• $entity_id
• $is_media_guard — For identification of the tag as internal or external. 1: external , 0 : internal use.
• $ui_order
• $is_enabled
• $expiration_age
• $description — tag description
• $enable_multiselect — 'enable_multiselect' determines if one or more tags can be set within the same
tertiary_category for creative self classification.
Fields
243
Services
int $id
• size : 5
• primary
string $primary_category
Primary category: This represents the source of the tag. Creative tags with primary_category "Self Classification" are
provided by advertiser on creative upload or edit, while "Creative Tester" tags are assigned by automated 'Creative
Tester'.
• size : 100
string $secondary_category
Secondary category: This designates a tag as a creative spec or theme. Creative specs describe the physical and
behavioral aspects of the creative, such as audio, active x, or popups. Creative themes is related to the content of a
creative such as political, religious or violent.
• size : 255
string $tertiary_category
Tertiary category: This is a logical grouping of creative specs or themes.
• size : 100
string $tag
• size : 255
int $entity_id
• size : 10
• nillable
int $is_media_guard
For identification of the tag as internal or external. 1: external , 0 : internal use.
Note : Internal tags are not available for targeting.
• size : 1
float $ui_order
• deprecated
• nillable
boolean $is_enabled
int $expiration_age
Default value: '0'
• size : 5
string $description
tag description
• nillable
int $enable_multiselect
'enable_multiselect' determines if one or more tags can be set within the same tertiary_category for creative self
classification.
244
Services
• size : 3
ct_report_result
Fields Summary
• $url
• $result
• $exception_detail
• $exception_text
• $item_id
Fields
string $url
boolean $result
exception_detail $exception_detail
string $exception_text
int $item_id
currency
See Currency Enum for more information.
♦ getCurrencies()
Fields Summary
• $id — Currency ID
• $name — Currency name
• $symbol — Currency symbol
• $abbreviation — Currency abbreviation
• $decimals — Currency decimals
• $current_exchange_rate — Current currency rate of exchange - latest exchange rate available
• $exchange_rate_as_of — Date and time from which currency exchange rate is set
Fields
int $id
Currency ID
• size : 3
• primary
string $name
Currency name
• size : 50
245
Services
string $symbol
Currency symbol
• size : 10
string $abbreviation
Currency abbreviation
• size : 3
int $decimals
Currency decimals
• size : 3
float $current_exchange_rate
Current currency rate of exchange - latest exchange rate available
• size : 10,4
dateTime $exchange_rate_as_of
Date and time from which currency exchange rate is set
custom_creative
• custom_settings
♦ $custom_creative
Fields Summary
• $custom_creative_code — Custom creative type
Fields
enum_custom_creative_type $custom_creative_code
Custom creative type
custom_geo_area
♦ addCustomGeoArea()
♦ getAllCustomGeoAreas()
♦ getCustomGeoArea()
Fields Summary
• $postal_codes — Array of postal_code
• $id — Custom geo area ID
• $entity_id — Entity ID
• $name — Custom geo area name
• $active — Active flag
• $country_woeid — Country WOEID to which the CGA belongs
246
Services
• $description — Custom geo area description
• $created_on
• $lastupd
Fields
array_of_string $postal_codes
Array of postal_code
int $id
Custom geo area ID
• size : 10
• primary
int $entity_id
Entity ID
• size : 10
string $name
Custom geo area name
• size : 255
int $active
Active flag
• size : 3
int $country_woeid
Ignored on update.
Country WOEID to which the CGA belongs
• size : 10
string $description
Custom geo area description
• size : 255
• nillable
dateTime $lastupd
custom_settings
• creative
♦ $custom_settings
♦ $custom_settings
247
Services
Fields Summary
• $custom_creative
Fields
custom_creative $custom_creative
• nillable
data_buyer_contact
• PixelService
♦ getAvailableSegmentBuyers()
Fields Summary
• $entity_id — Entity id of segment buyer.
• $company_name — Company name of segment buyer.
• $company_website — Company website of segment buyer.
• $contact_email — Contact email of segment buyer.
Fields
int $entity_id
Entity id of segment buyer.
Company name of segment buyer.
Company website of segment buyer.
Contact email of segment buyer.
data_seller_contact
• PixelService
♦ getSegmentOwner()
Fields Summary
• $entity_id — Data seller's entity id
• $company_name — Data seller's company name
• $contact_email — Data seller's contact email
• $segment_name — Name of the segment
Fields
int $entity_id
Data seller's entity id
248
Services
Data seller's company name
Data seller's contact email
string $segment_name
Name of the segment
date_imps
• AdjustmentService
♦ getImpsByDates()
Fields Summary
• $date — Date
• $imps — Imps number
Fields
date $date
Date
int $imps
Imps number
daypart
♦ getTargetDayparts()
♦ TargetProfileService::getTargetDaypartsDepr()
♦ setTargetDayparts()
♦ TargetProfileService::setTargetDaypartsDepr()
• rule_dayparts
♦ $daypart_list
• target_daypart
♦ $dayparts
Fields Summary
• $day_id — Day number from 1 for Sunday till 7 for Saturday
• $start_time — Start time in hours (0..23) for targeting
• $end_time — End time in hours (0..23) for targeting
Fields
int $day_id
Day number from 1 for Sunday till 7 for Saturday
The complete list of enum values you can see at day enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'day').
• enum : day
int $start_time
Start time in hours (0..23) for targeting
249
Services
int $end_time
End time in hours (0..23) for targeting
deal_properties
♦ getTargetDealProperties()
♦ TargetProfileService::getTargetDealPropertiesDepr()
♦ setTargetDealProperties()
♦ TargetProfileService::setTargetDealPropertiesDepr()
• targetings
♦ $DealProperties
Fields Summary
• $allow_cpa — if true, CPA pricing is allowed
• $allow_cpc — if true, CPC pricing is allowed
• $allow_cpm — if true, CPM pricing is allowed
• $allow_discretionary — if true, discretionary pricing is allowed
• $allow_roi_target — if true, return on investment target is allowed
• $allow_third_party_numbers — if true, third party numbers are allowed
Fields
boolean $allow_cpa
if true, CPA pricing is allowed
boolean $allow_cpc
if true, CPC pricing is allowed
boolean $allow_cpm
if true, CPM pricing is allowed
if true, discretionary pricing is allowed
boolean $allow_roi_target
if true, return on investment target is allowed
if true, third party numbers are allowed
default_target_profile
♦ getDefaultTargetProfiles()
Fields Summary
• $id — Target profile ID. Autoset on creation.
• $active — Target profile activity flag.
• $name — Name of the target profile
• $default_profile_name — Name of target profile if it is default
Fields
250
Services
int $id
Target profile ID. Autoset on creation.
• primary
boolean $active
Default value: 1
Target profile activity flag.
string $name
Default value: 'No Name Set'
Name of the target profile
string $default_profile_name
Name of target profile if it is default
• nillable
demand_blocklist
blocklist data type
♦ add()
♦ getAllSince()
♦ getByObjectId()
♦ update()
Fields Summary
• $id — Demand blocklist id.
• $name — Demand blocklist name.
• $description — Demand blocklist description.
• $managed_supply — Complex data type to represent managed supply attributes.
• $block_demand — Complex data type to represent demand attributes.
• $creative_control — Creative_control 'block','block_till_review','allow_till_review'
• $created_by_contact_id — Contact id who created demand blocklist.
• $modified_by_contact_id — Contact id who modified demand blocklist.
• $active — Demand blocklist activity flag.
• $created_on — Demand blocklist created on date/time.
• $lastupd — Demand blocklist last updated date/time.
Fields
int $id
Ignored on update.
Demand blocklist id.
• primary
string $name
Demand blocklist name.
string $description
Demand blocklist description.
int $entity_id
Owner entity ID
251
Services
managed_supply $managed_supply
Complex data type to represent managed supply attributes.
demand $block_demand
Complex data type to represent demand attributes.
Default value: 'block'
Creative_control 'block','block_till_review','allow_till_review'
Contact id who created demand blocklist.
Contact id who modified demand blocklist.
boolean $active
Default value: '0'
Demand blocklist activity flag.
Demand blocklist created on date/time.
dateTime $lastupd
Demand blocklist last updated date/time.
demand
demand data type
• demand_blocklist
♦ $block_demand
Fields Summary
• $marketplace — Demand rule applicable on Trading Pit, Netwrok of network, Intra Network(Managed
Advertiser) or any combination of these. See Buying Selling Marketplace Enum for valid values.
• $buying_technology — Array of buying technology 'RTBD', 'Hosted'. See Buying Technology Enum for valid
values.
• $advertisers — Advertiser ids.
• $creative_tags — Creative tag ids for creative_specs, creative_themes, creative_languages,
creative_beacons.
• $click_urls — Click Urls.
• $offer_types — Offer types.
Fields
Demand rule applicable on Trading Pit, Netwrok of network, Intra Network(Managed Advertiser) or any combination of
these. See Buying Selling Marketplace Enum for valid values.
Array of buying technology 'RTBD', 'Hosted'. See Buying Technology Enum for valid values.
252
Services
advertiser_list $advertisers
Advertiser ids.
Deal properties.
creative_properties $creative_tags
Creative tag ids for creative_specs, creative_themes, creative_languages, creative_beacons.
rule_attribute_names $click_urls
Click Urls.
rule_attribute $offer_types
Offer types.
domain_url_data
♦ getBlockList()
• advertiser_domain_blocklist
♦ $domain_urls
Fields Summary
• $url — Value "NULL" selected as excluded domain url means that every demand needs to come with a valid
advertiser domain.
• $visibility — Set "true" for public. Set "false" for private.
Fields
string $url
Value "NULL" selected as excluded domain url means that every demand needs to come with a valid advertiser
domain.
• nillable
boolean $visibility
Default value: '0'
Set "true" for public. Set "false" for private.
dxr_migration_reports
• InsertionOrderService
♦ dxrMigrationStatus()
Fields Summary
• $new_io_id — Id of new insertion order copied from old one.
• $migration_map_url — URL to migration map report
• $targeting_map_url — URL to targeting map report
Fields
int $new_io_id
Id of new insertion order copied from old one.
253
Services
string $migration_map_url
URL to migration map report
string $targeting_map_url
URL to targeting map report
Element index for package soap_api[e][i][p][r]
e
$expandable_final_height
in file p149.php, variable richmedia_creative_attributes::$expandable_final_height
Expandable Final Height
$expandable_final_width
in file p149.php, variable richmedia_creative_attributes::$expandable_final_width
Expandable Final Width
top
i
$is_expandable
in file p149.php, variable richmedia_creative_attributes::$is_expandable
Is Expandable Creative
$is_floating
in file p149.php, variable richmedia_creative_attributes::$is_floating
Is Floating Creative
$is_other
in file p149.php, variable richmedia_creative_attributes::$is_other
Does creative belong to any other rich media category?
$is_polite_download
in file p149.php, variable richmedia_creative_attributes::$is_polite_download
Is Polite Download
$is_video
in file p149.php, variable richmedia_creative_attributes::$is_video
Is Flash Video
top
p
p149.php
procedural page p149.php
top
r
richmedia_creative_attributes
in file p149.php, class richmedia_creative_attributes
◊ creative
⋅ $richmedia_creative_attribute
top
entity_data
• EntityService
♦ addEx()
254
Services
Fields Summary
• $entity — contains the entity object
• $contact — contains the contact object
• $create_site_section — site and section creation flag
• $site — contains the site object
• $section — contains the section object
• $create_io_li — insertion order and line item creation flag
• $insertion_order — contains the insertion order object
• $line_item — contains the line item object
Fields
entity $entity
contains the entity object
contact $contact
contains the contact object
boolean $create_site_section
site and section creation flag
site $site
contains the site object
section $section
contains the section object
boolean $create_io_li
insertion order and line item creation flag
contains the insertion order object
line_item $line_item
contains the line item object
entity
• EntityService
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByShellId()
♦ update()
• entity_data
♦ $entity
• link_data
♦ $entity
• publisher_data
♦ $entity
Fields Summary
• $id — entity ID
• $entity_type — entity type (Publisher, Advertiser, Network)
• $secondary_entity_type — secondary entity type.
• $business_type — business type
255
Services
• $managing_entity_id — managing entity ID. For using network's serving domain publisher should set the
network as its managing entity.
• $name — entity name
• $active — activity flag
• $comment — additional information
• $currency_id — the currency ID the entity pay/get paid in. See Currency table for additional information.
• $exchange_rate — exchange rate of the currency (if not in dollars)
• $created_on — the entity creation time
• $created_by_contact_id — the entity creator contact id
• $referral_source_id
• $no_imps_month
• $applied_on — applying time
• $default_site_id — default site ID
• $uses_site_codes — allows to use site codes
• $account_manager_id — account manager ID
• $trafficker_contact_id — trafficker contact ID
• $sales_region_id
• $serving_domain — default serving domain ad to be served from
• $simple_trafficking
• $uses_managed_entity_codes
• $default_managed_entity_id — default managed entity ID
• $managed_entity_code
• $time_zone — the entity time zone
• $timezone_id — the entity time zone id
• $sections_share_channels
• $pub_learn_percentage
• $serving_name
• $default_publisher_billing_code
• $adserver_profile_id
• $is_linkable
• $language_id — Language ID. See Language table for additional information.
• $target_profile_id — entity target profile ID
• $content_domain
• $log_predict_stats
• $network_only_linking
• $can_create_managed_pubs — can the entity create managed publishers
• $allow_rmxd
• $business_contact_id — business contact ID
• $operations_contact_id — operations contact ID
• $technical_contact_id — technical contact ID
• $lastupd
• $address1 — the first line of the publisher's address
• $address2 — the second line of the publisher's address
• $city — the entity city
• $region_id — The publisher region ID. See Region table for additional information.
• $zip — the publisher postal code
• $country_id — the publisher country ID. See Country table for additional information.
• $finance_office_currency_id
• $finance_office_billing_name
• $finance_contact_id
• $entity_metadata_notes
• $integration_code — integration code
• $use_all_delivery_priorities
• $allow_insert_objects_per_day
• $creative_tag_language_id — Language creative tag id
• $shell_id
• $joliet_id — For internal use only.
• $accepts_links — accepts links
• $can_see_reports — can see reports
• $age_querystring_key — age query string key
• $year_of_birth_querystring_key — year of birth query string key
• $gender_querystring_key — gender query string key
• $gender_male_querystring_val — gender male query string value
• $gender_female_querystring_val — gender female query string value
• $adx_buyer_visibility_default
• $content_buyer_visibility_default — Denote if Content Category buyer is by default visble to sellers.
• $is_rtbs — Can not be set for Advertiser
• $is_rtbd — Can not be set for Publisher
• $enable_rtbd — Can not be set for Advertiser
• $enable_rtbs — Can not be set for Publisher
• $default_seller_reserve_price — Default seller reserve price. Review Reserve Price and Setting reserve price
using API in the Yield Manager Knowledge Base for details on Reserve Price.
256
Services
• $allow_segment_selling — For internal use only
• $allow_segment_buying — For internal use only
• $allow_content_selling — For internal use only
• $allow_content_buying — For internal use only
Fields
int $id
entity ID
• size : 10
• primary
string $entity_type
Ignored on update.
entity type (Publisher, Advertiser, Network)
The complete list of enum values you can see at entity_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'entity_type').
• enum : entity_type
string $secondary_entity_type
Ignored on update.
secondary entity type.
The complete list of enum values you can see at secondary_entity_type enum page, at run time you can get all of
them using DictionaryService.getEnumValues(token, 'secondary_entity_type').
• enum : secondary_entity_type
string $business_type
business type
The complete list of enum values you can see at business_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'business_type').
• enum : business_type
int $managing_entity_id
Ignored on update.
managing entity ID. For using network's serving domain publisher should set the network as its managing entity.
• size : 10
string $name
entity name
• size : 100
boolean $active
Default value: '1'
activity flag
string $comment
• size : 255
int $currency_id
Ignored on update.
Default value: '1'
the currency ID the entity pay/get paid in. See Currency table for additional information.
257
Services
The complete list of enum values you can see at currency enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'currency').
• size : 3
• enum : currency
Default value: '1.0'
exchange rate of the currency (if not in dollars)
• size : 10,4
the entity creation time
the entity creator contact id
• size : 10
int $referral_source_id
• size : 10
string $notes
int $no_imps_month
Ignored by: Advertiser
• size : 15
dateTime $applied_on
applying time
int $default_site_id
Default value: '0'
default site ID
• size : 10
boolean $uses_site_codes
allows to use site codes
int $account_manager_id
account manager ID
• size : 5
int $trafficker_contact_id
trafficker contact ID
• size : 10
int $sales_region_id
258
Services
• size : 10
string $serving_domain
default serving domain ad to be served from
• size : 50
int $simple_trafficking
Ignored by: Publisher
• size : 3
boolean $uses_managed_entity_codes
int $default_managed_entity_id
default managed entity ID
• size : 10
string $managed_entity_code
• size : 50
string $time_zone
the entity time zone
• size : 255
int $timezone_id
Default value: '1'
the entity time zone id
• size : 3
int $sections_share_channels
• size : 1
int $pub_learn_percentage
Default value: '5'
• size : 6
string $serving_name
Default value: 'Yahoo Ad Exchange'
• size : 255
string $default_publisher_billing_code
• size : 255
int $adserver_profile_id
259
Services
• size : 11
int $is_linkable
• size : 1
int $language_id
Language ID. See Language table for additional information.
The complete list of enum values you can see at language enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'language').
• size : 10
• enum : language
entity target profile ID
• size : 8
string $content_domain
• size : 50
int $log_predict_stats
• size : 1
boolean $network_only_linking
boolean $can_create_managed_pubs
can the entity create managed publishers
boolean $allow_rmxd
int $business_contact_id
business contact ID
• size : 10
int $operations_contact_id
operations contact ID
• size : 10
int $technical_contact_id
technical contact ID
• size : 10
dateTime $lastupd
string $address1
Allowed to update by: Advertiser
the first line of the publisher's address
• object : db_address
260
Services
string $address2
the second line of the publisher's address
string $city
the entity city
int $region_id
Default value: '52'
The publisher region ID. See Region table for additional information.
The complete list of enum values you can see at region enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'region').
• enum : region
string $zip
the publisher postal code
int $country_id
Default value: '1'
the publisher country ID. See Country table for additional information.
The complete list of enum values you can see at country enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'country').
• enum : country
int $finance_office_currency_id
Default value: '1'
• size : 3
• field : currency_id
• object : db_finance_office
string $finance_office_billing_name
Allowed to update by: Publisher
• size : 55
• field : billing_name
int $finance_contact_id
Default value: '0'
• field : finance_contact_id
string $entity_metadata_notes
261
Services
• nillable
• field : notes
• object : db_entity_metadata
string $integration_code
integration code
Once integration code has been set it allows you to lookup up for advertisers with that code. Please keep in mind that
content of this field cannot be set by PublisherService::add() and PublisherService::update() calls. To that end use
PublisherService::setIntegrationCode().
int $use_all_delivery_priorities
• field : use_all_delivery_priorities
• object : db_entity_custom_settings
int $allow_insert_objects_per_day
• field : allow_insert_objects_per_day
• object : db_entity_custom_settings
int $creative_tag_language_id
Ignored on update.
Language creative tag id
• size : 3
• nillable
string $shell_id
Default value: NULL
• size : 19,0
• nillable
string $joliet_id
Default value: NULL
• size : 15
• nillable
boolean $accepts_links
Default value: '1'
accepts links
boolean $can_see_reports
Default value: '1'
can see reports
string $age_querystring_key
Default value: NULL
age query string key
• size : 20
• nillable
262
Services
string $year_of_birth_querystring_key
Default value: NULL
year of birth query string key
• size : 20
• nillable
string $gender_querystring_key
Default value: NULL
gender query string key
• size : 20
• nillable
string $gender_male_querystring_val
Default value: NULL
gender male query string value
• size : 10
• nillable
string $gender_female_querystring_val
Default value: NULL
gender female query string value
• size : 10
• nillable
int $adx_buyer_visibility_default
Default value: '1'
• size : 1
int $content_buyer_visibility_default
Default value: '1'
Denote if Content Category buyer is by default visble to sellers.
1. means buyer is visible and 0 means buyer is invisible
• size : 1
boolean $is_rtbs
Ignored on update.
Can not be set for Advertiser
boolean $is_rtbd
Ignored on update.
Can not be set for Publisher
boolean $enable_rtbd
Default value: '0'
Can not be set for Advertiser
boolean $enable_rtbs
Default value: '0'
Can not be set for Publisher
float $default_seller_reserve_price
Default value: NULL
Default seller reserve price. Review Reserve Price and Setting reserve price using API in the Yield Manager
Knowledge Base for details on Reserve Price.
• size : 17,5
263
Services
• nillable
boolean $allow_segment_selling
Default value: '0'
For internal use only
• nillable
boolean $allow_segment_buying
Default value: '0'
• nillable
boolean $allow_content_selling
Default value: '0'
• nillable
boolean $allow_content_buying
Default value: '0'
• nillable
entity_info
• EntityService
♦ getAdvByName()
♦ getByIds()
♦ getNetByName()
Fields Summary
• $id — Entity ID
• $name — Entity name
• $type — Entity Type (Publisher, Advertiser, Network)
Fields
int $id
Entity ID
string $name
Entity name
string $type
Entity Type (Publisher, Advertiser, Network)
entity_official_contacts
Fields Summary
• $account_managers — Account Managers array
• $trafficker_persons — Trafficker Persons array
• $sales_persons — Sales Persons array
264
Services
• $finance_contacts — Finance Contacts array
• $business_contacts — Business Contacts array
• $operations_contacts — Operations Contacts array
• $technical_contacts — Technical Contacts array
Fields
array_of_contact $account_managers
Account Managers array
array_of_contact $trafficker_persons
Trafficker Persons array
array_of_contact $sales_persons
Sales Persons array
array_of_contact $finance_contacts
Finance Contacts array
array_of_contact $business_contacts
Business Contacts array
array_of_contact $operations_contacts
Operations Contacts array
array_of_contact $technical_contacts
Technical Contacts array
entity_shell
• EntityService
♦ getMapByShellIds()
Fields Summary
• $entity_id — entity ID
• $shell_id — shell entity ID
Fields
int $entity_id
entity ID
string $shell_id
shell entity ID
exception_detail
• ct_report_result
♦ $exception_detail
• multiple_data_response
• multiple_data_result
265
Services
• multiple_result
Fields Summary
• $code — data object code
• $field_names
• $solution
Fields
string $code
data object code
array_of_string $field_names
string $solution
ex_entity_ids
• EntityService
♦ addEx()
Fields Summary
• $contact_id — contact ID
• $site_id — site ID
• $section_id — section ID
• $insertion_order_id — insertion order ID
• $line_item_id — line item ID
Fields
int $entity_id
entity ID
int $contact_id
contact ID
int $site_id
site ID
int $section_id
section ID
int $insertion_order_id
insertion order ID
int $line_item_id
line item ID
266
Services
flash_info
Fields Summary
• $is_high_risk
• $click_tags
• $click_urls
• $file_size
• $ad_height
• $ad_width
• $contains_audio
Fields
boolean $is_high_risk
array_of_string $click_tags
array_of_string $click_urls
int $file_size
int $ad_height
int $ad_width
boolean $contains_audio
gender
• managed_supply
♦ $gender
• preferred_terms_managed_supply
♦ $gender
• supply
♦ $gender
Fields Summary
• $include_male_gender — Male gender.
• $include_female_gender — Female gender.
• $include_unknown_gender — Gender information is not available.
Fields
boolean $include_male_gender
Male gender.
boolean $include_female_gender
Female gender.
boolean $include_unknown_gender
Gender information is not available.
267
Services
gender_target
♦ getTargetGender()
♦ TargetProfileService::getTargetGenderDepr()
♦ setTargetGender()
♦ TargetProfileService::setTargetGenderDepr()
Fields Summary
• $include_male_gender — show or not to show creatives to users of a male gender
• $include_female_gender — show or not to show creatives to users of a female gender
• $include_unknown_gender — show or not to show creatives to users when gender information is not
available
Fields
show or not to show creatives to users of a male gender
show or not to show creatives to users of a female gender
show or not to show creatives to users when gender information is not available
get_ivc_hidden_params
This file defines ivc_hidden_params data type
♦ getIVCHiddenParameters()
Fields Summary
• $control_type — IVC profile control type.
• $description — Control type description
• $hidden_parameters — IVC hidden parameters for control types macro, rtbd, targeting.
Fields
string $control_type
IVC profile control type.
string $description
Control type description
array_of_ivc_hidden_params_details $hidden_parameters
IVC hidden parameters for control types macro, rtbd, targeting.
getrtbdadminqpsresp
Fields Summary
• $advertiserId — Advertiser entity id
268
Services
• $region — Region to which qps setting belongs to
• $currentTime — Current time as seen by the service
• $qps — Query Per Second (QPS) value
• $lastUpdateTime — Timestamp the object was last updated
Fields
int $advertiserId
Advertiser entity id
• primary
string $region
Region to which qps setting belongs to
The complete list of enum values you can see at rtbd_region enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'rtbd_region').
• enum : rtbd_region
• primary
dateTime $currentTime
Current time as seen by the service
• nillable
float $qps
Query Per Second (QPS) value
dateTime $lastUpdateTime
Timestamp the object was last updated
• nillable
getrtbdqpsresp
• RtbdService
♦ getQPS()
Fields Summary
• $timeWindowLength — Number of minutes QPS setting will be valid, starting from now. Default is "-1", and it
means qps setting will be valid forever
• $lastUpdateTime — Timestamp the object was last updated
• $currentTime — Current time as seen by the service
• $windowExpirationTime — qps expiration time based on time_window_length value
Fields
int $advertiserId
• primary
269
Services
string $region
• primary
int $timeWindowLength
Default value: '-1'
Number of minutes QPS setting will be valid, starting from now. Default is "-1", and it means qps setting will be valid
forever
dateTime $lastUpdateTime
Timestamp the object was last updated
• nillable
dateTime $currentTime
Current time as seen by the service
• nillable
float $qps
dateTime $windowExpirationTime
qps expiration time based on time_window_length value
• nillable
global_template
• SitelistService
♦ createGT()
♦ createGTs()
♦ getAllGT()
♦ getGT()
♦ updateGT()
♦ updateGTs()
Fields Summary
• $locked — Sitelist locked flag.
• $sections — section_custom_group sections
Fields
270
Services
int $id
• size : 10
• primary
string $name
• size : 255
int $owner_id
Sitelist owner id
• size : 10
Ignored on update.
Sitelist owner type
boolean $active
Default value: '1'
boolean $locked
Default value: '0'
Sitelist locked flag.
array_of_int $sections
section_custom_group sections
string $notes
• size : 1000
dateTime $lastupd
Ignored on update.
Sitelist category
id_name
id data type
• advertiser_list
♦ $advertiser_custom_groups
♦ $advertisers
• creative_custom_object
271
Services
♦ $advertisers
♦ $beacons
• creative_properties
♦ $creative_beacons
♦ $creative_languages
♦ $creative_specs
♦ $creative_themes
• publisher_list
♦ $publisher_custom_groups
♦ $publishers
• rule_attribute
♦ $id_name_list
• trading_pit_creative_properties
♦ $creative_beacons
♦ $creative_languages
♦ $creative_policy_tags
♦ $creative_specs
♦ $creative_themes
Fields Summary
• $id — Object id.
• $name — Object name.
Fields
int $id
Object id.
string $name
Object name.
insertion_order
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByBuyer()
♦ getByBuyers()
♦ getBySeller()
♦ getBySellers()
♦ update()
• contract_history_item
♦ $insertion_order
• entity_data
• publisher_data
Fields Summary
• $billing_entity_id — Entity ID of the managed advertiser under the buyer seat. See Brand level billing for
details.
• $id — Insertion order ID. Autoset on creation.
• $description — Client's description of insertion order.
• $buyer_entity_id — ID of buyer (advertiser or network).
• $seller_entity_id — ID of seller (network or publisher).
• $bill_pricing_type — Bill pricing type
• $bill_amount — Bill amount
• $buyer_approved
• $seller_approved
• $buyer_auto_approval
272
Services
• $seller_auto_approval
• $date_created — Autoset at the call of InsertionOrderService::add() function
• $date_approved
• $po
• $comment — Any type of comments
• $buyer_notes
• $seller_notes
• $seller_contact_id
• $buyer_contact_id
• $billing_contact_id
• $exchange_rate
• $payment_terms_days
• $buyer_trafficker_id
• $buyer_po_number
• $internal_io_number
• $invoice_remarks
• $buyer_billing_code
• $seller_billing_code
• $linking_status — Linking status.
• $target_profile_id — Target profile ID.
• $lastupd
• $payment_method_id — Payment method id
• $force_use_third_party_numbers — Force billing on Third Party Numbers.
• $budget — Budget amount in currency. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency
specified by the owning entity's currency_id. If not set, unlimited budget is supposed.
listed in Imp Delivery Type Enum.
• $imp_delivery_cap — Max value for impression-capped delivery methods
• $smooth — When set to true, delivers budget/imps evenly or within caps (hourly/daily/weekly).
• $booking_country_id — For internal use only.
• $use_ruby_billing — For internal use only.
• $advertiser_name — For internal use only.
• $ycrm_io_id — For internal use only.
• $advertiser_joliet_id — For internal use only.
• $discount_code — For internal use only.
• $buyer_sales_region_id — For internal use only.
• $seller_sales_region_id — For internal use only.
• $default_enable_rtbd
• $default_enable_rtbs
• $sfdc_comment
Fields
int $billing_entity_id
Ignored on update.
Entity ID of the managed advertiser under the buyer seat. See Brand level billing for details.
int $id
Insertion order ID. Autoset on creation.
• size : 10
• primary
string $description
Client's description of insertion order.
• size : 255
Ignored on update.
ID of buyer (advertiser or network).
273
Services
• size : 10
int $seller_entity_id
Ignored on update.
ID of seller (network or publisher).
• size : 10
string $bill_pricing_type
Default value: NULL
Bill pricing type
The complete list of enum values you can see at bill_pricing_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'bill_pricing_type').
• nillable
• enum : bill_pricing_type
float $bill_amount
Default value: '0'
Bill amount
• size : 17,5
• nillable
boolean $buyer_approved
Default value: '0'
boolean $seller_approved
Default value: '0'
boolean $buyer_auto_approval
Default value: '0'
boolean $seller_auto_approval
Default value: '0'
dateTime $date_created
Autoset at the call of InsertionOrderService::add() function
• nillable
dateTime $date_approved
• nillable
string $po
• size : 20
• nillable
string $comment
Any type of comments
• nillable
string $buyer_notes
• nillable
274
Services
string $seller_notes
• nillable
int $seller_contact_id
• size : 10
• nillable
int $buyer_contact_id
• size : 10
• nillable
int $billing_contact_id
• size : 10
• nillable
Default value: '1'
• size : 10,4
int $payment_terms_days
Default value: '45'
• size : 4
int $buyer_trafficker_id
• size : 11
• nillable
string $buyer_po_number
• size : 255
• nillable
string $internal_io_number
• size : 255
• nillable
string $invoice_remarks
• nillable
string $buyer_billing_code
• size : 255
string $seller_billing_code
• size : 255
string $linking_status
Default value: ''
Linking status.
275
Services
The complete list of enum values you can see at linking_status enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'linking_status').
• enum : linking_status
Target profile ID.
• size : 8
• nillable
dateTime $lastupd
int $payment_method_id
Default value: '1'
Payment method id
• size : 2
boolean $force_use_third_party_numbers
Default value: '0'
Force billing on Third Party Numbers.
Defaults to false. Available on all managed advertiser IOs.
float $budget
Budget amount in currency. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency specified by the
owning entity's currency_id. If not set, unlimited budget is supposed.
• nillable
enum_delivery_type $delivery_type
float $delivery_cap
• nillable
int $imp_budget
• nillable
enum_imp_delivery_type $imp_delivery_type
Delivery method, may be set to ASAP, Even, hourly/daily/monthly cap. Valid types are listed in Imp Delivery Type
Enum.
Max value for impression-capped delivery methods
276
Services
• nillable
boolean $smooth
When set to true, delivers budget/imps evenly or within caps (hourly/daily/weekly).
int $booking_country_id
Default value: NULL
• size : 11
• nillable
int $use_ruby_billing
Default value: 0
• size : 1
string $advertiser_name
Default value: NULL
• size : 100
• nillable
string $ycrm_io_id
Default value: NULL
• size : 30
• nillable
string $advertiser_joliet_id
Default value: NULL
• size : 15
• nillable
float $discount_code
Default value: NULL
• nillable
int $buyer_sales_region_id
Default value: NULL
• size : 5
• nillable
int $seller_sales_region_id
Default value: NULL
• size : 5
• nillable
277
Services
int $default_enable_rtbd
Default value: 0
• size : 1
int $default_enable_rtbs
Default value: 0
• size : 1
string $sfdc_comment
• object : insertion_order_ext
inventory_media_type
See Inventory Media Type Enum for more information.
♦ getLineItemInventoryMediaType()
Fields Summary
• $id — Inventory media type id
• $inventory_media_type — Inventory media type
Fields
int $id
Inventory media type id
• size : 3
• primary
string $inventory_media_type
Inventory media type
• size : 255
inventory_type
See Inventory Type Enum for more information.
♦ getInventoryTypes()
Fields Summary
• $id — inventory type ID
• $name — inventory type name
Fields
int $id
inventory type ID
• size : 10
278
Services
• primary
string $name
inventory type name
• size : 50
inventory_visibility_controls
This file defines inventory_visibility_controls data type
• InventoryVisibilityControlsService
♦ add()
♦ addProfiles()
♦ get()
♦ getProfiles()
♦ update()
♦ updateProfiles()
Fields Summary
• $description — IVC profile description
• $buyer_entity_ids — Advertiser entity ids on which publisher control mask is set. Value 0 in this array will set
publisher control mask globally i.e. at network level.
• $hidden_params — Parameters to be masked.
• $top_level_domains — Top level domains.
• $profile_id — IVC profile id
• $owner_type — Owner type
• $owner_id — Owner Id
• $created_on — Pub control mask creation time
• $lastupd — Pub control mask last update time
Fields
string $description
IVC profile description
• nillable
array_of_int $buyer_entity_ids
Advertiser entity ids on which publisher control mask is set. Value 0 in this array will set publisher control mask
globally i.e. at network level.
ivc_hidden_params $hidden_params
Parameters to be masked.
• nillable
array_of_string $top_level_domains
Top level domains.
int $profile_id
IVC profile id
• size : 10
• primary
string $owner_type
Ignored on update.
279
Services
Default value: 'entity'
Owner type
The complete list of enum values you can see at pub_control_owner_type enum page, at run time you can get all of
them using DictionaryService.getEnumValues(token, 'pub_control_owner_type').
• enum : pub_control_owner_type
• primary
int $owner_id
Ignored on update.
Owner Id
• size : 10
• primary
Pub control mask creation time
dateTime $lastupd
Pub control mask last update time
isp
See Isp Enum for more information.
♦ getIsps()
Fields Summary
• $id — isp ID
• $name — isp name
Fields
int $id
isp ID
• size : 10
• primary
string $name
isp name
• size : 50
ivc_hidden_params_details
• get_ivc_hidden_params
♦ $hidden_parameters
Fields Summary
280
Services
• $parameter — IVC hidden parameter name in database.
• $display_name — Display name of IVC hidden parameter.
Fields
string $parameter
IVC hidden parameter name in database.
string $display_name
Display name of IVC hidden parameter.
The complete list of enum values you can see at 4_enum_pub_control_param .pkg, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'pub_control_param ').
• enum : pub_control_param
ivc_hidden_params
• get_ivc_hidden_params
♦ $hidden_parameters
• inventory_visibility_controls
♦ $hidden_params
Fields Summary
• $macro_hidden_params — IVC hidden parameter for control type 'macro'
• $rtbd_hidden_params — IVC hidden parameter for control type 'rtbd'
• $targeting_hidden_params — IVC hidden parameter for control type 'targeting'
Fields
macro_hidden_params $macro_hidden_params
IVC hidden parameter for control type 'macro'
• nillable
rtbd_hidden_params $rtbd_hidden_params
IVC hidden parameter for control type 'rtbd'
• nillable
targeting_hidden_params $targeting_hidden_params
IVC hidden parameter for control type 'targeting'
• nillable
language
See Language Enum for more information.
♦ getLanguages()
Fields Summary
281
Services
• $id — language ID
• $name — language name
• $iso_code — language ISO code
Fields
int $id
language ID
• size : 10
• primary
string $name
language name
• size : 50
string $iso_code
language ISO code
• size : 2
learn_type
See Learn Type Enum for more information.
♦ getLearnTypes()
Fields Summary
• $id — learn type ID
• $name — learn type name
Fields
int $id
learn type ID
• size : 10
• primary
string $name
learn type name
• size : 50
line_item_adjustment
This file defines line_item_adjustment data type
• AdjustmentService
♦ get()
♦ getAll()
♦ getAllByLineItem()
♦ getByBuyer()
♦ getCreatedByDates()
282
Services
♦ set()
Fields Summary
• $id — Adjusted period's id
• $line_item_id — Line item id
• $ymd_start — Start date of adjusted period
• $ymd_end — End date of adjusted period
• $value — Value of adjusted period
• $units — Units of adjusted period
• $adjustor_msg — Adjustment message
• $status — Adjustment's status
• $credit_comments — Credit request, reason for credit comments
Fields
int $id
Adjusted period's id
• size : 10
• primary
int $line_item_id
Default value: 0
Line item id
• size : 10
date $ymd_start
Default value: 0000-00-00
Start date of adjusted period
date $ymd_end
Default value: 0000-00-00
End date of adjusted period
float $value
Default value: 0
Value of adjusted period
string $units
Default value: 'revenue'
Units of adjusted period
The complete list of enum values you can see at adjustments_units enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'adjustments_units').
• nillable
• enum : adjustments_units
string $adjustor_msg
Adjustment message
string $status
Default value: 'new'
Adjustment's status
The complete list of enum values you can see at adjustments_status enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'adjustments_status').
• enum : adjustments_status
283
Services
string $credit_comments
Default value: null
Credit request, reason for credit comments
• nillable
line_item_goal
Fields Summary
• $conversion_id
• $goal_amount — Goal amount. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency
Fields
int $conversion_id
• size : 8
• primary
float $goal_amount
Goal amount. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency specified by the owning entity's
currency_id.
• size : 15,4
• nillable
line_item
• LineItemService
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByBuyer()
♦ getByCampaign()
♦ getByCreative()
♦ getByInsertionOrder()
♦ LineItemService::getByOrderDepr()
♦ getBySeller()
♦ setBillingStatus()
♦ update()
• contract_history_item
♦ $line_items
• entity_data
♦ $line_item
• placement
♦ $line_item
• publisher_data
♦ $line_item
Fields Summary
• $learning_slider — Learning slider for line items with dynamic pricing and CPC or CPA target.Â Use learnin
slider to set learning preferences: Value ranges from 0 to 100, where 0 = least learning, 100 = most learning
Learn more for higher accuracy and delivery at a higher cost.
• $delivery_clicks — delivery clicks, can be set with only CPC pricing, with delivery type hourly/daily/monthly.
Valid types are listed in Delivery Type Enum.
• $marketplace — Parameters that need to select line item marketplace('trading_pit','network_of_network').
Available only for managed advertiser Line item.
284
Services
• $campaign — Line item's campaign.
• $id — Line item ID. Autoset on creation.
• $description — Client's description of line item.
• $comment — Any type of comment
• $insertion_order_id — ID of insertion order, attached to campaign. Can be set by LineItemService::add()
function.
• $pricing_type — Pricing type, see valid types in Pricing Type Enum.
• $amount — Amount in currency for the pricing type. For fixed-rate, this is in USD; for dynamic-rate, this is in
the currency specified by the owning entity's currency_id.
• $bill_pricing_type — Bill pricing type, see valid types in Bill Pricing Type Enum.
• $bill_amount — Bill amount in currency for the pricing type. For fixed-rate, this is in USD; for dynamic-rate,
this is in the currency specified by the owning entity's currency_id.
• $active — Line item activity flag.
• $seller_approved — seller approval flag
• $buyer_approved — buyer approval flag
• $target_profile_id — Target profile ID.
• $delivery_rules_id — Delivery rules ID. Autoset by the server when creating a new line item.
• $delivery_adjustment — Used only for discretionary pricing type and if use_third_party_numbers set to TRUE
to optimize and deliver effectively (fill in percentage). See Yahoo Ad Exchange Knowledge Base for details.
• $use_third_party_numbers — Used only for discretionary pricing type and if use_third_party_numbers set to
TRUE to optimize and deliver effectively. See Yahoo Ad Exchange Knowledge Base for details.
• $show_advertisers
• $show_creatives
• $show_offer_types
• $show_creative_specs
• $show_deal_properties
• $conversion_id — For CPA line items only.
• $do_price_reduction — For dynamic and second price CPC line items only. Default value of this field for
dynamic line items is 1. For second price CPC line items default value is 0.See Using the line_item data type
to set up dynamic pricing options for details.
• $always_bid_the_maximum — Specify 'true' for Dynamic Pricing Option "Win at all costs". For more
information refer to KB Article: https://kb.yieldmanager.com/article.php?id=259
• $is_hard_target — Set to TRUE for CPC or CPA targeted line items. See Yahoo Ad Exchange Knowledge
Base for details.
• $buyer_sales_region_id
• $created_on
• $seller_sales_region_id
• $minimum_ecpm
• $using_minimum_seller_ecpm
• $buyer_minimum_profit_ecpm
• $seller_maximum_adjustment_percentage
• $buyer_maximum_discrepancy_percentage
• $buyer_code
• $buyer_code2
• $seller_code
• $priority — Line item priority.
• $allow_size_promotion
• $start_time — Start date and time (UTC) for line item, campaign or creative. If not set, current time is
assumed.
• $end_time — Line item end date and time (UTC).
• $budget — Budget by currency. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency
specified by the owning entity's currency_id. If not set, unlimited budget is assumed. If set then it has to be
non-zero.
• $imp_delivery_cap — Max value for impression capped delivery methods
• $tz_to_show — Specifies the time zone to use for start and end flight dates. See Flight dates for more
details.
• $smooth — When set to true, delivers budget/imps evenly over remainder of campaign or within caps
(hourly/daily/weekly).
• $convert_cpx_to_dcpm — Convert CPX to dCPM pricing
• $allow_convert_cpx_to_dcpm — Allow convert CPX to dCPM pricing
• $first_ran_date
• $last_ran_date
• $roi_modifier — Line Item ROI modifier
• $broker_fee_type — Broker fee type
• $broker_fee_amount — Broker fee amount
• $discretionary_cpm — Discretionary cpm
285
Services
• $ecpm_calculation_method — Ecpm calculation method
• $ym_numbers_difference — Ym numbers difference, field value NOT returned.
• $effective_price — Effective price
• $lastupd
• $line_item_goals — Line item's goals
• $show_to_linked_sellers — Flag to select one of showing mode
• $enable_rtbd
• $enable_rtbs
• $seller_reserve_price — Seller reserve price. Review Reserve Price and Setting reserve price using API in
the Yield Manager Knowledge Base for details on Reserve Price.
• $exempt_from_io_freq_cap — If set to 1, the insertion_order frequency cap target constraint will not be
applicable to this line_item.
• $type_id — Line Item type id for Display or Video see Media Type Table for additional information.
Fields
float $learning_slider
Learning slider for line items with dynamic pricing and CPC or CPA target.Â Use learnin slider to set learning
preferences: Value ranges from 0 to 100, where 0 = least learning, 100 = most learning Learn more for higher
accuracy and delivery at a higher cost.
Learn less to spend less, but with lower accuracy and delivery.
• nillable
int $delivery_clicks
delivery clicks, can be set with only CPC pricing, with delivery type hourly/daily/monthly. Valid types are listed in
Delivery Type Enum.
• nillable
array_of_enum_marketplace $marketplace
Parameters that need to select line item marketplace('trading_pit','network_of_network'). Available only for managed
advertiser Line item.
campaign $campaign
Line item's campaign.
Campaign object associated with line item, it can be used in add/update operation to update the value of campaign.
• object : campaign
int $id
Line item ID. Autoset on creation.
• size : 10
• primary
string $description
Client's description of line item.
• size : 255
string $comment
Any type of comment
• size : 1000
• nillable
Ignored on update.
ID of insertion order, attached to campaign. Can be set by LineItemService::add() function.
286
Services
• size : 10
string $pricing_type
Default value: 'CPM'
Pricing type, see valid types in Pricing Type Enum.
The complete list of enum values you can see at pricing_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'pricing_type').
• enum : pricing_type
float $amount
Default value: '0'
Amount in currency for the pricing type. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency specified
by the owning entity's currency_id.
• size : 17,5
string $bill_pricing_type
Default value: NULL
Bill pricing type, see valid types in Bill Pricing Type Enum.
The complete list of enum values you can see at bill_pricing_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'bill_pricing_type').
• enum : bill_pricing_type
float $bill_amount
Default value: '0'
Bill amount in currency for the pricing type. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency
• size : 17,5
boolean $active
Default value: '0'
Line item activity flag.
boolean $seller_approved
Default value: '0'
seller approval flag
boolean $buyer_approved
Default value: '0'
buyer approval flag
Target profile ID.
• size : 8
• nillable
Delivery rules ID. Autoset by the server when creating a new line item.
• size : 10
• nillable
int $delivery_adjustment
Used only for discretionary pricing type and if use_third_party_numbers set to TRUE to optimize and deliver effectively
(fill in percentage). See Yahoo Ad Exchange Knowledge Base for details.
287
Services
Please take into account that this field is connected to 'higher/lower than YM values' field in UI, the next logic is
followed: if you enter 40% and pick 'lower than YM numbers' the number save in delivery_adjustment is 100% - 40% =
60%, if you enter 150% and pick 'higher than YM numbers' the number save in delivery_adjustment is 100% + 150% =
250% (value 100 is 100%)
• size : 10,5
• nillable
boolean $use_third_party_numbers
Default value: '0'
Used only for discretionary pricing type and if use_third_party_numbers set to TRUE to optimize and deliver
effectively. See Yahoo Ad Exchange Knowledge Base for details.
boolean $show_advertisers
Default value: '0'
boolean $show_creatives
Default value: '0'
boolean $show_offer_types
Default value: '0'
boolean $show_creative_specs
Default value: '0'
boolean $show_deal_properties
Default value: '0'
int $conversion_id
Default value: '0'
For CPA line items only.
• size : 8
boolean $do_price_reduction
Default value: '1'
For dynamic and second price CPC line items only. Default value of this field for dynamic line items is 1. For second
price CPC line items default value is 0.See Using the line_item data type to set up dynamic pricing options for details.
boolean $always_bid_the_maximum
Default value: '0'
Specify 'true' for Dynamic Pricing Option "Win at all costs". For more information refer to KB Article:
https://kb.yieldmanager.com/article.php?id=259
boolean $is_hard_target
Default value: '1'
Set to TRUE for CPC or CPA targeted line items. See Yahoo Ad Exchange Knowledge Base for details.
int $buyer_sales_region_id
• size : 5
• nillable
Ignored on update.
• nillable
int $seller_sales_region_id
288
Services
• size : 5
• nillable
float $minimum_ecpm
Default value: 0
boolean $using_minimum_seller_ecpm
Default value: '0'
float $buyer_minimum_profit_ecpm
Default value: NULL
float $seller_maximum_adjustment_percentage
• size : 10,5
float $buyer_maximum_discrepancy_percentage
• size : 10,5
string $buyer_code
• size : 16
• nillable
string $buyer_code2
• size : 16
• nillable
string $seller_code
• size : 16
• nillable
Default value: 'Normal' Please see Delivery priority options for assistance with setting priority correctly for your line
item(s).
Line item priority.
boolean $allow_size_promotion
Default value: '1'
dateTime $start_time
Start date and time (UTC) for line item, campaign or creative. If not set, current time is assumed.
• nillable
dateTime $end_time
Line item end date and time (UTC).
If you leave this field unset or set it to null, it is equal to "never" value in UI. If you want to prevent a line item from
being trafficked, this field should be set to today and active to 0.
• nillable
289
Services
float $budget
Budget by currency. For fixed-rate, this is in USD; for dynamic-rate, this is in the currency specified by the owning
entity's currency_id. If not set, unlimited budget is assumed. If set then it has to be non-zero.
• nillable
string $delivery_type
The complete list of enum values you can see at delivery_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'delivery_type').
• enum : delivery_type
float $delivery_cap
• nillable
int $imp_budget
• nillable
Max value for impression capped delivery methods
• nillable
string $tz_to_show
Default value: 'America/New_York'
Specifies the time zone to use for start and end flight dates. See Flight dates for more details.
boolean $smooth
Default value: '1'
When set to true, delivers budget/imps evenly over remainder of campaign or within caps (hourly/daily/weekly).
boolean $convert_cpx_to_dcpm
Default value: '0'
Convert CPX to dCPM pricing
boolean $allow_convert_cpx_to_dcpm
Default value: '0'
290
Services
Allow convert CPX to dCPM pricing
float $roi_modifier
Line Item ROI modifier
string $broker_fee_type
Default value: 'Percent'
Broker fee type
The complete list of enum values you can see at fee_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'fee_type').
• field : fee_type
• enum : fee_type
• object : line_item_broker
float $broker_fee_amount
Broker fee amount
• size : 17,5
• nillable
• field : amount
• object : line_item_broker
float $discretionary_cpm
Default value: null
Discretionary cpm
• size : 17,5
• nillable
string $ecpm_calculation_method
Default value: '3-day'
Ecpm calculation method
enum_ym_numbers_difference $ym_numbers_difference
Default value: NULL
Ym numbers difference, field value NOT returned.
Setting lower/higher modifies the value of delivery_adjustment (please check delivery_adjustment field docs)
• nillable
float $effective_price
Effective price
dateTime $lastupd
array_of_line_item_goal $line_item_goals
Line item's goals
• nillable
291
Services
• field : campaign_goals
• object : campaign
string $show_to_linked_sellers
Default value: 'All Publishers'
Flag to select one of showing mode
The complete list of enum values you can see at line_item_show_to_linked_sellers enum page, at run time you can
get all of them using DictionaryService.getEnumValues(token, 'line_item_show_to_linked_sellers').
• size : 1
• enum : line_item_show_to_linked_sellers
boolean $enable_rtbd
Default value: 0
boolean $enable_rtbs
Default value: 0
float $seller_reserve_price
Default value: NULL
Seller reserve price. Review Reserve Price and Setting reserve price using API in the Yield Manager Knowledge Base
for details on Reserve Price.
• size : 17,5
boolean $exempt_from_io_freq_cap
Default value: NULL
If set to 1, the insertion_order frequency cap target constraint will not be applicable to this line_item.
int $type_id
Default value: 1
Line Item type id for Display or Video see Media Type Table for additional information.
link_data
• LinkingService
♦ getAllLinks()
♦ getAppliedLinks()
♦ getLinkData()
♦ getLinkableEntityData()
♦ getLinkedEntityData()
♦ getNonlinkedEntityData()
♦ getProposedLinks()
Fields Summary
• $id — link data object ID
• $linking_profile — contains the linking profile
• $ratings — contains the average rating values
• $user_ratings — contains the average rating values made by requester if there is an approved link
• $sections — contains the array of sections
• $billing_entity_id — Entity ID of the managed advertiser under the buyer seat. Applicable when sending the
billing links, otherwise zero. See Brand level billing for additional details.
• $link_status — Status of the link
• $insertion_order_id — Insertion order ID.
Fields
292
Services
int $id
link data object ID
entity $entity
linking_profile $linking_profile
contains the linking profile
linking_rating $ratings
contains the average rating values
linking_rating $user_ratings
contains the average rating values made by requester if there is an approved link
array_of_string $sections
contains the array of sections
Ignored on update.
Entity ID of the managed advertiser under the buyer seat. Applicable when sending the billing links, otherwise zero.
See Brand level billing for additional details.
string $link_status
Status of the link
Insertion order ID.
linked_entities_info
♦ getLinkedInfo()
Fields Summary
• $buyer_entity_id — Entity ID of buyer (advertiser or network).
• $buyer_name — Name of buyer (advertiser or network).
• $seller_entity_id — Entity ID of seller (network or publisher).
• $seller_name — Name of seller (network or publisher).
• $seller_integration_code
• $buyer_integration_code
• $billing_entity_id — Entity ID of the managed advertiser under the buyer seat. See Brand level billing for
details.
Fields
Entity ID of buyer (advertiser or network).
293
Services
string $buyer_name
Name of buyer (advertiser or network).
Entity ID of seller (network or publisher).
string $seller_name
Name of seller (network or publisher).
string $seller_integration_code
string $buyer_integration_code
Entity ID of the managed advertiser under the buyer seat. See Brand level billing for details.
linking_profile
• LinkingService
♦ addProfile()
♦ getProfile()
♦ updateProfile()
• link_data
♦ $linking_profile
Fields Summary
• $company_name — the company name
• $description — additional information
• $iso_adv — advertiser Independent Sales Organization
• $iso_pub — publisher Independent Sales Organization
• $logo_url
• $avg_rating — the average rating value
• $status
• $adv_contact_id — the advertiser contact ID
• $pub_contact_id — the publisher contact ID
• $date_created — the creation date
• $revenue_share — the amount of revenue share
• $minimum_payout — the minimum payout
• $company_website — the company website
• $pub_contact_email_address
• $payment_terms
• $payment_methods
• $rmxd_pub_contact_email
Fields
int $entity_id
entity ID
• size : 10
• primary
the company name
• size : 100
294
Services
string $description
string $iso_adv
advertiser Independent Sales Organization
• nillable
string $iso_pub
publisher Independent Sales Organization
• nillable
string $logo_url
• size : 127
• nillable
float $avg_rating
Default value: '0'
the average rating value
boolean $status
Default value: '1'
int $adv_contact_id
the advertiser contact ID
• size : 10
• nillable
int $pub_contact_id
the publisher contact ID
• size : 10
• nillable
dateTime $date_created
the creation date
float $revenue_share
Default value: '0'
the amount of revenue share
float $minimum_payout
Default value: '0'
the minimum payout
the company website
• size : 255
• nillable
string $pub_contact_email_address
• nillable
295
Services
int $payment_terms
• size : 6
• nillable
array_of_payment_method $payment_methods
• nillable
string $rmxd_pub_contact_email
• size : 50
• nillable
linking_rating
• link_data
♦ $ratings
♦ $user_ratings
Fields Summary
• $overall — the average value of common rating
• $trust — the average value of trust rating
• $cpm — the average value of cpm rating
• $timely_payout — the average value of timely payout rating
• $support — the average value of support rating
Fields
float $overall
the average value of common rating
float $trust
the average value of trust rating
float $cpm
the average value of cpm rating
float $timely_payout
the average value of timely payout rating
float $support
the average value of support rating
YieldManager SOAP API Documentation
Welcome to soap_api-!
This documentation was generated by phpDocumentor v1.3.0RC6
296
Services
login_options
• ContactService
♦ login()
Fields Summary
• $errors_level — errors level
• $use_master_db — use master db for reads (always)
• $language_code — The complete list of enum values you can see at language_iso_code enum page, at run
time you can get all of them using DictionaryService.getEnumValues(token, 'language_iso_code').
• $multiple_sessions — This flag is relevant only when this login would cause the entity's limit on maximum
concurrent sessions to be exceeded. Specifically, it controls login's behavior with respect to other currently
active API user sessions.
Fields
enum_errors_level $errors_level
Default value: 'throw_errors'
errors level
boolean $use_master_db
Default value: false
use master db for reads (always)
Enabling master db usage is allowed only for trusted api users
string $language_code
Default value: 'en'
The complete list of enum values you can see at language_iso_code enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'language_iso_code').
• enum : language_iso_code
boolean $multiple_sessions
Default value: false if entity is limited to 1 concurrent session, else true
This flag is relevant only when this login would cause the entity's limit on maximum concurrent sessions to be
exceeded. Specifically, it controls login's behavior with respect to other currently active API user sessions.
If false, and this login would cause the entity's limit on maximum concurrent sessions to be exceeded, then login will
first logout all (and only) API sessions belonging to the same contact, and then will create a new session. All the
sessions owned by other contacts of the same entity will remain untouched and other contacts may continue to use
them.
If true, and this login would cause the entity's limit on maximum concurrent sessions to be exceeded, then login will
fail. For this reason, it is important that customers using this flag be sure to call logout to close all sessions that were
created by their API client program. Otherwise, currently open sessions will remain active and count towards your
entity's limit on maximum concurrent sessions, thus blocking other API client programs that run under your entity.
Contact API Support at [email protected] if you need to increase your entity's limit on maximum concurrent
sessions.
macro_hidden_params
• ivc_hidden_params
♦ $macro_hidden_params
Fields Summary
297
Services
• $channels — IVC hidden parameter for channels.
• $url — IVC hidden parameter for URL.
• $publisher_id — IVC hidden parameter for publisher ID.
• $section_id — IVC hidden parameter for section ID.
• $section_code — IVC hidden parameter for section code.
• $site_id — IVC hidden parameter for site ID.
• $age — IVC hidden parameter for age.
• $gender — IVC hidden parameter for gender.
• $ip — IVC hidden parameter for IP.
• $content_segments — IVC hidden parameter for content segments.
Fields
boolean $channels
Default value: '0'
IVC hidden parameter for channels.
boolean $url
Default value: '0'
IVC hidden parameter for URL.
boolean $publisher_id
Default value: '0'
IVC hidden parameter for publisher ID.
boolean $section_id
Default value: '0'
IVC hidden parameter for section ID.
boolean $section_code
Default value: '0'
IVC hidden parameter for section code.
boolean $site_id
Default value: '0'
IVC hidden parameter for site ID.
boolean $age
Default value: '0'
IVC hidden parameter for age.
boolean $gender
Default value: '0'
IVC hidden parameter for gender.
boolean $ip
Default value: '0'
IVC hidden parameter for IP.
boolean $content_segments
Default value: '0'
IVC hidden parameter for content segments.
managed_demand
managed data type
298
Services
• supply_blocklist
♦ $managed_demand
Fields Summary
• $buying_technology — Array of buying technology RTBD, Hosted.
• $managed_advertisers — Managed advertisers.
Fields
Array of buying technology RTBD, Hosted.
advertiser_list $managed_advertisers
Managed advertisers.
Deal properties.
managed_supply
managed data type
• demand_blocklist
♦ $managed_supply
Fields Summary
• $managed_publishers — Managed publishers.
• $sections — Sections.
• $sizes — Sizes.
• $devices — Devices.
• $browsers — Browsers.
• $operating_systems — Operating systems.
• $carrier_isp — Carrier ISP.
• $selling_technology — Array of selling technology RTBS, Hosted
• $gender — Gender - Male, female, unknown.
• $ages — Ages to included or excluded.
Fields
publisher_list $managed_publishers
Managed publishers.
Sections.
rule_attribute $sizes
Sizes.
Woeids.
299
Services
rule_attribute $devices
Devices.
rule_attribute $browsers
Browsers.
rule_attribute $operating_systems
Operating systems.
rule_attribute $carrier_isp
Carrier ISP.
Channels.
Array of selling technology RTBS, Hosted
gender $gender
Gender - Male, female, unknown.
rule_attribute_ids $ages
Ages to included or excluded.
managing_entity_ids
managing_entity_ids data type.
Fields Summary
• $entity_id
• $managing_entity_name
• $managing_entity_id
Fields
int $entity_id
string $managing_entity_name
• nillable
int $managing_entity_id
• nillable
marketplace_settings
Fields Summary
• $trading_pit_buyer — Indicates if the seat is in Trading pit as buyer
• $trading_pit_seller — Indicates if the seat is in Trading pit as seller
• $network_of_network — Indicates if the seat is NoN (ie, linked) marketplace
• $trading_pit_rev_cap — Trading pit Max supply limits. Unlimited if null.
• $trading_pit_spend_cap — Trading pit Max demand limits. Unlimited if null.
• $trading_pit_active — Indicates if the seat is active for transactions on Trading pit
300
Services
• $buyer_tpbe_prefs — Buyer TPBE preferences
• $seller_tpbe_prefs — Seller TPBE preferences
• $entity_id — Entity ID of the seat
• $trading_pit_supply_fee_amount — Trading pit supply fee - rev share or flat ecpm. Rev share supported as
of now.
• $trading_pit_demand_fee_amount — Trading pit demand fee - rev share or flat ecpm. Rev share supported
as of now.
Fields
boolean $trading_pit_buyer
Default value: '0'
Indicates if the seat is in Trading pit as buyer
boolean $trading_pit_seller
Default value: '0'
Indicates if the seat is in Trading pit as seller
boolean $network_of_network
Default value: '0'
Indicates if the seat is NoN (ie, linked) marketplace
float $trading_pit_rev_cap
Trading pit Max supply limits. Unlimited if null.
• nillable
float $trading_pit_spend_cap
Trading pit Max demand limits. Unlimited if null.
• nillable
boolean $trading_pit_active
Default value: '0'
Indicates if the seat is active for transactions on Trading pit
array_of_tp_billing_entity_preferences $buyer_tpbe_prefs
Buyer TPBE preferences
array_of_tp_billing_entity_preferences $seller_tpbe_prefs
Seller TPBE preferences
int $entity_id
Ignored on update.
Entity ID of the seat
• size : 10
• primary
float $trading_pit_supply_fee_amount
Default value: 0.0
Trading pit supply fee - rev share or flat ecpm. Rev share supported as of now.
• size : 7,4
float $trading_pit_demand_fee_amount
Default value: 0.0
Trading pit demand fee - rev share or flat ecpm. Rev share supported as of now.
• size : 7,4
301
Services
media_type
See Media Type Enum for more information.
♦ getMediaTypes()
Fields Summary
• $id — media type ID
• $description — media type description
Fields
int $id
media type ID
• size : 5
• primary
string $description
media type description
• size : 50
mg_label_mapping
♦ getMGLabelMappings()
Fields Summary
• $creative_tag_id
• $adult_or_suggestive
• $distracting_or_flashing
• $deceptive
• $drugs_or_alcohol
• $gambling
• $profanity_or_violence
• $crude
• $opencat
• $always_banned
Fields
int $creative_tag_id
• size : 5
• primary
boolean $adult_or_suggestive
boolean $distracting_or_flashing
boolean $deceptive
boolean $drugs_or_alcohol
302
Services
boolean $gambling
boolean $profanity_or_violence
int $crude
• size : 1
boolean $opencat
boolean $always_banned
mime_type
See 4_enum_video_mime_type.pkg for more information.
Fields Summary
• $id — Mime type ID
• $mime_type — mime type name
• $video_type — video type name
Fields
int $id
Mime type ID
• size : 3
• primary
string $mime_type
mime type name
• size : 30
string $video_type
video type name
• size : 100
msa
See Msa Enum for more information.
♦ getMsas()
Fields Summary
• $id — msa ID
• $name — msa name
• $country_id — msa country ID
• $region_ids — The list of regions attached to the MSA.
Fields
303
Services
int $id
msa ID
• size : 5
• primary
string $name
msa name
• size : 50
int $country_id
msa country ID
• size : 5
The list of regions attached to the MSA.
multiple_data_response
multiple_data_response data type
• PixelService
♦ getShareForSegments()
• SegmentService
♦ getAncestorsInfo()
♦ getAncestorsPublicInfo()
♦ getDescendantsPublicInfo()
Fields Summary
• $resultIDs — array of identifiers to specific response objects
• $result
• $exception_text
• $item_id
Fields
array_of_int $resultIDs
array of identifiers to specific response objects
boolean $result
int $item_id
multiple_data_result
304
Services
♦ add()
♦ delete()
♦ deleteByUrls()
♦ update()
• CampaignService
♦ addCreatives()
♦ deleteCampaigns()
• CreativeService
♦ addAttach()
♦ addAttachCreatives()
♦ addCreatives()
♦ deleteCreatives()
♦ triggerCreativeTest()
• EntityService
♦ deleteAllPublisherControls()
♦ deleteEntities()
♦ setAllPublisherControls()
♦ deleteInsertionOrders()
• InventoryVisibilityControlsService
♦ addProfiles()
♦ deleteProfiles()
• LineItemService
♦ addCreatives()
♦ deleteLineItems()
• NotificationService
♦ NotificationService::validateTMReport()
• PassbackService
♦ activatePassbacks()
♦ deactivatePassbacks()
♦ deletePassbacks()
• PixelService
♦ deletePixels()
• PublisherReservePriceService
♦ addProfiles()
♦ deleteProfiles()
• ReportService
♦ addSegmentReportVisibility()
♦ updateSegmentReportVisibility()
• SiteService
• SitelistService
♦ createASLs()
♦ createGTs()
♦ updateASLs()
♦ updateGTs()
Fields Summary
• $result
• $exception_text
• $item_id
Fields
boolean $result
int $item_id
305
Services
multiple_result
♦ deleteTargetClickUrls()
♦ deleteTargetCreatives()
♦ setTargetClickUrlsV2()
Fields Summary
• $result
• $exception_text
• $item
Fields
int $result
string $item
netspeed
See Netspeed Enum for more information.
♦ getNetspeeds()
Fields Summary
• $id — netspeed ID
• $name — netspeed name
Fields
int $id
netspeed ID
• size : 5
• primary
string $name
netspeed name
• size : 50
notice
♦ getNotices()
306
Services
Fields Summary
• $id — The id of the notification message
• $head — The head of the notification message
• $body — The text of the notification message
Fields
int $id
The id of the notification message
string $head
The head of the notification message
string $body
The text of the notification message
offer_type
See Offer Type Enum for more information.
♦ getOfferTypes()
Fields Summary
• $id — offer type ID
• $parent_id — Parent offer type ID. Offer types are organized in 2 level hierarchy. This field indicates the
parent offer type id.
• $description — offer type description
• $long_description — offer type long description
Fields
int $id
offer type ID
• size : 10
• primary
int $parent_id
Default value: NULL
Parent offer type ID. Offer types are organized in 2 level hierarchy. This field indicates the parent offer type id.
The value is null if the offer type is first level, and non-null for 2nd level offer type.
• size : 10
string $description
offer type description
• size : 255
string $long_description
offer type long description
• size : 255
307
Services
optimization_config
Fields Summary
• $bucketId — optimization_config object bucketId
• $paraNameId — optimization_config object paraNameId
• $bucketStart — optimization_config object bucket start time
• $bucketEnd — optimization_config object bucket end time
• $paraValue — optimization_config object para value
Fields
int $bucketId
optimization_config object bucketId
• size : 10
• primary
int $paraNameId
optimization_config object paraNameId
• size : 4
• primary
dateTime $bucketStart
optimization_config object bucket start time
• primary
dateTime $bucketEnd
optimization_config object bucket end time
• primary
string $paraValue
optimization_config object para value
• size : 64
optimization_para_name
Fields Summary
• $id — optimization_para_name ID
• $paraName — optimization_para_name object paraName
• $description — optimization_para_name object description
Fields
int $id
optimization_para_name ID
308
Services
• size : 4
• primary
string $paraName
Default value: 'paraname'
optimization_para_name object paraName
• size : 32
string $description
optimization_para_name object description
• size : 64
passback
• PassbackService
♦ add()
♦ get()
♦ getAll()
♦ update()
Fields Summary
• $id — ID. Autoset on passback creation.
• $owner_type — Passback owner type
• $passback_type — Passback type
• $owner_id — Passback owner id
• $size_id — Passback size id
• $is_secure — Passback secure
• $content — Passback content
• $description — Description of passback.
• $media_type — content media type. See Media Type Enum for more information.
• $media_url — redirect URL to get the content
• $active — Passback active flag.
• $entity_id — entity id associated with the passback.
• $created_on — Passback creation time.
Fields
int $id
ID. Autoset on passback creation.
• size : 10
• primary
enum_passback_creative_owner_type $owner_type
Ignored on update.
Passback owner type
enum_passback_creative_type $passback_type
Passback type
array_of_int $owner_id
Passback owner id
int $size_id
Passback size id
309
Services
boolean $is_secure
Passback secure
string $content
Passback content
string $description
Description of passback.
string $media_type
content media type. See Media Type Enum for more information.
The complete list of enum values you can see at media_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'media_type').
• enum : media_type
string $media_url
redirect URL to get the content
boolean $active
Default value: '1'
Passback active flag.
int $entity_id
Ignored on update.
entity id associated with the passback.
• size : 10
Passback creation time.
payment_method
• linking_profile
♦ $payment_methods
Fields Summary
• $id — payment method ID
• $description — payment method description
Fields
int $id
payment method ID
• size : 2
• primary
string $description
payment method description
• size : 100
310
Services
piggyback_pixel
• PixelService
♦ addPiggybackPixel()
♦ getAllPiggybackPixelsSince()
♦ getPiggybackPixels()
Fields Summary
• $id
• $entity_id — The entity ID the pixel is bound to.
• $pixel_redirect_url — URL which will be used when a conversion is triggered
• $pixel_type — type of the pixel.
• $lastupd
Fields
int $id
• size : 10
• primary
int $entity_id
Ignored on update.
The entity ID the pixel is bound to.
Setting $entity_id to 0 will display the pixel to all publishers.
• size : 10
• nillable
string $pixel_redirect_url
URL which will be used when a conversion is triggered
• size : 255
string $pixel_type
type of the pixel.
The complete list of enum values you can see at pixel_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'pixel_type').
• enum : pixel_type
dateTime $lastupd
• nillable
pixel
• CreativeService
♦ getAttachedSegments()
• PixelService
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByEntity()
311
Services
♦ getByLineItem()
♦ getSegments()
♦ update()
Fields Summary
• $is_network_wide — Set to 1 if pixel is network-wide
• $id — pixel ID
• $public_segment_id — public segment ID
• $name — pixel name
• $integration_code — integration code - once an integration code has been set it allows you to lookup up for
pixels with that code
• $active — Active flag. Deactivating any segment pixel that you have shared via Audience Share will remove
the corresponding segment shares, and thus will deactivate any line items -- except your own -- that are
targeting this pixel and notify their owners. See Sharing or unsharing segments in the Audience marketplace
for details.
• $repeat_ignore_interval — repeat ignore interval
• $post_click_interval — post click interval
• $post_view_interval — post view interval
• $segment_duration — Segment duration
• $include_by_default — included by default flag
• $advertiser_entity_id — advertiser entity id the pixel is bound to
• $pixel_type — Pixel type
• $created_on — Conversion creation time. Autoset by API.
• $lastupd
• $hybrid_trigger_type — Indicate what kind of hybrid pixel current pixel is
• $property_flags — Indicate Property flags. ('no_frequency_data','no_recency_data','adcall_ingest_allowed')
This field should be set only for Y!'s BTRE segments.
• $segment_type_id — Segment type id. See valid types in Segment Type Enum. Applicable only when
$pixel_type = 'Segment'.
• $segment_manager_entity_id — Segment manager entity id. Applicable only when $pixel_type = 'Segment'.
Fields
int $is_network_wide
Set to 1 if pixel is network-wide
int $id
pixel ID
• size : 8
• primary
Default value: null
public segment ID
• size : 8
• nillable
string $name
pixel name
• size : 255
integration code - once an integration code has been set it allows you to lookup up for pixels with that code
boolean $active
Active flag. Deactivating any segment pixel that you have shared via Audience Share will remove the corresponding
segment shares, and thus will deactivate any line items -- except your own -- that are targeting this pixel and notify
their owners. See Sharing or unsharing segments in the Audience marketplace for details.
312
Services
int $repeat_ignore_interval
Default value: '0'
repeat ignore interval
• size : 10
int $post_click_interval
post click interval
The following rules are followed to determine the UI trigger type:
1. if post_click_interval is 0 and post_view_interval is 0 then trigger type is "Segment"
2. if post_click_interval is 0 and post_view_interval > 0 or NULL then trigger type is "Post-view"
3. if post_click_interval > 0 or NULL and post_view_interval is 0 then trigger type is "Post-click"
4. else trigger type is "Post-view and/or Post-click"
• size : 11
• nillable
int $post_view_interval
post view interval
• size : 11
• nillable
int $segment_duration
Default value: 0
Segment duration
This field's purpose - pixel expiration/duration period if pixel type is segment. It can be set for segment pixels only.
Pixel treated as as segment when post_click_interval = 0 and post_view_interval = 0. Valid range is 0..2 years (value
is stored in seconds, so the valid range is 0..63072000)
• size : 8
• nillable
boolean $include_by_default
included by default flag
Ignored on update.
advertiser entity id the pixel is bound to
• size : 10
Ignored on update.
Default value: '1'
• size : 10,4
enum_trigger_pixel_type $pixel_type
Default value: NULL
Pixel type
List of possible values: "Segment" is equal to post_click_interval is 0 and post_view_interval is 0 "Post-view" is equal
to post_click_interval is 0 and post_view_interval > 0 or NULL "Post-click" is equal to post_click_interval > 0 or NULL
and post_view_interval is 0 "Post-view and/or Post-click" in other cases
313
Services
• nillable
Ignored on update.
Conversion creation time. Autoset by API.
• nillable
dateTime $lastupd
• nillable
string $hybrid_trigger_type
Indicate what kind of hybrid pixel current pixel is
The complete list of enum values you can see at hybrid_trigger_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'hybrid_trigger_type').
• enum : hybrid_trigger_type
string $property_flags
Default value: null
Indicate Property flags. ('no_frequency_data','no_recency_data','adcall_ingest_allowed') This field should be set only
for Y!'s BTRE segments.
int $segment_type_id
Ignored on update.
Default value: NULL
Segment type id. See valid types in Segment Type Enum. Applicable only when $pixel_type = 'Segment'.
The complete list of enum values you can see at 4_enum_segment_type, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'segment_type ').
• size : 3
• enum : segment_type
• nillable
int $segment_manager_entity_id
Ignored on update.
Default value: NULL
Segment manager entity id. Applicable only when $pixel_type = 'Segment'.
• size : 10
• nillable
pixel_pair
• SegmentDefinitionService
♦ add()
Fields Summary
• $private_segment_id — Private segment id.
• $public_segment_id — Public segment id. Available to both Audience Manager buyers/sellers. Should be
used in buyer/seller communications.
Fields
314
Services
int $private_segment_id
Private segment id.
• nillable
Public segment id. Available to both Audience Manager buyers/sellers. Should be used in buyer/seller
communications.
pixel_tag_params
• PixelService
♦ getPixelTags()
Fields Summary
• $advertiser_id
• $conversion_ids
• $conversion_tag_type
• $secure_pixel
Fields
int $advertiser_id
array_of_int $conversion_ids
enum_conversion_tag_type $conversion_tag_type
Default value: 'img'
boolean $secure_pixel
Default value: '0'
placement_creative
• PlacementService
♦ PlacementService::addCreative()
Fields Summary
• $tag
• $media_type
• $pop_types
• $menubar
• $resizable
• $scrollbars
• $status
• $toolbar
• $addressbar
• $pop_expand_to_full_window
• $pop_height
• $pop_width
• $pop_window_title
• $is_third_party
• $creative_type
• $clickthrough_url
• $id — Creative ID. Autoset on creative creation by CreativeService::add() or CreativeService::addCreatives().
315
Services
• $code
• $advertiser_entity_id — ID of advertiser the creative belongs to.
• $active — Creative activity flag.
• $is_audited — Shows if object has been audited by Media Guard.
• $description — Client's description of creative.
• $adapt_media_hex
• $adapt_click_hex
• $size_id — ID of creative (width, length) pair, see Size Enum for valid values.
• $is_pending
• $created_on — Creative creation time. Autoset by CampaignService::addCreative().
• $height — Creative height, required for pop (size_id = 0); must be > 0 and <= 10000.
• $width — Creative width, required for pop (size_id = 0); must be > 0 and <= 10000.
• $beacon_conversion_id — ID of beacon switched by this creative. See Yahoo Ad Exchange Knowledge
Base for details.
• $original_tag
• $can_track_clicks — This is a Boolean that must be true in order for click tracking to function.
• $flash_loop — If TRUE, flash creative loops
• $flash_bgcolor — Background color for flash
• $flash_clicktag
• $third_party_type — Third party tag type. value is set depending on creative_content.content value, checked
at insert & update
• $is_ssl — Creative spec. See Yahoo Ad Exchange Knowledge Base for details.
• $is_distracting — Creative theme. See Creative themes for details.
• $is_suggestive — Creative theme. See Creative themes for details.
• $is_violent — Creative theme. See Creative themes for details.
• $is_textlink — Creative spec. See Creative specs for details.
• $has_active_x — Creative spec. See Creative specs for details.
• $has_exit_pop — Creative spec. See Creative specs for details.
• $banner_opens_pop — Creative spec. See Creative specs for details.
• $flash_has_embedded_url
• $offer_type_id — Creative's offer type. See Offer Type table for additional information. See also Creative
• $click_url — Creative's click url. Creative must be clickable to use it. See Yahoo Ad Exchange Knowledge
Base for details.
• $has_video_or_rich_media — Creative spec. See Creative specs for details.
• $is_deceptive — Creative theme. See Creative themes for details.
• $is_political — Creative theme. See Creative themes for details.
• $audio_type — Creative spec. See Creative specs for details.
• $target_profile_id — ID of target profile, attached to creative. Can be set by
CreativeService::addTargetProfile().
• $delivery_rules_id — Delivery rules ID. Autoset by the server when creating a new creative.
• $initiates_pop — If TRUE, YAX server initiates pop window at the client' side before pop creative delivery.
See Yahoo Ad Exchange Knowledge Base for details.
• $is_web_site_pop — Creative spec. See Creative specs for details.
• $no_iframes — If TRUE, tag code doesn't create IFRAME
• $is_pre_audited
• $last_audited_by_contact_id
• $last_human_audit
• $last_automated_audit
• $use_campaign_click_url
• $contents
• $custom_settings
• $imp_delivery_cap — Max value for impression-capped delivery methods.
• $is_bcm_upload
• $view_tracker — Allows clients to run agency deals by trafficking image and flash creative directly along with
a 3rd-party impression-tracking (view tracker) pixel. We store the URL of the impression-tracking pixel in
view_tracker field.
• $first_ran_date
• $last_ran_date
• $needs_arbitration
• $ad_size_in_bytes
• $lastupd
• $language_id — Id of language creative_tag
• $ad_vendor_id — Ad vendor ID. For internal use only. Do not use.
• $is_rtb — For RTB creative
• $is_3pi
• $classification_review_status — Creative classification review status, see valid types in Creative
Classification Review Status Enum.
• $video_creative — Complex data type to represent video creative attributes.
316
Services
Fields
string $tag
• nillable
string $media_type
• nillable
int $pop_types
• size : 11
• nillable
int $menubar
Default value: '0'
• size : 1
int $resizable
Default value: '0'
• size : 1
int $scrollbars
Default value: '0'
• size : 1
int $status
Default value: '0'
• size : 1
int $toolbar
Default value: '0'
• size : 1
int $addressbar
Default value: '0'
• size : 1
int $pop_expand_to_full_window
Default value: '0'
• size : 1
int $pop_height
• size : 11
• nillable
int $pop_width
• size : 11
• nillable
317
Services
string $pop_window_title
• size : 100
• nillable
int $is_third_party
Default value: '0'
• size : 4
string $creative_type
• nillable
string $clickthrough_url
Default value: '0'
int $id
Creative ID. Autoset on creative creation by CreativeService::add() or CreativeService::addCreatives().
• size : 10
• primary
string $code
• size : 100
• nillable
Ignored on update.
ID of advertiser the creative belongs to.
Can be set by CampaignService::addCreative() or CreativeService::update(). Please note that (advertiser_entity_id,
description) should be a unique tuple.
• size : 10
boolean $active
Default value: '1'
Creative activity flag.
boolean $is_audited
Default value: '0'
Shows if object has been audited by Media Guard.
This field is deprecated. Media Guard will not audit creatives to associate creative specs/themes. Refer Creative
specs, Creative themes for more details
• deprecated
string $description
Client's description of creative.
Please note that (advertiser_entity_id, description) should be a unique tuple.
• size : 255
string $adapt_media_hex
• size : 255
• nillable
318
Services
string $adapt_click_hex
• size : 255
• nillable
int $size_id
Default value: '0'
ID of creative (width, length) pair, see Size Enum for valid values.
Please note that size id provided in Linear Video creative will be ignored.
The complete list of enum values you can see at size enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'size').
• size : 10
• enum : size
boolean $is_pending
Creative creation time. Autoset by CampaignService::addCreative().
int $height
Creative height, required for pop (size_id = 0); must be > 0 and <= 10000.
int $width
Creative width, required for pop (size_id = 0); must be > 0 and <= 10000.
ID of beacon switched by this creative. See Yahoo Ad Exchange Knowledge Base for details.
• size : 8
string $original_tag
boolean $can_track_clicks
Default value: '0'
This is a Boolean that must be true in order for click tracking to function.
When you use the My Yieldmanager UI to add clickable creatives, the UI asks you to manually test the creative to be
sure that click tracking is working properly. Once that testing has been completed successfully, the UI automatically
sets the $can_track_clicks on the creative. However, this testing mechanism is not available via the API, so you must
set this flag manually. Keep in mind that setting this flag will affect the way your ads are served; we strongly
recommend that, before setting $can_track_clicks, you have used the UI to test the clickability of a creative that is
representative of your creative object.
boolean $flash_loop
If TRUE, flash creative loops
string $flash_bgcolor
Background color for flash
• size : 10
string $flash_clicktag
• size : 30
319
Services
enum_creative_third_party_types $third_party_type
Third party tag type. value is set depending on creative_content.content value, checked at insert & update
• nillable
boolean $is_ssl
This flag is = 0 when creative is not CT tested or when it is non ssl.
• deprecated
• deprecated
boolean $is_violent
• deprecated
• deprecated
• deprecated
• deprecated
320
Services
boolean $flash_has_embedded_url
int $offer_type_id
Creative's offer type. See Offer Type table for additional information. See also Creative offer types for details.
The complete list of enum values you can see at offer_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'offer_type').
• size : 10
• enum : offer_type
string $click_url
Creative's click url. Creative must be clickable to use it. See Yahoo Ad Exchange Knowledge Base for details.
• nillable
• deprecated
• deprecated
• deprecated
string $audio_type
This field is deprecated. Use corresponding Creative Tag ID (IDs: 241, 242) in creative::$self_classification_tags to
• deprecated
ID of target profile, attached to creative. Can be set by CreativeService::addTargetProfile().
• size : 8
• nillable
Delivery rules ID. Autoset by the server when creating a new creative.
• size : 10
321
Services
• nillable
boolean $initiates_pop
If TRUE, YAX server initiates pop window at the client' side before pop creative delivery. See Yahoo Ad Exchange
Knowledge Base for details.
• deprecated
boolean $no_iframes
If TRUE, tag code doesn't create IFRAME
int $is_pre_audited
• size : 1
• nillable
int $last_audited_by_contact_id
• size : 10
• nillable
dateTime $last_human_audit
• nillable
dateTime $last_automated_audit
• nillable
int $use_campaign_click_url
Default value: '0'
• size : 1
Campaign priority.
array_of_creative_content $contents
custom_settings $custom_settings
• nillable
int $imp_budget
• nillable
322
Services
Max value for impression-capped delivery methods.
• nillable
int $is_bcm_upload
Default value: '0'
• size : 1
Allows clients to run agency deals by trafficking image and flash creative directly along with a 3rd-party
impression-tracking (view tracker) pixel. We store the URL of the impression-tracking pixel in view_tracker field.
• size : 255
• nillable
boolean $needs_arbitration
int $ad_size_in_bytes
• size : 11
• nillable
dateTime $lastupd
• nillable
int $language_id
Id of language creative_tag
int $ad_vendor_id
Ad vendor ID. For internal use only. Do not use.
• field : ad_vendor_id
• object : db_creative_ad_vendor
• nillable
323
Services
boolean $is_rtb
Default value: '0'
For RTB creative
boolean $is_3pi
Default value: '0'
Default value: 'not-reviewed'
Creative classification review status, see valid types in Creative Classification Review Status Enum.
The complete list of enum values you can see at creative_classification_review_status enum page, at run time you
can get all of them using DictionaryService.getEnumValues(token, 'creative_classification_review_status').
• nillable
• enum : creative_classification_review_status
video_creative $video_creative
Complex data type to represent video creative attributes.
placement
♦ PlacementService::get()
♦ PlacementService::getByInsertionOrder()
Fields Summary
• $id — placement ID
• $name — placement line item description
• $price — placement line item amount, in USD
• $size_id — placement creative size ID
• $tag — placement creative content
• $geo_target — placement geography target information
• $section_target — placement section target information
• $frequency_target — placement frequency target information
• $enabled — placement line item activity flag
• $line_item — placement line item
• $creative — placement creative
Fields
int $id
placement ID
• primary
string $name
placement line item description
float $price
placement line item amount, in USD
int $size_id
placement creative size ID
string $tag
324
Services
placement creative content
target_geography $geo_target
placement geography target information
target_section $section_target
placement section target information
target_frequency $frequency_target
placement frequency target information
boolean $enabled
placement line item activity flag
placement line item
creative $creative
placement creative
pop_type
See Pop Types Enum for more information.
♦ getPopTypes()
Fields Summary
• $id — pop type ID
• $name — pop type name
Fields
int $id
pop type ID
• size : 3
• primary
string $name
pop type name
• size : 50
postal_code
Fields Summary
• $woeid — WOEID
• $postal_code — Postal code
• $iso — Country ISO
Fields
325
Services
int $woeid
WOEID
• size : 10
• primary
string $postal_code
Postal code
• size : 10
string $iso
Country ISO
• size : 2
preferred_terms_demand
preferred_terms_demand data type
• preferred_terms
♦ $preferred_terms_demand
Fields Summary
• $marketplace — Demand rule applicable on Trading Pit, Netwrok of network, Intra Network(Managed
Advertiser) or any combination of these. See Buying Selling Marketplace Enum for valid values.
values.
• $advertisers — Advertiser ids.
creative_beacons.
Fields
Demand rule applicable on Trading Pit, Netwrok of network, Intra Network(Managed Advertiser) or any combination of
these. See Buying Selling Marketplace Enum for valid values.
advertiser_list $advertisers
Advertiser ids.
Deal properties.
creative_properties $creative_tags
Click Urls.
326
Services
Offer types.
preferred_terms_getall
preferred data type
• PreferredTermsService
♦ getAllPreferredTerms()
♦ quickSearch()
Fields Summary
• $id — Preferred terms id.
• $name — Preferred terms name.
• $description — Preferred terms description.
• $pvt_marketplace_id — Private Marketplace id.
• $is_pvt_marketplace — Is Private Marketplace.
• $markup — Field markup introduces bias on bids for certain slices of demand.
• $created_by_contact_id — Contact id who created Preferred terms.
• $created_by_contact_name — Name of contact who created Preferred terms.
• $modified_by_contact_id — Contact id who modified Preferred terms.
• $modified_by_contact_name — Name of contact who modified Preferred terms.
• $active — Preferred terms activity flag.
• $created_on — Preferred terms created on date/time.
• $lastupd — Preferred terms last updated date/time.
Fields
int $id
Preferred terms id.
string $name
Preferred terms name.
string $description
Preferred terms description.
int $entity_id
Owner entity ID
string $entity_name
int $pvt_marketplace_id
Default value: '0'
Private Marketplace id.
boolean $is_pvt_marketplace
Default value: '0'
Is Private Marketplace.
float $markup
Field markup introduces bias on bids for certain slices of demand.
327
Services
Contact id who created Preferred terms.
Name of contact who created Preferred terms.
Contact id who modified Preferred terms.
Name of contact who modified Preferred terms.
boolean $active
Default value: '0'
Preferred terms activity flag.
Preferred terms created on date/time.
dateTime $lastupd
Preferred terms last updated date/time.
preferred_terms
preferred_terms data type
♦ add()
♦ getAllSince()
♦ getByObjectId()
♦ update()
Fields Summary
• $id — Preferred Terms id.
• $name — Preferred Terms name.
• $description — Preferred Terms description.
• $preferred_terms_managed_supply — Complex data type to represent managed supply attributes.
• $preferred_terms_demand — Complex data type to represent demand attributes.
• $priority — Preferred Terms priority.
• $reserve_price — Reserve price. It should be greater than 0.
• $forex_currency_id — Forex Currency Id
• $is_pvt_marketplace — Is Private Marketplace.
• $pvt_marketplace_controls — Complex data type to represent deal controls.
• $pvt_marketplace_id — Private Marketplace id.
• $markup — Field markup introduces bias on bids for certain slices of demand.
• $created_by_contact_id — Contact id who created Preferred Terms.
• $modified_by_contact_id — Contact id who modified Preferred Terms.
• $active — Preferred Terms activity flag.
• $created_on — Preferred Terms created on date/time.
• $lastupd — Preferred Terms last updated date/time.
Fields
int $id
Ignored on update.
Preferred Terms id.
328
Services
• primary
string $name
Preferred Terms name.
string $description
Preferred Terms description.
int $entity_id
Owner entity ID
preferred_terms_managed_supply $preferred_terms_managed_supply
Complex data type to represent managed supply attributes.
preferred_terms_demand $preferred_terms_demand
enum_preferred_terms_priority $priority
Default value: 'Normal' Please see the Exchange Knowledge base article on preferred terms priority options for more
information.
Preferred Terms priority.
float $reserve_price
Reserve price. It should be greater than 0.
int $forex_currency_id
Forex Currency Id
boolean $is_pvt_marketplace
Default value: '0'
Is Private Marketplace.
private_marketplace_controls $pvt_marketplace_controls
Complex data type to represent deal controls.
int $pvt_marketplace_id
Default value: '0'
• primary
float $markup
Field markup introduces bias on bids for certain slices of demand.
Contact id who created Preferred Terms.
Contact id who modified Preferred Terms.
boolean $active
Default value: '0'
329
Services
Preferred Terms activity flag.
Preferred Terms created on date/time.
dateTime $lastupd
Preferred Terms last updated date/time.
preferred_terms_managed_supply
preferred_terms_managed_supply data type
• preferred_terms
♦ $preferred_terms_managed_supply
Fields Summary
• $managed_publishers — Managed publishers.
• $seller_line_items — Publisher LineItems.
• $urls — URLs.
• $inventory_types — Section inventory type. See valid types in Inventory Type Enum
• $sizes — Sizes.
• $dayparts — Dayparts
• $devices — Devices.
• $browsers — Browsers.
• $operating_systems — Operating systems.
• $carrier_isp — Carrier ISP.
• $selling_technology — Array of selling technology RTBS, Hosted
• $gender — Gender - Male, female, unknown.
• $ages — Ages to included or excluded.
• $vurls — Vurls.
• $segment_ids — Segments.
Fields
publisher_list $managed_publishers
Managed publishers.
Sections.
rule_attribute $seller_line_items
Publisher LineItems.
Channels.
rule_attribute_names $urls
URLs.
rule_attribute $inventory_types
Section inventory type. See valid types in Inventory Type Enum
330
Services
rule_attribute $sizes
Sizes.
Woeids.
rule_dayparts $dayparts
Dayparts
rule_attribute $devices
Devices.
rule_attribute $browsers
Browsers.
rule_attribute $operating_systems
Operating systems.
rule_attribute $carrier_isp
Carrier ISP.
Array of selling technology RTBS, Hosted
gender $gender
Gender - Male, female, unknown.
Ages to included or excluded.
rule_vurl_data $vurls
Vurls.
rule_attribute $segment_ids
Segments.
preferred_terms_search_options
preferred data type
♦ getAllPreferredTerms()
Fields Summary
• $ids — Array of preferred terms ids.
• $names — Array of preferred terms names.
• $descriptions — Array of preferred terms descriptions.
331
Services
Fields
array_of_int $ids
Array of preferred terms ids.
Array of preferred terms names.
Array of preferred terms descriptions.
int $is_active
private_marketplace_controls
private_marketplace_controls data type
• preferred_terms
♦ $pvt_marketplace_controls
Fields Summary
• $share_through_rtb_bids — Flag to send DealId as part of the RTB request.
• $share_reserve_price — Flag to send ReservePrice as part of the RTB request.
• $allow_bid_in_open_auction — Flag to allow if the bidder can bid outside the deal.
Fields
boolean $share_through_rtb_bids
Default value: '0'
Flag to send DealId as part of the RTB request.
boolean $share_reserve_price
Default value: '0'
Flag to send ReservePrice as part of the RTB request.
boolean $allow_bid_in_open_auction
Default value: '0'
Flag to allow if the bidder can bid outside the deal.
332
Services
private_marketplace
• preferred_terms
♦ $pvt_marketplace_controls
Fields Summary
• $id — Private Marketplace ID.
• $name — Private Marketplace name.
• $description — Private Marketplace description.
• $selling_rule_id — Selling Rule ID.
• $active — Active / inactive flag. Only active profiles will be taken by cache gen.
• $lastupd — Private Marketplace last updated date/time.
• $is_deleted — Shows if object is deleted.
• $share_through_rtb_bids — Flag to send DealId as part of the RTB request.
• $share_reserve_price — Flag to send ReservePrice as part of the RTB request.
• $allows_double_dipping — Flag to allow if the bidder can bid outside the deal.
Fields
int $id
Private Marketplace ID.
• size : 8
• primary
string $name
Private Marketplace name.
• size : 50
string $description
Private Marketplace description.
• size : 255
int $selling_rule_id
Selling Rule ID.
• size : 8
boolean $active
Active / inactive flag. Only active profiles will be taken by cache gen.
dateTime $lastupd
Private Marketplace last updated date/time.
boolean $is_deleted
Default value: '0'
Shows if object is deleted.
boolean $share_through_rtb_bids
Default value: '0'
Flag to send DealId as part of the RTB request.
boolean $share_reserve_price
Default value: '0'
Flag to send ReservePrice as part of the RTB request.
333
Services
boolean $allows_double_dipping
Default value: '0'
Flag to allow if the bidder can bid outside the deal.
publisher_control_data
This file defines publisher_control_data data type
• EntityService
♦ getPublisherControls()
• SiteService
♦ getPublisherControls()
Fields Summary
• $type — control type (macro, rtbd)
• $hidden_params — parameters that need to hide(channels, url, publisher_id, section_id, section_code,
site_id)
• $owner_type — Owner type
• $owner_id — Owner Id
• $buyer_entity_id — Buyer entity id
• $created_on — Pub control mask creation time
• $lastupd — Pub control mask last update time
Fields
string $type
Default value: 'rtbd'
control type (macro, rtbd)
The complete list of enum values you can see at 4_enum_pub_control_type .pkg, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'pub_control_type ').
• enum : pub_control_type
array_of_enum_pub_control_param $hidden_params
parameters that need to hide(channels, url, publisher_id, section_id, section_code, site_id)
• nillable
string $owner_type
Default value: 'entity'
Owner type
The complete list of enum values you can see at pub_control_owner_type enum page, at run time you can get all of
them using DictionaryService.getEnumValues(token, 'pub_control_owner_type').
• enum : pub_control_owner_type
• primary
int $owner_id
Owner Id
• size : 10
• primary
Default value: 0
Buyer entity id
• size : 10
• primary
334
Services
Pub control mask creation time
dateTime $lastupd
Pub control mask last update time
publisher_control_masks
This file defines publisher_control_masks data type that is used in bulk operations
• EntityService
♦ getAllPublisherControls()
• SiteService
♦ getAllPublisherControls()
Fields Summary
• $type — control type (all, macro, rtbd)
• $hidden_params — parameters that need to hide(channels, url, publisher_id, section_id, section_code,
site_id, age, gender, ip)
• $buyer_entity_ids — Array of advertisers to which publisher control masks will be applied
Fields
string $type
control type (all, macro, rtbd)
The complete list of enum values you can see at 4_enum_pub_control_type .pkg, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'pub_control_type ').
• enum : pub_control_type
array_of_enum_pub_control_param $hidden_params
parameters that need to hide(channels, url, publisher_id, section_id, section_code, site_id, age, gender, ip)
• nillable
Array of advertisers to which publisher control masks will be applied
publisher_data
Fields Summary
• $publisher — contains the publisher object
• $contact — contains the contact object
• $create_site_section — site and section creation flag
• $site — contains the site object
• $section — contains the section object
• $create_io_li — insertion order and line item creation flag
• $insertion_order — contains the insertion order object
• $line_item — contains the line item object
335
Services
Fields
publisher $publisher
contains the publisher object
• deprecated
entity $entity
contact $contact
contains the contact object
boolean $create_site_section
site and section creation flag
site $site
contains the site object
section $section
contains the section object
boolean $create_io_li
insertion order and line item creation flag
contains the insertion order object
contains the line item object
publisher_list
publisher data type
• buying_terms_supply
♦ $publishers
• managed_supply
♦ $managed_publishers
♦ $managed_publishers
• supply
♦ $publishers
Fields Summary
• $publisher_custom_groups — Custom groups of publishers.
• $include — Flag include is set "true" to include or "false" to exclude particular publishers in the $publishers
and $publisher_custom_groups arrays.
Fields
array_of_id_name $publishers
Publishers.
336
Services
array_of_id_name $publisher_custom_groups
Custom groups of publishers.
boolean $include
Flag include is set "true" to include or "false" to exclude particular publishers in the $publishers and
$publisher_custom_groups arrays.
publisher_reserve_price_profile
This file defines publisher reserve price profile data type
♦ add()
♦ addProfiles()
♦ get()
♦ getAll()
♦ update()
Fields Summary
• $section_ids — Array of section ids belonging to same publisher entity id. Reserve price applicable on given
section ids. Not allowed for network level entity.
• $demand_types — Demand types.If demand_type is passed as empty it will apply to all types of
demands.See Demand Type Enum for valid values.
• $buyer_entity_ids — Array of buyer entity ids.
• $segment_ids — Array of segment ids.
• $woeids — Array of WOEIDs.
• $cga_ids — Array of custom geographic area ids.
• $size_ids — Array of size ids.
• $creative_tag_ids — Array of creative tag ids. Currently richmedia tags are available(Tag ids : 233, 281, 283,
297).
• $device_ids — Array of device ids. Available devices are 'PC' and 'Mobile'.
• $id — Reserve price profile id.
• $description — Reserve price description. If it is not provided by user, default description will be added as
'Reserve price for entity $entity_id'. Description should not be greater than 50 characters.
• $entity_id — Entity id. Reserve price applicable on given entity id. Should be 'Publisher' or 'Network' entity id.
• $price — Seller reserve price. Reserve price should be greater than 0.
• $forex_currency_id — Forex currency id.
• $mark_up — Mark up [Not operational].
• $active — Flag indicates if reserve price profile is active.
• $lastupd
Fields
array_of_int $section_ids
Array of section ids belonging to same publisher entity id. Reserve price applicable on given section ids. Not allowed
for network level entity.
array_of_enum_demand_type $demand_types
Default value: ''
Demand types.If demand_type is passed as empty it will apply to all types of demands.See Demand Type Enum for
valid values.
Array of buyer entity ids.
array_of_int $segment_ids
Array of segment ids.
array_of_int $woeids
337
Services
Array of WOEIDs.
array_of_int $cga_ids
Array of custom geographic area ids.
Array of size ids.
array_of_int $creative_tag_ids
Array of creative tag ids. Currently richmedia tags are available(Tag ids : 233, 281, 283, 297).
array_of_int $device_ids
Array of device ids. Available devices are 'PC' and 'Mobile'.
int $id
Reserve price profile id.
• size : 8
• primary
string $description
Reserve price description. If it is not provided by user, default description will be added as 'Reserve price for entity
$entity_id'. Description should not be greater than 50 characters.
• size : 255
int $entity_id
Ignored on update.
Entity id. Reserve price applicable on given entity id. Should be 'Publisher' or 'Network' entity id.
• size : 8
float $price
Seller reserve price. Reserve price should be greater than 0.
Forex currency id.
• size : 3
float $mark_up
Mark up [Not operational].
• size : 17,5
boolean $active
Default value: '1'
Flag indicates if reserve price profile is active.
dateTime $lastupd
338
Services
pv_section_data
Fields Summary
• $section_id — Section id
• $time_offset
Fields
int $section_id
Section id
dateTime $time_offset
pvt_marketplace
private_marketplace data type
• EntityService
♦ getEligiblePrivateMarketPlaces()
Fields Summary
• $id — Private Marketplace id.
• $name — Private Marketplace name.
• $active — Private Marketplace active status.
• $seller_entity_id — Owner entity ID
• $seller_entity_name — Owner entity name
• $reserve_price — Reserve Price
Fields
int $id
• primary
string $name
Private Marketplace name.
boolean $active
Private Marketplace active status.
Owner entity ID
string $seller_entity_name
Owner entity name
float $reserve_price
Reserve Price
339
Services
quicksearch_result
This file contains quicksearch_result data type
• SearchService
♦ quickSearch()
Fields Summary
• $owner_entity_id
• $owner_entity_name
• $owner_entity_type — entity type (Publisher, Advertiser, Network)
• $object_type — object type
• $object_id
• $object_name
• $owner_additional_type — owned additional entity type (Publisher, Advertiser, Network)
Fields
int $owner_entity_id
string $owner_entity_name
string $owner_entity_type
entity type (Publisher, Advertiser, Network)
string $object_type
object type
The complete list of enum values you can see at quicksearch_object_type enum page, at run time you can get all of
them using DictionaryService.getEnumValues(token, 'quicksearch_object_type').
• enum : quicksearch_object_type
int $object_id
string $object_name
string $owner_additional_type
owned additional entity type (Publisher, Advertiser, Network)
quota
• QuotaService
♦ getQuotaByCmdGroup()
340
Services
♦ getQuotaByServiceByMethod()
Fields Summary
• $entity_id — Entity ID for which quota limit is set. For internal use only.
• $service — Service name for which quota limit is set. Included in
QuotaService::getQuotaByServiceByMethod() output only.
• $method — Service method for which quota limit is set. Included in
QuotaService::getQuotaByServiceByMethod() output only.
• $limit — Allocated limit.
• $used — Quota used so far. Included in QuotaService::getQuotaByServiceByMethod() output only.
• $cmdgroup_name — Name of the command group.
• $time_zone — Time zone that a given entity is configured with. For internal use only.
• $type — Quota type
Fields
int $entity_id
Entity ID for which quota limit is set. For internal use only.
string $service
Service name for which quota limit is set. Included in QuotaService::getQuotaByServiceByMethod() output only.
string $method
Service method for which quota limit is set. Included in QuotaService::getQuotaByServiceByMethod() output
only.
int $limit
Allocated limit.
int $used
Quota used so far. Included in QuotaService::getQuotaByServiceByMethod() output only.
string $cmdgroup_name
Name of the command group.
string $time_zone
Time zone that a given entity is configured with. For internal use only.
string $type
Quota type
The complete list of enum values you can see at quota_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'quota_type').
• enum : quota_type
rating_options
See Rating Enum for more information.
341
Services
• LinkingService
♦ setRating()
Fields Summary
• $entity_id — ID of the entity this ratings belongs to
• $overall — overall rating (1..5)
• $trust — trust rating (1..5)
• $cpm — cpm rating (1..5)
• $timely_payout — timely payout rating (1..5)
• $support — support rating (1..5)
• $comment — additional information
Fields
int $entity_id
ID of the entity this ratings belongs to
int $overall
overall rating (1..5)
int $trust
trust rating (1..5)
int $cpm
cpm rating (1..5)
int $timely_payout
timely payout rating (1..5)
int $support
support rating (1..5)
string $comment
region
See Region Enum for more information.
♦ getRegions()
Fields Summary
• $id — region ID
• $name — region name
• $code — region code
• $country_id — region country ID
• $has_tz — region time zone flag
• $std_offset — daylight save time offset
• $timezone — region time zone
• $msa_ids — The list of MSA attached to the region.
Fields
int $id
region ID
342
Services
• size : 5
• primary
string $name
region name
• size : 50
string $code
region code
• size : 2
int $country_id
region country ID
• size : 5
int $has_tz
region time zone flag
• size : 4
int $std_offset
daylight save time offset
• size : 11
string $timezone
region time zone
• size : 100
array_of_int $msa_ids
The list of MSA attached to the region.
reserve_price_buyer_entity
Fields Summary
• $reserve_price_profile_id — Reserve price profile id.
• $buyer_entity_id — Buyer entity id.
• $demand_type — Demand types.If demand_type is passed as empty it will apply to all types of demands.See
Demand Type Enum for valid values.
Fields
int $reserve_price_profile_id
Reserve price profile id.
• size : 8
• primary
Buyer entity id.
• size : 10
• primary
343
Services
enum_demand_type $demand_type
Default value: ''
Demand types.If demand_type is passed as empty it will apply to all types of demands.See Demand Type Enum for
valid values.
• primary
reserve_price_filter_options
♦ getAll()
Fields Summary Fields
richmedia_creative_attributes
• creative
♦ $richmedia_creative_attribute
Fields Summary
• $is_expandable — Is Expandable Creative
• $is_floating — Is Floating Creative
• $is_polite_download — Is Polite Download
• $is_video — Is Flash Video
• $is_other — Does creative belong to any other rich media category?
• $expandable_final_width — Expandable Final Width
• $expandable_final_height — Expandable Final Height
Fields
boolean $is_expandable
Default value: '0'
Is Expandable Creative
boolean $is_floating
Default value: '0'
Is Floating Creative
boolean $is_polite_download
Default value: '0'
Is Polite Download
boolean $is_video
Default value: '0'
Is Flash Video
boolean $is_other
Default value: '0'
Does creative belong to any other rich media category?
int $expandable_final_width
Expandable Final Width
• size : 10
• nillable
344
Services
int $expandable_final_height
Expandable Final Height
• size : 10
• nillable
role
See Role Enum for more information.
♦ getRoles()
Fields Summary
• $id
• $description
Fields
int $id
• size : 10
• primary
string $description
• size : 255
rtbdadminqps
Fields Summary
Fields
int $advertiserId
• primary
string $region
• primary
float $qps
345
Services
rtbdbidurl
• RtbdService
♦ getBidURL()
♦ setBidURL()
Fields Summary
• $region — Region to which BidUrl setting belongs to
• $bidUrl — Url where bid is to be sent at the time of Ad call
• $bidApiVersion — The API version used The complete list of enum values you can see at bid_api_version
enum page, at run time you can get all of them using DictionaryService.getEnumValues(token,
'bid_api_version').
• $bidTransportFormat — Format in which bid is to be sent The complete list of enum values you can see at
bid_transport_format enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'bid_transport_format').
• $bidTransferEncoding — Encoding in which bid is to be sent The complete list of enum values you can see at
bid_transfer_encoding enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'bid_transfer_encoding').
Fields
int $advertiserId
• primary
string $region
Region to which BidUrl setting belongs to
• primary
string $bidUrl
Url where bid is to be sent at the time of Ad call
int $bidApiVersion
The API version used The complete list of enum values you can see at bid_api_version enum page, at run time you
can get all of them using DictionaryService.getEnumValues(token, 'bid_api_version').
• nillable
• enum : bid_api_version
string $bidTransportFormat
Default value: 'xml'
Format in which bid is to be sent The complete list of enum values you can see at bid_transport_format enum page, at
run time you can get all of them using DictionaryService.getEnumValues(token, 'bid_transport_format').
• enum : bid_transport_format
string $bidTransferEncoding
Default value: 'uncompressed'
Encoding in which bid is to be sent The complete list of enum values you can see at bid_transfer_encoding enum
page, at run time you can get all of them using DictionaryService.getEnumValues(token,
'bid_transfer_encoding').
• enum : bid_transfer_encoding
346
Services
rtbdfailurereport
• RtbdService
♦ getFailureReport()
Fields Summary
• $beginTime — The start time for the reporting item, eg. 2011-10-31 00:00
• $endTime — The end time for the reporting item, ie. 2011-10-31 00:30
• $bidUrl — URL where the bid request send to
• $bidErrorType — The failure error code
• $bidErrorName — The failure error string
• $numOfFailedRequests — The number of failed requests.
Fields
int $advertiserId
• primary
dateTime $beginTime
The start time for the reporting item, eg. 2011-10-31 00:00
• nillable
dateTime $endTime
The end time for the reporting item, ie. 2011-10-31 00:30
• nillable
string $bidUrl
URL where the bid request send to
string $bidErrorType
The failure error code
string $bidErrorName
The failure error string
int $numOfFailedRequests
The number of failed requests.
rtbd_hidden_params
♦ $rtbd_hidden_params
Fields Summary
• $channels — IVC hidden parameter for channels
• $url — IVC hidden parameter for URL
347
Services
• $publisher_id — IVC hidden parameter for publisher ID
• $section_id — IVC hidden parameter for section ID
• $section_code — IVC hidden parameter for section code
• $site_id — IVC hidden parameter for site ID
• $age — IVC hidden parameter for age
• $gender — IVC hidden parameter for gender
• $ip — IVC hidden parameter for IP Address
• $content_segments — IVC hidden parameter for content segments
• $ip_based_location — IVC hidden parameter for IP-based location
• $lat_long_based_location — IVC hidden parameter for Lat/Long-based location
• $sub_domain — IVC hidden parameter for Sub domain.
• $puburl_hash — IVC hidden parameter for Pub Url Hash.
• $appid_appname — IVC hidden parameter for appId/appName.
• $device_id — IVC hidden parameter for Device Id.
• $inventory_type — IVC hidden parameter for Inventory Type.
Fields
boolean $channels
Default value: '0'
IVC hidden parameter for channels
boolean $url
Default value: '0'
IVC hidden parameter for URL
boolean $publisher_id
Default value: '0'
IVC hidden parameter for publisher ID
boolean $section_id
Default value: '0'
IVC hidden parameter for section ID
boolean $section_code
Default value: '0'
IVC hidden parameter for section code
boolean $site_id
Default value: '0'
IVC hidden parameter for site ID
boolean $age
Default value: '0'
IVC hidden parameter for age
boolean $gender
Default value: '0'
IVC hidden parameter for gender
boolean $ip
Default value: '0'
IVC hidden parameter for IP Address
Default value: '0'
IVC hidden parameter for content segments
boolean $ip_based_location
Default value: '0'
IVC hidden parameter for IP-based location
348
Services
boolean $lat_long_based_location
Default value: '0'
IVC hidden parameter for Lat/Long-based location
boolean $sub_domain
Default value: '0'
IVC hidden parameter for Sub domain.
boolean $puburl_hash
Default value: '0'
IVC hidden parameter for Pub Url Hash.
boolean $appid_appname
Default value: '0'
IVC hidden parameter for appId/appName.
boolean $device_id
Default value: '0'
IVC hidden parameter for Device Id.
boolean $inventory_type
Default value: '0'
IVC hidden parameter for Inventory Type.
rtbdqps
• RtbdService
♦ setQPS()
Fields Summary
• $timeWindowLength — Number of minutes QPS setting will be valid, starting from now. Default is "-1", and it
means qps setting will be valid forever
Fields
int $advertiserId
• primary
string $region
• primary
int $timeWindowLength
Default value: '-1'
Number of minutes QPS setting will be valid, starting from now. Default is "-1", and it means qps setting will be valid
forever
349
Services
float $qps
rtbdrecenttrafficreport
• RtbdService
♦ getRecentTrafficReport()
Fields Summary
• $averageQPS — Sliding window aggregate to estimate QPS to advertiser observed over time window
(end_time - begin_time).
• $requestsSent — The total number of requests sent to this advertiser over time window.
• $requestsSuccessful — The total number of successful requests sent to this advertiser over time window.
• $requestsSuccessfulLatency — The measured latency between requests successfully sent and responses
received from the advertiser.
• $requestsTimedOut — Number of requests that were sent to this advertiser but were discarded because a
response was not received in the allocated time.
• $requestsWithError — Number of requests that were not successfully processed due to an error condition
(eg. network failure, advertiser server 404, etc.)
Fields
int $advertiserId
• primary
string $region
• primary
dateTime $beginTime
• nillable
dateTime $endTime
• nillable
float $averageQPS
Sliding window aggregate to estimate QPS to advertiser observed over time window (end_time - begin_time).
int $requestsSent
The total number of requests sent to this advertiser over time window.
350
Services
int $requestsSuccessful
The total number of successful requests sent to this advertiser over time window.
float $requestsSuccessfulLatency
The measured latency between requests successfully sent and responses received from the advertiser.
int $requestsTimedOut
Number of requests that were sent to this advertiser but were discarded because a response was not received in the
allocated time.
int $requestsWithError
Number of requests that were not successfully processed due to an error condition (eg. network failure, advertiser
server 404, etc.)
rtbdsuccessreport
• RtbdService
♦ getSuccessReport()
Fields Summary
• $bidUrl — URL where the bid request send to
• $totalBidRequests — total number of requests sent to the advertiser.
• $numOfSuccessfulRequests — The total number of requests with response received from advertiser.
• $measuredLatency — The measured latency between requests successfully sent and responses received
from the advertiser.
Fields
int $advertiserId
• primary
dateTime $beginTime
• nillable
dateTime $endTime
• nillable
string $bidUrl
URL where the bid request send to
int $totalBidRequests
total number of requests sent to the advertiser.
int $numOfSuccessfulRequests
The total number of requests with response received from advertiser.
351
Services
float $measuredLatency
The measured latency between requests successfully sent and responses received from the advertiser.
rule_attribute
rule data type
♦ $creative_size_ids
♦ $line_items
• buying_terms_supply
♦ $cga_ids
♦ $channels
♦ $private_marketplace
♦ $sections
♦ $woeids
• demand
♦ $click_urls
♦ $offer_types
• managed_supply
♦ $ages
♦ $browsers
♦ $carrier_isp
♦ $cga_ids
♦ $channels
♦ $devices
♦ $operating_systems
♦ $sections
♦ $sizes
♦ $woeids
♦ $click_urls
♦ $offer_types
♦ $ages
♦ $browsers
♦ $carrier_isp
♦ $cga_ids
♦ $channels
♦ $devices
♦ $inventory_types
♦ $operating_systems
♦ $sections
♦ $segment_ids
♦ $seller_line_items
♦ $sizes
♦ $urls
♦ $woeids
• supply
♦ $ages
♦ $cga_ids
♦ $channels
♦ $sections
♦ $urls
♦ $woeids
• trading_pit_demand
♦ $click_urls
♦ $offer_types
• trading_pit_supply
♦ $ages
♦ $urls
♦ $woeids
Fields Summary
• $id_name_list — Array of ids, names of different attributes.
• $include — Set flag include to "true" to include or "false" to exclude the ids provided in $id_name_list.
352
Services
Fields
array_of_id_name $id_name_list
Array of ids, names of different attributes.
boolean $include
Set flag include to "true" to include or "false" to exclude the ids provided in $id_name_list.
rule_attribute_ids
rule data type
• managed_supply
♦ $ages
♦ $ages
• supply
♦ $ages
♦ $ages
Fields Summary
• $ids — Array of integers.
• $include — Include is set "true" to include or "false" to exclude particular data specified in $ids array.
Fields
array_of_int $ids
Array of integers.
boolean $include
Include is set "true" to include or "false" to exclude particular data specified in $ids array.
rule_attribute_names
rule data type
• demand
♦ $click_urls
♦ $click_urls
♦ $urls
• supply
♦ $urls
♦ $click_urls
♦ $urls
Fields Summary
• $names — Array of strings.
• $include — Include is set "true" to include or "false" to exclude particular data specified in $names array.
Fields
353
Services
Array of strings.
boolean $include
Include is set "true" to include or "false" to exclude particular data specified in $names array.
rule_dayparts
rule data type
♦ $dayparts
Fields Summary
• $relative_time_region_id — ID of a region targeting is relative to (0 - relative to user's time, otherwise relative
to the region specified by this ID)
• $daypart_list — Array of daypart targeting.
Fields
int $relative_time_region_id
ID of a region targeting is relative to (0 - relative to user's time, otherwise relative to the region specified by this ID)
array_of_daypart $daypart_list
Array of daypart targeting.
rule_deal_properties
♦ $deal_properties
• demand
• managed_demand
Fields Summary
• $allow_cpa — if true, CPA pricing is allowed
• $allow_cpc — if true, CPC pricing is allowed
• $allow_cpm — if true, CPM pricing is allowed
• $allow_discretionary — if true, discretionary pricing is allowed
• $allow_third_party_numbers — if true, third party numbers are allowed
Fields
boolean $allow_cpa
if true, CPA pricing is allowed
boolean $allow_cpc
if true, CPC pricing is allowed
boolean $allow_cpm
if true, CPM pricing is allowed
354
Services
if true, discretionary pricing is allowed
if true, third party numbers are allowed
rule_getall
rule data type
♦ getAllBuyingTerms()
♦ quickSearch()
Fields Summary
• $id — ID.
• $name — Name.
• $description — Description.
• $created_by_contact_id — Contact id who created rule.
• $created_by_contact_name — Name of contact who created rule.
• $modified_by_contact_id — Contact id who modified rule.
• $modified_by_contact_name — Name of contact who modified rule.
• $bid_multiplier — Bid multiplier.
• $active — Rule activity flag.
• $created_on — Rule created on date/time.
• $lastupd — Rule last updated date/time.
Fields
int $id
ID.
string $name
Name.
string $description
Description.
int $entity_id
Owner entity ID
string $entity_name
Contact id who created rule.
Name of contact who created rule.
Contact id who modified rule.
355
Services
Name of contact who modified rule.
float $bid_multiplier
Bid multiplier.
boolean $active
Default value: '0'
Rule activity flag.
Rule created on date/time.
dateTime $lastupd
Rule last updated date/time.
rule_search_options
rule data type
♦ getAllBuyingTerms()
Fields Summary
• $ids — Array of ids.
• $names — Array of names.
• $descriptions — Array of descriptions.
Fields
array_of_int $ids
Array of ids.
Array of names.
Array of descriptions.
int $is_active
356
Services
rule_vurl_data
rule_vurl_data data type
♦ $vurls
• supply
♦ $vurls
♦ $vurls
Fields Summary
• $vurl_count — Returns total count of VURLs for rule are included or excluded.
• $include — Indicate if VURL is included or excluded. Set to "true" for include and "false" for exclude.
Fields
int $vurl_count
Returns total count of VURLs for rule are included or excluded.
boolean $include
Indicate if VURL is included or excluded. Set to "true" for include and "false" for exclude.
sales_region
• EntityService
♦ getAllSalesRegions()
• LineItemService
♦ getSalesRegionsByEntity()
Fields Summary
• $id — sales region ID
• $name — sales region name
Fields
int $id
sales region ID
• size : 10
• primary
int $entity_id
entity ID
• size : 10
string $name
sales region name
• size : 255
357
Services
search_data
• SearchService
♦ search()
Fields Summary
• $field_name
• $field_value
• $exact_match
Fields
string $field_name
string $field_value
boolean $exact_match
Default value: '1'
section_custom_group
Fields Summary
• $locked — Sitelist locked flag.
Fields
int $id
• size : 10
• primary
string $name
• size : 255
int $owner_id
Sitelist owner id
• size : 10
Ignored on update.
Sitelist owner type
358
Services
boolean $active
Default value: '1'
boolean $locked
Default value: '0'
Sitelist locked flag.
string $notes
• size : 1000
dateTime $lastupd
Ignored on update.
Sitelist category
section
• SectionService
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByEntity()
♦ getBySite()
♦ update()
• entity_data
♦ $section
• publisher_data
♦ $section
Fields Summary
• $is_kids_directed — Flag that indicates 'Under-13 Kids Directed'.
• $accept_stream_ads — Flag that indicates 'accept stream ads'.
• $id — Site ID. Autoset on creation by SectionService::add()
• $description — Section description
• $site_id — ID of site, the section belongs to. Set by SiteService::addSection()
• $active — Section activity flag.
• $code — Section code. May be used if site::$uses_section_codes set to TRUE
• $mpaa_rating — Section MPAA rating. See valid ratings in Rating Enum
• $inventory_type_id — Section inventory type. See valid types in Inventory Type Enum
• $url — Section URL.
• $beacon_conversion_id — ID of beacon switched by this section. See Yahoo Ad Exchange Knowledge Base
for details.
• $channels — The list of channel IDs of the section.
• $is_click_fraud — Clickfraud activity flag.
• $lastupd
• $policy_violation — Policy violation flag Only 'Policy violation detector' user can change this field
• $vurl_id
Fields
359
Services
boolean $is_kids_directed
Default value: 0
Flag that indicates 'Under-13 Kids Directed'.
boolean $accept_stream_ads
Default value: 0
Flag that indicates 'accept stream ads'.
int $id
Site ID. Autoset on creation by SectionService::add()
• size : 10
• primary
string $description
Section description
• size : 50
int $site_id
Ignored on update.
ID of site, the section belongs to. Set by SiteService::addSection()
• size : 10
boolean $active
Default value: '1'
Section activity flag.
string $code
Section code. May be used if site::$uses_section_codes set to TRUE
• size : 32
• nillable
string $mpaa_rating
Default value: 'Unknown'
Section MPAA rating. See valid ratings in Rating Enum
The complete list of enum values you can see at rating enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'rating').
• enum : rating
int $inventory_type_id
Section inventory type. See valid types in Inventory Type Enum
The complete list of enum values you can see at inventory_type enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'inventory_type').
• size : 10
• enum : inventory_type
string $url
Section URL.
• size : 255
ID of beacon switched by this section. See Yahoo Ad Exchange Knowledge Base for details.
360
Services
• size : 8
• nillable
array_of_int $channels
The list of channel IDs of the section.
The complete list of channels you can see at Channel Enum page.
NOTE: The IASH categories have been made available on the Exchange for purposes of convenience. Individual
IASH networks are solely responsible for managing and categorizing their inventory according to and complying with
IASH code of conduct.
boolean $is_click_fraud
Clickfraud activity flag.
dateTime $lastupd
boolean $policy_violation
Default value: 0
Policy violation flag Only 'Policy violation detector' user can change this field
• private
string $vurl_id
• size : 10
section_urls
♦ NotificationService::setAdwareSections()
♦ NotificationService::setPolicyViolationSections()
Fields Summary
• $section_id — Section id
• $section_urls — URLs corresponding to section id
Fields
int $section_id
Section id
array_of_string $section_urls
URLs corresponding to section id
segment_attributes
♦ add()
♦ get()
♦ update()
361
Services
Fields Summary
• $srt_segment_attributes — SRT segment attributes
Fields
srt_segment_attributes $srt_segment_attributes
SRT segment attributes
• nillable
segment_contributor
• PixelService
♦ addSegmentContributor()
♦ getSegmentContributor()
Fields Summary
• $id — Segment Contributor ID
• $entity_id — Entity ID
• $pub_value — Unique ID that you specify to identify a publisher. Must be unique for the specified $entity_id.
Must be alphanumeric.
Fields
int $id
Segment Contributor ID
• size : 10
• primary
int $entity_id
Entity ID
string $pub_value
Unique ID that you specify to identify a publisher. Must be unique for the specified $entity_id. Must be alphanumeric.
• size : 100
segment
segment data type
• SegmentService
♦ add()
♦ get()
♦ getAll()
♦ getAncestorsInfo()
♦ getChildSegments()
♦ syncSegments()
♦ update()
Fields Summary
• $id — Segment ID
362
Services
• $name — Segment name
• $integration_code — integration code - once an integration code has been set it allows you to lookup up for
segment with that code
• $active — Active flag. Deactivating any segment pixel that you have shared via Audience Share will remove
the corresponding segment shares, and thus will deactivate any line items -- except your own -- that are
targeting this pixel and notify their owners. See Sharing or unsharing segments in the Audience marketplace
for details.
• $repeat_ignore_interval — repeat ignore interval
• $post_click_interval — post click interval
• $post_view_interval — post view interval
• $segment_duration — Segment duration
• $include_by_default — included by default flag
• $advertiser_entity_id — advertiser entity id the pixel is bound to
• $is_deleted — shows if object is deleted
• $created_on — Conversion creation time. Autoset by API.
• $lastupd
• $hybrid_trigger_type — Indicate what kind of hybrid pixel current pixel is
• $property_flags — Indicate Property flags. ('no_frequency_data','no_recency_data') This field should be set
only for Y!'s BTRE segments.
• $segment_type_id — Segment type id. See valid types in Segment Type Enum. Applicable only when
$pixel_type = 'Segment'.
• $segment_manager_entity_id — Segment manager entity id. Applicable only when $pixel_type = 'Segment'.
• $parent_external_segment_id — This field can be used to denote the hierarchy in case of heirarchy
maintained externally.
• $parent_segment_id — If parent_segment_id is set parent_external_segment_id is ignored..
• $no_of_children — Segment No Of children
• $external_segment_id — API users needs to set this if the hierarchy is maintained externally.
• $segment_dimension — Represents root of the tree in case particular segment has multiple sub trees. For
eg: device,os,browser in case tts v2 segments
• $display_name — Represents the last part of the segment name i.e. without the hierarchy
Fields
int $id
Segment ID
• primary
Default value: null
public segment ID
• nillable
string $name
Segment name
integration code - once an integration code has been set it allows you to lookup up for segment with that code
boolean $active
Active flag. Deactivating any segment pixel that you have shared via Audience Share will remove the corresponding
segment shares, and thus will deactivate any line items -- except your own -- that are targeting this pixel and notify
their owners. See Sharing or unsharing segments in the Audience marketplace for details.
int $repeat_ignore_interval
Default value: '0'
repeat ignore interval
int $post_click_interval
post click interval
363
Services
• nillable
int $post_view_interval
post view interval
• nillable
int $segment_duration
Default value: 0
Segment duration
This field's purpose - pixel expiration/duration period if pixel type is segment. It can be set for segment pixels only.
Pixel treated as as segment when post_click_interval = 0 and post_view_interval = 0. Valid range is 0..2 years (value
is stored in seconds, so the valid range is 0..63072000)
• nillable
boolean $include_by_default
included by default flag
Ignored on update.
advertiser entity id the pixel is bound to
Ignored on update.
Default value: '1'
boolean $is_deleted
Default value: '0'
shows if object is deleted
Ignored on update.
Conversion creation time. Autoset by API.
• nillable
dateTime $lastupd
• nillable
string $hybrid_trigger_type
Indicate what kind of hybrid pixel current pixel is
The complete list of enum values you can see at hybrid_trigger_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'hybrid_trigger_type').
364
Services
• enum : hybrid_trigger_type
string $property_flags
Default value: null
Indicate Property flags. ('no_frequency_data','no_recency_data') This field should be set only for Y!'s BTRE segments.
int $segment_type_id
Ignored on update.
Default value: NULL
Segment type id. See valid types in Segment Type Enum. Applicable only when $pixel_type = 'Segment'.
The complete list of enum values you can see at 4_enum_segment_type, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'segment_type ').
• enum : segment_type
• nillable
int $segment_manager_entity_id
Ignored on update.
Default value: NULL
Segment manager entity id. Applicable only when $pixel_type = 'Segment'.
• nillable
int $parent_external_segment_id
Default value: NULL
This field can be used to denote the hierarchy in case of heirarchy maintained externally.
• nillable
int $parent_segment_id
Default value: NULL
If parent_segment_id is set parent_external_segment_id is ignored..
• nillable
int $no_of_children
Segment No Of children
int $external_segment_id
API users needs to set this if the hierarchy is maintained externally.
• size : 8
string $segment_dimension
Represents root of the tree in case particular segment has multiple sub trees. For eg: device,os,browser in case tts v2
segments
The complete list of enum values you can see at segment_dimension enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'segment_dimension').
• enum : segment_dimension
Represents the last part of the segment name i.e. without the hierarchy
• size : 50
365
Services
segment_public_info
segment_public_info data type
• SegmentService
♦ getAncestorsPublicInfo()
♦ getDescendantsPublicInfo()
Fields Summary
• $name — Segment name
• $is_deleted — shows if object is deleted
• $active — Active flag.
• $parent_public_segment_id — parent public segment ID
Fields
Default value: null
public segment ID
• nillable
string $name
Segment name
boolean $is_deleted
Default value: '0'
shows if object is deleted
boolean $active
Active flag.
int $parent_public_segment_id
Default value: null
parent public segment ID
• nillable
segment_report_visibility
This file contains segment report visibility data type that will be used as part of segment visiblity control
• ReportService
♦ addSegmentReportVisibility()
♦ getSegmentReportVisibility()
♦ updateSegmentReportVisibility()
Fields Summary
• $buyer_id — identifiers of the buyer
• $seller_id — identifiers of the seller
• $show_impressions — Denotes if buyer can see the impressions related reports
• $show_conversions — Denotes if buyer can see the conversions related reports
• $show_clicks — Denotes if buyer can see the clicks related reports
• $show_revenue — Denotes if buyer can see the revenue related reports
• $show_click_through_rate — Denotes if buyer can see the CTR related reports
366
Services
• $show_conversion_rate — Denotes if buyer can see the conversion rate related reports
• $lastupd
Fields
int $buyer_id
identifiers of the buyer
• primary
int $seller_id
identifiers of the seller
• primary
boolean $show_impressions
Default value: true
Denotes if buyer can see the impressions related reports
boolean $show_conversions
Default value: true
Denotes if buyer can see the conversions related reports
boolean $show_clicks
Default value: true
Denotes if buyer can see the clicks related reports
boolean $show_revenue
Default value: true
Denotes if buyer can see the revenue related reports
boolean $show_click_through_rate
Default value: true
Denotes if buyer can see the CTR related reports
boolean $show_conversion_rate
Default value: true
Denotes if buyer can see the conversion rate related reports
dateTime $lastupd
• nillable
• private
segment_search_options
• PixelService
♦ getSegments()
Fields Summary
• $pixel_ids — Pixel ids
• $pixel_name_pattern — Pixel name pattern
Fields
367
Services
array_of_int $pixel_ids
Pixel ids
• nillable
string $pixel_name_pattern
Pixel name pattern
Pixel name pattern - search pattern. Leading and/or trailing wild cards (*) can be added to get results for Pixel names
matching the string provided.
• nillable
segment_share
• PixelService
♦ addSegmentShares()
♦ getSegmentShares()
♦ getShareForSegments()
♦ syncSegmentShares()
Fields Summary
• $public_segment_id — Public segment id. Available to both Audience Manager buyers/sellers. Should be
used in buyer/seller communications.
• $network_ids — Seller entity ids to which this segment's targeting is restricted. I.e., this segment may only be
targeted to these sellers. If not set, buyer can target this segment share on any network. Note: Current
implementation allows segment owner to restrict only to their own network.
• $targeted_line_items — Array of line items that are currently targeting this segment.
• $id — Segment share id.
• $private_segment_id — Actual segment id, private to segment's owner. Only available to Audience Manager
sellers.
• $buyer_entity_id — Data buyer entity id.
Fields
Public segment id. Available to both Audience Manager buyers/sellers. Should be used in buyer/seller
communications.
• nillable
array_of_int $network_ids
Seller entity ids to which this segment's targeting is restricted. I.e., this segment may only be targeted to these sellers.
If not set, buyer can target this segment share on any network. Note: Current implementation allows segment owner to
restrict only to their own network.
array_of_int $targeted_line_items
Array of line items that are currently targeting this segment.
int $id
Segment share id.
• size : 8
• primary
int $private_segment_id
Default value: '0'
368
Services
Actual segment id, private to segment's owner. Only available to Audience Manager sellers.
• size : 8
• field : conversion_id
• object : segment_share
Default value: '0'
Data buyer entity id.
• size : 10
• field : adx_buyer_entity_id
• object : segment_share
segment_share_info
segment_share_info data type
Fields Summary
• $buyer_id — identifiers of the buyer
• $segment_id — identifiers of the segment
• $public_segment_id — public identifiers of the segment
• $segment_name — name of the segment
• $buyer_name — name of the buyer
Fields
int $buyer_id
identifiers of the buyer
int $segment_id
identifiers of the segment
public identifiers of the segment
string $segment_name
name of the segment
string $buyer_name
name of the buyer
served_domain_data
Fields Summary
• $domain_url — domain url
• $network_entity_id — network_entity_id
• $publisher_entity_id — publisher_entity_id
Fields
string $domain_url
domain url
int $network_entity_id
network_entity_id
369
Services
int $publisher_entity_id
publisher_entity_id
session
• ContactService
♦ getActiveSessions()
Fields Summary
• $token — session token
• $creation_time — Creation time
• $modification_time — Modification time
• $ip_address — Numeric network address in network byte order. Use a standard inet_ntoa function to convert
to the dotted-quad representation of the address as a string.
• $contact_id — contact id
Fields
string $token
session token
dateTime $creation_time
Creation time
dateTime $modification_time
Modification time
string $ip_address
Numeric network address in network byte order. Use a standard inet_ntoa function to convert to the dotted-quad
representation of the address as a string.
int $contact_id
contact id
site
• SiteService
♦ add()
♦ get()
♦ getAll()
♦ getAllSince()
♦ getByEntity()
♦ SiteService::getByPublisherDepr()
♦ update()
• entity_data
♦ $site
• publisher_data
♦ $site
Fields Summary
• $id — Site ID. Autoset on creation by SiteService::add()
• $description — Site description
• $publisher_entity_id — ID of publisher, the site belongs to. Set by PublisherService::addSite()
• $active — Site activity flag.
• $default_section_id — ID of site default section
370
Services
• $uses_section_codes — If TRUE, section code may be used in a tag if $default_section_id is specified.
• $site_url
• $code — Site code. May be used if publisher::$uses_site_codes set to TRUE
• $sections_share_channels
• $vurl_id
• $lastupd
Fields
int $id
Site ID. Autoset on creation by SiteService::add()
• size : 10
• primary
string $description
Site description
• size : 50
int $publisher_entity_id
Ignored on update.
ID of publisher, the site belongs to. Set by PublisherService::addSite()
• size : 10
boolean $active
Default value: '1'
Site activity flag.
int $default_section_id
Default value: '0'
ID of site default section
• size : 10
boolean $uses_section_codes
Default value: '0'
If TRUE, section code may be used in a tag if $default_section_id is specified.
string $site_url
• size : 255
string $code
Site code. May be used if publisher::$uses_site_codes set to TRUE
• size : 32
• nillable
int $sections_share_channels
Default value: '1'
• size : 1
string $vurl_id
• size : 10
371
Services
dateTime $lastupd
size_data
This file defines size_data data type
Fields Summary
• $serial_no — external serial number
• $width — size width
• $height — size height
• $network_learn_price — size network_learn_price
• $size_code — size size_code
• $daily_volume — size daily_volume
• $daily_revenue — size daily_revenue
• $description — size description
Fields
int $serial_no
external serial number
int $width
size width
int $height
size height
float $network_learn_price
size network_learn_price
string $size_code
size size_code
int $daily_volume
size daily_volume
size daily_revenue
string $description
size description
size
See Size Enum for more information on the Size enum.
♦ getSizes()
Fields Summary
• $id — size ID
• $width — size width
• $height — size height
372
Services
• $network_learn_price — network learn price, in USD
• $daily_volume — size daily volume
• $daily_revenue — size daily revenue, in USD
• $description — size description
Fields
int $id
size ID
• size : 10
• primary
int $width
size width
• size : 8
int $height
size height
• size : 8
float $network_learn_price
network learn price, in USD
int $daily_volume
size daily volume
• size : 20
size daily revenue, in USD
string $description
size description
• size : 255
srt_segment_attributes
• segment_attributes
♦ $srt_segment_attributes
Fields Summary
• $linguistic_market — Linguistic market. See valid types in Srt Linguistic Markets Enum. Once
$linguistic_market has been set for a segment. It cannot be changed.
• $match_type — Match type. See valid types in Srt Match Type Enum
• $recency_in_days — Recency in days. See valid types in Srt Recency In Days Enum
Fields
enum_srt_linguistic_markets $linguistic_market
Linguistic market. See valid types in Srt Linguistic Markets Enum. Once $linguistic_market has been set for a
segment. It cannot be changed.
enum_srt_match_type $match_type
373
Services
Match type. See valid types in Srt Match Type Enum
enum_srt_recency_in_days $recency_in_days
Recency in days. See valid types in Srt Recency In Days Enum
srt_segment_report
♦ srtKeywordsReport()
Fields Summary
• $keyword — SRT keyword
• $match_type — Match type for keyword 'exact' or 'broad'. Notes: empty string in the case of unattributed
impressions, clicks, and conversions where keyword will be listed as 'unattributed'. Broad match contribution
to the segment performance will be listed as a single row with match_type of 'broad' and empty keyword
string.
• $impressions — The number of impressions.
• $clicks — The number of clicks.
• $conversions — The number of conversions.
Fields
string $keyword
SRT keyword
string $match_type
Match type for keyword 'exact' or 'broad'. Notes: empty string in the case of unattributed impressions, clicks, and
conversions where keyword will be listed as 'unattributed'. Broad match contribution to the segment performance will
be listed as a single row with match_type of 'broad' and empty keyword string.
int $impressions
The number of impressions.
int $clicks
The number of clicks.
int $conversions
The number of conversions.
srt_segment_status
♦ srtKeywordsGet()
Fields Summary
• $keyword — SRT keyword
• $status — Keyword status
Fields
string $keyword
SRT keyword
374
Services
enum_srt_keyword_status $status
Keyword status
supply_attributes
attributes data type
Fields Summary
• $marketplace — Supply rule applicable on Trading Pit, Network of network, Intra Network(Managed) or any
combination of these. See Buying Selling Marketplace Enum for valid values.
• $selling_technology — Array of selling technology. Allowed values are 'RTBD','Hosted'. See Buying
• $custom_groups — Custom groups of managed advertiser ids.
• $content_segments — Content segments.
Fields
Supply rule applicable on Trading Pit, Network of network, Intra Network(Managed) or any combination of these. See
Buying Selling Marketplace Enum for valid values.
Array of selling technology. Allowed values are 'RTBD','Hosted'. See Buying Technology Enum for valid values.
blocklist_attribute $publishers
Publishers.
blocklist_attribute $custom_groups
Custom groups of managed advertiser ids.
blocklist_attribute $content_segments
Content segments.
blocklist_attribute $woeids
Woeids.
blocklist_attribute $cga_ids
supply_blocklist
supply_blocklist data type
♦ add()
♦ getAllSince()
♦ getByObjectId()
♦ update()
Fields Summary
• $id — Supply blocklist ID.
• $name — Supply block list name.
375
Services
• $description — Supply block list description.
• $entity_id — Owner entity ID.
• $managed_demand — Complex data type to represent managed advertiser attributes.
• $block_supply — Complex data type to represent supply attributes.
• $created_by_contact_id — Contact id who created supply blocklist.
• $modified_by_contact_id — Contact id who modified supply blocklist.
• $active — Supply blocklist activity flag.
• $created_on — Supply blocklist created on date/time.
• $lastupd — Supply blocklist last updated date/time.
Fields
int $id
Ignored on update.
Supply blocklist ID.
• primary
string $name
Supply block list name.
string $description
Supply block list description.
int $entity_id
Owner entity ID.
managed_demand $managed_demand
Complex data type to represent managed advertiser attributes.
supply $block_supply
Contact id who created supply blocklist.
Contact id who modified supply blocklist.
boolean $active
Default value: '0'
Supply blocklist activity flag.
Supply blocklist created on date/time.
dateTime $lastupd
Supply blocklist last updated date/time.
supply
supply data type
376
Services
• supply_blocklist
♦ $block_supply
Fields Summary
• $marketplace — Supply rule applicable on Trading Pit, Network of network, Intra Network(Managed) or any
combination of these. See Buying Selling Marketplace Enum for valid values.
• $urls — URLs.
• $ages — Ages.
• $gender — Gender.
Fields
Supply rule applicable on Trading Pit, Network of network, Intra Network(Managed) or any combination of these. See
Buying Selling Marketplace Enum for valid values.
publisher_list $publishers
Publishers.
Woeids.
Sections.
Channels.
URLs.
Ages.
gender $gender
Gender.
Vurls.
377
Services
supported_locale
♦ getSupportedLocales()
Fields Summary
• $id — Locale ID
• $locale — Locale name
• $description — Locale description
Fields
int $id
Locale ID
• size : 5
• primary
string $locale
Locale name
• size : 100
string $description
Locale description
supporting_file
• CreativeService
♦ addSupportingFiles()
♦ PlacementService::addCreative()
Fields Summary
• $filename — the file name of the ad to be uploaded
• $data — the actual binary data of the ad to be uploaded
Fields
string $filename
the file name of the ad to be uploaded
binary $data
the actual binary data of the ad to be uploaded
sync_segment_response
sync_segment_response data type
• SegmentService
♦ syncSegments()
378
Services
Fields Summary
• $result — status of the operation
• $sync_result — enum of (created/updated/deleted/unchanged) to be used incase of $result is true
• $external_segment_id — for mapping to the input request
• $segment_id — id of segment thats created/modified
• $error_message — to be used in case result is false
Fields
boolean $result
status of the operation
string $sync_result
enum of (created/updated/deleted/unchanged) to be used incase of $result is true
The complete list of enum values you can see at sync_result enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'sync_result').
• enum : sync_result
int $external_segment_id
for mapping to the input request
int $segment_id
id of segment thats created/modified
string $error_message
to be used in case result is false
tag_emails
Fields Summary
• $tag_id
• $emails
Fields
int $tag_id
array_of_string $emails
target_advertiser_entity
• targetings
♦ $Advertisers
Fields Summary
• $advertiser_default
• $advertiser_ids
Fields
379
Services
boolean $advertiser_default
target_age
• targetings
♦ $Ages
Fields Summary
• $age_default — Default age
• $target_age — Target ages
Fields
boolean $age_default
Default age
array_of_int $target_age
Target ages
target_asl
Fields Summary
• $section_group_ids — section group id list
Fields
array_of_int $section_group_ids
section group id list
target_browser
• targetings
♦ $Browsers
Fields Summary
• $browser_default
• $browser_ids — List of browser's ids
Fields
boolean $browser_default
array_of_int $browser_ids
List of browser's ids
380
Services
target_buyer_entity
• targetings
♦ $Buyers
Fields Summary
• $buyer_entity_default
• $buyer_ids — List of buyer entity ids
Fields
boolean $buyer_entity_default
array_of_int $buyer_ids
List of buyer entity ids
target_buyer_line_item
• targetings
♦ $BuyerLineItems
Fields Summary
• $buyer_line_item_default — Default treatment flag
• $line_items — Array if line item ids
Fields
boolean $buyer_line_item_default
Default treatment flag
array_of_int $line_items
Array if line item ids
target_cga
Fields Summary
• $target_cga — Target CGA
• $cga_ids — List of cgas
Fields
boolean $target_cga
Target CGA
List of cgas
381
Services
target_channel
NOTE: Inventory classified with one of the IASH categories does not automatically imply that the inventory is in fact
IASH compliant or that Yahoo Ad Exchange is making any representations or warranties about the IASH status of
such inventory. The IASH categories have been made available on the Exchange for purposes of convenience.
Individual IASH networks are solely responsible for managing and categorizing their inventory according to and
complying with IASH code of conduct. Targeting to both an IASH channel and a non-IASH channel may result in only
the non-IASH channel being targeted.
• targetings
♦ $Channels
Fields Summary
• $channel_default — Default treatment flag
• $include_channel_ids — List of included channel ids
• $exclude_channel_ids — List of excluded channel ids
Fields
boolean $channel_default
array_of_int $include_channel_ids
List of included channel ids
array_of_int $exclude_channel_ids
List of excluded channel ids
target_click_url
• targetings
♦ $ClickUrls
Fields Summary
• $click_url_default
• $urls — List of URL patterns in effect
Fields
boolean $click_url_default
array_of_string $urls
List of URL patterns in effect
target_click_url_object
Fields Summary
• $total_count
Fields
382
Services
string $click_url_default
int $total_count
target_click_url_v2
Fields Summary
• $total_count
Fields
int $total_count
target_country
Fields Summary
• $country_include — Country include
• $country_id — List of countries id
Fields
boolean $country_include
Country include
array_of_int $country_id
List of countries id
target_creative_beacon
• targetings
♦ $CreativeBeacons
Fields Summary
• $creative_beacon_default
• $creative_beacon_id — Creative beacons list
Fields
boolean $creative_beacon_default
383
Services
array_of_int $creative_beacon_id
Creative beacons list
target_creative
• targetings
♦ $CreativeBeacons
♦ $CreativeTags
♦ $Creatives
Fields Summary
• $creative_default — Creative default
• $creative_ids — Creative id list
Fields
boolean $creative_default
Creative default
Creative id list
target_creative_tag
• targetings
♦ $CreativeTags
Fields Summary
• $creative_tag_id — Creative tags list
Fields
array_of_int $creative_tag_id
Creative tags list
target_csl
Fields Summary
• $section_ids — section group id list
Fields
section group id list
384
Services
target_daypart
• targetings
♦ $Dayparts
Fields Summary
• $relative_time_region_id — ID of a region targeting is relative to (0 - relative to user's time, otherwise relative
to the region specified by this ID)
• $dayparts — List of dayparts when creative may be shown
Fields
ID of a region targeting is relative to (0 - relative to user's time, otherwise relative to the region specified by this ID)
array_of_daypart $dayparts
List of dayparts when creative may be shown
target_frequency
• placement
♦ $frequency_target
• targetings
♦ $Frequency
Fields Summary
• $frequency
• $period
Fields
int $frequency
• nillable
int $period
• nillable
target_gender
• targetings
♦ $Gender
Fields Summary
• $include_male_gender — show or not to show creatives to users of a male gender
• $include_female_gender — show or not to show creatives to users of a female gender
• $include_unknown_gender — show or not to show creatives to users when gender information is not
available
Fields
385
Services
show or not to show creatives to users of a male gender
show or not to show creatives to users of a female gender
show or not to show creatives to users when gender information is not available
target_geography
• placement
♦ $geo_target
• targetings
♦ $Geography
Fields Summary
• $use_regions — Switch between country & region or DMA usage
• $country_ids — List of country ids
• $region_ids — List of region ids
• $dma_ids — List of DMA ids
Fields
boolean $use_regions
Switch between country & region or DMA usage
array_of_int $country_ids
List of country ids
List of region ids
array_of_int $dma_ids
List of DMA ids
targeting_hidden_params
♦ $targeting_hidden_params
Fields Summary
• $url — IVC hidden parameter for URL
• $content_segments — IVC hidden parameter for content segments
• $sub_domain — IVC hidden parameter for Sub domain.
Fields
boolean $url
Default value: '0'
IVC hidden parameter for URL
386
Services
Default value: '0'
IVC hidden parameter for content segments
boolean $sub_domain
Default value: '0'
IVC hidden parameter for Sub domain.
targetings
♦ get()
♦ getByObject()
Fields Summary
• $Sizes — List of creative sizes
• $Sections — List of sections
• $Languages — List of languags
• $Netspeeds — list of netspeeds
• $InventoryTypes — List of inventory types
• $Publishers — List of publisher entitys
• $Urls — List of URL patterns in effect
• $ClickUrls — List of click URL patterns in effect
• $Browsers — List of browsers
• $Isps — List of ISPs
• $Channels — List of excluded channels
• $Rating — Target rating
• $Frequency — Target Frequency
• $Geography — Targeting rules on region, country and msa
• $GeographyV2 — Targeting rules on woeid and cga
• $Gender — Object of target_gender
• $Dayparts — List of dayparts when creative may be shown
• $Pixels — Objects of target_pixel
• $QueryString — Query string
• $VurlTags — List of validated url tags
• $ValidatedUrls — List of validated urls
• $Advertisers — List of entity ids
• $DealProperties — Object of deal properties
• $Ages — List of target ages
• $CreativeTags — Creative tags list
• $CreativeBeacons — Creative beacon list
• $CreativeSpecs — Creative specs object
• $Creatives — Creatives list
• $BuyerLineItems — Array of buyer line items
• $SellerLineItems — Array of seller line items
• $OfferTypes — List of offer types
• $Buyers — List of buyer entities
Fields
target_size $Sizes
List of creative sizes
• nillable
target_section $Sections
List of sections
• nillable
target_language $Languages
List of languags
387
Services
• nillable
target_netspeed $Netspeeds
list of netspeeds
• nillable
target_inventory_type $InventoryTypes
List of inventory types
• nillable
target_publisher_entity $Publishers
List of publisher entitys
• nillable
target_url $Urls
• nillable
target_click_url $ClickUrls
List of click URL patterns in effect
• nillable
target_browser $Browsers
List of browsers
• nillable
target_isp $Isps
List of ISPs
• nillable
target_channel $Channels
List of excluded channels
• nillable
target_rating $Rating
Target rating
target_frequency $Frequency
Target Frequency
target_geography $Geography
Targeting rules on region, country and msa
• nillable
target_woeid_cga $GeographyV2
Targeting rules on woeid and cga
• nillable
target_gender $Gender
Object of target_gender
388
Services
• nillable
target_daypart $Dayparts
List of dayparts when creative may be shown
• nillable
target_pixels $Pixels
Objects of target_pixel
• from : conversion
• nillable
target_querystring $QueryString
Query string
• nillable
target_vurl_tag $VurlTags
List of validated url tags
• nillable
target_vurl $ValidatedUrls
List of validated urls
• nillable
target_advertiser_entity $Advertisers
List of entity ids
• nillable
deal_properties $DealProperties
Object of deal properties
• nillable
target_age $Ages
List of target ages
• nillable
target_creative_tag $CreativeTags
Creative tags list
• nillable
target_creative_beacon $CreativeBeacons
Creative beacon list
• nillable
creative_specs $CreativeSpecs
Creative specs object
• nillable
target_creative $Creatives
Creatives list
389
Services
• nillable
target_buyer_line_item $BuyerLineItems
Array of buyer line items
• nillable
target_seller_line_item $SellerLineItems
Array of seller line items
• nillable
target_offer_type $OfferTypes
List of offer types
• nillable
target_buyer_entity $Buyers
List of buyer entities
• nillable
target_inventory_media_type
Fields Summary
• $inventory_media_type_default
• $inventory_media_type_ids — List of inventory media type's ids
Fields
boolean $inventory_media_type_default
array_of_int $inventory_media_type_ids
List of inventory media type's ids
target_inventory_type
• targetings
♦ $InventoryTypes
Fields Summary
• $inventory_type_default
• $inventory_type_ids — List of inventory type's ids
Fields
boolean $inventory_type_default
array_of_int $inventory_type_ids
List of inventory type's ids
390
Services
target_isp
• targetings
♦ $Isps
Fields Summary
• $isp_default
• $isp_ids — List of ISP's ids
Fields
boolean $isp_default
array_of_int $isp_ids
List of ISP's ids
target_language
• targetings
♦ $Languages
Fields Summary
• $language_default
• $language_ids — List of language ids
Fields
boolean $language_default
array_of_int $language_ids
List of language ids
target_mobile_carrier_data
♦ getMobileCarriers()
Fields Summary
• $mobile_id — mobile id
• $country — country
• $carrier — carrier
Fields
int $mobile_id
mobile id
• nillable
string $country
391
Services
country
• nillable
string $carrier
carrier
• nillable
target_mobile_os_data
♦ getMobileOSs()
Fields Summary
• $mobile_id — mobile id
• $os — os
Fields
int $mobile_id
mobile id
• nillable
string $os
os
• nillable
target_netspeed
• targetings
♦ $Netspeeds
Fields Summary
• $netspeed_default
• $netspeed_ids — List of netspeed ids
Fields
boolean $netspeed_default
array_of_int $netspeed_ids
List of netspeed ids
target_offer_type
• targetings
392
Services
♦ $OfferTypes
Fields Summary
• $offer_type_default — Default treatment flag
• $offer_type_ids — List of creative size's ids
Fields
boolean $offer_type_default
List of creative size's ids
target_pixel
♦ getTargetContentCategories()
♦ getTargetPixels()
♦ setTargetContentCategories()
♦ setTargetPixels()
• target_pixels
♦ $target_pixels
• targetings
♦ $Pixels
Fields Summary
• $conversion_id — Conversion ID. Should be empty if this segment does not belong to you.
• $public_segment_id — Public segment ID
• $negated — If true, limits delivery to users who have not seen the pixel. Otherwise, to users who have seen
the pixel.
• $seconds_since_conversion — If given, limits delivery to users who have seen/not seen the pixel (depending
on $negated) within this time interval (in seconds).
• $frequency_min — If given, limits delivery to users who have seen/not seen the pixel (depending on
$negated) at least this number of times (Min: 0, Max: 255).
Fields
int $conversion_id
Conversion ID. Should be empty if this segment does not belong to you.
• nillable
Public segment ID
boolean $negated
Default value: '0'
If true, limits delivery to users who have not seen the pixel. Otherwise, to users who have seen the pixel.
int $seconds_since_conversion
If given, limits delivery to users who have seen/not seen the pixel (depending on $negated) within this time interval (in
seconds).
• nillable
int $frequency_min
393
Services
If given, limits delivery to users who have seen/not seen the pixel (depending on $negated) at least this number of
times (Min: 0, Max: 255).
• nillable
target_pixels
• targetings
♦ $Pixels
Fields Summary
• $require_all — if true - limiting delivery only to those who have seen the pixel, false - otherwise
• $target_pixels
• $logical_expression — Logical expression
Fields
boolean $require_all
if true - limiting delivery only to those who have seen the pixel, false - otherwise
• var : require all pixels
array_of_target_pixel $target_pixels
string $logical_expression
Logical expression
target_profile
♦ get()
♦ getAllSince()
♦ getByObject()
♦ updateTargetProfile()
Fields Summary
• $creative_beacon_default
• $id
• $name
• $entity_id
• $time_relative_to — The complete list of enum values you can see at time_relative_to enum page, at run
time you can get all of them using DictionaryService.getEnumValues(token, 'time_relative_to').
• $relative_time_region_id — The complete list of enum values you can see at region enum page, at run time
you can get all of them using DictionaryService.getEnumValues(token, 'region').
• $time_include
• $country_include
• $section_default
• $gmt_offset
• $target_msa
• $target_woeid
• $target_cga
• $show_to_unknown
• $age_default
• $netspeed_default
• $seller_entity_default
• $browser_default
• $size_default
394
Services
• $active
• $created_on
• $lastupd
• $language_default
• $channel_default
• $inventory_type_default
• $offer_type_default
• $max_mpaa_rating — The complete list of enum values you can see at max_rating enum page, at run time
you can get all of them using DictionaryService.getEnumValues(token, 'max_rating').
• $creative_specs_id
• $buyer_entity_default
• $creative_default
• $frequency_period
• $frequency_exposures
• $isp_default
• $url_default
• $click_url_rtbd_default
• $click_url_hosted_default
• $line_item_default
• $buyer_line_item_default
• $seller_line_item_default
• $site_default
• $querystring_default
• $require_all_querystrings
• $querystring_logic_expression
• $require_all_conversions
• $pixel_logic_expression
• $vurl_default
• $vurl_category_default
• $require_audited_vurl
• $no_adware
• $no_click_fraud — For configuring VURL targets.Set to 0 will serve to the URLs of sites with suspicious
traffic.
• $rmx_100_only
• $rmx_250_only
• $advertiser_default
• $include_male_gender
• $include_female_gender
• $include_unknown_gender
• $no_foreign_language_vurls
• $approved_vurls_only
• $active_vurls_only
• $is_default
• $default_profile_name — Name of target profile if it is default
• $creative_tag_default
• $pvt_marketplace_default
• $inventory_media_type_default
Fields
boolean $creative_beacon_default
Default value: 1
int $id
• size : 8
• primary
string $name
Default value: 'No Name Set'
• size : 255
int $entity_id
• size : 10
395
Services
string $time_relative_to
Default value: 'User'
The complete list of enum values you can see at time_relative_to enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'time_relative_to').
• enum : time_relative_to
Default value: 34
The complete list of enum values you can see at region enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'region').
• size : 5
• enum : region
boolean $time_include
Default value: 0
boolean $country_include
Default value: 0
boolean $section_default
Default value: 1
int $gmt_offset
Default value: 0
• size : 9
boolean $target_msa
Default value: 0
boolean $target_woeid
Default value: 0
boolean $target_cga
Default value: 0
boolean $show_to_unknown
Default value: 1
boolean $age_default
Default value: 1
boolean $netspeed_default
Default value: 1
boolean $seller_entity_default
Default value: 1
boolean $browser_default
Default value: 1
boolean $size_default
Default value: 1
boolean $active
Default value: 1
396
Services
Ignored on update.
• nillable
dateTime $lastupd
• nillable
boolean $language_default
Default value: 1
boolean $channel_default
Default value: 1
boolean $inventory_type_default
Default value: 1
boolean $offer_type_default
Default value: 1
string $max_mpaa_rating
Default value: 'Any'
The complete list of enum values you can see at max_rating enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'max_rating').
• enum : max_rating
int $creative_specs_id
Default value: NULL
• size : 10
• nillable
boolean $buyer_entity_default
Default value: 1
boolean $creative_default
Default value: 1
int $frequency_period
Default value: 0
• size : 11
• nillable
int $frequency_exposures
Default value: 0
• size : 9
• nillable
boolean $isp_default
Default value: 1
boolean $url_default
Default value: 1
397
Services
Default value: 1
boolean $click_url_rtbd_default
Default value: 1
boolean $click_url_hosted_default
Default value: 1
boolean $line_item_default
Default value: 1
boolean $buyer_line_item_default
Default value: 1
boolean $seller_line_item_default
Default value: 1
boolean $site_default
Default value: 1
boolean $querystring_default
Default value: 1
boolean $require_all_querystrings
Default value: 0
string $querystring_logic_expression
Default value: NULL
• size : 1024
boolean $require_all_conversions
Default value: 1
string $pixel_logic_expression
Default value: NULL
• size : 1024
boolean $vurl_default
Default value: 1
boolean $vurl_category_default
Default value: 1
boolean $require_audited_vurl
Default value: 0
boolean $no_adware
Default value: 0
boolean $no_click_fraud
Default value: 0
For configuring VURL targets.Set to 0 will serve to the URLs of sites with suspicious traffic.
Set to 1 will not serve to URLs of sites with suspicious traffic
398
Services
boolean $rmx_100_only
Default value: 0
Default value: 0
boolean $advertiser_default
Default value: 1
Default value: 1
Default value: 1
Default value: 1
boolean $no_foreign_language_vurls
Default value: 0
boolean $approved_vurls_only
Default value: 0
boolean $active_vurls_only
Default value: 0
int $is_default
• size : 1
• nillable
string $default_profile_name
Name of target profile if it is default
• size : 127
• nillable
boolean $creative_tag_default
Default value: 1
boolean $pvt_marketplace_default
Default value: 1
boolean $inventory_media_type_default
Default value: 2
target_publisher_entity
• targetings
♦ $Publishers
399
Services
Fields Summary
• $seller_entity_default
• $publisher_entity_ids — List of publisher entity ids
Fields
boolean $seller_entity_default
array_of_int $publisher_entity_ids
List of publisher entity ids
target_pvt_marketplace
Fields Summary
• $pvt_marketplace_default — Default
• $pvt_marketplace_ids — Target Private Markeplaces
Fields
boolean $pvt_marketplace_default
Default
array_of_int $pvt_marketplace_ids
Target Private Markeplaces
target_querystring
• targetings
♦ $QueryString
Fields Summary
• $query_string_option — Query string option
• $query_strings
• $query_string_logical_expression
Fields
enum_query_string_option $query_string_option
Query string option
array_of_string $query_strings
string $query_string_logical_expression
target_rating
• targetings
♦ $Rating
400
Services
Fields Summary
• $max_mpaa_rating — Maximum allowed rating
Fields
string $max_mpaa_rating
Maximum allowed rating
target_section
• placement
♦ $section_target
• targetings
♦ $Sections
Fields Summary
• $section_default — this flag let you specify how to treat the elements of section_ids array. If it is set to true not listed sections are allowed, false - not listed sections are forbidden.
• $section_ids — the array of section IDs
Fields
boolean $section_default
this flag let you specify how to treat the elements of section_ids array. If it is set to true - not listed sections are
allowed, false - not listed sections are forbidden.
the array of section IDs
target_seller_line_item
• targetings
♦ $SellerLineItems
Fields Summary
• $seller_line_item_default — Default treatment flag
• $line_items — Array if line item ids
Fields
boolean $seller_line_item_default
array_of_int $line_items
Array if line item ids
target_size
401
Services
• targetings
♦ $Sizes
Fields Summary
• $size_default — Target profile size_default
• $size_ids — List of creative size's ids
Fields
boolean $size_default
Target profile size_default
List of creative size's ids
target_url
• targetings
♦ $Urls
Fields Summary
• $url_default
Fields
boolean $url_default
target_vurl
• targetings
♦ $ValidatedUrls
♦ $VurlTags
Fields Summary
• $options
• $vurl_ids
Fields
vurl_options $options
array_of_int $vurl_ids
402
Services
target_vurl_tag
• targetings
♦ $VurlTags
Fields Summary
• $vurl_tag_ids
Fields
array_of_int $vurl_tag_ids
target_woeid_cga
• targetings
♦ $GeographyV2
Fields Summary
• $woeids — List of woeids
• $cga_ids — List of cga ids
Fields
List of woeids
List of cga ids
target_woeid
• targetings
♦ $GeographyV2
Fields Summary
• $target_woeid — Target Woeid
• $woeids — List of woeids
Fields
boolean $target_woeid
Target Woeid
List of woeids
403
Services
techno_data
techno_data data type
♦ getTechnoDimensions()
♦ getTechnoIds()
Fields Summary
• $techno_id — Techno id
• $parent_techno_id — This field can be used to denote the hierarchy.
• $name — Techo name
• $display_name — Techno display name
Fields
int $techno_id
Techno id
int $parent_techno_id
This field can be used to denote the hierarchy.
string $name
Techo name
Techno display name
tp_billing_entity_preferences
id data type
• marketplace_settings
♦ $buyer_tpbe_prefs
♦ $seller_tpbe_prefs
Fields Summary
• $tpbe_id — TPBE ID.
• $preference_order — Preferences order - 1, 2, 3, 4, 5. 1 - highest. 5 - lowest.
• $forex_currency_id — Forex currency id - preferred currency of business with TPBE
• $active — Active flag
Fields
int $tpbe_id
TPBE ID.
• size : 2
• primary
int $preference_order
Default value: '1'
Preferences order - 1, 2, 3, 4, 5. 1 - highest. 5 - lowest.
• size : 1
404
Services
Forex currency id - preferred currency of business with TPBE
• size : 3
boolean $active
Default value: '1'
Active flag
trading_pit_blocklist
trading data type
Fields Summary
• $id — Exchange wide blocklist id for trading pit.
• $name — Trading pit blocklist name.
• $description — Trading pit blocklist description.
• $supply — Complex data type to represent supply attributes.
• $demand — Complex data type to represent demand attributes.
• $created_by_contact_id — Contact id who created trading pit blocklist.
• $modified_by_contact_id — Contact id who modified trading pit blocklist.
• $active — Trading pit blocklist activity flag.
• $created_on — Trading pit blocklist created on date/time.
• $lastupd — Trading pit blocklist last updated date/time.
Fields
int $id
Ignored on update.
Exchange wide blocklist id for trading pit.
• primary
string $name
Trading pit blocklist name.
string $description
Trading pit blocklist description.
int $entity_id
Owner entity ID
trading_pit_supply $supply
trading_pit_demand $demand
Contact id who created trading pit blocklist.
Contact id who modified trading pit blocklist.
405
Services
boolean $active
Default value: '0'
Trading pit blocklist activity flag.
Trading pit blocklist created on date/time.
dateTime $lastupd
Trading pit blocklist last updated date/time.
trading_pit_creative_properties
trading data type
♦ $creative_tags
Fields Summary
• $creative_policy_tags — Creative policy tags.
• $creative_specs — Creative specs.
• $creative_themes — Creative themes.
• $creative_languages — Creative languages.
• $creative_beacons — Creative beacons.
• $include — Include is set "true" to include or "false" to exclude particular segments specified in
$creative_specs, $creative_themes, $creative_beacons, $creative_languages arrays.
Fields
array_of_id_name $creative_policy_tags
Creative policy tags.
array_of_id_name $creative_specs
Creative specs.
array_of_id_name $creative_themes
Creative themes.
array_of_id_name $creative_languages
Creative languages.
array_of_id_name $creative_beacons
Creative beacons.
boolean $include
Include is set "true" to include or "false" to exclude particular segments specified in $creative_specs,
$creative_themes, $creative_beacons, $creative_languages arrays.
trading_pit_demand
trading data type
406
Services
• trading_pit_blocklist
♦ $demand
Fields Summary
values.
creative_beacons.
Fields
trading_pit_creative_properties $creative_tags
Click Urls.
Offer types.
trading_pit_supply
trading data type
• trading_pit_blocklist
♦ $supply
Fields Summary
• $urls — URLs.
• $ages — Ages.
Fields
Woeids.
URLs.
Ages.
Vurls.
407
Services
traf_monitor_alert
♦ addTMAlert()
♦ getAllTMAlerts()
♦ getTMAlert()
♦ updateTMAlert()
Fields Summary
• $id — Alert ID
• $name — Alert name
• $description — Alert description
• $entity_id — Entity ID, the alert belong to.
• $contact_id — Contact ID
• $active — Activity flag
• $domain — Domain
• $use_all_objects — Use all objects
• $use_all_objects_secondary — Use all objects (secondary) should be used only in case of arbitrage
• $min_imps — Minimum imps
• $max_imps — Maximum imps
• $min_volume — Minimum volume
• $max_volume — Maximum volume
• $pct_decrease — PCT decrease
• $pct_increase — PCT increase
• $min_losses_pct — min_losses_pct
• $sigma_multiplier — Sigma multiplier
• $metric_type — Metric type
• $is_daily — Daily alert
• $is_hourly — Hourly alert
• $min_metric_value — Minimum metric value
• $max_metric_value — Maximum metric value
• $version — Version
• $analysis_scheme — Analysis Scheme
• $selected_entity_ids — Selected Entities IDs should be set/get from traf_monitor_alert_entity table
• $selected_entity_ids_secondary — Selected Entities IDs Secondary will be filled only in case of arbitrage
should be set/get from traf_monitor_alert_entity table
• $emails — Emails should be set/get from traf_monitor_alert_email table
• $tm_environment — TM Environment (Q/A, Production, Test), Could be set only by traffic monitor
• $selected_line_item_ids — Line Items IDs should be set/get from traf_monitor_alert_line_item table
Fields
int $id
Alert ID
• size : 10
• primary
string $name
Alert name
• size : 50
string $description
Alert description
• size : 255
• nillable
int $entity_id
Ignored on update.
408
Services
Entity ID, the alert belong to.
• size : 10
int $contact_id
Ignored on update.
Contact ID
• size : 10
boolean $active
Default value: '1'
Activity flag
string $domain
Domain
The complete list of enum values you can see at tma_domain enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'tma_domain').
• enum : tma_domain
boolean $use_all_objects
Default value: '0'
Use all objects
boolean $use_all_objects_secondary
Default value: '0'
Use all objects (secondary) should be used only in case of arbitrage
int $min_imps
Default value: '0'
Minimum imps
• size : 10
int $max_imps
Default value: '0'
Maximum imps
• size : 10
float $min_volume
Minimum volume
• nillable
float $max_volume
Maximum volume
• nillable
float $pct_decrease
PCT decrease
• nillable
float $pct_increase
PCT increase
• nillable
409
Services
float $min_losses_pct
Default value: NULL
min_losses_pct
• nillable
float $sigma_multiplier
Sigma multiplier
• nillable
string $metric_type
Metric type
The complete list of enum values you can see at tma_metric_type enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'tma_metric_type').
• enum : tma_metric_type
boolean $is_daily
Default value: '0'
Daily alert
boolean $is_hourly
Default value: '0'
Hourly alert
float $min_metric_value
Minimum metric value
• nillable
float $max_metric_value
Maximum metric value
• nillable
int $version
Default value: '1'
Version
• size : 6
int $analysis_scheme
Default value: '1'
Analysis Scheme
• size : 6
• nillable
array_of_int $selected_entity_ids
Selected Entities IDs should be set/get from traf_monitor_alert_entity table
array_of_int $selected_entity_ids_secondary
Selected Entities IDs Secondary will be filled only in case of arbitrage should be set/get from traf_monitor_alert_entity
table
array_of_string $emails
Emails should be set/get from traf_monitor_alert_email table
string $tm_environment
410
Services
TM Environment (Q/A, Production, Test), Could be set only by traffic monitor
The complete list of enum values you can see at tma_tm_environment enum page, at run time you can get all of them
using DictionaryService.getEnumValues(token, 'tma_tm_environment').
• enum : tma_tm_environment
array_of_int $selected_line_item_ids
Line Items IDs should be set/get from traf_monitor_alert_line_item table
valid_vurl
valid_vurl data type
• vurl_data
♦ $valid_urls_data
Fields Summary
• $id — Vurl id.
• $url — Vurl.
Fields
int $id
Vurl id.
string $url
Vurl.
vast_tag
• ad_tag_options
♦ $vast_tag
Fields Summary
• $vast_verstion — VAST version number "2" or "3"
• $vast_type_id — VAST Type Id see VAST Type Table for additional information.
• $vast_placement_type_id — Placement type ID see Placement Type Table for additional information.
• $min_duration — Minimum duration of the video
• $max_duration — Maximum duration of the video
Fields
int $vast_verstion
VAST version number "2" or "3"
int $vast_type_id
VAST Type Id see VAST Type Table for additional information.
int $vast_placement_type_id
Placement type ID see Placement Type Table for additional information.
int $min_duration
411
Services
Minimum duration of the video
int $max_duration
Maximum duration of the video
video_api_framework
See Video Api Framework Type Enum for more information.
Fields Summary
• $id — Video api frameworke ID
• $video_api_framework — Video api framework type
Fields
int $id
Video api frameworke ID
• size : 3
• primary
string $video_api_framework
Video api framework type
• size : 30
video_creative
• creative
♦ $video_creative
♦ $video_creative
Fields Summary
• $vast_ad_tag_uri — Identifying vast tag from a secondary ad server for wrapper Ad
• $video_vast_type_id — Video vast type ID see VAST Type Table for additional information.
• $duration — Media duration in seconds
• $version
• $video_placement_type_id — Placement type ID see Placement Type Table for additional information.
Fields
string $vast_ad_tag_uri
Identifying vast tag from a secondary ad server for wrapper Ad
• size : 10000
int $video_vast_type_id
Video vast type ID see VAST Type Table for additional information.
• size : 3
int $duration
Media duration in seconds
• size : 10
412
Services
string $version
• size : 5,3
int $video_placement_type_id
Placement type ID see Placement Type Table for additional information.
• size : 3
video_delivery
See Video Delivery Type Enum for more information.
Fields Summary
• $id — Video delivery ID
• $video_delivery — Video delivery type
Fields
int $id
Video delivery ID
• size : 3
• primary
string $video_delivery
Video delivery type
• size : 100
video_placement_type
See Video Placement Type Enum for more information.
♦ getVideoPlacementType()
Fields Summary
• $id — Video placement ID
• $placement_type — Video Placement Type
Fields
int $id
Video placement ID
• size : 3
• primary
string $placement_type
Video Placement Type
• size : 100
413
Services
video_vast_type
See Video Vast Type Enum for more information.
♦ getVideoVastType()
Fields Summary
• $id — Video vast type ID
• $video_vast_type — video vast type
Fields
int $id
Video vast type ID
• size : 3
• primary
string $video_vast_type
video vast type
• size : 100
vurl_category
See Vurl Category Enum for more information.
♦ getVurlCategories()
♦ TargetProfileService::getVurlCategoriesDepr()
Fields Summary
• $id — category ID
• $name — category name
Fields
int $id
category ID
• size : 10
• primary
string $name
category name
• size : 64
vurl_data
vurl_data type
414
Services
♦ validateVurls()
Fields Summary
• $valid_urls_data — Valid url data.
• $invalid_urls — Invalid url.
Fields
array_of_valid_vurl $valid_urls_data
Valid url data.
array_of_string $invalid_urls
Invalid url.
vurl_get_data
vurl_get_data data type
♦ getVurls()
♦ getVurls()
Fields Summary
• $id — Vurl ID.
• $vurl — Vurl.
• $is_selected — Is select valid url.
Fields
int $id
Vurl ID.
string $vurl
Vurl.
boolean $is_selected
Is select valid url.
vurl
♦ searchVurls()
• target_vurl
♦ $options
Fields Summary
• $id — validated URL ID
• $active — activity flag
415
Services
• $url — URL string
• $vurl_category_id — category ID this vurl object belongs to
• $is_rmx_100 — rmx top 100 property
• $is_rmx_250 — rmx top 250 property
• $is_adware — adware property
• $is_click_fraud — click fraud property
• $is_audited — audited property
• $description — vurl object description
• $vurl_parent_id — parent ID
• $foreign_lang — foreign language property
• $minimum_brandsafe_level — minimum brandsafe level
• $created_by — Created by The complete list of enum values you can see at created_by enum page, at run
time you can get all of them using DictionaryService.getEnumValues(token, 'created_by').
Fields
int $id
validated URL ID
• size : 10
• primary
boolean $active
Default value: '0'
activity flag
string $url
Default value: ''
URL string
• size : 160
int $vurl_category_id
Default value: '0'
category ID this vurl object belongs to
• size : 10
boolean $is_rmx_100
Default value: '0'
rmx top 100 property
boolean $is_rmx_250
Default value: '0'
boolean $is_adware
Default value: '0'
adware property
Default value: '0'
click fraud property
boolean $is_audited
Default value: '0'
audited property
string $description
Default value: ''
vurl object description
416
Services
• size : 128
int $vurl_parent_id
Default value: '0'
parent ID
• size : 10
boolean $foreign_lang
Default value: '0'
foreign language property
enum_minimum_brandsafe_level $minimum_brandsafe_level
Default value: '0'
minimum brandsafe level
string $created_by
Created by The complete list of enum values you can see at created_by enum page, at run time you can get all of
them using DictionaryService.getEnumValues(token, 'created_by').
• enum : created_by
vurl_options
♦ getTargetValidatedUrls()
♦ TargetProfileService::getTargetValidatedUrlsDepr()
♦ setTargetValidatedUrls()
• target_vurl
♦ $options
Fields Summary
• $vurl_default — this flag let you specify how to treat the elements of $vurl_ids array for the
setTargetValidatedUrls and getTargetValidatedUrls calls.
• $vurl_category_default — default category
• $require_audited_vurl — is audited vurl required
• $rmx_100_only — rmx top 100 property
• $rmx_250_only — rmx top 250 property
• $no_adware — adware property
• $no_click_fraud — click fraud property
• $no_foreign_language — foreign language property
• $no_banned — banned property
• $no_inactive — inactive property
• $banned_vurl_categories — the list of banned vurl categories
Fields
boolean $vurl_default
Default value: '1'
this flag let you specify how to treat the elements of $vurl_ids array for the setTargetValidatedUrls and
getTargetValidatedUrls calls.
boolean $vurl_category_default
Default value: '1'
default category
boolean $require_audited_vurl
Default value: '0'
is audited vurl required
417
Services
Default value: '0'
Default value: '0'
boolean $no_adware
Default value: '0'
adware property
boolean $no_click_fraud
Default value: '0'
click fraud property
boolean $no_foreign_language
foreign language property
boolean $no_banned
banned property
boolean $no_inactive
inactive property
array_of_int $banned_vurl_categories
the list of banned vurl categories
vurl_search_options
♦ searchVurls()
Fields Summary
• $ids — seek only with given ids
• $pattern — search pattern
• $description — search description pattern
• $parent
• $category_ids — seek only among the following categories
• $rmx_100_only — seek only with rmx top 100 property
• $rmx_250_only — seek only with rmx top 250 property
• $is_adware — seek only with adware property
• $is_click_fraud — seek only with click fraud property
• $is_audited — seek only with audited property
• $is_foreign_language — seek only with foreign language property
• $is_active — seek only among active objects
• $minimum_brandsafe_levels — seek only with minimum_brandsafe_level in
Fields
array_of_int $ids
seek only with given ids
• nillable
string $pattern
Default value: 'a*'
418
Services
search pattern
• nillable
string $description
search description pattern
• nillable
string $parent
• nillable
array_of_int $category_ids
seek only among the following categories
• nillable
seek only with rmx top 100 property
• nillable
seek only with rmx top 250 property
• nillable
boolean $is_adware
seek only with adware property
• nillable
seek only with click fraud property
• nillable
boolean $is_audited
seek only with audited property
• nillable
boolean $is_foreign_language
seek only with foreign language property
• nillable
boolean $is_active
seek only among active objects
• nillable
array_of_enum_minimum_brandsafe_level $minimum_brandsafe_levels
seek only with minimum_brandsafe_level in
• nillable
419
Services
vurl_tag_list
See Vurl Tag Enum for more information.
♦ getVurlTags()
Fields Summary
• $id
• $primary_category
• $secondary_category
• $tertiary_category
• $tag
• $entity_id
• $is_media_guard
• $ui_order
• $is_enabled
• $brandsafe_level
• $lastupd
Fields
int $id
• size : 10
• primary
string $primary_category
• size : 100
string $secondary_category
• size : 100
string $tertiary_category
• size : 100
string $tag
• size : 255
int $entity_id
• size : 10
int $is_media_guard
• size : 1
float $ui_order
420
Services
int $is_enabled
• size : 1
int $brandsafe_level
• size : 6
dateTime $lastupd
woeid
♦ getWoeidDetails()
Fields Summary
• $woeid — Woe ID
• $level — Level
• $parent_woeid — Parent WOEID
• $parent_woeid2 — Parent WOEID2
• $description — Description
• $iso — Country ISO
• $display_name — Display name
• $exposed — Flag to indicate if the woeid id exposed for targeting
• $legacy — Determines if it is a legacy geo entity
• $breadcrumb — Breadcrumb
Fields
int $woeid
Woe ID
• size : 10
• primary
int $level
Level
The complete list of enum values you can see at woeid_level enum page, at run time you can get all of them using
DictionaryService.getEnumValues(token, 'woeid_level').
• enum : woeid_level
int $parent_woeid
Parent WOEID
• size : 10
int $parent_woeid2
Parent WOEID2
• size : 10
421
Services
string $description
Description
• size : 255
string $iso
Country ISO
• size : 2
Display name
• size : 100
int $exposed
Flag to indicate if the woeid id exposed for targeting
• size : 3
int $legacy
Determines if it is a legacy geo entity
• size : 3
string $breadcrumb
Breadcrumb
woeid_search_result
This file contains woeid_search_result data type
• SearchService
♦ searchWoeids()
Fields Summary
• $woeid
• $description
Fields
int $woeid
string $description
422

Yahoo Ad Exchange SOAP API Reference

Transcription

Similar documents

Flemish String Board Attachment

Basic Information - Tecnológico de Monterrey

AlAhliToken

class notes

READY TO FLY!!!

AGSES - the key to freedom Situation Motivation Explanation

Dual 8“ 2-way bi-amp line array speaker

Worcester State College

Simple Distributed Control Strategy for Hover Control

AlAhliToken