com.google.analytics.data.v1alpha

Class RecurringAudienceList

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1alpha.RecurringAudienceList

All Implemented Interfaces:

RecurringAudienceListOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class RecurringAudienceList
extends com.google.protobuf.GeneratedMessageV3
implements RecurringAudienceListOrBuilder

 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.
 

Protobuf type google.analytics.data.v1alpha.RecurringAudienceList

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecurringAudienceList.Builder A recurring audience list produces new audience lists each day.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_DAYS_REMAINING_FIELD_NUMBER
static int	AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
static int	AUDIENCE_FIELD_NUMBER
static int	AUDIENCE_LISTS_FIELD_NUMBER
static int	DIMENSIONS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
com.google.protobuf.ProtocolStringList	getAudienceListsList() Output only.
static RecurringAudienceList	getDefaultInstance()
RecurringAudienceList	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<RecurringAudienceList>	getParserForType()
int	getSerializedSize()
boolean	hasActiveDaysRemaining() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RecurringAudienceList.Builder	newBuilder()
static RecurringAudienceList.Builder	newBuilder(RecurringAudienceList prototype)
RecurringAudienceList.Builder	newBuilderForType()
protected RecurringAudienceList.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RecurringAudienceList	parseDelimitedFrom(InputStream input)
static RecurringAudienceList	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecurringAudienceList	parseFrom(byte[] data)
static RecurringAudienceList	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecurringAudienceList	parseFrom(ByteBuffer data)
static RecurringAudienceList	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecurringAudienceList	parseFrom(com.google.protobuf.ByteString data)
static RecurringAudienceList	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecurringAudienceList	parseFrom(com.google.protobuf.CodedInputStream input)
static RecurringAudienceList	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecurringAudienceList	parseFrom(InputStream input)
static RecurringAudienceList	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RecurringAudienceList>	parser()
RecurringAudienceList.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER

See Also:

Constant Field Values

AUDIENCE_DISPLAY_NAME_FIELD_NUMBER

public static final int AUDIENCE_DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

ACTIVE_DAYS_REMAINING_FIELD_NUMBER

public static final int ACTIVE_DAYS_REMAINING_FIELD_NUMBER

See Also:

Constant Field Values

AUDIENCE_LISTS_FIELD_NUMBER

public static final int AUDIENCE_LISTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public 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];

Specified by:

getName in interface RecurringAudienceListOrBuilder

Returns:

The name.

getNameBytes

public 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];

Specified by:

getNameBytes in interface RecurringAudienceListOrBuilder

Returns:

The bytes for name.

getAudience

public 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];

Specified by:

getAudience in interface RecurringAudienceListOrBuilder

Returns:

The audience.

getAudienceBytes

public 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];

Specified by:

getAudienceBytes in interface RecurringAudienceListOrBuilder

Returns:

The bytes for audience.

getAudienceDisplayName

public 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];

Specified by:

getAudienceDisplayName in interface RecurringAudienceListOrBuilder

Returns:

The audienceDisplayName.

getAudienceDisplayNameBytes

public 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];

Specified by:

getAudienceDisplayNameBytes in interface RecurringAudienceListOrBuilder

Returns:

The bytes for audienceDisplayName.

getDimensionsList

public 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];

Specified by:

getDimensionsList in interface RecurringAudienceListOrBuilder

getDimensionsOrBuilderList

public 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];

Specified by:

getDimensionsOrBuilderList in interface RecurringAudienceListOrBuilder

getDimensionsCount

public 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];

Specified by:

getDimensionsCount in interface RecurringAudienceListOrBuilder

getDimensions

public 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];

Specified by:

getDimensions in interface RecurringAudienceListOrBuilder

getDimensionsOrBuilder

public 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];

Specified by:

getDimensionsOrBuilder in interface RecurringAudienceListOrBuilder

hasActiveDaysRemaining

public 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];

Specified by:

hasActiveDaysRemaining in interface RecurringAudienceListOrBuilder

Returns:

Whether the activeDaysRemaining field is set.

getActiveDaysRemaining

public 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];

Specified by:

getActiveDaysRemaining in interface RecurringAudienceListOrBuilder

Returns:

The activeDaysRemaining.

getAudienceListsList

public com.google.protobuf.ProtocolStringList 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];

Specified by:

getAudienceListsList in interface RecurringAudienceListOrBuilder

Returns:

A list containing the audienceLists.

getAudienceListsCount

public 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];

Specified by:

getAudienceListsCount in interface RecurringAudienceListOrBuilder

Returns:

The count of audienceLists.

getAudienceLists

public 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];

Specified by:

getAudienceLists in interface RecurringAudienceListOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The audienceLists at the given index.

getAudienceListsBytes

public 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];

Specified by:

getAudienceListsBytes in interface RecurringAudienceListOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the audienceLists at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RecurringAudienceList parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecurringAudienceList parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecurringAudienceList parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecurringAudienceList parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecurringAudienceList parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecurringAudienceList parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecurringAudienceList parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static RecurringAudienceList parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static RecurringAudienceList parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static RecurringAudienceList parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static RecurringAudienceList parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static RecurringAudienceList parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public RecurringAudienceList.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RecurringAudienceList.Builder newBuilder()

newBuilder

public static RecurringAudienceList.Builder newBuilder(RecurringAudienceList prototype)

toBuilder

public RecurringAudienceList.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RecurringAudienceList.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RecurringAudienceList getDefaultInstance()

parser

public static com.google.protobuf.Parser<RecurringAudienceList> parser()

getParserForType

public com.google.protobuf.Parser<RecurringAudienceList> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RecurringAudienceList getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder