Struct Audience

pub struct Audience {
    pub resource_name: String,
    pub id: i64,
    pub status: i32,
    pub name: String,
    pub description: String,
    pub dimensions: Vec<AudienceDimension>,
    pub exclusion_dimension: Option<AudienceExclusionDimension>,
    pub scope: i32,
    pub asset_group: String,
}

Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.

Fields

resource_name: String

Immutable. The resource name of the audience. Audience names have the form:

customers/{customer_id}/audiences/{audience_id}

id: i64

Output only. ID of the audience.

status: i32

Output only. Status of this audience. Indicates whether the audience is enabled or removed.

name: String

Name of the audience. It should be unique across all audiences within the account. It must have a minimum length of 1 and maximum length of 255. Required when scope is not set or is set to CUSTOMER. Cannot be set or updated when scope is ASSET_GROUP.

description: String

Description of this audience.

dimensions: Vec<AudienceDimension>

Positive dimensions specifying the audience composition.

exclusion_dimension: Option<AudienceExclusionDimension>

Negative dimension specifying the audience composition.

scope: i32

Defines the scope this audience can be used in. By default, the scope is CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for exclusive use by a single asset_group. Scope may change from ASSET_GROUP to CUSTOMER but not from CUSTOMER to ASSET_GROUP.

asset_group: String

Immutable. The asset group that this audience is scoped under. Must be set if and only if scope is ASSET_GROUP. Immutable after creation. If an audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field will automatically be cleared.

Implementations

impl Audience

pub fn status(&self) -> AudienceStatus

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

pub fn set_status(&mut self, value: AudienceStatus)

Sets status to the provided enum value.

pub fn scope(&self) -> AudienceScope

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

pub fn set_scope(&mut self, value: AudienceScope)

Sets scope to the provided enum value.

Trait Implementations

impl Clone for Audience

fn clone(&self) -> Audience

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Audience

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

Formats the value using the given formatter.

impl Default for Audience

fn default() -> Self

Returns the “default value” for a type.

impl Message for Audience

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for Audience

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Audience