Jump to Content
API Reference
Community Discussion
Announcements
API Reference
Announcements
Community Discussion
Taboola Backstage API
Taboola Conversion Tracking
Taboola DCO
Taboola Mobile SDK
Taboola Web Integrations
Taboola Newsroom
Taboola Recommendations API
API Reference
Community Discussion
Announcements
Log In
API Reference
Log In
Taboola Backstage API
API Reference
DICTIONARY OVERVIEW
All
Pages
Start typing to search…
JUMP TO
Overview
Welcome
A Note for Publishers
Video Campaigns
Java Client SDK
Authentication
Authentication Basics
Getting an Access Token
Client Credentials Flow
post
Request Basics
Making Requests
Errors
Dictionary
Your Account
Your Account ID
Get Account Details
get
Network Accounts
Get Advertiser Accounts in Network
get
Get Allowed Accounts
get
Campaigns
Campaigns Overview
Get All Campaigns
get
Get a Campaign
get
Get all campaigns across the network
get
Create a Campaign
post
Campaign Reach Estimator
post
Examples
Additional fields
Duplicating Campaigns
Duplicate a Campaign
post
Updating Campaigns
Update a Campaign
post
Bulk Update Campaigns
post
Patching Collections
Patching Bid Modifiers
Patch a Collection
patch
Pausing/unpausing Campaigns
Deleting Campaigns
Delete a Campaign
del
Campaign Fields
Campaign Object
Campaign Fields
id
advertiser_id
name
branding_text
tracking_code
pricing_model
cpc
daily_cap
daily_ad_delivery_model
spending_limit
spending_limit_model
cpa_goal
country_targeting
sub_country_targeting
dma_country_targeting
region_country_targeting
city_targeting
postal_code_targeting
platform_targeting
publisher_targeting
os_targeting
connection_type_targeting
auto_publisher_targeting
publisher_bid_modifier
publisher_bid_strategy_modifiers
comments
spent
bid_strategy
bid_type
traffic_allocation_mode
traffic_allocation_ab_test_end_date
external_brand_safety
start_date
end_date
approval_state
is_active
status
audience_segments_multi_targeting
custom_audience_targeting
marking_label_multi_targeting
lookalike_audience_targeting
contextual_segments_targeting
marketing_objective
verification_pixel
viewability_tag
activity_schedule
policy_review
browser_targeting
Bidding strategies
Maximize conversions
Target CPA
Enhanced CPC (aka SmartBid)
Fixed CPC
Targeting
Policy Review Object
External Brand Safety
External Brand Safety Object
External Brand Safety Restriction Object
Verification Pixel
Verification Pixel Object
Verification Pixel Item Object
Viewability Tags
Viewability Tag Object
Viewability Tag Item Object
Publisher Bid Modifier Object
'Bid Modifier Per Publisher' Object
Publisher Bid Strategy Modifier Object
'Bid Strategy Per Publisher' Object
Patch Object
patch_operation
publisher_bid_modifier
publisher_bid_strategy_modifiers
publisher_targeting
Activity Schedule Object
mode
rules
time_zone
Activity Schedule Item Object
type
day
from_hour
until_hour
Items (Ads)
Campaign Items Overview
Campaign Item Fields
id
campaign_id
type
url
thumbnail_url
title
description
approval_state
is_active
status
policy_review
cta
creative_focus
verification_pixel
viewability_tag
custom_data
CTA Object
Creative Focus Object
Coordinates Object
Item Status
Item Types
Get All Campaign Items
get
Get a Campaign Item
get
Creating a Campaign Item
Create a Campaign Item
post
Updating Campaign Items
Update a Campaign Item
post
Deleting Campaign Items
Delete a Campaign Item
del
Creative Focus
Creative CTA
Pausing/unpausing Campaign Items
RSS Items
Get Children Items
get
Get a Child Item
get
Update a Child Item
post
Bulk Operations
Mass create items for a given campaign
post
Bulk create items across campaigns
put
Bulk update items across campaigns
post
Bulk delete items across campaigns
del
MANAGING IMAGES
Upload Image From Local Device
Get Taxonomies
get
Get Images From Image Library
get
Upload Image From an Image Library
post
End-To-End Flow
Motion Ads
Overview & flow
Submitting motion assets
Update a Motion Ad
put
Motion ad fields
id
campaign_id
url
title
description
approval_state
is_active
status
policy_review
video_url
video_file
fallback_url
fallback_file
gif_url
verification_pixel
viewability_tag
Deprecated endpoints
Create a Motion Ad
post
Get All Motion Ads
get
Get a Motion Ad
get
Delete a Motion Ad
del
Taboola Pixel API
Taboola Pixel API Overview
CONVERSION RULE QUICK REFERENCE
Get All Conversion Rules
get
Get a Conversion Rule
get
Get All Conversion Rules Plus Data
get
Create a Conversion Rule
post
Update a Conversion Rule
post
Archiving/unarchiving a Conversion Rule
Sample Conversion Rule
Conversion Rule Fields
id
display_name
look_back_window
view_through_look_back_window
category
status
type
event_name
condition
effects
include_in_total_conversions
exclude_from_campaigns
description
advertiser_id
last_modified_by
last_modified_at
Effect Object
type
data
Condition Object
property
predicate
value
children
CUSTOM AUDIENCE QUICK REFERENCE
Get All Custom Audiences
get
Get a Custom Audience Rule
get
Create a Custom Audience Rule
post
Update a Custom Audience Rule
post
Sample Custom Audience Rule
Custom Audience Fields
id
display_name
look_back_window
category
status
type
event_name
condition
exclude_from_campaigns
description
advertiser_id
last_modified_by
last_modified_at
audience_size
Targeting
Targeting Overview
Targeting Object
Targeting Flow
Geo Targeting
Country And Sub-Country Targeting
Examples
Examples - INCORRECT Usage
City Targeting
Examples and flow
Postal Code Targeting
Get Postal Codes Targeting
get
Update Postal Codes Targeting
post
Postal Code Targeting Flow
Postal Codes Targeting Restrictions Object
Platform Targeting
OS Targeting
Browser Targeting
Connection Type Targeting
Publisher Targeting (Blocking)
List Of Publishers
Get list of available Publishers
get
Patching Targeted Publishers
Auto-Targeted Publishers
Publisher Targeting Patch Object
ACCOUNT LEVEL BLOCKING
Get Blocked Publishers At Account Level
get
Block Publishers At Account Level
post
Audience Targeting
Audience Targeting Overview
Audience Targeting Flow
Multi-Targeting Object
Audience Targeting Quick Reference
Audience Targeting Object
Audience Targeting Restrictions Object
Lookalike Audience Object
Get Marketplace Audience Targeting
get
Update Marketplace Audience Targeting
post
Get Custom Audience Targeting
get
Update Custom Audience Targeting
post
Get Lookalike Audience Targeting
get
Update Lookalike Audience Targeting
post
Contextual Targeting
Get Contextual Targeting
get
Update Contextual Targeting
post
COMBINED AUDIENCES
Overview
List available audiences
get
Available audience object schema
Get all combined audiences
get
Get a combined audience
get
Create a combined audience
post
Update a combined audience
post
Audience Onboarding
First Party Audience Onboarding
Create a First Party Audience
post
Fields
Add/remove users
post
Fields
User Object
User ID Object
Get My Audience
get
Get My Audience Targeting
get
Update My Audience Targeting
post
Reporting
Reporting Overview
Dimensions, Filters and Columns
CAMPAIGN SUMMARY REPORT
Campaign Summary Report
get
Dimensions Overview
Dimensions Cheat Sheet
Filters
start_date
end_date
campaign
platform
country
site
partner_name
Standard Columns
Dimension Columns
Network-wide reports
Custom Conversion Columns
2 new properties (dynamic_fields)
The Metadata Section
An Example
Metadata Object Schema
caption
id
format
data_type
Row Object Schema
id
value
TOP CAMPAIGN CONTENT
Top Campaign Content Report
get
Dimension Cheat Sheet
Supported Filters
start_date
end_date
campaign
Standard Columns
Dimension Columns
Custom Conversion Columns
Real-time Reports
Realtime Campaign Report
get
The response object
Some examples
Dimensions Cheat Sheet
Filters
Dimension columns
Campaign columns
Standard columns
Realtime Ads Report
get
The response object
Some examples
Dimensions Cheat Sheet
Filters
Dimension columns
Item columns
Standard columns
Dictionary
DICTIONARY OVERVIEW
Common Use Cases
Request URL
Response
Traversing the Tree
ENUMS
Get list of Dictionaries
get
Get list of Campaign Enums
get
Get list of Item Enums
get
GENERAL LISTS
Get Days of Week
get
Get list of Languages
get
Get list of Minimum CPC values
get
POSSIBLE VALUES
Get possible values for Campaign Category
get
Get possible values for Item Status
get
Get possible values for Item CTA
get
Get supported languages for Image Library
get
TARGETING
Get list of Platforms
get
Get list of Operating Systems
get
Get list of iOS Versions
get
Get list of Android Versions
get
Get list of Browsers
get
GEO TARGETING
Get list of Countries
get
Get Regions in a Country
get
Get DMAs in the US
get
Get Cities in a Country
get
Get Postal Codes for a Country
get
AUDIENCE TARGETING
Get Marketplace Audiences
get
Get Marketplace Audiences for a specific Country
get
Get Lookalike Audiences
get
Get Lookalike Audiences for a specific Country
get
Get Contextual Segments
get
Video Campaigns
Video campaign management
Video campaign creatives
Video campaign reports
Stuff
header-bidding-data-access
DICTIONARY OVERVIEW
