Edit

Share via

AssetGroup

  • Article
  • 01/10/2025

Contains the methods used to manage an asset group.

Methods

Method Name Return Type Description
enable void Enabless this asset group.
getEntityType string Gets this entity's type.
getId string Gets the ID that uniquely identifies this asset group.
getName string Gets this asset group's name.
getPerformanceMaxCampaign Campaign Gets this asset group's campaign.
isEnabled Boolean Gets a Boolean value that indicates whether this asset group is enabled.
isPaused Boolean Gets a Boolean value that indicates whether this asset group is paused.
isRemoved Boolean Gets a Boolean value that indicates whether this asset group is removed.
pause void Pauses this asset group.
remove void Removes this asset group.
setName(String name) void Sets the asset group's name.
urls AssetGroupUrls Contains the methods used to manage this asset group's final URLs, tracking template, and custom parameters.

enable

Enables this asset group.

Returns

Type Description
void Returns nothing.

getEntityType

Gets this entity's type.

Returns

Type Description
string This entity's type, which is AssetGroup.

getId

Gets the ID that uniquely identifies this asset group.

Returns

Type Description
string The ID that uniquely identifies this asset group.

getName

Gets this asset group's name.

Returns

Type Description
string The name of this asset group.

getPerformanceMaxCampaign

Gets the campaign that this asset group belongs to.

Returns

Type Description
Campaign The campaign that this asset group belongs to.

isEnabled

Gets a Boolean value that indicates whether this asset group is enabled.

Returns:

Type Description
Boolean Is true if this asset group is enabled; otherwise, false.

isPaused

Gets a Boolean value that indicates whether this asset group is paused.

Returns:

Type Description
Boolean Is true if this asset group is paused; otherwise, false.

isRemoved

Gets a Boolean value that indicates whether this asset group is removed (deleted).

Returns

Type Description
Boolean Is true if this asset group is removed; otherwise, false.

pause

Pauses this asset group.

Returns

Type Description
void Returns nothing.

remove

Removes this asset group.

Returns

Type Description
void Returns nothing.

setName(string name)

Sets this asset group's name.

Arguments

Name Type Description
name string The name of this asset group. The name may contain a maximum of 256 characters and must be unique amongst all asset groups in the campaign.

Returns

Type Description
void Returns nothing.

urls

Contains the methods used to manage this asset group's final URLs, tracking template, and custom parameters.

Returns

Type Description
AssetGroupUrls The object used to manage this asset group's final URLs, tracking template, and custom parameters.

See also