AdWordsApp.​VideoAdSelector

Fetches video ads. Supports filtering and sorting.

Typical usage:

 var videoAdSelector = "AdWordsApp"
     .videoAds()
     .withCondition("Impressions > 100")
     .forDateRange("LAST_MONTH")
     .orderBy("Clicks DESC");

 var videoAdIterator = videoAdSelector.get();
 while (videoAdIterator.hasNext()) {
   var videoAd = videoAdIterator.next();
 }
Related:

Methods:

MemberTypeDescription
forDateRange AdWordsApp.VideoAdSelector Sets a predefined date range onto the selector.
forDateRange AdWordsApp.VideoAdSelector Sets a custom date range onto the selector.
get AdWordsApp.VideoAdIterator Fetches the requested video ads and returns an iterator.
orderBy AdWordsApp.VideoAdSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.VideoAdSelector Adds the specified condition to the selector in order to narrow down the results.
withIds AdWordsApp.VideoAdSelector Restricts this selector to return only video ads with the given video ad IDs.
withLimit AdWordsApp.VideoAdSelector Specifies limit for the selector to use.

forDateRange(dateRange)

Sets a predefined date range onto the selector. 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:
 selector.forDateRange("THIS_WEEK_SUN_TODAY");

Date range must be specified if the selector has conditions or ordering for a stat field. Note that only the last date range specified for the selector will take effect.

Arguments:

NameTypeDescription
dateRange String Date range to set onto the selector.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector with date range applied.

forDateRange(dateFrom, dateTo)

Sets a custom date range onto the selector. 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") sets the range of one day.

Date range must be specified if the selector has conditions or ordering for a stat field. Note that only the last date range specified for the selector will take effect.

Arguments:

NameTypeDescription
dateFrom Object Start date of the date range.
dateTo Object End date of the date range.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector with date range applied.

get()

Fetches the requested video ads and returns an iterator.

Return values:

TypeDescription
AdWordsApp.VideoAdIterator Iterator of the requested video ads.

orderBy(orderBy)

Specifies the ordering of the resulting entities. orderBy parameter can have one of the following forms:
  • orderBy("Cost") - orders results by Cost, in ascending order.
  • orderBy("Ctr ASC") - orders results by Ctr, in ascending order.
  • orderBy("MaxCpc DESC") - orders results by MaxCpc, in descending order.

See VideoAdSelector.withCondition(String) for enumeration of columns that can be used.

orderBy() may be called multiple times. Consider the following example:

 selector = selector.forDateRange("LAST_14_DAYS")
     .orderBy("Clicks DESC")
     .orderBy("CTR ASC");

The results will be ordered by Clicks in descending order. Results with equal Clicks value will be ordered by Ctr in ascending order.

If a stats column is used in the ordering, date range must be specified via VideoAdSelector.forDateRange(String) or VideoAdSelector.forDateRange(Object, Object).

LabelNames column cannot be used for ordering.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector with ordering applied.

withCondition(condition)

Adds the specified condition to the selector in order to narrow down the results.

Multiple conditions may be added to the same selector:

 selector = selector.forDateRange("LAST_MONTH")
     .withCondition("Clicks > 5")
     .withCondition("Impressions > 100");
All specified conditions are AND-ed together. The above example will retrieve entities that observed over 100 impressions AND more than 5 clicks.

The parameter to be passed into this method must be of the following form:

 "COLUMN_NAME OPERATOR VALUE"

Operators

The operator that can be used in a condition depends on the type of column.
  • For Integer and Long columns (e.g. Impressions, Clicks):
    <  <=  >  >=  =  !=
  • For Double columns (e.g. Ctr, AveragePosition):
    <  >
  • For String columns (e.g. Name):
    =  !=  STARTS_WITH  STARTS_WITH_IGNORE_CASE  CONTAINS
     CONTAINS_IGNORE_CASE  DOES_NOT_CONTAIN  DOES_NOT_CONTAIN_IGNORE_CASE
  • For Enumeration columns (ones that can only take one value from a predefined list, such as Status):
    =  !=  IN []  NOT_IN []
  • For StringSet columns (e.g. LabelNames):
    CONTAINS_ALL []  CONTAINS_ANY []  CONTAINS_NONE []
Conditions using IN, NOT_IN, CONTAINS_ALL, CONTAINS_ANY and CONTAINS_NONE operators look as follows:
 withCondition("ColumnName IN [Value1, Value2]")
Operators are case-sensitive: starts_with won't work.

Columns

All column names are case-sensitive, and so are all values of enumerated columns (such as Status).

Column Type Example
Stats
AverageCpc Double withCondition("AverageCpc < 1.45")
AverageCpm Double withCondition("AverageCpm > 0.48")
AverageCpv Double withCondition("AverageCpv < 0.23")
AveragePageviews Double withCondition("AveragePageviews > 0")
AveragePosition Double withCondition("AveragePosition > 7.5")
BounceRate Double withCondition("BounceRate < 0.5")
Clicks Long withCondition("Clicks >= 21")
ConversionRate Double withCondition("ConversionRate > 0.1")
Conversions Long withCondition("Conversions <= 4")
Cost Double withCondition("Cost > 4.48"). The value is in the currency of the account.
Ctr Double withCondition("Ctr > 0.01"). Note that Ctr is returned in 0..1 range, so 5% Ctr is represented as 0.05.
Impressions Long withCondition("Impressions != 0")
Ad attributes
Status Enumeration: ENABLED, PAUSED, DISABLED withCondition("Status = PAUSED")
ApprovalStatus Enumeration: APPROVED, DISAPPROVED, FAMILY_SAFE, NON_FAMILY_SAFE, PORN, UNCHECKED withCondition("ApprovalStatus NOT_IN [DISAPPROVED, UNCHECKED]")
Headline String withCondition("Headline CONTAINS_IGNORE_CASE 'leather shoes'")
Description1 String withCondition("Description1 STARTS_WITH 'Leather'")
Description2 String withCondition("Description2 = 'Hurry to buy'")
DisplayUrl String withCondition("DisplayUrl STARTS_WITH 'www.example.com'")
DestinationUrl String withCondition("DestinationUrl STARTS_WITH 'http://www.example.com'")
CreativeFinalUrls String withCondition("CreativeFinalUrls CONTAINS 'http://www.example.com'")
Type Enumeration: TRUE_VIEW_IN_STREAM_VIDEO_AD, TRUE_VIEW_IN_DISPLAY_VIDEO_AD withCondition("Type = 'TRUE_VIEW_IN_STREAM_VIDEO_AD'")
AdGroupName String withCondition("AdGroupName CONTAINS_IGNORE_CASE 'shoes'")
AdGroupStatus Enumeration: ENABLED, PAUSED, REMOVED withCondition("AdGroupStatus = ENABLED"). Use to fetch ads from only ENABLED ad groups.
CampaignName String withCondition("CampaignName CONTAINS_IGNORE_CASE 'promotion'")
CampaignStatus Enumeration: ENABLED, PAUSED, REMOVED withCondition("CampaignStatus = ENABLED"). Use to fetch ads from only ENABLED campaigns.
LabelNames StringSet withCondition("LabelNames CONTAINS_ANY ['Xmas', 'New Year']"). The value is a list of exact, case-sensitive label names.

If a stats column is used in the condition, date range must be specified via VideoAdSelector.forDateRange(String) or VideoAdSelector.forDateRange(Object, Object).

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector with the condition applied.

withIds(ids)

Restricts this selector to return only video ads with the given video ad IDs.

All video ads are uniquely identified by the combination of their "ad group" ID and video ad ID. The IDs for this selector are thus represented as two-element arrays, with the first element being the "ad group" ID and the second being the video ad ID:

 var videoAdIds = [
   [12345, 987987],
   [23456, 876876],
   [34567, 765765],
 ];
 selector = selector.withIds(videoAdIds);

In cases where the ad group ID is already known, the IDs for this selector can then be just an array of ad IDs. Any provided ad group ID and ad ID combination will override the embedded ad group ID. For instance, the following will select the ads with the given ad IDs in the given ad group:

 var ids = [12345, 23456, 34567];
 var videoAds = videoAdGroup.videoAds().withIds(ids);

The resulting selector can be further refined by applying additional conditions to it. The ID-based condition will then be AND-ed together with all the other conditions, including any other ID-based conditions. So, for instance, the following selector:

 var ids1 = [
   [12345, 987987],
   [23456, 876876],
   [34567, 765765],
 ];
 var ids2 = [
   [34567, 765765],
   [45678, 654654],
   [56789, 543543],
 ];
 AdWordsApp.videoAds()
    .withIds(ids1)
    .withIds(ids2);
will only get the video ad with ID [34567, 765765], since it would be the only video ad that satisfies both ID conditions.

Arguments:

NameTypeDescription
ids long[][] Array of video ad IDs.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector restricted to the given IDs.

withLimit(limit)

Specifies limit for the selector to use. For instance, withLimit(50) returns only the first 50 entities.

Arguments:

NameTypeDescription
limit int How many entities to return.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector with limit applied.

发送以下问题的反馈:

此网页
AdWords Scripts
AdWords Scripts
需要帮助?请访问我们的支持页面