CampaignLike

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def addAdSchedule(dayOfWeek: String, startHour: Int, startMinute: Int, endHour: Int, endMinute: Int, bidModifier: Double): Unit

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.
def addLocation(locationId: Int, bidModifier: Double): Unit

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.
def addProximity(latitude: Double, longitude: Double, radius: Double, radiusUnits: String, optArgs: AnyRef): Unit

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.
def applyLabel(name: String): Unit

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.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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.
def enable(): Unit

Enables the campaign.
Enables the campaign.
Returns nothing.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

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

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.
def finalize(): Unit

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

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
def getBiddingStrategyType(): String

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
def getBudget(): Budget

Returns the budget of the campaign.
Returns the budget of the campaign. In order to change the campaign's budget, use Budget.setAmount(double) .
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getEndDate(): AdWordsDate

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} .
def getEntityType(): String

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" .
def getId(): Long

Returns the ID of the campaign.
def getName(): String

Returns the name of the campaign.
def getStartDate(): AdWordsDate

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} .
def getStatsFor(dateFrom: AnyRef, dateTo: AnyRef): Stats

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.
def hashCode(): Int

Definition Classes
AnyRef → Any
def isEnabled(): Boolean

Returns true if the campaign is enabled.
Returns true if the campaign is enabled.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPaused(): Boolean

Returns true if the campaign is paused.
Returns true if the campaign is paused.
def labels(): LabelSelector

Creates a selector of all labels applied to the campaign.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def negativeKeywords(): NegativeKeywordSelector

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.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pause(): Unit

Pauses the campaign.
Pauses the campaign.
Returns nothing.
def removeLabel(name: String): Unit

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.
def setAdRotationType(adRotationType: String): Unit

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.
def setEndDate(date: AnyRef): Unit

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.
def setName(name: String): Unit

Sets the name of the campaign.
Sets the name of the campaign.
Returns nothing.
def setStartDate(date: AnyRef): Unit

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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def targeting(): Targeting

Provides access to campaign-level targeting criteria: device targeting, ad scheduling, and location targeting.
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package adwords

trait CampaignLike extends Any

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

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

def addLocation(locationId: Int, bidModifier: Double): Unit

def addProximity(latitude: Double, longitude: Double, radius: Double, radiusUnits: String, optArgs: AnyRef): Unit

def applyLabel(name: String): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def createNegativeKeyword(keywordText: String): Unit

def enable(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def excludeLocation(locationOrId: AnyRef): Unit

def finalize(): Unit

def getAdRotationType(): String

def getBiddingStrategyType(): String

def getBudget(): Budget

final def getClass(): Class[_]

def getEndDate(): AdWordsDate

def getEntityType(): String

def getId(): Long

def getName(): String

def getStartDate(): AdWordsDate

def getStatsFor(dateFrom: AnyRef, dateTo: AnyRef): Stats

def hashCode(): Int

def isEnabled(): Boolean

final def isInstanceOf[T0]: Boolean

def isPaused(): Boolean

def labels(): LabelSelector

final def ne(arg0: AnyRef): Boolean

def negativeKeywords(): NegativeKeywordSelector

final def notify(): Unit

final def notifyAll(): Unit

def pause(): Unit

def removeLabel(name: String): Unit

def setAdRotationType(adRotationType: String): Unit

def setEndDate(date: AnyRef): Unit

def setName(name: String): Unit

def setStartDate(date: AnyRef): Unit

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

def targeting(): Targeting

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped