AdsApp.​VideoCampaign

Methods:

addAdSchedule(adSchedule)

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

• Existing AdSchedule objects, perhaps from another campaign:

  var campaigns = AdsApp.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 = AdsApp.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:

Return values:

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

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

var campaign = AdsApp.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 = AdsApp.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 241-hour-long periods is not.

Arguments:

Return values:

addExcludedPlacementList(excludedPlacementList)

Returns nothing.

Arguments:

addLanguage(languageObject)

Use a plain JavaScript object to describe a language. For instance, this would create a language target for German:

var campaign = AdsApp.videoCampaigns().get().next();
campaign.addLanguage({
  id: 1001,
});

• id: Required. The ID of the language to target. For a list of languages and their corresponding codes, see the API documentation on languages.

Arguments:

Return values:

addLanguage(languageId)

For a list of languages and their corresponding codes, see the API documentation on languages. For instance, this will create a language target for German:

var campaign = AdsApp.videoCampaigns().get().next();
campaign.addLanguage(1001);

Arguments:

Return values:

addLanguage(language)

The existing Language objects can be from another campaign:

var campaigns = AdsApp.videoCampaigns().get();
var campaign1 = campaigns.next();
var campaign2 = campaigns.next();
var language = campaign1.targeting().languages().get().next();
campaign2.addLanguage(language);

Arguments:

Return values:

addLocation(locationId)

You must specify a location ID. For a list of locations and their corresponding IDs, see the API documentation on geotargeting.

Arguments:

Return values:

addLocation(location)

You must specify an existing TargetedLocation object, perhaps from another campaign:

var campaigns = AdsApp.campaigns().get();
var campaign1 = campaigns.next();
var campaign2 = campaigns.next();
var location = campaign1.targeting().targetedLocations().get().next();
campaign2.addLocation(location);

Arguments:

Return values:

addLocation(location)

You must specify a plain JavaScript object describing a location. For instance, this would create a location target for Tennessee:

var campaign = AdsApp.campaigns().get().next();
campaign.addLocation({
  id: 21175,
  bidModifier: 1.2,
});

• id: Required. The ID of the location to target. For a list of locations and their corresponding IDs, see the API documentation on geotargeting.
• bidModifier: Optional. The bid modifier for this location.

Arguments:

Return values:

addLocation(locationId, bidModifier)

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

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

Arguments:

Return values:

addNegativeKeywordList(negativeKeywordList)

Returns nothing.

Arguments:

addProximity(proximity)

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

• Existing TargetedProximity objects, perhaps from another campaign:

  var campaigns = AdsApp.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 = AdsApp.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:

Return values:

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

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

var campaign = AdsApp.videoCampaigns().get().next();
campaign.addProximity(37.423021, -122.083739, 20, "KILOMETERS");

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:

Return values:

applyLabel(name)

Note that the video campaign cannot have more than 50 labels.

Returns nothing.

Arguments:

bidding()

Return values:

enable()

Returns nothing.

excludeContentLabel(contentLabelType)

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 = AdsApp.videoCampaigns().get().next();
campaign.excludeContentLabel('VIDEO_RATING_DV_G');

Arguments:

Return values:

excludeContentLabel(contentLabelType)

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 = AdsApp.videoCampaigns().get().next();
campaign.excludeLocation({
  contentLabelType: 'VIDEO_RATING_DV_G'
});

Arguments:

Return values:

excludeContentLabel(contentLabel)

The existing ExcludedContentLabel objects can be from another campaign:

var campaigns = AdsApp.videoCampaigns().get();
var campaign1 = campaigns.next();
var campaign2 = campaigns.next();
var contentLabel =
  campaign1.targeting().excludedContentLabels().get().next();
campaign2.excludeContentLabel(contentLabel);

Arguments:

Return values:

excludeLocation(location)

You must specify an existing ExcludedLocation object, perhaps from another campaign:

var campaigns = AdsApp.campaigns().get();
var campaign1 = campaigns.next();
var campaign2 = campaigns.next();
var location = campaign1.targeting().excludedLocations().get().next();
campaign2.excludeLocation(location);

Arguments:

Return values:

excludeLocation(locationId)

You must specify a location ID. For a list of locations and their corresponding IDs, see the API documentation on geotargeting:

var campaign = AdsApp.campaigns().get().next();
campaign.excludeLocation(21175);

Arguments:

Return values:

excludeLocation(location)

You must specify a plain JavaScript object describing a location. For instance, this would create a location exclusion for Tennessee:

var campaign = AdsApp.campaigns().get().next();
campaign.excludeLocation({
  id: 21175
});

Arguments:

Return values:

excludedPlacementLists()

Return values:

getAdRotationType()

OPTIMIZE, CONVERSION_OPTIMIZE, ROTATE

Return values:

getBiddingStrategyType()

MANUAL_CPV

Return values:

getBudget()

Return values:

getEndDate()

For instance, if a campaign ended on May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3}.

Return values:

getEntityType()

Return values:

getFrequencyCaps()

Return values:

getId()

Return values:

getInventoryType()

EXPANDED_INVENTORY, STANDARD_INVENTORY, LIMITED_INVENTORY.

Return values:

getName()

Return values:

getNetworks()

YOUTUBE_SEARCH, YOUTUBE_VIDEO, VIDEO_PARTNER_ON_THE_DISPLAY_NETWORK

Return values:

getResourceName()

Return values:

getStartDate()

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

Return values:

getStatsFor(dateRange)

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:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

isEnabled()

Return values:

isPaused()

Return values:

isRemoved()

Return values:

labels()

Return values:

negativeKeywordLists()

Return values:

newVideoAdGroupBuilder()

Return values:

pause()

Returns nothing.

removeExcludedPlacementList(excludedPlacementList)

Returns nothing.

Arguments:

removeLabel(name)

Returns nothing.

Arguments:

removeNegativeKeywordList(negativeKeywordList)

Returns nothing.

Arguments:

setAdRotationType(adRotationType)

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

Returns nothing.

Arguments:

setEndDate(date)

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:

setInventoryType(inventoryType)

For instance, campaign.setInventoryType("EXPANDED_INVENTORY"); instructs Google Ads to show ads on all videos that meet our standards for monetization. For more information, see About content exclusions for Video campaigns help article.

Returns nothing.

Arguments:

setName(name)

Returns nothing.

Arguments:

setNetworks(networks)

Returns nothing.

Arguments:

setStartDate(date)

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:

targeting()

Return values:

videoAdGroups()

Return values:

videoAds()

Return values:

videoTargeting()

Return values: