linearSettings Object – API Help Center

Related Entities

Endpoints Using the linearSettings Object

Ad Resource

Parent Objects

linearSettings 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 Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Parameter	Description	Type	Required	Notes
fileDuration	Play time duration of the linear assets.	Double	Read-only	Duration time is in seconds.
scalable	Control whether the linear asset should scale to fit the player.	Boolean	Read-only
maintainAspectRatio	Control whether to maintain the aspect radio of the linear asset in case of scaling.	Boolean	Read-only
clickthrough	Clickthrough URL to navigate to when clicking on the linear asset.	String	Read-only
skipEnabled	Control whether to allow the user to skip the ad.	Boolean	Read-only
skipDelay	Delay into the ad from which the skip button is clickable.	Double	Read-only	Delay time is in seconds.
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 Amazon Ad Server (AAS) 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

"relationsBag": {
        "parents": {
                "account": {
                        "id": 16674,
                        "name": "[TEST] migrated account",
                        "internal": true
                },
                "advertiser": null,
                "brand": null,
                "campaign": null,
                "site": null
        },
        "children": {
                "advertisers": {
                        "count": 0
                },
                "brands": {
                        "count": 1
                },
                "campaigns": {
                        "count": 231
                },
                "users": {
                        "count": 0
                }
        },
        "creativeAccountContact": false
},

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
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

Related Entities

Endpoints Using the linearSettings Object

Parent Objects

linearSettings Object Definition

Note

Object JSON Example

relationsBag Object

relationsBag Object Definition

Note

Object JSON Example

Parents Object

Parents Object Definition

Object JSON Example

Children Object

Children Object Definition

Object JSON Example

Comments