Struct google_api_proto::google::analytics::data::v1alpha::RecurringAudienceList

pub struct RecurringAudienceList {
    pub name: String,
    pub audience: String,
    pub audience_display_name: String,
    pub dimensions: Vec<AudienceDimension>,
    pub active_days_remaining: Option<i32>,
    pub audience_lists: Vec<String>,
    pub webhook_notification: Option<WebhookNotification>,
}

A recurring audience list produces new audience lists each day. Audience lists are users in an audience at the time of the list’s creation. A recurring audience list ensures that you have audience list based on the most recent data available for use each day.

Fields

name: String

Output only. Identifier. The recurring audience list resource name assigned during creation. This resource name identifies this RecurringAudienceList.

Format: properties/{property}/recurringAudienceLists/{recurring_audience_list}

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 audience list response.

active_days_remaining: Option<i32>

Optional. The number of remaining days that a recurring audience export will produce an audience list instance. This counter decreases by one each day, and when it reaches zero, no new audience lists will be created.

Recurring audience list request for Analytics 360 properties default to 180 days and have a maximum of 365 days. Requests for standard Analytics properties default to 14 days and have a maximum of 30 days.

The minimum value allowed during creation is 1. Requests above their respective maximum will be coerced to their maximum.

audience_lists: Vec<String>

Output only. Audience list resource names for audience list instances created for this recurring audience list. One audience list is created for each day, and the audience list will be listed here.

This list is ordered with the most recently created audience list first.

webhook_notification: Option<WebhookNotification>

Optional. Configures webhook notifications to be sent from the Google Analytics Data API to your webhook server. Use of webhooks is optional. If unused, you’ll need to poll this API to determine when a recurring audience list creates new audience lists. Webhooks allow a notification to be sent to your servers & avoid the need for polling.

Two POST requests will be sent each time a recurring audience list creates an audience list. This happens once per day until a recurring audience list reaches 0 active days remaining. The first request will be sent showing a newly created audience list in its CREATING state. The second request will be sent after the audience list completes creation (either the ACTIVE or FAILED state).

Implementations

impl RecurringAudienceList

pub fn active_days_remaining(&self) -> i32

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

Trait Implementations

impl Clone for RecurringAudienceList

fn clone(&self) -> RecurringAudienceList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecurringAudienceList

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

Formats the value using the given formatter.

impl Default for RecurringAudienceList

fn default() -> Self

Returns the “default value” for a type.

impl Message for RecurringAudienceList

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 RecurringAudienceList

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