Struct googapis::google::ads::googleads::v8::resources::UserList [−][src]
pub struct UserList {Show 20 fields
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>,
}
Expand description
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. 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 is read-only.
name: Option<String>
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. 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.
It’ll be ignored for logical_user_list.
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
Returns the enum value of membership_status
, or the default if the field is set to an invalid enum value.
Sets membership_status
to the provided enum value.
Returns the enum value of size_range_for_display
, or the default if the field is set to an invalid enum value.
Sets size_range_for_display
to the provided enum value.
Returns the enum value of size_range_for_search
, or the default if the field is set to an invalid enum value.
Sets size_range_for_search
to the provided enum value.
Returns the enum value of type
, or the default if the field is set to an invalid enum value.
Sets type
to the provided enum value.
Returns the enum value of closing_reason
, or the default if the field is set to an invalid enum value.
Sets closing_reason
to the provided enum value.
Returns the enum value of access_reason
, or the default if the field is set to an invalid enum value.
Sets access_reason
to the provided enum value.
Returns the enum value of account_user_list_status
, or the default if the field is set to an invalid enum value.
Sets account_user_list_status
to the provided enum value.
Returns the value of match_rate_percentage
, or the default value if match_rate_percentage
is unset.
Returns the value of read_only
, or the default value if read_only
is unset.
Returns the value of description
, or the default value if description
is unset.
Returns the value of integration_code
, or the default value if integration_code
is unset.
Returns the value of membership_life_span
, or the default value if membership_life_span
is unset.
Returns the value of size_for_display
, or the default value if size_for_display
is unset.
Returns the value of size_for_search
, or the default value if size_for_search
is unset.
Returns the value of eligible_for_search
, or the default value if eligible_for_search
is unset.
Returns the value of eligible_for_display
, or the default value if eligible_for_display
is unset.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for UserList
impl UnwindSafe for UserList
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more