AdsApp.​UserList

    • The content describes a Google Ads user list entity and provides methods to interact with it.

    • You can get and set properties like description, membership lifespan, and name for a user list.

    • Methods are available to check eligibility, status (open/closed, read-only), and estimated size of the user list for both Display and Search networks.

    • You can retrieve selectors for ad groups and campaigns that are either targeting or negatively targeting the user list.

     Represents a Google Ads user list.

    Methods:

    Member Type Description
    close()
    		void Close user list so it will no longer accumulate new members.
    excludedAdGroups()
    		AdsApp.AdGroupSelector Returns a selector of all the search and display ad groups negatively targeting this user list.
    excludedCampaigns()
    		AdsApp.CampaignSelector Returns a selector of all the search and display campaigns negatively targeting this user list.
    getDescription()
    		String Returns the description of the user list.
    getEntityType()
    		String Returns the type of this entity as a String , in this case, "UserList" .
    getId()
    		String 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.
    getResourceName()
    		String Returns the resource 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(description)
    		void Sets the description of the user list.
    setMembershipLifeSpan(membershipLifeSpan)
    		void Sets the number of days a user's cookie stays on your list since its most recent addition to the list.
    setName(name)
    		void Sets the name of the user list.
    targetedAdGroups()
    		AdsApp.AdGroupSelector Returns a selector of all the search and display ad groups targeting this user list.
    targetedCampaigns()
    		AdsApp.CampaignSelector Returns a selector of all the search and display 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 and display ad groups negatively targeting this user list.

    Return values:

    Type Description
    AdsApp.AdGroupSelector The selector of excluded ad groups.

    excludedCampaigns()

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

    Return values:

    Type Description
    AdsApp.CampaignSelector The selector of excluded campaigns.

    getDescription()

    Returns the description of the user list.

    Return values:

    Type Description
    String Description of the user list.

    getEntityType()

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

    Return values:

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

    getId()

    Returns the ID of the user list.

    Return values:

    Type Description
    String 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:

    Type Description
    long Number of days a user is a member.

    getName()

    Returns the name of the user list.

    Return values:

    Type Description
    String Name of the user list.

    getResourceName()

    Returns the resource name of the user list.

    Return values:

    Type Description
    String The resource 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:

    Type Description
    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:

    Type Description
    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:

    Type Description
    String Size range of the list.

    getSizeRangeForSearch()

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

    Return values:

    Type Description
    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:

    Type Description
    String Type type of user list.

    isClosed()

    Is the user list closed to new members being added.

    Return values:

    Type Description
    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:

    Type Description
    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:

    Type Description
    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:

    Type Description
    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:

    Type Description
    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:

    Name Type Description
    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:

    Name Type Description
    membershipLifeSpan
    		 long Number of days a user is a member.

    setName(name)

    Sets the name of the user list.

    Returns nothing.

    Arguments:

    Name Type Description
    name
    		 String The new name for user list.

    targetedAdGroups()

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

    Return values:

    Type Description
    AdsApp.AdGroupSelector The selector of targeted ad groups.

    targetedCampaigns()

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

    Return values:

    Type Description
    AdsApp.CampaignSelector The selector of targeted campaigns.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: