PRODUCT
Follow

Related Entities

panel Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Sizmek Ad Suite (SAS) internal use) If the field was received in the GET call, include it in the PUT call.

Parameter

Description

Type

Required

Notes

name

Name of the panel.

String

Required

defaultPanel

Indicates whether the panel is set to be the default panel.

Boolean

Read-only

positionX

X position of the panel.

Float

Required

positionY

Y position of the panel.

Float

Required

positionType

Type of positioning.

String

Required

autoExpand

Determines if the panel automatically expands.

Boolean

Required

delayedExpansion

Determines if the panel expands after ??

Boolean

Required

retraction

Defines the method in which the panel retracts after expansion.

String

Required

transparent

Determines

Boolean

Required

autoGeneratedPanel

Indicated if the panel is user defined or server generated.

Boolean

Read-only

assetId

ID of the asset to be used

Long

Required

assetStatus

Status of the asset to be used.

String

Read-only

source

Internal

Boolean

Internal

width

Width of the asset.

Integer

Read-only

height

Height of the asset.

Integer

Read-only

assetName

Name of the asset to be used.

String

Read-only

folderId

ID of the folder the asset resides in

Long

Read-only

workspaceFolderId

ID of the workspace where the asset is stored.

Long

Read-only

size

Size (in KB) of the asset.

Long

Read-only

duration

Length of the asset (If applicable).

Long

Read-only

bitRate

Bit rate of the asset (If applicable).

Long

Read-only

mimeType

Label used to identify the type of data.

String

Read-only

mediaType

Media type for the asset.

String

Read-only

format

Format of the asset, depending on the mediaType.

String

Read-only

Examples include jpg and mp4.

external

Determines if the asset is external.

Boolean

Internal

thumbnailUrl

URL to the path of the asset thumbnail image.

String

Read-only

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

Read-only

Object JSON Example

relationsBag Object

This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.

relationsBag Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Sizmek Ad Suite (SAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

parents

This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data.

An advertiser will only include the "account".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Parents Object

Parents Object Definition

Name

Description

Type

Required

Notes

account

Parent account of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1072241834,
 "name": "testing account",
 "internal": false
 }

advertiser

Parent advertiser of current entity (if applicable).

Object

Read-Only

Example:

{
 "id": 1073741822,
 "name": "AAA"
 }

brand

Parent brand of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741833,
 "name": "BBB"
 }

campaign

Parent campaign of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741831,
 "name": "ccc"
 }

site

Parent site of current entity (if applicable).

Object

Read-Only

Example:

 {
 "id": 1073741853,
 "name": "ddd"
 }

Object JSON Example

Children Object

Children Object Definition

Name

Description

Type

Required

Notes

advertisers

Contains the count of child advertisers (if applicable).

Object

Read-Only

brands

Contains the count of child brands (if applicable).

Object

Read-Only

campaigns

Contains the count of child campaigns (if applicable).

Object

Read-Only

users

Contains the count of child users (if applicable).

Object

Read-Only

Object JSON Example

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk