AdsApp.VideoTopic
Stay organized with collections
Save and categorize content based on your preferences.
Represents a Google Ads Topic in a Video Campaign.
Methods:
bidding()
Provides access to bidding fields of this video topic.
Return values:
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:
getVideoCampaign()
Returns the campaign to which this video topic belongs.
Return values:
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eRepresents a Google Ads topic specifically for video campaigns, allowing for targeted advertising based on video content categories.\u003c/p\u003e\n"],["\u003cp\u003eProvides methods to access and manage bidding, retrieve performance statistics, and check the status (enabled/paused).\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this to programmatically control video topic targeting within their Google Ads campaigns.\u003c/p\u003e\n"],["\u003cp\u003eIncludes functionalities to identify the associated ad group and campaign for the video topic.\u003c/p\u003e\n"],["\u003cp\u003eOffers methods to retrieve the topic ID and resource name for integration with other Google Ads services.\u003c/p\u003e\n"]]],[],null,["# AdsApp.VideoTopic\n\nRepresents a Google Ads Topic in a Video Campaign.\n\n### Methods:\n\n| Member | Type | Description |\n|---------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [bidding()](#bidding) | [AdsApp.VideoCriterionBidding](/google-ads/scripts/docs/reference/adsapp/adsapp_videocriterionbidding) | Provides access to bidding fields of this video topic. |\n| [getEntityType()](#getEntityType) | `String` | Returns the type of this entity as a `String`, in this case, `\"VideoTopic\"`. |\n| [getId()](#getId) | `String` | Returns the ID of the video topic. |\n| [getResourceName()](#getResourceName) | `String` | Returns the resource name of the video topic. |\n| [getStatsFor(dateRange)](#getStatsFor_dateRange) | [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | Returns stats for the specified date range. |\n| [getStatsFor(dateFrom, dateTo)](#getStatsFor_dateFrom-dateTo) | [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | Returns stats for the specified custom date range. |\n| [getTopicId()](#getTopicId) | `String` | Returns the topic ID of the topic. |\n| [getVideoAdGroup()](#getVideoAdGroup) | [AdsApp.VideoAdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_videoadgroup) | Returns the ad group to which this video topic belongs. |\n| [getVideoCampaign()](#getVideoCampaign) | [AdsApp.VideoCampaign](/google-ads/scripts/docs/reference/adsapp/adsapp_videocampaign) | Returns the campaign to which this video topic belongs. |\n| [isEnabled()](#isEnabled) | `boolean` | Returns `true` if the video topic is enabled. |\n| [isPaused()](#isPaused) | `boolean` | Returns `true` if the video topic is paused. |\n| [remove()](#remove) | `void` | Removes the video topic. |\n\n`bidding()`\n-----------\n\nProvides access to bidding fields of this video topic.\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------------------------|-----------------------------------------------|\n| [AdsApp.VideoCriterionBidding](/google-ads/scripts/docs/reference/adsapp/adsapp_videocriterionbidding) | Access to bidding fields of this video topic. |\n\n`getEntityType()`\n-----------------\n\nReturns the type of this entity as a `String`, in this case, `\"VideoTopic\"`.\n\n### Return values:\n\n| Type | Description |\n|----------|--------------------------------------|\n| `String` | Type of this entity: `\"VideoTopic\"`. |\n\n`getId()`\n---------\n\nReturns the ID of the video topic.\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------|\n| `String` | The ID of the video topic. |\n\n`getResourceName()`\n-------------------\n\nReturns the resource name of the video topic.\n\n### Return values:\n\n| Type | Description |\n|----------|---------------------------------------|\n| `String` | The resource name of the video topic. |\n\n`getStatsFor(dateRange)`\n------------------------\n\nReturns stats for the specified date range. Supported values:\n\n`TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK,\nLAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT,\nTHIS_MONTH, LAST_MONTH, ALL_TIME`.\n\nExample:\n\n```gdscript\nvar stats = topic.getStatsFor(\"THIS_MONTH\");\n```\n\n### Arguments:\n\n| Name | Type | Description |\n|-----------|----------|-----------------------------------------------|\n| dateRange | `String` | Date range for which the stats are requested. |\n\n### Return values:\n\n| Type | Description |\n|------------------------------------------------------------------------|-----------------------------------------|\n| [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | The stats for the specified date range. |\n\n`getStatsFor(dateFrom, dateTo)`\n-------------------------------\n\nReturns 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,\n2013` is represented as either `{year: 2013, month: 3, day:\n24}` or `\"20130324\"`. The date range is inclusive on both ends, so `forDateRange(\"20130324\", \"20130324\")` defines a range of a single day.\n\n### Arguments:\n\n| Name | Type | Description |\n|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------|\n| 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. |\n| 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. |\n\n### Return values:\n\n| Type | Description |\n|------------------------------------------------------------------------|-----------------------------------------|\n| [AdsApp.Stats](/google-ads/scripts/docs/reference/adsapp/adsapp_stats) | The stats for the specified date range. |\n\n`getTopicId()`\n--------------\n\nReturns the topic ID of the topic. The topic ID identifies the topic category. A list of valid topic IDs is available on our [Verticals](/google-ads/api/reference/data/verticals) page.\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------|\n| `String` | The topic ID of the topic. |\n\n`getVideoAdGroup()`\n-------------------\n\nReturns the ad group to which this video topic belongs.\n\n### Return values:\n\n| Type | Description |\n|--------------------------------------------------------------------------------------|-------------------------------------------------|\n| [AdsApp.VideoAdGroup](/google-ads/scripts/docs/reference/adsapp/adsapp_videoadgroup) | The ad group to which this video topic belongs. |\n\n`getVideoCampaign()`\n--------------------\n\nReturns the campaign to which this video topic belongs.\n\n### Return values:\n\n| Type | Description |\n|----------------------------------------------------------------------------------------|-------------------------------------------------|\n| [AdsApp.VideoCampaign](/google-ads/scripts/docs/reference/adsapp/adsapp_videocampaign) | The campaign to which this video topic belongs. |\n\n`isEnabled()`\n-------------\n\nReturns `true` if the video topic is enabled.\n\n### Return values:\n\n| Type | Description |\n|-----------|---------------------------------------|\n| `boolean` | `true` if the video topic is enabled. |\n\n`isPaused()`\n------------\n\nReturns `true` if the video topic is paused.\n\n### Return values:\n\n| Type | Description |\n|-----------|--------------------------------------|\n| `boolean` | `true` if the video topic is paused. |\n\n`remove()`\n----------\n\nRemoves the video topic.\n\nReturns nothing."]]
