Class AudienceExport

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.

Inheritance
object
AudienceExport
Implements
Inherited Members
Namespace: Google.Analytics.Data.V1Beta
Assembly: Google.Analytics.Data.V1Beta.dll
Syntax
public sealed class AudienceExport : IMessage<AudienceExport>, IEquatable<AudienceExport>, IDeepCloneable<AudienceExport>, IBufferMessage, IMessage

Constructors

AudienceExport()

Declaration
public AudienceExport()

AudienceExport(AudienceExport)

Declaration
public AudienceExport(AudienceExport other)
Parameters
Type Name Description
AudienceExport other

Properties

Audience

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}

Declaration
public string Audience { get; set; }
Property Value
Type Description
string

AudienceDisplayName

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

Declaration
public string AudienceDisplayName { get; set; }
Property Value
Type Description
string

AudienceExportName

AudienceExportName-typed view over the Name resource name property.

Declaration
public AudienceExportName AudienceExportName { get; set; }
Property Value
Type Description
AudienceExportName

BeginCreatingTime

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

Declaration
public Timestamp BeginCreatingTime { get; set; }
Property Value
Type Description
Timestamp

CreationQuotaTokensCharged

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.

Declaration
public int CreationQuotaTokensCharged { get; set; }
Property Value
Type Description
int

Dimensions

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

Declaration
public RepeatedField<AudienceDimension> Dimensions { get; }
Property Value
Type Description
RepeatedField<AudienceDimension>

ErrorMessage

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

Declaration
public string ErrorMessage { get; set; }
Property Value
Type Description
string

HasErrorMessage

Gets whether the "error_message" field is set

Declaration
public bool HasErrorMessage { get; }
Property Value
Type Description
bool

HasPercentageCompleted

Gets whether the "percentage_completed" field is set

Declaration
public bool HasPercentageCompleted { get; }
Property Value
Type Description
bool

HasRowCount

Gets whether the "row_count" field is set

Declaration
public bool HasRowCount { get; }
Property Value
Type Description
bool

HasState

Gets whether the "state" field is set

Declaration
public bool HasState { get; }
Property Value
Type Description
bool

Name

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

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

Declaration
public string Name { get; set; }
Property Value
Type Description
string

PercentageCompleted

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

Declaration
public double PercentageCompleted { get; set; }
Property Value
Type Description
double

RowCount

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

Declaration
public int RowCount { get; set; }
Property Value
Type Description
int

State

Output only. The current state for this AudienceExport.

Declaration
public AudienceExport.Types.State State { get; set; }
Property Value
Type Description
AudienceExport.Types.State