com.google.analytics.data.v1alpha

Interface RecurringAudienceListOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RecurringAudienceList, RecurringAudienceList.Builder

public interface RecurringAudienceListOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getActiveDaysRemaining() Optional.
String	getAudience() Required.
com.google.protobuf.ByteString	getAudienceBytes() Required.
String	getAudienceDisplayName() Output only.
com.google.protobuf.ByteString	getAudienceDisplayNameBytes() Output only.
String	getAudienceLists(int index) Output only.
com.google.protobuf.ByteString	getAudienceListsBytes(int index) Output only.
int	getAudienceListsCount() Output only.
List<String>	getAudienceListsList() Output only.
AudienceDimension	getDimensions(int index) Required.
int	getDimensionsCount() Required.
List<AudienceDimension>	getDimensionsList() Required.
AudienceDimensionOrBuilder	getDimensionsOrBuilder(int index) Required.
List<? extends AudienceDimensionOrBuilder>	getDimensionsOrBuilderList() Required.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
boolean	hasActiveDaysRemaining() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 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}`
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 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}`
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getAudience

String getAudience()

 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}`
 

string audience = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The audience.

getAudienceBytes

com.google.protobuf.ByteString getAudienceBytes()

 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}`
 

string audience = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for audience.

getAudienceDisplayName

String getAudienceDisplayName()

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

string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The audienceDisplayName.

getAudienceDisplayNameBytes

com.google.protobuf.ByteString getAudienceDisplayNameBytes()

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

string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for audienceDisplayName.

getDimensionsList

List<AudienceDimension> getDimensionsList()

 Required. The dimensions requested and displayed in the audience list
 response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

getDimensions

AudienceDimension getDimensions(int index)

 Required. The dimensions requested and displayed in the audience list
 response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

getDimensionsCount

int getDimensionsCount()

 Required. The dimensions requested and displayed in the audience list
 response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

getDimensionsOrBuilderList

List<? extends AudienceDimensionOrBuilder> getDimensionsOrBuilderList()

 Required. The dimensions requested and displayed in the audience list
 response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

getDimensionsOrBuilder

AudienceDimensionOrBuilder getDimensionsOrBuilder(int index)

 Required. The dimensions requested and displayed in the audience list
 response.
 

repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

hasActiveDaysRemaining

boolean hasActiveDaysRemaining()

 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.
 

optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the activeDaysRemaining field is set.

getActiveDaysRemaining

int getActiveDaysRemaining()

 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.
 

optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The activeDaysRemaining.

getAudienceListsList

List<String> getAudienceListsList()

 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.
 

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

A list containing the audienceLists.

getAudienceListsCount

int getAudienceListsCount()

 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.
 

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The count of audienceLists.

getAudienceLists

String getAudienceLists(int index)

 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.
 

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the element to return.

Returns:

The audienceLists at the given index.

getAudienceListsBytes

com.google.protobuf.ByteString getAudienceListsBytes(int index)

 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.
 

repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the audienceLists at the given index.