AdWordsApp.​UserList

Represents an AdWords user list.

Methods:

MemberTypeDescription
close void Close user list so it will no longer accumulate new members.
excludedAdGroups AdWordsApp.AdGroupSelector Returns a selector of all the search ad groups negatively targeting this user list.
excludedCampaigns AdWordsApp.CampaignSelector Returns a selector of all the search campaigns negatively targeting this user list.
getDescription String Returns the description of the user list.
getId long Returns the ID of the user list.
getMembershipLifeSpan long Returns the number of days a user's cookie stays on your list since its most recent addition to the list.
getName String Returns the name of the user list.
getSizeForDisplay long Estimated number of users in this user list, on the Google Display Network.
getSizeForSearch long Estimated number of users in this user list in the google.com domain.
getSizeRangeForDisplay String Size range in terms of number of users of the UserList for ads on Google Display Network.
getSizeRangeForSearch String Size range in terms of number of users of the UserList, for Search ads.
getType String Type of this list: remarketing/logical/external remarketing.
isClosed boolean Is the user list closed to new members being added.
isEligibleForDisplay boolean Is the user list eligible for display campaigns/ad groups.
isEligibleForSearch boolean Is the user list eligible for search campaigns/ad groups.
isOpen boolean Is the user list accruing new members.
isReadOnly boolean Is the user list read only.
open void Open user list to accrue new members.
setDescription void Sets the description of the user list.
setMembershipLifeSpan void Sets the number of days a user's cookie stays on your list since its most recent addition to the list.
setName void Sets the name of the user list.
targetedAdGroups AdWordsApp.AdGroupSelector Returns a selector of all the search ad groups targeting this user list.
targetedCampaigns AdWordsApp.CampaignSelector Returns a selector of all the search campaigns targeting this user list.

close()

Close user list so it will no longer accumulate new members.

Returns nothing.

excludedAdGroups()

Returns a selector of all the search ad groups negatively targeting this user list.

Return values:

TypeDescription
AdWordsApp.AdGroupSelector The selector of all excluded ad groups.

excludedCampaigns()

Returns a selector of all the search campaigns negatively targeting this user list.

Return values:

TypeDescription
AdWordsApp.CampaignSelector The selector of all excluded campaigns.

getDescription()

Returns the description of the user list.

Return values:

TypeDescription
String Description of the user list.

getId()

Returns the ID of the user list.

Return values:

TypeDescription
long The ID of the user list.

getMembershipLifeSpan()

Returns the number of days a user's cookie stays on your list since its most recent addition to the list.

Return values:

TypeDescription
long Number of days a user is a member.

getName()

Returns the name of the user list.

Return values:

TypeDescription
String Name of the user list.

getSizeForDisplay()

Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined.

Return values:

TypeDescription
long Number of members in the list.

getSizeForSearch()

Estimated number of users in this user list in the google.com domain. These are the users available for targeting in search campaigns. This value is null if the number of users has not yet been determined.

Return values:

TypeDescription
long Number of members in the list.

getSizeRangeForDisplay()

Size range in terms of number of users of the UserList for ads on Google Display Network.

Return values:

TypeDescription
String Size range of the list.

getSizeRangeForSearch()

Size range in terms of number of users of the UserList, for Search ads.

Return values:

TypeDescription
String Size range of the list.

getType()

Type of this list: remarketing/logical/external remarketing. Enumerations: UNKNOWN, REMARKETING, LOGICAL, EXTERNAL_REMARKETING, RULE_BASED, SIMILAR, CRM_BASED.

Return values:

TypeDescription
String Type type of user list.

isClosed()

Is the user list closed to new members being added.

Return values:

TypeDescription
boolean true if user list not adding more members, false if it is accruing new members.

isEligibleForDisplay()

Is the user list eligible for display campaigns/ad groups.

Return values:

TypeDescription
boolean true if user list is eligible for display, false if it is NOT eligible for display.

isEligibleForSearch()

Is the user list eligible for search campaigns/ad groups.

Return values:

TypeDescription
boolean true if user list is eligible for search, false if it is NOT eligible for search.

isOpen()

Is the user list accruing new members.

Return values:

TypeDescription
boolean true if user list accruing new members, false if it is NOT accruing new members.

isReadOnly()

Is the user list read only.

Return values:

TypeDescription
boolean true if user list is read only, false if it is editable.

open()

Open user list to accrue new members.

Returns nothing.

setDescription(description)

Sets the description of the user list.

Returns nothing.

Arguments:

NameTypeDescription
description String The new description for the user list.

setMembershipLifeSpan(membershipLifeSpan)

Sets the number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based user lists, this field can be set to 10000 which means no expiration.

Returns nothing.

Arguments:

NameTypeDescription
membershipLifeSpan Long Number of days a user is a member.

setName(name)

Sets the name of the user list.

Returns nothing.

Arguments:

NameTypeDescription
name String The new name for user list.

targetedAdGroups()

Returns a selector of all the search ad groups targeting this user list.

Return values:

TypeDescription
AdWordsApp.AdGroupSelector The selector of all ad groups.

targetedCampaigns()

Returns a selector of all the search campaigns targeting this user list.

Return values:

TypeDescription
AdWordsApp.CampaignSelector The selector of all campaigns.

Оставить отзыв о...

Текущей странице
AdWords Scripts
AdWords Scripts
Нужна помощь? Обратитесь в службу поддержки.