AdsApp.​ExcludedVideoAudience

Represents a Google Ads excluded Audience in a Video Campaign.

Methods:

MemberTypeDescription
getAudienceId String Returns the ID of the excluded audience.
getAudienceType String Returns the type of the excluded audience.
getEntityType String Returns the type of this entity as a String, in this case, "ExcludedVideoAudience".
getId String Returns the ID of the excluded video audience.
getName String Returns the name of the excluded audience.
getResourceName String Returns the resource name of the excluded video audience.
getVideoAdGroup AdsApp.VideoAdGroup Returns the ad group to which this excluded video audience belongs, or null if the excluded video audience is excluded at the campaign level.
getVideoCampaign AdsApp.VideoCampaign Returns the campaign to which this excluded video audience belongs.
remove void Removes the excluded video audience.

getAudienceId()

Returns the ID of the excluded audience. User List IDs (List IDs) are available on the details page of a User List (found under the Audiences section of the Shared Library).

Return values:

TypeDescription
String The audience ID of the audience.

getAudienceType()

Returns the type of the excluded audience. Possible return values: USER_INTEREST, USER_LIST or CUSTOM_AFFINITY.

Return values:

TypeDescription
String The type of the excluded audience.

getEntityType()

Returns the type of this entity as a String, in this case, "ExcludedVideoAudience".

Return values:

TypeDescription
String Type of this entity: "ExcludedVideoAudience".

getId()

Returns the ID of the excluded video audience.

Return values:

TypeDescription
String The ID of the excluded video audience.

getName()

Returns the name of the excluded audience.

Return values:

TypeDescription
String The name of the excluded audience.

getResourceName()

Returns the resource name of the excluded video audience.

Return values:

TypeDescription
String The resource name of the excluded video audience.

getVideoAdGroup()

Returns the ad group to which this excluded video audience belongs, or null if the excluded video audience is excluded at the campaign level.

Return values:

TypeDescription
AdsApp.VideoAdGroup The ad group to which this excluded video audience belongs or null.

getVideoCampaign()

Returns the campaign to which this excluded video audience belongs.

Return values:

TypeDescription
AdsApp.VideoCampaign The campaign to which this excluded video audience belongs.

remove()

Removes the excluded video audience.

Returns nothing.