Trait

com.google.appsscript.adwords

ShoppingCampaign

Related Doc: package adwords

Permalink

trait ShoppingCampaign extends Object with CampaignLike

Represents a shopping campaign.

Annotations
@RawJSType()
Linear Supertypes
CampaignLike, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShoppingCampaign
  2. CampaignLike
  3. Object
  4. Any
  5. AnyRef
  6. 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. def adGroups(): ShoppingAdGroupSelector

    Permalink

    Returns the selector of all shopping ad groups in the shopping campaign.

  5. def addAdSchedule(dayOfWeek: String, startHour: Int, startMinute: Int, endHour: Int, endMinute: Int, bidModifier: Double): Unit

    Permalink

    Creates an ad schedule criterion.

    Creates an ad schedule criterion. Once created, the campaign will start showing ads during the specified time.

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

     var campaign = AdWordsApp.campaigns().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 = AdWordsApp.campaigns().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.

    Returns nothing.

    Definition Classes
    CampaignLike
  6. def addLocation(locationId: Int, bidModifier: Double): Unit

    Permalink

    Creates a location target in this campaign from a location ID and bid modifier.

    Creates a location target in this campaign from a location ID and bid modifier. Once created, the campaign will start showing ads to the location with the given location ID.

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

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

    Returns nothing.

    Definition Classes
    CampaignLike
  7. def addProximity(latitude: Double, longitude: Double, radius: Double, radiusUnits: String, optArgs: AnyRef): Unit

    Permalink

    Creates a proximity target in this campaign.

    Creates a proximity target in this campaign. Once created, the campaign will start showing ads to geographical points within the specified radius of the specified central point.

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

     var campaign = AdWordsApp.campaigns().get().next();
     campaign.addProximity(37.423021, -122.083739, 20, "KILOMETERS");
    
    Similarly, to create the same proximity target with a bid modifier and address:
     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"
       }
     });
    

    Returns nothing.

    Definition Classes
    CampaignLike
  8. def ads(): ProductAdSelector

    Permalink

    Returns the selector of all product ads in the shopping campaign.

  9. def applyLabel(name: String): Unit

    Permalink

    Applies a label to the campaign.

    Applies a label to the campaign. name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.

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

    Returns nothing.

    Definition Classes
    CampaignLike
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def bidding(): ShoppingCampaignBidding

    Permalink

    Provides access to this shopping campaign's bidding fields.

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def createNegativeKeyword(keywordText: String): Unit

    Permalink

    Creates a new campaign-level negative keyword with the specified text.

    Creates a new campaign-level negative keyword with the specified text. Match type for the new negative keyword is specified as follows:

    • createNegativeKeyword("shoes") - broad match.
    • createNegativeKeyword("\"shoes\"") - phrase match.
    • createNegativeKeyword("[leather shoes]") - exact match.

    Returns nothing.

    Definition Classes
    CampaignLike
  14. def enable(): Unit

    Permalink

    Enables the campaign.

    Enables the campaign.

    Returns nothing.

    Definition Classes
    CampaignLike
  15. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def excludeLocation(locationOrId: AnyRef): Unit

    Permalink

    Creates a location exclusion in this campaign.

    Creates a location exclusion in this campaign. Once created, the campaign will not show ads to the location with the given location ID.

    This method accepts three forms of input:

    • A simple location ID. For a list of locations and their corresponding IDs, please see the AdWords API documentation on geotargeting:
       var campaign = AdWordsApp.campaigns().get().next();
       campaign.excludeLocation(21175);
      
    • Existing TargetedLocation or ExcludedLocation objects, perhaps from another campaign:
       var campaigns = AdWordsApp.campaigns().get();
       var campaign1 = campaigns.next();
       var campaign2 = campaigns.next();
       var location = campaign1.targeting().excludedLocations().get().next();
       campaign2.excludeLocation(location);
      
    • Plain JavaScript objects describing a location. For instance, this would create a location exclusion for Tennessee:
       var campaign = AdWordsApp.campaigns().get().next();
       campaign.excludeLocation({
         id: 21175
       });
      
      The only field of the object which will be looked at is id, which represents the location ID.

    Returns nothing.

    }); Returns nothing.

    Definition Classes
    CampaignLike
  18. def finalize(): Unit

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

    Permalink

    Returns the ad rotation type of the campaign.

    Returns the ad rotation type of the campaign. Possible return values:

    OPTIMIZE, CONVERSION_OPTIMIZE, ROTATE, ROTATE_FOREVER

    Definition Classes
    CampaignLike
  20. def getBiddingStrategyType(): String

    Permalink

    Returns the bidding strategy type of the campaign.

    Returns the bidding strategy type of the campaign. Possible return values:

    MANUAL_CPC, MANUAL_CPM, BUDGET_OPTIMIZER, CONVERSION_OPTIMIZER, PERCENT_CPA

    Definition Classes
    CampaignLike
  21. def getBudget(): Budget

    Permalink

    Returns the budget of the campaign.

    Returns the budget of the campaign. In order to change the campaign's budget, use Budget.setAmount(double) .

    Definition Classes
    CampaignLike
  22. final def getClass(): Class[_]

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

    Permalink

    Returns the campaign's end date, or null if there is no end date.

    Returns the campaign's end date, or null if there is no end date. For instance, if a campaign ended on May 3, 2013, this would return the following object: {year: 2013, month: 5, day: 3} .

    Definition Classes
    CampaignLike
  24. def getEntityType(): String

    Permalink

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

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

    Definition Classes
    CampaignLike
  25. def getId(): Long

    Permalink

    Returns the ID of the campaign.

    Returns the ID of the campaign.

    Definition Classes
    CampaignLike
  26. def getName(): String

    Permalink

    Returns the name of the campaign.

    Returns the name of the campaign.

    Definition Classes
    CampaignLike
  27. def getStartDate(): AdWordsDate

    Permalink

    Returns the campaign's start date.

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

    Definition Classes
    CampaignLike
  28. def getStatsFor(dateFrom: AnyRef, dateTo: AnyRef): Stats

    Permalink

    Returns stats for the specified custom date range.

    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.

    Definition Classes
    CampaignLike
  29. def hasOwnProperty(v: String): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  31. def isDeleted(): Boolean

    Permalink

    Returns true if the shopping campaign is deleted.

    Returns true if the shopping campaign is deleted.

  32. def isEnabled(): Boolean

    Permalink

    Returns true if the campaign is enabled.

    Returns true if the campaign is enabled.

    Definition Classes
    CampaignLike
  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. def isPaused(): Boolean

    Permalink

    Returns true if the campaign is paused.

    Returns true if the campaign is paused.

    Definition Classes
    CampaignLike
  35. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  36. def labels(): LabelSelector

    Permalink

    Creates a selector of all labels applied to the campaign.

    Creates a selector of all labels applied to the campaign.

    Definition Classes
    CampaignLike
  37. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. def negativeKeywords(): NegativeKeywordSelector

    Permalink

    Returns a selector of the campaign-level negative keywords belonging to this campaign.

    Returns a selector of the campaign-level negative keywords belonging to this campaign.

    Note that this selector will not return any negative keywords belonging to this campaign's child ad groups — it only returns campaign-level negative keywords.

    Definition Classes
    CampaignLike
  39. def newAdGroupBuilder(): ShoppingAdGroupBuilder

    Permalink

    Returns a new shopping ad group builder for this shopping campaign.

  40. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  42. def pause(): Unit

    Permalink

    Pauses the campaign.

    Pauses the campaign.

    Returns nothing.

    Definition Classes
    CampaignLike
  43. def productGroups(): ProductGroupSelector

    Permalink

    Returns the selector of all product groups in the campaign.

  44. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  45. def removeLabel(name: String): Unit

    Permalink

    Removes a label from the campaign.

    Removes a label from the campaign. name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.

    Returns nothing.

    Definition Classes
    CampaignLike
  46. def setAdRotationType(adRotationType: String): Unit

    Permalink

    Sets the ad rotation type of the campaign.

    Sets the ad rotation type of the campaign. For instance, campaign.setAdRotationType("OPTIMIZE"); instructs AdWords to optimize ad serving based on the campaign's CTR. For more information, see Choose an ad delivery method help article.

    Returns nothing.

    Definition Classes
    CampaignLike
  47. def setEndDate(date: AnyRef): Unit

    Permalink

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

    Sets the campaign's end date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. 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.

    Definition Classes
    CampaignLike
  48. def setName(name: String): Unit

    Permalink

    Sets the name of the campaign.

    Sets the name of the campaign.

    Returns nothing.

    Definition Classes
    CampaignLike
  49. def setStartDate(date: AnyRef): Unit

    Permalink

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

    Sets the campaign's start date from either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD format. 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.

    Definition Classes
    CampaignLike
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  51. def targeting(): Targeting

    Permalink

    Provides access to campaign-level targeting criteria: device targeting, ad scheduling, and location targeting.

    Provides access to campaign-level targeting criteria: device targeting, ad scheduling, and location targeting.

    Definition Classes
    CampaignLike
  52. def toLocaleString(): String

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

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

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

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

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

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

Inherited from CampaignLike

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped