Campaign
Related Doc:
package adwords
Returns the selector of all ad groups in the campaign.
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.
Adds a callout extension to this campaign.
Adds a callout extension to this campaign. See also Extensions.newCalloutBuilder()
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.
Adds a mobile app extension to this campaign.
Adds a mobile app extension to this campaign. See also Extensions.newMobileAppBuilder()
Adds a phone number extension to this campaign.
Adds a phone number extension to this campaign. See also Extensions.newPhoneNumberBuilder()
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.
Adds a review extension to this campaign.
Adds a review extension to this campaign. See also Extensions.newReviewBuilder()
Adds a sitelink extension to this campaign.
Adds a sitelink extension to this campaign. See also Extensions.newSitelinkBuilder()
Returns the selector of all ads in the campaign.
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.
Provides access to this campaign's bidding fields.
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.
Provices access to this campaign's display criteria: Audience , ExcludedAudience , DisplayKeyword , ExcludedDisplayKeyword , Placement , ExcludedPlacement , Topic , and ExcludedTopic .
Provices access to this campaign's display criteria: Audience , ExcludedAudience , DisplayKeyword , ExcludedDisplayKeyword , Placement , ExcludedPlacement , Topic , and ExcludedTopic .
Enables the campaign.
Enables the campaign.
Returns nothing.
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:
var campaign = AdWordsApp.campaigns().get().next(); campaign.excludeLocation(21175);
var campaigns = AdWordsApp.campaigns().get(); var campaign1 = campaigns.next(); var campaign2 = campaigns.next(); var location = campaign1.targeting().excludedLocations().get().next(); campaign2.excludeLocation(location);
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.
Provides access to this campaign's extensions: CampaignCallout , CampaignMobileApp , CampaignPhoneNumber , CampaignReview , and CampaignSitelink .
Provides access to this campaign's extensions: CampaignCallout , CampaignMobileApp , CampaignPhoneNumber , CampaignReview , and CampaignSitelink .
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
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
Returns the budget of the campaign.
Returns the budget of the campaign. In order to change the campaign's budget, use Budget.setAmount(double) .
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}
.
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"
.
Returns the ID of the campaign.
Returns the ID of the campaign.
Returns the name of the campaign.
Returns the name of the campaign.
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}
.
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.
Returns
true
if the campaign is enabled.
Returns
true
if the campaign is enabled.
Returns
true
if the campaign is paused.
Returns
true
if the campaign is paused.
Returns
true
if the campaign is removed.
Returns
true
if the campaign is removed.
Returns the selector of all keywords in the campaign.
Creates a selector of all labels applied to the campaign.
Creates a selector of all labels applied to the campaign.
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.
Returns a new ad group builder for this campaign.
Returns a new ad group builder for this campaign. Once
builder.create()
is called, the ad group will be created in this campaign.
Pauses the campaign.
Pauses the campaign.
Returns nothing.
Removes a callout extension from this campaign.
Removes a callout extension from this campaign.
Returns nothing.
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.
Removes a mobile app extension from this campaign.
Removes a mobile app extension from this campaign.
Returns nothing.
Removes a phone number extension from this campaign.
Removes a phone number extension from this campaign.
Returns nothing.
Removes a review extension from this campaign.
Removes a review extension from this campaign.
Returns nothing.
Removes a sitelink extension from this campaign.
Removes a sitelink extension from this campaign.
Returns nothing.
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.
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:
{year: 2013, month: 5, day: 55}),Returns nothing.
Sets the name of the campaign.
Sets the name of the campaign.
Returns nothing.
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:
{year: 2013, month: 5, day: 55}),Returns nothing.
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.
Provides access to this campaign's URL fields.
Provides access to this campaign's URL fields. See Using Upgraded URLs for more information.
Represents an AdWords campaign.