AdWordsApp.​VideoAd

Represents an AdWords video ad.

Methods:

MemberTypeDescription
applyLabel void Applies a label to the video ad.
enable void Enables the video ad.
getApprovalStatus String Returns the approval status of the ad.
getChannelName String Returns the channel ID of the ad's video.
getDescription1 String Returns the first line of the ad description.
getDescription2 String Returns the second line of the ad description.
getDestinationPage String Returns the type of destination page of the ad.
getDisapprovalReasons String[] Returns the array of disapproval reasons.
getDisplayUrl String Returns the display URL of the ad.
getEntityType String Returns the type of this entity as a String, in this case, "VideoAd".
getHeadline String Returns the headline of the ad.
getId long Returns the ID of the ad.
getName String Returns the ad name.
getPolicyApprovalStatus String Returns the policy approval status of the ad.
getPolicyTopics AdWordsApp.PolicyTopic[] Returns the list of policy topics associated with the ad.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getType String Returns the type of the ad.
getVideoAdGroup AdWordsApp.VideoAdGroup Returns the video ad group to which this video ad belongs.
getVideoCampaign AdWordsApp.VideoCampaign Returns the video campaign to which this video ad belongs.
getVideoId String Returns the video ID of the ad.
isEnabled boolean Returns true if the video ad is enabled.
isPaused boolean Returns true if the video ad is paused.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the video ad.
pause void Pauses the video ad.
remove void Removes the video ad.
removeLabel void Removes a label from the video ad.
urls AdWordsApp.VideoAdUrls Provides access to this ad's URL fields.

applyLabel(name)

Applies a label to the video ad. name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.

Note that the video ad cannot not have more than 50 labels.

Returns nothing.

Arguments:

NameTypeDescription
name String Name of the label to apply.

enable()

Enables the video ad.

Returns nothing.

getApprovalStatus()

Returns the approval status of the ad. Possible values: APPROVED, DISAPPROVED, FAMILY_SAFE, NON_FAMILY_SAFE, PORN, UNCHECKED.

Return values:

TypeDescription
String The approval status of the ad.

getChannelName()

Returns the channel ID of the ad's video.

Return values:

TypeDescription
String The channel ID of the ad's video.

getDescription1()

Returns the first line of the ad description. May return null for some types of ads.

Return values:

TypeDescription
String The first line of the ad description.

getDescription2()

Returns the second line of the ad description. May return null for some types of ads.

Return values:

TypeDescription
String The second line of the ad description.

getDestinationPage()

Returns the type of destination page of the ad. Possible values: WATCH_PAGE, CHANNEL_PAGE.

Return values:

TypeDescription
String The video ID of the ad.

getDisapprovalReasons()

Returns the array of disapproval reasons.

The returned array will contain entries like 'Editorial Standards-Spacing', 'Inaccurate Display URL', etc. An empty array will be returned if the ad has not been disapproved.

Return values:

TypeDescription
String[] The disapproval reasons of the ad.

getDisplayUrl()

Returns the display URL of the ad. May return null for some types of ads.

Return values:

TypeDescription
String The display URL of the ad.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "VideoAd".

getHeadline()

Returns the headline of the ad. May return null for some types of ads.

Return values:

TypeDescription
String The headline of the ad.

getId()

Returns the ID of the ad.

Ad IDs may be shared across ad groups. In order to uniquely identify one ad, one must specify both its ad group ID and its creative ID.

Return values:

TypeDescription
long The ID of the ad.

getName()

Returns the ad name.

Return values:

TypeDescription
String The ad name.

getPolicyApprovalStatus()

Returns the policy approval status of the ad. For a full list of policy approval statuses, please see the AdWords API documentation on policy approval statuses.

Return values:

TypeDescription
String The policy approval status of the ad.

getPolicyTopics()

Returns the list of policy topics associated with the ad. Policy topics contain information about policy decisions taken regarding the ad.

Return values:

TypeDescription
AdWordsApp.PolicyTopic[] The policy topics of the ad.

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 = videoAd.getStatsFor("THIS_MONTH");

Arguments:

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

Return values:

TypeDescription
AdWordsApp.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
AdWordsApp.Stats The stats for the specified date range.

getType()

Returns the type of the ad. Possible values: TRUE_VIEW_IN_STREAM_VIDEO_AD, TRUE_VIEW_IN_DISPLAY_VIDEO_AD, BUMPER_VIDEO_AD.

Return values:

TypeDescription
String The type of the ad.

getVideoAdGroup()

Returns the video ad group to which this video ad belongs.

Return values:

TypeDescription
AdWordsApp.VideoAdGroup The video ad group to which this video ad belongs.

getVideoCampaign()

Returns the video campaign to which this video ad belongs.

Return values:

TypeDescription
AdWordsApp.VideoCampaign The video campaign to which this video ad belongs.

getVideoId()

Returns the video ID of the ad.

Return values:

TypeDescription
String The video ID of the ad.

isEnabled()

Returns true if the video ad is enabled.

Return values:

TypeDescription
boolean true if the video ad is enabled.

isPaused()

Returns true if the video ad is paused.

Return values:

TypeDescription
boolean true if the video ad is paused.

labels()

Creates a selector of all labels applied to the video ad.

Return values:

TypeDescription
AdWordsApp.LabelSelector Selector of all labels applied to the video ad.

pause()

Pauses the video ad.

Returns nothing.

remove()

Removes the video ad.

Returns nothing.

removeLabel(name)

Removes a label from the video ad. name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.

Returns nothing.

Arguments:

NameTypeDescription
name String Name of the label.

urls()

Provides access to this ad's URL fields. See Using Upgraded URLs for more information.

Return values:

TypeDescription
AdWordsApp.VideoAdUrls Access to this video ad's URL fields.

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。