Struct google_api_proto::google::ads::googleads::v17::resources::UserList

pub struct UserList {

    pub resource_name: String,
    pub id: Option<i64>,
    pub read_only: Option<bool>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub membership_status: i32,
    pub integration_code: Option<String>,
    pub membership_life_span: Option<i64>,
    pub size_for_display: Option<i64>,
    pub size_range_for_display: i32,
    pub size_for_search: Option<i64>,
    pub size_range_for_search: i32,
    pub type: i32,
    pub closing_reason: i32,
    pub access_reason: i32,
    pub account_user_list_status: i32,
    pub eligible_for_search: Option<bool>,
    pub eligible_for_display: Option<bool>,
    pub match_rate_percentage: Option<i32>,
    pub user_list: Option<UserList>,
}

A user list. This is a list of users a customer may target.

Fields

resource_name: String

Immutable. The resource name of the user list. User list resource names have the form:

customers/{customer_id}/userLists/{user_list_id}

id: Option<i64>

Output only. Id of the user list.

read_only: Option<bool>

Output only. An option 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 is read-only.

name: Option<String>

Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)

description: Option<String>

Description of this user list.

membership_status: i32

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.

integration_code: Option<String>

An ID from external system. It is used by user list sellers to correlate IDs on their systems.

membership_life_span: Option<i64>

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.

This field is ignored for logical_user_list and rule_based_user_list types. Membership to lists of these types depends on the rules defined by the lists.

size_for_display: Option<i64>

Output only. 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 is read-only.

size_range_for_display: i32

Output only. Size range in terms of number of users of the UserList, on the Google Display Network.

This field is read-only.

size_for_search: Option<i64>

Output only. 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 is read-only.

size_range_for_search: i32

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

This field is read-only.

type: i32

Output only. Type of this list.

This field is read-only.

closing_reason: i32

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.

access_reason: i32

Output only. Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED.

This field is read-only.

account_user_list_status: i32

Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED.

eligible_for_search: Option<bool>

Indicates if this user list is eligible for Google Search Network.

eligible_for_display: Option<bool>

Output only. Indicates this user list is eligible for Google Display Network.

This field is read-only.

match_rate_percentage: Option<i32>

Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it’s not possible to calculate the match rate.

This field is read-only.

user_list: Option<UserList>

The user list.

Exactly one must be set.

Implementations

impl UserList

pub fn membership_status(&self) -> UserListMembershipStatus

Returns the enum value of membership_status, or the default if the field is set to an invalid enum value.

pub fn set_membership_status(&mut self, value: UserListMembershipStatus)

Sets membership_status to the provided enum value.

pub fn size_range_for_display(&self) -> UserListSizeRange

Returns the enum value of size_range_for_display, or the default if the field is set to an invalid enum value.

pub fn set_size_range_for_display(&mut self, value: UserListSizeRange)

Sets size_range_for_display to the provided enum value.

pub fn size_range_for_search(&self) -> UserListSizeRange

Returns the enum value of size_range_for_search, or the default if the field is set to an invalid enum value.

pub fn set_size_range_for_search(&mut self, value: UserListSizeRange)

Sets size_range_for_search to the provided enum value.

pub fn type(&self) -> UserListType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: UserListType)

Sets type to the provided enum value.

pub fn closing_reason(&self) -> UserListClosingReason

Returns the enum value of closing_reason, or the default if the field is set to an invalid enum value.

pub fn set_closing_reason(&mut self, value: UserListClosingReason)

Sets closing_reason to the provided enum value.

pub fn access_reason(&self) -> AccessReason

Returns the enum value of access_reason, or the default if the field is set to an invalid enum value.

pub fn set_access_reason(&mut self, value: AccessReason)

Sets access_reason to the provided enum value.

pub fn account_user_list_status(&self) -> UserListAccessStatus

Returns the enum value of account_user_list_status, or the default if the field is set to an invalid enum value.

pub fn set_account_user_list_status(&mut self, value: UserListAccessStatus)

Sets account_user_list_status to the provided enum value.

pub fn match_rate_percentage(&self) -> i32

Returns the value of match_rate_percentage, or the default value if match_rate_percentage is unset.

pub fn id(&self) -> i64

Returns the value of id, or the default value if id is unset.

pub fn read_only(&self) -> bool

Returns the value of read_only, or the default value if read_only is unset.

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn description(&self) -> &str

Returns the value of description, or the default value if description is unset.

pub fn integration_code(&self) -> &str

Returns the value of integration_code, or the default value if integration_code is unset.

pub fn membership_life_span(&self) -> i64

Returns the value of membership_life_span, or the default value if membership_life_span is unset.

pub fn size_for_display(&self) -> i64

Returns the value of size_for_display, or the default value if size_for_display is unset.

pub fn size_for_search(&self) -> i64

Returns the value of size_for_search, or the default value if size_for_search is unset.

pub fn eligible_for_search(&self) -> bool

Returns the value of eligible_for_search, or the default value if eligible_for_search is unset.

pub fn eligible_for_display(&self) -> bool

Returns the value of eligible_for_display, or the default value if eligible_for_display is unset.

Trait Implementations

impl Clone for UserList

fn clone(&self) -> UserList

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserList

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UserList

fn default() -> Self

Returns the “default value” for a type.

impl Message for UserList

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for UserList

fn eq(&self, other: &UserList) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserList