Struct google_api_proto::google::analytics::data::v1beta::AudienceExport

pub struct AudienceExport {
    pub name: String,
    pub audience: String,
    pub audience_display_name: String,
    pub dimensions: Vec<AudienceDimension>,
    pub state: Option<i32>,
    pub begin_creating_time: Option<Timestamp>,
    pub creation_quota_tokens_charged: i32,
    pub row_count: Option<i32>,
    pub error_message: Option<String>,
    pub percentage_completed: Option<f64>,
}

An audience export is a list of users in an audience at the time of the list’s creation. One audience may have multiple audience exports created for different days.

Fields

name: String

Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport.

Format: properties/{property}/audienceExports/{audience_export}

audience: String

Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs.

Format: properties/{property}/audiences/{audience}

audience_display_name: String

Output only. The descriptive display name for this audience. For example, “Purchasers”.

dimensions: Vec<AudienceDimension>

Required. The dimensions requested and displayed in the query response.

state: Option<i32>

Output only. The current state for this AudienceExport.

begin_creating_time: Option<Timestamp>

Output only. The time when CreateAudienceExport was called and the AudienceExport began the CREATING state.

creation_quota_tokens_charged: i32

Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceExport enters the ACTIVE or FAILED states.

row_count: Option<i32>

Output only. The total number of rows in the AudienceExport result.

error_message: Option<String>

Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.

percentage_completed: Option<f64>

Output only. The percentage completed for this audience export ranging between 0 to 100.

Implementations

impl AudienceExport

pub fn state(&self) -> State

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

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn row_count(&self) -> i32

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

pub fn error_message(&self) -> &str

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

pub fn percentage_completed(&self) -> f64

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

Trait Implementations

impl Clone for AudienceExport

fn clone(&self) -> AudienceExport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudienceExport

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

Formats the value using the given formatter.

impl Default for AudienceExport

fn default() -> Self

Returns the “default value” for a type.

impl Message for AudienceExport

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 AudienceExport

fn eq(&self, other: &AudienceExport) -> 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 AudienceExport