AdsApp.​VideoTopic

    • The VideoTopic object represents a Google Ads Topic within a Video Campaign.

    • It provides methods to access bidding information, retrieve entity type, IDs, resource name, and stats.

    • You can get the associated video ad group and video campaign using this object.

    • Methods are available to check if the video topic is enabled or paused and to remove it.

     Represents a Google Ads Topic in a Video Campaign.

    Methods:

    Member Type Description
    bidding()
    		AdsApp.VideoCriterionBidding Provides access to bidding fields of this video topic.
    getEntityType()
    		String Returns the type of this entity as a String , in this case, "VideoTopic" .
    getId()
    		String Returns the ID of the video topic.
    getResourceName()
    		String Returns the resource name of the video topic.
    getStatsFor(dateRange)
    		AdsApp.Stats Returns stats for the specified date range.
    getStatsFor(dateFrom, dateTo)
    		AdsApp.Stats Returns stats for the specified custom date range.
    getTopicId()
    		String Returns the topic ID of the topic.
    getVideoAdGroup()
    		AdsApp.VideoAdGroup Returns the ad group to which this video topic belongs.
    getVideoCampaign()
    		AdsApp.VideoCampaign Returns the campaign to which this video topic belongs.
    isEnabled()
    		boolean Returns true if the video topic is enabled.
    isPaused()
    		boolean Returns true if the video topic is paused.
    remove()
    		void Removes the video topic.

    bidding()

    Provides access to bidding fields of this video topic.

    Return values:

    Type Description
    AdsApp.VideoCriterionBidding Access to bidding fields of this video topic.

    getEntityType()

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

    Return values:

    Type Description
    String Type of this entity: "VideoTopic" .

    getId()

    Returns the ID of the video topic.

    Return values:

    Type Description
    String The ID of the video topic.

    getResourceName()

    Returns the resource name of the video topic.

    Return values:

    Type Description
    String The resource name of the video topic.

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

    Arguments:

    Name Type Description
    dateRange
    		 String Date range for which the stats are requested.

    Return values:

    Type Description
    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:

    Name Type Description
    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:

    Type Description
    AdsApp.Stats The stats for the specified date range.

    getTopicId()

    Returns the topic ID of the topic. The topic ID identifies the topic category. A list of valid topic IDs is available on our Verticals page.

    Return values:

    Type Description
    String The topic ID of the topic.

    getVideoAdGroup()

    Returns the ad group to which this video topic belongs.

    Return values:

    Type Description
    AdsApp.VideoAdGroup The ad group to which this video topic belongs.

    getVideoCampaign()

    Returns the campaign to which this video topic belongs.

    Return values:

    Type Description
    AdsApp.VideoCampaign The campaign to which this video topic belongs.

    isEnabled()

    Returns true if the video topic is enabled.

    Return values:

    Type Description
    boolean true if the video topic is enabled.

    isPaused()

    Returns true if the video topic is paused.

    Return values:

    Type Description
    boolean true if the video topic is paused.

    remove()

    Removes the video topic.

    Returns nothing.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: