Trait

com.google.appsscript.adwords

AdCustomizerItem

Related Doc: package adwords

Permalink

trait AdCustomizerItem extends Object

Represents an ad customizer data item. Each ad customizer item can be seen as one row in an ad customizer source in the Business Data section of the Shared Library. Ad customizer items have attribute values, which are values that correspond to the attributes of the item's source (see AdCustomizerSource ). These values can be substituted into an ad with placeholders of the form {=SourceName.AttributeName} . See the feature guide for more information.

Annotations
@RawJSType()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdCustomizerItem
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clearTargetAdGroup(): Unit

    Permalink

    Clears the set target ad group and campaign.

    Clears the set target ad group and campaign. Does nothing if target ad group is not set.

    Returns nothing.

  6. def clearTargetCampaign(): Unit

    Permalink

    Clears the set target campaign.

    Clears the set target campaign. Does nothing if the target ad group is set.

    Returns nothing.

  7. def clearTargetKeyword(): Unit

    Permalink

    Clears the set target keyword.

    Clears the set target keyword.

    Returns nothing.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def getAttributeValue(name: String): AnyRef

    Permalink

    Returns the value of the named attribute.

    Returns the value of the named attribute. Returns null if the attribute does not have a value. Throws an error if the item's source has no attribute with the given name. The return will match the type of the attribute. An attribute of type number will return a number, an attribute of type text will return a string, and an attribute of type date will return a string in YYYYMMDD HHMMSS format.

  13. def getAttributeValues(): AnyRef

    Permalink

    Returns a map from attribute name to attribute value.

    Returns a map from attribute name to attribute value. Attributes with no value are not included in the map. For instance, for an ad customizer item with attribute values item

    null , numLeft

    5 , and lowCost

    "$0.99" , calling adCustomizerItem.getAttributeValues() would return {numLeft: 5, lowCost: "$0.99"} .

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def getEndDate(): AdWordsDate

    Permalink

    Returns the end date of the ad customizer item.

    Returns the end date of the ad customizer item. For instance, if the end date of the ad customizer item is May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3} .

  16. def getEntityType(): String

    Permalink

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

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

  17. def getId(): Long

    Permalink

    Returns the ID of the ad customizer item.

  18. def getSchedules(): Array[ExtensionSchedule]

    Permalink

    Returns the scheduling of the ad customizer item.

  19. def getStartDate(): AdWordsDate

    Permalink

    Returns the start date of the ad customizer item.

    Returns the start date of the ad customizer item. For instance, if the start date of the ad customizer item is May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3} .

  20. def getTargetAdGroupName(): String

    Permalink

    Returns the name of the target ad group, if it is set.

    Returns the name of the target ad group, if it is set. Returns null otherwise.

  21. def getTargetCampaignName(): String

    Permalink

    Returns the name of the target campaign, if it is set.

    Returns the name of the target campaign, if it is set. Returns null otherwise.

  22. def getTargetKeywordText(): String

    Permalink

    Returns the ad customizer item's target keyword text, if it is set.

    Returns the ad customizer item's target keyword text, if it is set. Returns null otherwise. The text returned will be formatted as follows, depending on the match type:

    • shoes - broad match
    • "shoes" - phrase match
    • [leather shoes] - exact match
  23. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. def isMobilePreferred(): Boolean

    Permalink

    Returns true if the ad customizer item specifies mobile device preference.

    Returns true if the ad customizer item specifies mobile device preference.

  27. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  32. def remove(): Unit

    Permalink

    Removes the ad customizer item.

    Removes the ad customizer item.

    Returns nothing.

  33. def setAttributeValue(name: String, value: AnyRef): Unit

    Permalink

    Sets the named attribute to the given value, or clears its value if null is given.

    Sets the named attribute to the given value, or clears its value if null is given. The value must be consistent with the type of the attribute:

    Type Expected Value Format Example
    text String "leather shoes"
    number Number (Integer) 42
    price String "$4.20"
    date String in YYYYMMDD HHMMSS format "20130505 110000". Invalid dates such as "20130005 110000" will result in an error (there is no month 0).
    The special attribute custom id also requires that the new value is unique across all items in the ad customizer data source.

    The change will fail and report an error if:

    • this item's source has no attribute by the given name,
    • the value is not consistent with the type of the attribute, or
    • for the custom id attribute, another item in the data source has the same value.

    Related:

    Returns nothing.

  34. def setAttributeValues(attributeValues: AnyRef): Unit

    Permalink

    Sets the named attributes to the respective values.

    Sets the named attributes to the respective values. A null value will clear any existing value for the attribute. The value must be consistent with the type of the attribute. See AdCustomizerItem.setAttributeValue for more information on the expected values for each attribute type. The special attribute custom id also requires that the new value is unique across all items in the ad customizer data source.

    Examples of the expected value formats for each valid attribute type:

     var attributeValues = {
         item: "leather shoes"         // text
         numLeft: 5,                   // number
         lowCost: "$5.99",             // price
         endDate: "20130401 120000"};  // date
     adCustomizerItem.setAttributeValues(attributeValues);
    

    The change will fail and report an error if:

    • this item's source has no attribute with one of the given names,
    • the value is not consistent with the type of the attribute, or
    • for the custom id attribute, another item in the data source has the same value.

    Related:

    Returns nothing.

  35. def setEndDate(date: AnyRef): Unit

    Permalink

    Sets the ad customizer item's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

    Sets the ad customizer item's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. For instance, adCustomizerItem.setEndDate("20130503"); is equivalent to adCustomizerItem.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}),
    • the start date now comes after the end date, or
    • it's a date in the past.

    Returns nothing.

  36. def setMobilePreferred(isMobilePreferred: Boolean): Unit

    Permalink

    Sets the ad customizer item's device preference.

    Sets the ad customizer item's device preference.

    Returns nothing.

  37. def setSchedules(schedules: Array[ExtensionSchedule]): Unit

    Permalink

    Sets the ad customizer item scheduling.

    Sets the ad customizer item scheduling. Scheduling of a ad customizer item allows you to control the days of week and times of day during which the ad customizer item will show alongside your ads.

    Passing in an empty array clears the scheduling field, causing the ad customizer item to run at all times.

    The following example sets the ad customizer item to run on Mondays and Tuesday from 8:00 to 11:00.

     var mondayMorning = {
       dayOfWeek: "MONDAY",
       startHour: 8,
       startMinute: 0,
       endHour: 11,
       endMinute: 0
     };
     var tuesdayMorning = {
       dayOfWeek: "TUESDAY",
       startHour: 8,
       startMinute: 0,
       endHour: 11,
       endMinute: 0
     };
     adCustomizerItem.setSchedules([mondayMorning, tuesdayMorning]);
    

    Returns nothing.

  38. def setStartDate(date: AnyRef): Unit

    Permalink

    Sets the ad customizer item's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format.

    Sets the ad customizer item's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. For instance, adCustomizerItem.setStartDate("20130503"); is equivalent to adCustomizerItem.setStartDate({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}),
    • the given date is after the ad customizer item's end date.

    Returns nothing.

  39. def setTargetAdGroup(campaignName: String, adGroupName: String): Unit

    Permalink

    Sets the target ad group and campaign of the ad customizer item.

    Sets the target ad group and campaign of the ad customizer item. This will fail if a target campaign exists. For instance,

     adCustomizerItem.setTargetCampaign("Campaign");
     adCustomizerItem.setTargetAdGroup("Campaign", "Ad group");
    
    will fail on the second statement, while
     adCustomizerItem.setTargetCampaign("Campaign");
     adCustomizerItem.clearTargetCampaign();
     adCustomizerItem.setTargetAdGroup("Campaign", "Ad group");
    
    will target the ad group "Ad group" and target the campaign "Campaign".

    Returns nothing.

  40. def setTargetCampaign(campaignName: String): Unit

    Permalink

    Sets the target campaign of the ad customizer item.

    Sets the target campaign of the ad customizer item. This will fail if a target ad group exists. For instance,

     adCustomizerItem.setTargetAdGroup("Campaign", "Ad group");
     adCustomizerItem.setTargetCampaign("Campaign");
    
    will fail on the second statement, while
     adCustomizerItem.setTargetAdGroup("Campaign", "Ad group");
     adCustomizerItem.clearTargetAdGroup();
     adCustomizerItem.setTargetCampaign("Campaign");
    
    will target the campaign "Campaign".

    Returns nothing.

  41. def setTargetKeyword(keyword: String): Unit

    Permalink

    Sets the target keyword of the ad customizer item.

    Sets the target keyword of the ad customizer item. Setting the target keyword to one that does not yet exist in your account will not cause an error, but will prevent the ad customizer item from being used to populate ads (until you create the keyword in your account). The keyword should be formatted based on its match type:

    • setTargetKeyword('shoes') - broad match
    • setTargetKeyword('"shoes"') - phrase match
    • setTargetKeyword('[leather shoes]') - exact match

    Returns nothing.

  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  43. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  44. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  45. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  46. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped