// Create a phone number builder.
var phoneNumberBuilder = AdsApp.extensions().newPhoneNumberBuilder();
// Create a phone number operation.
var phoneNumberOperation = phoneNumberBuilder
.withCountry("US") // required
.withPhoneNumber("1234567891") // required
.withMobilePreferred(true) // optional
.build();
// Optional: examine the outcome. The call to isSuccessful()
// will block until the operation completes.
if (phoneNumberOperation.isSuccessful()) {
// Get the result.
var phoneNumber = phoneNumberOperation.getResult();
} else {
// Handle the errors.
var errors = phoneNumberOperation.getErrors();
}
Sets the phone number's start date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format.
build(buildLegacy)
Creates a PhoneNumber.
Returns a PhoneNumberOperation
that can be used to get the new phone number (or access any
associated errors if creation failed).
Defaults to building the type of phone number that is currently
serving. If there are upgraded phone numbers, then an upgraded
phone number will be built by default. If there are only legacy
phone numbers, then a legacy phone number will be built
by default. If there are neither, then an upgraded phone number will
be built by default.
Arguments:
Name
Type
Description
buildLegacy
boolean
If true, builds a legacy phone number. If false, builds an upgraded phone number. If
unspecified, defaults to building whichever type is currently serving.
A phone number builder with the specified country code.
withEndDate(date)
Sets the phone number's end date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format. This field is optional.
For instance, phoneNumberBuilder.withEndDate("20130503"); is equivalent to phoneNumberBuilder.withEndDate({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}),
A phone number builder with the specified end date.
withMobilePreferred(isMobilePreferred)
Sets the phone number's device preference to mobile or clears it.
This field is optional and defaults to false.
Arguments:
Name
Type
Description
isMobilePreferred
boolean
Whether or not this phone number should be
mobile preferred. If true is passed in, device preference
will be set to mobile. If false is passed in, device
preference will be set to none.
A phone number builder with the specified phone number.
withSchedules(schedules)
Sets the phone number scheduling. Scheduling of a phone number allows you to control the days of week and times of day during which
the phone number will show alongside your ads.
Passing in an empty array clears the scheduling field, causing the phone number to run at all times.
The following example sets the phone number to run on Mondays and
Tuesday from 8:00 to 11:00.
A phone number builder with the specified schedules.
withStartDate(date)
Sets the phone number's start date from either an object containing
year, month, and day fields, or an 8-digit string in YYYYMMDD
format. This field is optional.
For instance, phoneNumberBuilder.withStartDate("20130503"); is equivalent to phoneNumberBuilder.withStartDate({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 phone number's end date,
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-10 UTC."],[],[]]