Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for TW-1001

...

Body Parameter

Type

Required

Validations

Description

name

String

No

  • Maximum length is 250 characters

  • Name should be unique for your account

  • Unsupported characters are |!{}[]^"~*?:;+\

Name of the targeting

description

String

No

  • Maximum length is 250 characters

  • Unsupported characters are |!{}[]^"~*?:;+\

Description of the targeting

geos

JSON Array of Integer

No

Value should already exist in the system

Geos to be associated with the targeting
For example, US, Canada, New York

zips

JSON Array of Integer

No


Zips for Targeting
e.g. 453216

audienceSegments

JSON Array of Integer

No

Value should already exist in the system

Custom audience segments audiences to be associated with the targeting

pixel (Inclusion/Exclusion)

JSON Array of Integer

No

Value should already exist in the system

Targeting/Re-targeting pixels to be included in the targeting (pixel.includes) and/or excluded from the targeting unit (pixel.excludes)

daysOfWeek

JSON Array of Integer

No

Value should already exist in the system

Days of the week on which the targeting will be applicable

startTimeParting

Timestamp

No

HH:MM:SS

Time of the day from which the targeting will be applicable

endTimeParting

Timestamp

No

HH:MM:SS

Time of the day till which the targeting will be applicable

browsers

JSON Array of Integer

No

Value should already exist in the system

Browsers to be associated with the targeting
For example, IE, Firefox, etc.

connectionTypes

JSON Array of Integer

No

Value should already exist in the system

Connection types to be associated with the targeting
For example, Cellular, Dialup, etc.

osTypes

JSON Array of Integer

No

Value should already exist in the system

OS types to be associated with the targeting
For example, iOS, Android, etc.

os

JSON Array of Integer

No

Value should already exist in the system

IDs of the OSs to be associated with the targeting

carriers

JSON Array of Integer

No

Value should already exist in the system

Mobile carriers to be associated with the targeting

latLong

Boolean

No

Should be a valid Boolean value

Indicates whether latitude/longitude targeting should be enabled in the targeting or not.

deviceIdType

Integer

No

Value should already exist in the system
 

Types of device IDs to be associated with the targeting. Possible options are:
1 - IDFA
3 - Android ID

videoAdTypes

JSON Array of Integer

No

Value should already exist in the system

Types of video ads to be associated with the targeting
For example, Linear, Non-Linear, etc.

videoAdPositions

JSON Array of Integer

No

Value should already exist in the system

Video ad positions to be associated with the targeting
For example, Pre-roll, Post-roll, etc.

videoPlaybackMethods

JSON Array of Integer

No

Value should already exist in the system

Video Playback methods to be associated with the targeting
For example, 'Auto-play sound on', Click-to-play, etc.

preset

Boolean

No

Should be a valid Boolean value

Indicates whether the targeting should be saved as a preset for future use or not.

richMediaTechnologies

JSON Array of Integer

No

Value should already exist in the system

Rich Media Technologies for targeting

For example,  Eyeblaster , Pointroll

matchedUsers

Boolean

No

Valid boolean value

Indicates whether cookies are placed on visitor's browser or not

smartphones

JSON Array of Integer

No

Value should already exist in the system

Smart phone devices for targeting
For example, Smart Phone

tablets

JSON Array of Integer

No

Value should already exist in the system

Tablet devices for targeting
For example, Tablet

ownerType

Integer

Yes

Possible values are:

Type of Account

Value

Publisher

1

Demand Partner

5

ATD/Buyer

7


Indicates the type of account of the user invoking this API.

ownerId

Long

Yes

Should be a valid Publisher ID, DSP, or Buyer ID

Indicates account ID

...

Error Code

Error Message

CC02_0006

User is not allowed to access this resource.

CC03_0007

Multiple associated resources found during search operation. Pass loggedInOwnerId and loggedInOwnerTypeId in query parameters.

IU_001_0007

Invalid or null value for Publisher ID.

TU_001_0001

Invalid targeting unit ID.

TU_001_0002

Invalid user ID.

TU_001_0003

Name cannot exceed 255 characters.

TU_001_0004

Description cannot exceed 512 characters.

TU_001_0005

Invalid or null value for Owner Type field.

TU_001_0006

Invalid owner ID.

TU_001_0008

Error in validating publisher info.

TU_001_0009

Invalid or null value for Owner Type field.

TU_001_0010

Invalid Audience Segments Audiences selected.

TU_001_0011

Invalid Geos selected.

TU_001_0012

Internal error in validating selected Geos.

TU_001_0013

Invalid Browser IDs passed.

TU_001_0014

Invalid Mobile OS IDs passed.

TU_001_0016

Invalid Connection type IDs passed.

TU_001_0018

Invalid Mobile Carrier IDs passed.

TU_001_0019

Invalid Phone Type IDs passed.

TU_001_0020

Invalid Video Playback Method IDs passed.

TU_001_0021

Invalid Video Position IDs passed.

TU_001_0022

Invalid Mobile OS type IDs passed.

TU_001_0023

Invalid Geo IDs passed.

TU_001_0025

Invalid Video Type IDs passed.

TU_001_0026

Invalid Resource Type found for logged in user.

TU_001_0027

Mobile OS IDs are not mapped to Mobile OS Type IDs.

TU_001_0029

Invalid Days Of Week IDs passed.

TU_001_0030

Invalid Device ID Types passed.

TU_001_0031

Targeting creation failed

TU_001_0032

End time parting cannot be before start time parting.

TU_001_0033

Targeting name already exists. Please use another name.

TU_001_0034

Demand Partner/ATD not supported

TU_001_0035

Invalid Targeting name. Following characters are not allowed: |!{}[]^"~*?:;+\

TU_001_0036

Invalid Targeting description. Following characters are not allowed: |!{}[]^"~*?:;+\

TU_001_0037

Invalid Pixels passed.

TU_001_0038

Targeting name cannot be null, if preset is set to true.

TU_001_0039

No targeting found for given targeting ID.

TU_001_0040

Error in fetching targeting details.

TU_001_0043

Publisher ID filter is not applicable for this user.

TU_001_0045

Invalid Rich Media Technology ID passed.

TU_001_0046

Targeting cannot be edited as it is already used in a transaction entity

TU_001_0048

Invalid Smartphone IDs passed.

TU_001_0049

Invalid Tablets IDs passed.

TU_001_XXXX

Invalid Targeting ID.

TU_001_YYYY

Cannot delete Targeting as it is already in use.

...