AdsApp.​Account

AI-generated Key Takeaways

• Google Ads Account information is accessible via AdsApp.currentAccount(), providing details about the script's running account.

• You can add or remove various extensions like callouts, mobile apps, prices, sitelinks, and snippets to and from the account.

• Methods are available to retrieve the account's currency code, customer ID, entity type ("Account"), name, and time zone.

• You can get performance statistics for the account for predefined or custom date ranges using getStatsFor().

• The extensions() method provides access to manage account-level extensions.

Miscellaneous information about Google Ads Accounts. When accessed by AdsApp.currentAccount(), it will provide information about the account in which the script is currently running.

Methods:

Member	Type	Description
addCallout(calloutExtension)	AdsApp.CalloutOperation	Adds a callout extension to this account.
addMobileApp(mobileAppExtension)	AdsApp.MobileAppOperation	Adds a mobile app extension to this account.
addPrice(priceExtension)	AdsApp.PriceOperation	Adds a price extension to this account.
addSitelink(sitelinkExtension)	AdsApp.SitelinkOperation	Adds a sitelink extension to this account.
addSnippet(snippetExtension)	AdsApp.SnippetOperation	Adds a snippet extension to this account.
extensions()	AdsApp.AccountExtensions	Provides access to account-level extensions: AccountCallout, AccountMobileApp, AccountPhoneNumber, AccountSitelink, and AccountSnippet.
getCurrencyCode()	String	Returns the currency code of the account.
getCustomerId()	String	Returns the customer ID of the account.
getEntityType()	String	Returns the type of this entity as a String, in this case, "Account".
getName()	String	Returns the name of the account.
getStatsFor(dateRange)	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	AdsApp.Stats	Returns stats for the specified custom date range.
getTimeZone()	String	Returns the POSIX time zone of the account.
removeCallout(calloutExtension)	void	Removes a callout extension from this account.
removeMobileApp(mobileAppExtension)	void	Removes a mobile app extension from this account.
removePrice(priceExtension)	void	Removes a price extension from this account.
removeSitelink(sitelinkExtension)	void	Removes a sitelink extension from this account.
removeSnippet(snippetExtension)	void	Removes a snippet extension from this account.

addCallout(calloutExtension)

Adds a callout extension to this account. See also Extensions.newCalloutBuilder()

Arguments:

Name	Type	Description
calloutExtension	AdsApp.Callout	The callout to add to this account.

Return values:

Type	Description
AdsApp.CalloutOperation	The associated callout operation.

addMobileApp(mobileAppExtension)

Adds a mobile app extension to this account. See also Extensions.newMobileAppBuilder()

Arguments:

Name	Type	Description
mobileAppExtension	AdsApp.MobileApp	The mobile app to add to this account.

Return values:

Type	Description
AdsApp.MobileAppOperation	The associated mobile app operation.

addPrice(priceExtension)

Adds a price extension to this account. See also Extensions.newPriceBuilder().

Arguments:

Name	Type	Description
priceExtension	AdsApp.Price	The price to add to this account.

Return values:

Type	Description
AdsApp.PriceOperation	The associated price operation.

addSitelink(sitelinkExtension)

Adds a sitelink extension to this account. See also Extensions.newSitelinkBuilder()

Arguments:

Name	Type	Description
sitelinkExtension	AdsApp.Sitelink	The sitelink to add to this account.

Return values:

Type	Description
AdsApp.SitelinkOperation	The associated sitelink operation.

addSnippet(snippetExtension)

Adds a snippet extension to this account. See also Extensions.newSnippetBuilder()

Arguments:

Name	Type	Description
snippetExtension	AdsApp.Snippet	The snippet to add to this account.

Return values:

Type	Description
AdsApp.SnippetOperation	The associated snippet operation.

extensions()

Provides access to account-level extensions: AccountCallout, AccountMobileApp, AccountPhoneNumber, AccountSitelink, and AccountSnippet.

Return values:

Type	Description
AdsApp.AccountExtensions	Access to account-level extensions.

getCurrencyCode()

Returns the currency code of the account. The returned values are in the three-letter ISO 4217 format, e.g. 'USD', 'CAD', 'JPY', etc.

Please refer to Google Ads API Currency Codes for the full list of possible return values.

Return values:

Type	Description
String	The currency code of the account.

getCustomerId()

Returns the customer ID of the account.

The returned value is in the standard Google Ads format, e.g. '123-456-7890'.

Return values:

Type	Description
String	The customer ID of the account.

getEntityType()

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

Return values:

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

getName()

Returns the name of the account.

Return values:

Type	Description
String	The account descriptive name, or null if one doesn't exist.

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

getTimeZone()

Returns the POSIX time zone of the account.

Returned values are in the standard time zone identifier form, such as 'America/Los_Angeles'.

Please refer to Google Ads API Timezones for the full list of possible return values.

Return values:

Type	Description
String	The time zone of the account.

removeCallout(calloutExtension)

Removes a callout extension from this account.

Returns nothing.

Arguments:

Name	Type	Description
calloutExtension	AdsApp.Callout	The callout to remove from this account.

removeMobileApp(mobileAppExtension)

Removes a mobile app extension from this account.

Returns nothing.

Arguments:

Name	Type	Description
mobileAppExtension	AdsApp.MobileApp	The mobile app to remove from this account.

removePrice(priceExtension)

Removes a price extension from this account.

Returns nothing.

Arguments:

Name	Type	Description
priceExtension	AdsApp.Price	The price to remove from this account.

removeSitelink(sitelinkExtension)

Removes a sitelink extension from this account.

Returns nothing.

Arguments:

Name	Type	Description
sitelinkExtension	AdsApp.Sitelink	The sitelink to remove from this account.

removeSnippet(snippetExtension)

Removes a snippet extension from this account.

Returns nothing.

Arguments:

Name	Type	Description
snippetExtension	AdsApp.Snippet	The snippet to remove from this account.