AdWordsApp.​VideoCampaign

Represents an AdWords video campaign.

Methods:

MemberTypeDescription
addAdSchedule AdWordsApp.AdScheduleOperation Creates an ad schedule criterion from an ad schedule object.
addAdSchedule AdWordsApp.AdScheduleOperation Creates an ad schedule criterion.
addExcludedPlacementList void Adds a excluded placement list to this campaign.
addLanguage AdWordsApp.LanguageOperation Creates a language target in this campaign from a plain JavaScript object.
addLanguage AdWordsApp.LanguageOperation Creates a language target in this campaign from an existing language object.
addLanguage AdWordsApp.LanguageOperation Creates a language target in this campaign from language ID.
addLocation AdWordsApp.TargetedLocationOperation Creates a location target in this campaign from a location ID.
addLocation AdWordsApp.TargetedLocationOperation Creates a location target in this campaign from a location.
addLocation AdWordsApp.TargetedLocationOperation Creates a location target in this campaign from a location JSON.
addLocation AdWordsApp.TargetedLocationOperation Creates a location target in this campaign from a location ID and bid modifier.
addNegativeKeywordList void Adds a negative keyword list to this campaign.
addProximity AdWordsApp.TargetedProximityOperation Creates a proximity target in this campaign from a proximity object.
addProximity AdWordsApp.TargetedProximityOperation Creates a proximity target in this campaign.
applyLabel void Applies a label to the video campaign.
bidding AdWordsApp.VideoCampaignBidding Provides access to this campaign's bidding fields.
enable void Enables the video campaign.
excludeContentLabel AdWordsApp.ExcludedContentLabelOperation Creates a content label exclusion in this campaign from content label type.
excludeContentLabel AdWordsApp.ExcludedContentLabelOperation Creates a content label exclusion in this campaign from an existing content label object.
excludeContentLabel AdWordsApp.ExcludedContentLabelOperation Creates a content label exclusion in this campaign.
excludeLocation AdWordsApp.ExcludedLocationOperation Creates a location exclusion in this campaign.
excludeLocation AdWordsApp.ExcludedLocationOperation Creates a location exclusion in this campaign.
excludeLocation AdWordsApp.ExcludedLocationOperation Creates a location exclusion in this campaign.
excludedPlacementLists AdWordsApp.ExcludedPlacementListSelector Returns a selector of excluded placement lists associated with this campaign.
getAdRotationType String Returns the ad rotation type of the campaign.
getBiddingStrategyType String Returns the bidding strategy type of the campaign.
getBudget AdWordsApp.Budget Returns the budget of the campaign.
getEndDate AdWordsApp.AdWordsDate Returns the campaign's end date, or null if there is no end date.
getEntityType String Returns the type of this entity as a String, in this case, "VideoCampaign".
getFrequencyCaps AdWordsApp.FrequencyCaps Returns frequency caps set for this campaign.
getId long Returns the ID of the video campaign.
getName String Returns the name of the campaign.
getNetworks String[] Returns the advertising network setting of the campaign.
getStartDate AdWordsApp.AdWordsDate Returns the campaign's start date.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
isEnabled boolean Returns true if the video campaign is enabled.
isPaused boolean Returns true if the video campaign is paused.
isRemoved boolean Returns true if the campaign is removed.
labels AdWordsApp.LabelSelector Creates a selector of all labels applied to the video campaign.
negativeKeywordLists AdWordsApp.NegativeKeywordListSelector Returns a selector of negative keyword lists associated with this campaign.
newVideoAdGroupBuilder AdWordsApp.VideoAdGroupBuilder Returns a new video ad group builder for this campaign.
pause void Pauses the video campaign.
removeExcludedPlacementList void Removes a excluded placement list from this campaign.
removeLabel void Removes a label from the video campaign.
removeNegativeKeywordList void Removes a negative keyword list from this campaign.
setAdRotationType void Sets the ad rotation type of the campaign.
setEndDate void Sets the campaign's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
setName void Sets the name of the campaign.
setNetworks void Sets the network setting of the campaign.
setStartDate void Sets the campaign's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.
targeting AdWordsApp.VideoCampaignTargeting Provides access to campaign-level targeting criteria: device, ad scheduling, location, language, and content label.
videoAdGroups AdWordsApp.VideoAdGroupSelector Returns the selector of all ad groups in the video campaign.
videoAds AdWordsApp.VideoAdSelector Returns the selector of all ads in the video campaign.
videoTargeting AdWordsApp.CampaignVideoTargeting Provides access to this campaign's video targeting criteria.

addAdSchedule(adSchedule)

Creates an ad schedule criterion from an ad schedule object. Once created, the campaign will start showing ads during the specified time.

When called with one argument, addAdSchedule supports two kinds of input:

  • Existing AdSchedule objects, perhaps from another campaign:
     var campaigns = AdWordsApp.videoCampaigns().get();
     var campaign1 = campaigns.next();
     var campaign2 = campaigns.next();
     var schedule = campaign1.targeting().adSchedules().get().next();
     campaign2.addAdSchedule(schedule);
  • Plain JavaScript objects describing an ad schedule. For instance, this will create an ad schedule covering Saturday mornings:
     var campaign = AdWordsApp.videoCampaigns().get().next();
     campaign.addAdSchedule({
       dayOfWeek: "SATURDAY",
       startHour: 7,
       startMinute: 0,
       endHour: 11,
       endMinute: 0,
       bidModifier: 1.1
     });
    This will look at the following properties of the given object:
    • dayOfWeek: Required. Must be one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", or "SUNDAY".
    • startHour and startMinute: Required. The starting time of this segment of the ad schedule. startHour must be an integer between 0 and 23, and startMinute must be either 0, 15, 30, or 45. For instance, a startHour of 18 and a startMinute of 30 would result in an ad schedule starting at 6:30PM. Acceptable starting times range from 00:00 to 23:45.
    • endHour and endMinute: Required. The ending time of this segment of the ad schedule. endHour must be an integer between 0 and 24, and endMinute must be either 0, 15, 30, or 45. For instance, a endHour of 18 and a endMinute of 30 would result in an ad schedule ending at 6:30PM. Acceptable ending times range from 00:15 to 24:00.
    • bidModifier: Optional. The bid modifier for this segment of the ad schedule.

One thing to keep in mind is that, by default, campaigns have no ad schedule criteria and hence serve ads at all times. Adding the first ad schedule to a campaign will cause ads to be shown during that time only.

There is a limit of 6 ad schedules for each day of the week — for instance, splitting up each day into 6 4-hour-long periods is supported, but splitting up each day into 24 1-hour-long periods is not.

Arguments:

NameTypeDescription
adSchedule Object The schedule to create.

Return values:

TypeDescription
AdWordsApp.AdScheduleOperation The associated ad schedule operation.

addAdSchedule(dayOfWeek, startHour, startMinute, endHour, endMinute, bidModifier)

Creates an ad schedule criterion. Once created, the campaign will start showing ads during the specified time.

For instance, this will create an ad schedule covering Saturday mornings:

 var campaign = AdWordsApp.videoCampaigns().get().next();
 campaign.addAdSchedule("SATURDAY", 7, 0, 11, 0);

This will create the same schedule, but with a bid modifier of 1.1:

 var campaign = AdWordsApp.videoCampaigns().get().next();
 campaign.addAdSchedule("SATURDAY", 7, 0, 11, 0, 1.1);

One thing to keep in mind is that, by default, campaigns have no ad schedule criteria and hence serve ads at all times. Adding the first ad schedule to a campaign will cause ads to be shown during that time only.

There is a limit of 6 ad schedules for each day of the week — for instance, splitting up each day into 6 4-hour-long periods is supported, but splitting up each day into 24 1-hour-long periods is not.

Arguments:

NameTypeDescription
dayOfWeek String The day of week. Must be one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", or "SUNDAY".
startHour int The start hour. Must be an integer between 0 and 23. Acceptable starting times range from 00:00 to 23:45.
startMinute int The start minute. Must be either 0, 15, 30, or 45. Acceptable starting times range from 00:00 to 23:45.
endHour int The end hour. Must be an integer between 0 and 24. Acceptable ending times range from 00:15 to 24:00.
endMinute int The end minute. Must be either 0, 15, 30, or 45. Acceptable ending times range from 00:15 to 24:00.
bidModifier double Optional. The bid modifier to use for the newly created ad schedule.

Return values:

TypeDescription
AdWordsApp.AdScheduleOperation The associated ad schedule operation.

addExcludedPlacementList(excludedPlacementList)

Adds a excluded placement list to this campaign.

Returns nothing.

Arguments:

NameTypeDescription
excludedPlacementList AdWordsApp.ExcludedPlacementList The excluded placement list to be added to this campaign.

addLanguage(languageObject)

Creates a language target in this campaign from a plain JavaScript object. Use a plain JavaScript object to describe a language. For instance, this would create a language target for German:
 var campaign = AdWordsApp.videoCampaigns().get().next();
 campaign.addLanguage({
   id: 1001,
 });
This will look at the following properties of the given object:

Arguments:

NameTypeDescription
languageObject Object Plain JavaScript object describing the language to target.

Return values:

TypeDescription
AdWordsApp.LanguageOperation The associated language operation.

addLanguage(language)

Creates a language target in this campaign from an existing language object. The existing Language objects can be from another campaign:
 var campaigns = AdWordsApp.videoCampaigns().get();
 var campaign1 = campaigns.next();
 var campaign2 = campaigns.next();
 var language = campaign1.targeting().languages().get().next();
 campaign2.addLanguage(language);

Arguments:

NameTypeDescription
language AdWordsApp.Language The language to target for this campaign.

Return values:

TypeDescription
AdWordsApp.LanguageOperation The associated language operation.

addLanguage(languageId)

Creates a language target in this campaign from language ID. For a list of languages and their corresponding codes, please see the AdWords API documentation on languages. For instance, this will create a language target for German:
 var campaign = AdWordsApp.videoCampaigns().get().next();
 campaign.addLanguage(1001);

Arguments:

NameTypeDescription
languageId int The language ID for the new language.

Return values:

TypeDescription
AdWordsApp.LanguageOperation The associated language operation.

addLocation(locationId)

Creates a location target in this campaign from a location ID. Once created, the campaign will start showing ads to the location with the given location ID. You must specify a location ID. For a list of locations and their corresponding IDs, please see the AdWords API documentation on geotargeting.

Arguments:

NameTypeDescription
locationId int The location ID to target.

Return values:

TypeDescription
AdWordsApp.TargetedLocationOperation The associated targeted location operation.

addLocation(location)

Creates a location target in this campaign from a location. Once created, the campaign will start showing ads to the location with the given location ID. You must specify an existing TargetedLocation object, perhaps from another campaign:
 var campaigns = AdWordsApp.campaigns().get();
 var campaign1 = campaigns.next();
 var campaign2 = campaigns.next();
 var location = campaign1.targeting().targetedLocations().get().next();
 campaign2.addLocation(location);

Arguments:

NameTypeDescription
location AdWordsApp.TargetedLocation The location to target.

Return values:

TypeDescription
AdWordsApp.TargetedLocationOperation The associated targeted location operation.

addLocation(location)

Creates a location target in this campaign from a location JSON. Once created, the campaign will start showing ads to the location with the given location ID. You must specify a plain JavaScript object describing a location. For instance, this would create a location target for Tennessee:
 var campaign = AdWordsApp.campaigns().get().next();
 campaign.addLocation({
   id: 21175,
   bidModifier: 1.2,
 });
This will look at the following properties of the given object:
  • id: Required. The ID of the location to target. For a list of locations and their corresponding IDs, please see the AdWords API documentation on geotargeting.
  • bidModifier: Optional. The bid modifier for this location.

Arguments:

NameTypeDescription
location Object JSON representation of the location to target.

Return values:

TypeDescription
AdWordsApp.TargetedLocationOperation The associated targeted location operation.

addLocation(locationId, bidModifier)

Creates a location target in this campaign from a location ID and bid modifier. Once created, the campaign will start showing ads to the location with the given location ID.

For instance, this will create a location target for Tennessee with a bid modifier of 1.15:

 var campaign = AdWordsApp.campaigns().get().next();
 campaign.addLocation(21175, 1.15);

Arguments:

NameTypeDescription
locationId int The ID of the location to target. For a list of locations and their corresponding IDs, please see the AdWords API documentation on geotargeting.
bidModifier double The desired bid modifier for the new location target.

Return values:

TypeDescription
AdWordsApp.TargetedLocationOperation The associated targeted location operation.

addNegativeKeywordList(negativeKeywordList)

Adds a negative keyword list to this campaign.

Returns nothing.

Arguments:

NameTypeDescription
negativeKeywordList AdWordsApp.NegativeKeywordList The negative keyword list to be added to this campaign.

addProximity(proximity)

Creates a proximity target in this campaign from a proximity object. Once created, the campaign will start showing ads to geographical points within the specified radius of the specified central point.

When called with one argument, addProximity supports two kinds of input:

  • Existing TargetedProximity objects, perhaps from another campaign:
     var campaigns = AdWordsApp.videoCampaigns().get();
     var campaign1 = campaigns.next();
     var campaign2 = campaigns.next();
     var proximity = campaign1.targeting().targetedProximities().get().next();
     campaign2.addProximity(proximity);
  • Plain JavaScript objects describing a proximity. For instance, this would create a proximity targeting 20km around Google headquarters:
     var campaign = AdWordsApp.videoCampaigns().get().next();
     campaign.addProximity({
       latitude: 37.423021,
       longitude: -122.083739,
       radius: 20,
       radiusUnits: "KILOMETERS",
       bidModifier: 0.75,
       address: {
         streetAddress: "1600 Amphitheatre Parkway",
         cityName: "Mountain View",
         provinceName: "California",
         provinceCode: "CA",
         postalCode: "94043",
         countryCode: "US"
       }
     });
    This will look at the following properties of the given object:
    • latitude and longitude: Required. The central geographic point of the proximity to target.
    • radius and radiusUnits: Required. The radius around the central point to target. radiusUnits must be either "MILES" or "KILOMETERS".
    • bidModifier: Optional. The bid modifier for this proximity.
    • address: Optional. The address associated with the central geographical point.

      If present, this is expected to be an object, which contains any of streetAddress, streetAddress2, cityName, provinceName, provinceCode, postalCode, and countryCode as properties with string values. This corresponds to the Address objects returned by existing proximity targets.

      There is no validation to check that the address actually belongs to the given latitude and longitude. It has no functionality except to change what shows up in the Campaign Management interface.

Arguments:

NameTypeDescription
proximity Object The proximity to target.

Return values:

TypeDescription
AdWordsApp.TargetedProximityOperation The associated targeted proximity operation.

addProximity(latitude, longitude, radius, radiusUnits, optArgs)

Creates a proximity target in this campaign. Once created, the campaign will start showing ads to geographical points within the specified radius of the specified central point.

For instance, this will create a proximity targeting 20km around Google headquarters:

 var campaign = AdWordsApp.videoCampaigns().get().next();
 campaign.addProximity(37.423021, -122.083739, 20, "KILOMETERS");
Similarly, to create the same proximity target with a bid modifier and address:
 campaign.addProximity(37.423021, -122.083739, 20, "KILOMETERS", {
   bidModifier: 1.15,
   address: {
     streetAddress: "1600 Amphitheatre Parkway",
     cityName: "Mountain View",
     provinceName: "California",
     provinceCode: "CA",
     postalCode: "94043",
     countryCode: "US"
   }
 });

Arguments:

NameTypeDescription
latitude double The latitude of the central point.
longitude double The longitude of the central point.
radius double The radius of the proximity target.
radiusUnits String The units of the radius, either "MILES" or "KILOMETERS".
optArgs Object Optional. Either a number, which will be interpreted as the desired bid modifier for the proximity, or an object containing extra additional arguments.

For TargetedProximities, there are two supported optional arguments:

  • bidModifier: The bid modifier for this proximity.
  • address: The address associated with the central geographical point.

    If present, this is expected to be an object, which contains any of streetAddress, streetAddress2, cityName, provinceName, provinceCode, postalCode, and countryCode as properties with string values. This corresponds to the Address objects returned by existing proximity targets.

    There is no validation to check that the address actually belongs to the given latitude and longitude. It has no functionality except to change what shows up in the Campaign Management interface.

Return values:

TypeDescription
AdWordsApp.TargetedProximityOperation The associated targeted proximity operation.

applyLabel(name)

Applies a label to the video campaign. 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 campaign cannot not have more than 50 labels.

Returns nothing.

Arguments:

NameTypeDescription
name String Name of the label to apply.

bidding()

Provides access to this campaign's bidding fields.

Return values:

TypeDescription
AdWordsApp.VideoCampaignBidding Access to this campaign's bidding fields.

enable()

Enables the video campaign.

Returns nothing.

excludeContentLabel(contentLabelType)

Creates a content label exclusion in this campaign from content label type. Acceptable values for content label types:

VIDEO_RATING_DV_G, VIDEO_RATING_DV_PG, VIDEO_RATING_DV_T, VIDEO_RATING_DV_MA, VIDEO_NOT_YET_RATED, EMBEDDED_VIDEO, LIVE_STREAMING_VIDEO, GAMES, VIDEO_SENS_TRAGEDY, VIDEO_SENS_SOCIAL_ISSUES

 var campaign = AdWordsApp.videoCampaigns().get().next();
 campaign.excludeContentLabel('VIDEO_RATING_DV_G');

Arguments:

NameTypeDescription
contentLabelType String The type of content label to exclude.

Return values:

TypeDescription
AdWordsApp.ExcludedContentLabelOperation The associated content label operation.

excludeContentLabel(contentLabelType)

Creates a content label exclusion in this campaign from an existing content label object. The existing ExcludedContentLabel objects can be from another campaign:
 var campaigns = AdWordsApp.videoCampaigns().get();
 var campaign1 = campaigns.next();
 var campaign2 = campaigns.next();
 var contentLabel = campaign1.targeting().excludedContentLabels().get().next();

Arguments:

NameTypeDescription
contentLabelType AdWordsApp.ExcludedContentLabel The content label to exclude.

Return values:

TypeDescription
AdWordsApp.ExcludedContentLabelOperation The associated content label operation.

excludeContentLabel(contentLabelType)

Creates a content label exclusion in this campaign. Use a plain JavaScript objects to describe a content label. For instance, this would create a content label exclusion for videos with rating G:
 var campaign = AdWordsApp.videoCampaigns().get().next();
 campaign.excludeLocation({
   contentLabelType: 'VIDEO_RATING_DV_G'
 });

Arguments:

NameTypeDescription
contentLabelType Object Plain JavaScript object describing the content label to exclude.

Return values:

TypeDescription
AdWordsApp.ExcludedContentLabelOperation The associated content label operation.

excludeLocation(location)

Creates a location exclusion in this campaign. Once created, the campaign will not show ads to the location with the given location ID. You must specify an existing ExcludedLocation object, perhaps from another campaign:
 var campaigns = AdWordsApp.campaigns().get();
 var campaign1 = campaigns.next();
 var campaign2 = campaigns.next();
 var location = campaign1.targeting().excludedLocations().get().next();
 campaign2.excludeLocation(location);

Arguments:

NameTypeDescription
location AdWordsApp.ExcludedLocation The location to exclude.

Return values:

TypeDescription
AdWordsApp.ExcludedLocationOperation The associated excluded location operation.

excludeLocation(locationId)

Creates a location exclusion in this campaign. Once created, the campaign will not show ads to the location with the given location ID. You must specify a location ID. For a list of locations and their corresponding IDs, please see the AdWords API documentation on geotargeting:
 var campaign = AdWordsApp.campaigns().get().next();
 campaign.excludeLocation(21175);

Arguments:

NameTypeDescription
locationId int The ID of the location to exclude.

Return values:

TypeDescription
AdWordsApp.ExcludedLocationOperation The associated excluded location operation.

excludeLocation(location)

Creates a location exclusion in this campaign. Once created, the campaign will not show ads to the location with the given location ID. You must specify a plain JavaScript object describing a location. For instance, this would create a location exclusion for Tennessee:
 var campaign = AdWordsApp.campaigns().get().next();
 campaign.excludeLocation({
   id: 21175
 });
The only field of the object which will be looked at is id, which represents the location ID.

Arguments:

NameTypeDescription
location Object JSON representation of the location to exclude.

Return values:

TypeDescription
AdWordsApp.ExcludedLocationOperation The associated excluded location operation.

excludedPlacementLists()

Returns a selector of excluded placement lists associated with this campaign.

Return values:

TypeDescription
AdWordsApp.ExcludedPlacementListSelector A selector of excluded placement lists associated with this campaign.

getAdRotationType()

Returns the ad rotation type of the campaign. Possible return values:

OPTIMIZE, CONVERSION_OPTIMIZE, ROTATE

Return values:

TypeDescription
String Ad rotation type of the campaign.

getBiddingStrategyType()

Returns the bidding strategy type of the campaign. Possible return values:

MANUAL_CPV

Return values:

TypeDescription
String Type of campaign's bidding strategy.

getBudget()

Returns the budget of the campaign. In order to change the campaign's budget, use Budget.setAmount(double).

Return values:

TypeDescription
AdWordsApp.Budget Budget of the campaign.

getEndDate()

Returns the campaign's end date, or null if there is no end date. For instance, if a campaign ended on May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3}.

Return values:

TypeDescription
AdWordsApp.AdWordsDate The campaign's end date, or null if there's no end date.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "VideoCampaign".

getFrequencyCaps()

Returns frequency caps set for this campaign. For details on frequency cap, please see Frequency capping.

Return values:

TypeDescription
AdWordsApp.FrequencyCaps A FrequencyCaps object to access frequency caps.

getId()

Returns the ID of the video campaign.

Return values:

TypeDescription
long The ID of the video campaign.

getName()

Returns the name of the campaign.

Return values:

TypeDescription
String Name of the campaign.

getNetworks()

Returns the advertising network setting of the campaign. The setting is a set of enable networks. Possible network types:

YOUTUBE_SEARCH, YOUTUBE_VIDEO, VIDEO_PARTNER_ON_THE_DISPLAY_NETWORK

Return values:

TypeDescription
String[] An array of enabled network types.

getStartDate()

Returns the campaign's start date. For instance, if a campaign started on May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3}.

Return values:

TypeDescription
AdWordsApp.AdWordsDate The campaign's start date.

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 = videoCampaign.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.

isEnabled()

Returns true if the video campaign is enabled.

Return values:

TypeDescription
boolean true if the video campaign is enabled.

isPaused()

Returns true if the video campaign is paused.

Return values:

TypeDescription
boolean true if the video campaign is paused.

isRemoved()

Returns true if the campaign is removed.

Return values:

TypeDescription
boolean true if the campaign is removed.

labels()

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

Return values:

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

negativeKeywordLists()

Returns a selector of negative keyword lists associated with this campaign.

Return values:

TypeDescription
AdWordsApp.NegativeKeywordListSelector A selector of negative keyword lists associated with this campaign.

newVideoAdGroupBuilder()

Returns a new video ad group builder for this campaign. Once builder.create() is called, the ad group will be created in this campaign.

Return values:

TypeDescription
AdWordsApp.VideoAdGroupBuilder Video ad group builder.

pause()

Pauses the video campaign.

Returns nothing.

removeExcludedPlacementList(excludedPlacementList)

Removes a excluded placement list from this campaign.

Returns nothing.

Arguments:

NameTypeDescription
excludedPlacementList AdWordsApp.ExcludedPlacementList The excluded placement list to be removed from this campaign.

removeLabel(name)

Removes a label from the video campaign. 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.

removeNegativeKeywordList(negativeKeywordList)

Removes a negative keyword list from this campaign.

Returns nothing.

Arguments:

NameTypeDescription
negativeKeywordList AdWordsApp.NegativeKeywordList The negative keyword list to be removed from this campaign.

setAdRotationType(adRotationType)

Sets the ad rotation type of the campaign. For instance, campaign.setAdRotationType("OPTIMIZE"); instructs AdWords to optimize ad serving based on the campaign's VTR. For more information, see Choose an ad delivery method help article.

Returns nothing.

Arguments:

NameTypeDescription
adRotationType String The new ad rotation type of the campaign. Must be one of "OPTIMIZE", "CONVERSION_OPTIMIZE", or "ROTATE".

setEndDate(date)

Sets the campaign's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. For instance, campaign.setEndDate("20130503"); is equivalent to campaign.setEndDate({year: 2013, month: 5, day: 3});. The change will fail and report an error if:
  • the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
  • it's a date in the past, or
  • it's a date after the latest allowed end date of December 30, 2037.

Returns nothing.

Arguments:

NameTypeDescription
date Object The new campaign end date.

setName(name)

Sets the name of the campaign.

Returns nothing.

Arguments:

NameTypeDescription
name String The new name for the campaign.

setNetworks(networks)

Sets the network setting of the campaign. The original setting will be overridden by the new setting.

Returns nothing.

Arguments:

NameTypeDescription
networks String[] An array of enabled network types. Possible network types:

YOUTUBE_SEARCH, YOUTUBE_VIDEO, VIDEO_PARTNER_ON_THE_DISPLAY_NETWORK

setStartDate(date)

Sets the campaign's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. For instance, campaign.setStartDate("20130503"); is equivalent to campaign.setStartDate({year: 2013, month: 5, day: 3});. The change will fail and report an error if:
  • the campaign has already started,
  • the given date is invalid (e.g., {year: 2013, month: 5, day: 55}),
  • the given date is after the campaign's end date,
  • it's a date in the past, or
  • it's a date after the latest allowed end date of December 30, 2037.

Returns nothing.

Arguments:

NameTypeDescription
date Object The new campaign end date.

targeting()

Provides access to campaign-level targeting criteria: device, ad scheduling, location, language, and content label.

Return values:

TypeDescription
AdWordsApp.VideoCampaignTargeting Access to certain kinds of targeting criteria in this campaign.

videoAdGroups()

Returns the selector of all ad groups in the video campaign.

Return values:

TypeDescription
AdWordsApp.VideoAdGroupSelector The selector of all ad groups in the video campaign.

videoAds()

Returns the selector of all ads in the video campaign.

Return values:

TypeDescription
AdWordsApp.VideoAdSelector The selector of all ads in the video campaign.

videoTargeting()

Provides access to this campaign's video targeting criteria.

Return values:

TypeDescription
AdWordsApp.CampaignVideoTargeting Access to this campaign's video targeting criteria.

Feedback geben zu...

AdWords Scripts
AdWords Scripts