AdsApp.​DisplayKeyword

    • The content describes a Google Ads display keyword and provides a table of its available methods.

    • Methods are available to access bidding information, retrieve associated ad groups and campaigns, get identifying information like ID and resource name, and obtain performance statistics for specified date ranges.

    • You can also get the text of the display keyword and check if it is enabled or paused using the provided methods.

    • The remove() method allows for the deletion of the display keyword.

     Represents a Google Ads display keyword.

    Methods:

    Member Type Description
    bidding()
    		AdsApp.DisplayCriterionBidding Provides access to this display keyword's bidding fields.
    getAdGroup()
    		AdsApp.AdGroup Returns the ad group to which this display keyword belongs.
    getBaseAdGroup()
    		AdsApp.AdGroup Returns the base ad group to which this display keyword belongs.
    getBaseCampaign()
    		AdsApp.Campaign Returns the base campaign to which this display keyword belongs.
    getCampaign()
    		AdsApp.Campaign Returns the campaign to which this display keyword belongs or null if it does not belong to a search or display campaign.
    getEntityType()
    		String Returns the type of this entity as a String , in this case, "DisplayKeyword" .
    getId()
    		String Returns the ID of the display keyword.
    getResourceName()
    		String Returns the resource name of the display keyword.
    getStatsFor(dateRange)
    		AdsApp.Stats Returns stats for the specified date range.
    getStatsFor(dateFrom, dateTo)
    		AdsApp.Stats Returns stats for the specified custom date range.
    getText()
    		String Returns the text of the display keyword.
    isEnabled()
    		boolean Returns true if the display keyword is enabled.
    isPaused()
    		boolean Returns true if the display keyword is paused.
    remove()
    		void Removes the display keyword.

    bidding()

    Provides access to this display keyword's bidding fields.

    Return values:

    Type Description
    AdsApp.DisplayCriterionBidding Access to this display keyword's bidding fields.

    getAdGroup()

    Returns the ad group to which this display keyword belongs.

    Return values:

    Type Description
    AdsApp.AdGroup The ad group to which this display keyword belongs.

    getBaseAdGroup()

    Returns the base ad group to which this display keyword belongs.

    Return values:

    Type Description
    AdsApp.AdGroup The base ad group to which this display keyword belongs.

    getBaseCampaign()

    Returns the base campaign to which this display keyword belongs.

    Return values:

    Type Description
    AdsApp.Campaign The base campaign to which this display keyword belongs.

    getCampaign()

    Returns the campaign to which this display keyword belongs or null if it does not belong to a search or display campaign.

    Return values:

    Type Description
    AdsApp.Campaign The campaign to which this display keyword belongs or null if it does not belong to a search or display campaign.

    getEntityType()

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

    Return values:

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

    getId()

    Returns the ID of the display keyword.

    Return values:

    Type Description
    String The ID of the display keyword.

    getResourceName()

    Returns the resource name of the display keyword.

    Return values:

    Type Description
    String The resource name of the display keyword.

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

    getText()

    Returns the text of the display keyword.

    Return values:

    Type Description
    String The text of the display keyword.

    isEnabled()

    Returns true if the display keyword is enabled.

    Return values:

    Type Description
    boolean true if the display keyword is enabled.

    isPaused()

    Returns true if the display keyword is paused.

    Return values:

    Type Description
    boolean true if the display keyword is paused.

    remove()

    Removes the display keyword.

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