Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.UserList Class Reference

Represents a UserList object that is sent over the wire. This is a list of users an account may target. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.UserList:
Google.Api.Ads.AdWords.v201809.BasicUserList Google.Api.Ads.AdWords.v201809.CrmBasedUserList Google.Api.Ads.AdWords.v201809.LogicalUserList Google.Api.Ads.AdWords.v201809.RuleBasedUserList Google.Api.Ads.AdWords.v201809.SimilarUserList Google.Api.Ads.AdWords.v201809.CombinedRuleUserList Google.Api.Ads.AdWords.v201809.DateSpecificRuleUserList Google.Api.Ads.AdWords.v201809.ExpressionRuleUserList

Classes

class  Fields
 List of all supported fields for the UserList class. More...
 
class  FilterableFields
 List of all supported filterable fields for the UserList class. More...
 
class  SelectableFields
 List of all supported selectable fields for the UserList class. More...
 

Properties

long id [get, set]
 Id of this user list. This field can be selected using the value "Id".This field can be filtered on. This field is required and should not be More...
 
bool idSpecified [get, set]
 
bool isReadOnly [get, set]
 A flag that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field can be selected using the value "IsReadOnly". This field is read only and will be ignored when sent to the API. More...
 
bool isReadOnlySpecified [get, set]
 
string name [get, set]
 Name of this user list. Depending on its AccessReason, the user list name may not be unique (e.g. if More...
 
string description [get, set]
 Description of this user list. This field can be selected using the value "Description". More...
 
UserListMembershipStatus status [get, set]
 Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to. This field can be selected using the value "Status".This field can be filtered on. More...
 
bool statusSpecified [get, set]
 
string integrationCode [get, set]
 An Id from external system. It is used by user list sellers to correlate ids on their systems. This field can be selected using the value "IntegrationCode".This field can be filtered on. More...
 
AccessReason accessReason [get, set]
 Indicates the reason this account has been granted access to the list. The reason can be Shared, Owned, Licensed or Subscribed. This field can be selected using the value "AccessReason".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool accessReasonSpecified [get, set]
 
AccountUserListStatus accountUserListStatus [get, set]
 Indicates if this share is still active. When a UserList is shared with the user this field is set to Active. Later the userList owner can decide to revoke the share and make it Inactive. The default value of this field is set to Active. This field can be selected using the value "AccountUserListStatus".This field can be filtered on. More...
 
bool accountUserListStatusSpecified [get, set]
 
long membershipLifeSpan [get, set]
 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 userlists, this field can be set to 10000 which means no expiration. More...
 
bool membershipLifeSpanSpecified [get, set]
 
long size [get, set]
 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. This field can be selected using the value "Size".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool sizeSpecified [get, set]
 
SizeRange sizeRange [get, set]
 Size range in terms of number of users of the UserList. This field can be selected using the value "SizeRange". This field is read only and will be ignored when sent to the API. More...
 
bool sizeRangeSpecified [get, set]
 
long sizeForSearch [get, set]
 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. This field can be selected using the value "SizeForSearch".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool sizeForSearchSpecified [get, set]
 
SizeRange sizeRangeForSearch [get, set]
 Size range in terms of number of users of the UserList, for Search ads. This field can be selected using the value "SizeRangeForSearch". This field is read only and will be ignored when sent to the API. More...
 
bool sizeRangeForSearchSpecified [get, set]
 
UserListType listType [get, set]
 Type of this list: remarketing/logical/external remarketing. This field can be selected using the value "ListType".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool listTypeSpecified [get, set]
 
bool isEligibleForSearch [get, set]
 A flag that indicates this user list is eligible for Google Search Network. This field can be selected using the value "IsEligibleForSearch".This field can be filtered on. More...
 
bool isEligibleForSearchSpecified [get, set]
 
bool isEligibleForDisplay [get, set]
 A flag that indicates this user list is eligible for Display Network. This field can be selected using the value "IsEligibleForDisplay".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool isEligibleForDisplaySpecified [get, set]
 
UserListClosingReason closingReason [get, set]
 Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open. This field can be selected using the value "ClosingReason".This field can be filtered on. More...
 
bool closingReasonSpecified [get, set]
 
string UserListType [get, set]
 Indicates that this instance is a subtype of UserList. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead. More...
 

Detailed Description

Represents a UserList object that is sent over the wire. This is a list of users an account may target.

Property Documentation

AccessReason Google.Api.Ads.AdWords.v201809.UserList.accessReason
getset

Indicates the reason this account has been granted access to the list. The reason can be Shared, Owned, Licensed or Subscribed. This field can be selected using the value "AccessReason".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.UserList.accessReasonSpecified
getset

true, if a value is specified for accessReason, false otherwise.

AccountUserListStatus Google.Api.Ads.AdWords.v201809.UserList.accountUserListStatus
getset

Indicates if this share is still active. When a UserList is shared with the user this field is set to Active. Later the userList owner can decide to revoke the share and make it Inactive. The default value of this field is set to Active. This field can be selected using the value "AccountUserListStatus".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.UserList.accountUserListStatusSpecified
getset

true, if a value is specified for accountUserListStatus, false otherwise.

UserListClosingReason Google.Api.Ads.AdWords.v201809.UserList.closingReason
getset

Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open. This field can be selected using the value "ClosingReason".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.UserList.closingReasonSpecified
getset

true, if a value is specified for closingReason, false otherwise.

string Google.Api.Ads.AdWords.v201809.UserList.description
getset

Description of this user list. This field can be selected using the value "Description".

long Google.Api.Ads.AdWords.v201809.UserList.id
getset

Id of this user list. This field can be selected using the value "Id".This field can be filtered on. This field is required and should not be

null when it is contained within Operators : SET.

bool Google.Api.Ads.AdWords.v201809.UserList.idSpecified
getset

true, if a value is specified for id, false otherwise.

string Google.Api.Ads.AdWords.v201809.UserList.integrationCode
getset

An Id from external system. It is used by user list sellers to correlate ids on their systems. This field can be selected using the value "IntegrationCode".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.UserList.isEligibleForDisplay
getset

A flag that indicates this user list is eligible for Display Network. This field can be selected using the value "IsEligibleForDisplay".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.UserList.isEligibleForDisplaySpecified
getset

true, if a value is specified for isEligibleForDisplay, false otherwise.

bool Google.Api.Ads.AdWords.v201809.UserList.isEligibleForSearch
getset

A flag that indicates this user list is eligible for Google Search Network. This field can be selected using the value "IsEligibleForSearch".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.UserList.isEligibleForSearchSpecified
getset

true, if a value is specified for isEligibleForSearch, false otherwise.

bool Google.Api.Ads.AdWords.v201809.UserList.isReadOnly
getset

A flag that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field can be selected using the value "IsReadOnly". This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.UserList.isReadOnlySpecified
getset

true, if a value is specified for isReadOnly, false otherwise.

UserListType Google.Api.Ads.AdWords.v201809.UserList.listType
getset

Type of this list: remarketing/logical/external remarketing. This field can be selected using the value "ListType".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.UserList.listTypeSpecified
getset

true, if a value is specified for listType, false otherwise.

long Google.Api.Ads.AdWords.v201809.UserList.membershipLifeSpan
getset

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 userlists, this field can be set to 10000 which means no expiration.

It'll be ignored for LogicalUserList. This field can be selected using the value "MembershipLifeSpan".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.UserList.membershipLifeSpanSpecified
getset

true, if a value is specified for membershipLifeSpan, false otherwise.

string Google.Api.Ads.AdWords.v201809.UserList.name
getset

Name of this user list. Depending on its AccessReason, the user list name may not be unique (e.g. if

AccessReason=SHARED). This field can be selected using the value "Name".This field can be filtered on.

long Google.Api.Ads.AdWords.v201809.UserList.size
getset

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. This field can be selected using the value "Size".This field can be filtered on. This field is read only and will be ignored when sent to the API.

long Google.Api.Ads.AdWords.v201809.UserList.sizeForSearch
getset

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. This field can be selected using the value "SizeForSearch".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.UserList.sizeForSearchSpecified
getset

true, if a value is specified for sizeForSearch, false otherwise.

SizeRange Google.Api.Ads.AdWords.v201809.UserList.sizeRange
getset

Size range in terms of number of users of the UserList. This field can be selected using the value "SizeRange". This field is read only and will be ignored when sent to the API.

SizeRange Google.Api.Ads.AdWords.v201809.UserList.sizeRangeForSearch
getset

Size range in terms of number of users of the UserList, for Search ads. This field can be selected using the value "SizeRangeForSearch". This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.UserList.sizeRangeForSearchSpecified
getset

true, if a value is specified for sizeRangeForSearch, false otherwise.

bool Google.Api.Ads.AdWords.v201809.UserList.sizeRangeSpecified
getset

true, if a value is specified for sizeRange, false otherwise.

bool Google.Api.Ads.AdWords.v201809.UserList.sizeSpecified
getset

true, if a value is specified for size, false otherwise.

UserListMembershipStatus Google.Api.Ads.AdWords.v201809.UserList.status
getset

Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to. This field can be selected using the value "Status".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.UserList.statusSpecified
getset

true, if a value is specified for status, false otherwise.

string Google.Api.Ads.AdWords.v201809.UserList.UserListType
getset

Indicates that this instance is a subtype of UserList. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.


The documentation for this class was generated from the following file: