Jump to Content

API Reference Community Discussion Announcements Subscribe

API Reference Announcements Community Discussion

API Reference Community Discussion Announcements Subscribe Log In

API Reference

Overview

Welcome
A Note for Publishers
Video Campaigns
Java Client SDK

Authentication

Authentication Basics
Getting an Access Token
Client Credentials Flowpost
Password Credentials Flowpost
- The Refresh Token

Request Basics

Making Requests
Errors
Dictionary

Your Account

Your Account ID
Get Account Detailsget
Network Accounts
Get Advertiser Accounts in Networkget
Get Allowed Accountsget

Campaigns

Campaigns Overview
Get All Campaignsget
Get a Campaignget
Get all campaigns across the networkget
Create a Campaignpost
Duplicating Campaigns
Duplicate a Campaignpost
Updating Campaigns
Update a Campaignpost
Bulk Update Campaignspost
Patching Collections
Patching Bid Modifiers
Patch a Collectionpatch
Pausing/unpausing Campaigns
Deleting Campaigns
Delete a Campaigndelete

Campaign Fields

Campaign Object
Campaign Fields
Bidding strategies
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
Activity Schedule Object
Activity Schedule Item Object

Items (Ads)

Motion Ads

Performance Video Items (Motion Ads)
Get All Performance Video Items (Motion Ads)get
Get a Performance Video Item (Motion Ad)get
Create a Performance Video Item (Motion Ad)post
Update a Performance Video Item (Motion Ad)put
Delete a Performance Video Item (Motion Ad)delete
Performance Video Items (Motion Ads) - Flow
Performance Video Items (Motion Ads) - Fields

Taboola Pixel

Taboola Pixel Overview
CONVERSION RULE QUICK REFERENCE
Get All Conversion Rulesget
Get a Conversion Ruleget
Get All Conversion Rules Plus Dataget
Create a Conversion Rulepost
Update a Conversion Rulepost
Archiving/unarchiving a Conversion Rule
Sample Conversion Rule
Conversion Rule Fields
Effect Object
- type
- data
Condition Object
CUSTOM AUDIENCE QUICK REFERENCE
Get All Custom Audiencesget
Get a Custom Audience Ruleget
Create a Custom Audience Rulepost
Update a Custom Audience Rulepost
Sample Custom Audience Rule
Custom Audience Fields

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 Targetingget
Update Postal Codes Targetingpost
- 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 Publishersget
Patching Targeted Publishers
Auto-Targeted Publishers
Publisher Targeting Patch Object
ACCOUNT LEVEL BLOCKING
Get Blocked Publishers At Account Levelget
Block Publishers At Account Levelpost

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 Targetingget
Update Marketplace Audience Targetingpost
Get Custom Audience Targetingget
Update Custom Audience Targetingpost
Get Lookalike Audience Targetingget
Update Lookalike Audience Targetingpost
Contextual Targeting
Get Contextual Targetingget
Update Contextual Targetingpost

COMBINED AUDIENCES

Overview
List available audiencesget
- Available audience object schema
Get all combined audiencesget
Get a combined audienceget
Create a combined audiencepost
Update a combined audiencepost

Audience Onboarding

First Party Audience Onboarding
Create a First Party Audiencepost
Fields
Add/remove userspost
Fields
- User Object
- User ID Object
Get My Audienceget
Get My Audience Targetingget
Update My Audience Targetingpost

Reporting

Reporting Overview
Dimensions, Filters and Columns
CAMPAIGN SUMMARY REPORT
Campaign Summary Reportget
Dimensions Overview
Dimensions Cheat Sheet
Filters
Standard Columns
Dimension Columns
Network-wide reports
Custom Conversion Columns
Metadata Object Schema
Row Object Schema
- id
- value
TOP CAMPAIGN CONTENT
Top Campaign Content Reportget
- Dimension Cheat Sheet
Supported Filters
Standard Columns
Dimension Columns
Custom Conversion Columns

Real-time Reports

Realtime Campaign Reportget
Realtime Ads Reportget

Dictionary

DICTIONARY OVERVIEW
Common Use Cases
Request URL
Response
Traversing the Tree
ENUMS
Get list of Dictionariesget
Get list of Campaign Enumsget
Get list of Item Enumsget
GENERAL LISTS
Get Days of Weekget
Get list of Languagesget
Get list of Minimum CPC valuesget
POSSIBLE VALUES
Get possible values for Campaign Categoryget
Get possible values for Item Statusget
Get possible values for Item CTAget
Get supported languages for Image Libraryget
TARGETING
Get list of Platformsget
Get list of Operating Systemsget
Get list of iOS Versionsget
Get list of Android Versionsget
Get list of Browsersget
GEO TARGETING
Get list of Countriesget
Get Regions in a Countryget
Get DMAs in the USget
- Get Cities in a Countryget
Get Postal Codes for a Countryget
AUDIENCE TARGETING
Get Marketplace Audiencesget
Get Marketplace Audiences for a specific Countryget
Get Lookalike Audiencesget
Get Lookalike Audiences for a specific Countryget
Get Contextual Segmentsget

Overview

Welcome
A Note for Publishers
Video Campaigns
Java Client SDK

Authentication

Authentication Basics
Getting an Access Token
Client Credentials Flowpost
Password Credentials Flowpost
- The Refresh Token

Request Basics

Making Requests
Errors
Dictionary

Your Account

Your Account ID
Get Account Detailsget
Network Accounts
Get Advertiser Accounts in Networkget
Get Allowed Accountsget

Campaigns

Campaigns Overview
Get All Campaignsget
Get a Campaignget
Get all campaigns across the networkget
Create a Campaignpost
Duplicating Campaigns
Duplicate a Campaignpost
Updating Campaigns
Update a Campaignpost
Bulk Update Campaignspost
Patching Collections
Patching Bid Modifiers
Patch a Collectionpatch
Pausing/unpausing Campaigns
Deleting Campaigns
Delete a Campaigndelete

Campaign Fields

Campaign Object
Campaign Fields
Bidding strategies
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
Activity Schedule Object
Activity Schedule Item Object

Items (Ads)

Motion Ads

Performance Video Items (Motion Ads)
Get All Performance Video Items (Motion Ads)get
Get a Performance Video Item (Motion Ad)get
Create a Performance Video Item (Motion Ad)post
Update a Performance Video Item (Motion Ad)put
Delete a Performance Video Item (Motion Ad)delete
Performance Video Items (Motion Ads) - Flow
Performance Video Items (Motion Ads) - Fields

Taboola Pixel

Taboola Pixel Overview
CONVERSION RULE QUICK REFERENCE
Get All Conversion Rulesget
Get a Conversion Ruleget
Get All Conversion Rules Plus Dataget
Create a Conversion Rulepost
Update a Conversion Rulepost
Archiving/unarchiving a Conversion Rule
Sample Conversion Rule
Conversion Rule Fields
Effect Object
- type
- data
Condition Object
CUSTOM AUDIENCE QUICK REFERENCE
Get All Custom Audiencesget
Get a Custom Audience Ruleget
Create a Custom Audience Rulepost
Update a Custom Audience Rulepost
Sample Custom Audience Rule
Custom Audience Fields

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 Targetingget
Update Postal Codes Targetingpost
- 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 Publishersget
Patching Targeted Publishers
Auto-Targeted Publishers
Publisher Targeting Patch Object
ACCOUNT LEVEL BLOCKING
Get Blocked Publishers At Account Levelget
Block Publishers At Account Levelpost

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 Targetingget
Update Marketplace Audience Targetingpost
Get Custom Audience Targetingget
Update Custom Audience Targetingpost
Get Lookalike Audience Targetingget
Update Lookalike Audience Targetingpost
Contextual Targeting
Get Contextual Targetingget
Update Contextual Targetingpost

COMBINED AUDIENCES

Overview
List available audiencesget
- Available audience object schema
Get all combined audiencesget
Get a combined audienceget
Create a combined audiencepost
Update a combined audiencepost

Audience Onboarding

First Party Audience Onboarding
Create a First Party Audiencepost
Fields
Add/remove userspost
Fields
- User Object
- User ID Object
Get My Audienceget
Get My Audience Targetingget
Update My Audience Targetingpost

Reporting

Reporting Overview
Dimensions, Filters and Columns
CAMPAIGN SUMMARY REPORT
Campaign Summary Reportget
Dimensions Overview
Dimensions Cheat Sheet
Filters
Standard Columns
Dimension Columns
Network-wide reports
Custom Conversion Columns
Metadata Object Schema
Row Object Schema
- id
- value
TOP CAMPAIGN CONTENT
Top Campaign Content Reportget
- Dimension Cheat Sheet
Supported Filters
Standard Columns
Dimension Columns
Custom Conversion Columns

Real-time Reports

Realtime Campaign Reportget
Realtime Ads Reportget

Dictionary

DICTIONARY OVERVIEW
Common Use Cases
Request URL
Response
Traversing the Tree
ENUMS
Get list of Dictionariesget
Get list of Campaign Enumsget
Get list of Item Enumsget
GENERAL LISTS
Get Days of Weekget
Get list of Languagesget
Get list of Minimum CPC valuesget
POSSIBLE VALUES
Get possible values for Campaign Categoryget
Get possible values for Item Statusget
Get possible values for Item CTAget
Get supported languages for Image Libraryget
TARGETING
Get list of Platformsget
Get list of Operating Systemsget
Get list of iOS Versionsget
Get list of Android Versionsget
Get list of Browsersget
GEO TARGETING
Get list of Countriesget
Get Regions in a Countryget
Get DMAs in the USget
- Get Cities in a Countryget
Get Postal Codes for a Countryget
AUDIENCE TARGETING
Get Marketplace Audiencesget
Get Marketplace Audiences for a specific Countryget
Get Lookalike Audiencesget
Get Lookalike Audiences for a specific Countryget
Get Contextual Segmentsget

spent

Name	Modifier & Defaults	Type	Description
spent	Read-only	Double	Represents the estimated amount of money this campaign has consumed.