AdsApp.​VideoAudience

Represents a Google Ads Audience in a Video Campaign.

Methods:

MemberTypeDescription
bidding AdsApp.VideoAudienceBidding Provides access to bidding fields of this video audience.
getAudienceId Long Returns the audience ID of the audience.
getAudienceType String Returns the type of the audience.
getEntityType String Returns the type of this entity as a String, in this case, "VideoAudience".
getId long Returns the ID of the video audience.
getName String Returns the name of the audience.
getStatsFor AdsApp.Stats Returns stats for the specified date range.
getStatsFor AdsApp.Stats Returns stats for the specified custom date range.
getVideoAdGroup AdsApp.VideoAdGroup Returns the ad group to which this video audience belongs.
getVideoCampaign AdsApp.VideoCampaign Returns the campaign to which this video audience belongs.
isEnabled boolean Returns true if the video audience is enabled.
isPaused boolean Returns true if the video audience is paused.
remove void Removes the video audience.

bidding()

Provides access to bidding fields of this video audience.

Return values:

TypeDescription
AdsApp.VideoAudienceBidding Access to bidding fields of this video audience.

getAudienceId()

Returns the audience ID of the 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
Long The audience ID of the audience.

getAudienceType()

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

Return values:

TypeDescription
String The type of the audience.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "VideoAudience".

getId()

Returns the ID of the video audience.

Return values:

TypeDescription
long The ID of the video audience.

getName()

Returns the name of the audience.

Return values:

TypeDescription
String The name of the audience.

getStatsFor(dateRange)

Returns stats for the specified date range. Supported values:

TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME.

Example:
 var stats = videoAudience.getStatsFor("THIS_MONTH");

Arguments:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
AdsApp.Stats The stats for the specified date range.

getStatsFor(dateFrom, dateTo)

Returns stats for the specified custom date range. Both parameters can be either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD form. For instance, March 24th, 2013 is represented as either {year: 2013, month: 3, day: 24} or "20130324". The date range is inclusive on both ends, so forDateRange("20130324", "20130324") defines a range of a single day.

Arguments:

NameTypeDescription
dateFrom Object Start date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.
dateTo Object End date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.

Return values:

TypeDescription
AdsApp.Stats The stats for the specified date range.

getVideoAdGroup()

Returns the ad group to which this video audience belongs.

Return values:

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

getVideoCampaign()

Returns the campaign to which this video audience belongs.

Return values:

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

isEnabled()

Returns true if the video audience is enabled.

Return values:

TypeDescription
boolean true if the video audience is enabled.

isPaused()

Returns true if the video audience is paused.

Return values:

TypeDescription
boolean true if the video audience is paused.

remove()

Removes the video audience.

Returns nothing.

Send feedback about...

Google Ads scripts
Google Ads scripts
Need help? Visit our support page.