Edit

UserList

  • Article

Contains the methods for managing a user list. For more information, see UserList.

Methods

Method Name Return Type Description
getDescription string Gets this user list's description.
getEntityType string Gets this entity's type, which is UserList.
getId string Gets the ID that uniquely identifies this user list.
getMembershipLifeSpan int Gets how far back in time (number of days) Microsoft Advertising should look for actions that match this user list definition.
getName string Gets this user list's name.
getSizeForAudienceNetwork long Gets this user list's size in the Audience network.
getSizeForSearch long Gets this user list's size in the Search network.
getType string Gets this user list's type.
setDescription(string description) void Sets this user list's description.
setMembershipLifeSpan(int membershipLifeSpan) void Sets how far back in time (number of days) Microsoft Advertising should look for actions that match this user list definition.
setName(string name) void Sets this user list's name.
targetedAdGroups AdGroupSelector Gets a selector used to filter the list of ad groups targeted by the user list.

getDescription

Gets the user list's description.

Returns

Type Description
string The user list's description.

getEntityType

Gets this entity's type.

Returns

Type Description
string This entity's type, which is UserList.

getId

Gets the ID that uniquely identifies this user list.

Returns

Type Description
string The ID that uniquely identifies this user list.

getMembershipLifeSpan

Gets how far back in time (number of days) Microsoft Advertising should look for actions that match this user list definition.

Returns:

Type Description
string The user list's membership life span (number of days).

getName

Gets this user list's name.

Returns:

Type Description
string The user list's name.

getSizeForAudienceNetwork

Gets this user list's size in the Audience network.

Returns:

Type Description
long The user list's size in the Audience network.

getSizeForSearch

Gets this user list's size in the Search network.

Returns:

Type Description
long The user list's size in the Search network.

getType

Gets this user list's type.

Returns:

Type Description
string The user list's type.

setDescription(string description)

Sets this user list's description.

Arguments

Name Type Description
description string The user list's description.

Returns

Type Description
void Returns nothing.

setMembershipLifeSpan(string membershipLifeSpan)

Sets how far back in time (number of days) Microsoft Advertising should look for actions that match this user list definition.

Arguments

Name Type Description
membershipLifeSpan string The user list's membership life span (number of days).

Returns

Type Description
void Returns nothing.

setName(string name)

Sets this user list's name.

Arguments

Name Type Description
name string The user list's name.

Returns

Type Description
void Returns nothing.

targetedAdGroups

Gets a selector used to filter the list of ad groups targeted by the user list.

Returns

Type Description
AdGroupSelector A selector used to filter the list of ad groups targeted by the user list.

See also

UserListIterator.next()