Class AudienceList.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AudienceList.Builder>
com.google.analytics.data.v1alpha.AudienceList.Builder
- All Implemented Interfaces:
AudienceListOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- AudienceList
public static final class AudienceList.Builder
extends com.google.protobuf.GeneratedMessage.Builder<AudienceList.Builder>
implements AudienceListOrBuilder
An audience list is a list of users in an audience at the time of the list's creation. One audience may have multiple audience lists created for different days.Protobuf type
google.analytics.data.v1alpha.AudienceList-
Method Summary
Modifier and TypeMethodDescriptionaddAllDimensions(Iterable<? extends AudienceDimension> values) Required.addDimensions(int index, AudienceDimension value) Required.addDimensions(int index, AudienceDimension.Builder builderForValue) Required.addDimensions(AudienceDimension value) Required.addDimensions(AudienceDimension.Builder builderForValue) Required.Required.addDimensionsBuilder(int index) Required.build()clear()Required.Output only.Output only.Output only.Required.Output only.Output only.Output only.Output only.Output only.Output only.Optional.Required.com.google.protobuf.ByteStringRequired.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.Timestamp.BuilderOutput only.com.google.protobuf.TimestampOrBuilderOutput only.intOutput only.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetDimensions(int index) Required.getDimensionsBuilder(int index) Required.Required.intRequired.Required.getDimensionsOrBuilder(int index) Required.List<? extends AudienceDimensionOrBuilder>Required.Output only.com.google.protobuf.ByteStringOutput only.getName()Output only.com.google.protobuf.ByteStringOutput only.doubleOutput only.Output only.com.google.protobuf.ByteStringOutput only.intOutput only.getState()Output only.intOutput only.Optional.Optional.Optional.booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanhasState()Output only.booleanOptional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeBeginCreatingTime(com.google.protobuf.Timestamp value) Output only.mergeFrom(AudienceList other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Optional.removeDimensions(int index) Required.setAudience(String value) Required.setAudienceBytes(com.google.protobuf.ByteString value) Required.setAudienceDisplayName(String value) Output only.setAudienceDisplayNameBytes(com.google.protobuf.ByteString value) Output only.setBeginCreatingTime(com.google.protobuf.Timestamp value) Output only.setBeginCreatingTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.setCreationQuotaTokensCharged(int value) Output only.setDimensions(int index, AudienceDimension value) Required.setDimensions(int index, AudienceDimension.Builder builderForValue) Required.setErrorMessage(String value) Output only.setErrorMessageBytes(com.google.protobuf.ByteString value) Output only.Output only.setNameBytes(com.google.protobuf.ByteString value) Output only.setPercentageCompleted(double value) Output only.setRecurringAudienceList(String value) Output only.setRecurringAudienceListBytes(com.google.protobuf.ByteString value) Output only.setRowCount(int value) Output only.setState(AudienceList.State value) Output only.setStateValue(int value) Output only.Optional.setWebhookNotification(WebhookNotification.Builder builderForValue) Optional.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<AudienceList.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<AudienceList.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<AudienceList.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AudienceList.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<AudienceList.Builder>
-
mergeFrom
public AudienceList.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AudienceList.Builder>- Throws:
IOException
-
getName
Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this `AudienceList`. Format: `properties/{property}/audienceLists/{audience_list}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNamein interfaceAudienceListOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this `AudienceList`. Format: `properties/{property}/audienceLists/{audience_list}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNameBytesin interfaceAudienceListOrBuilder- Returns:
- The bytes for name.
-
setName
Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this `AudienceList`. Format: `properties/{property}/audienceLists/{audience_list}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this `AudienceList`. Format: `properties/{property}/audienceLists/{audience_list}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
setNameBytes
Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this `AudienceList`. Format: `properties/{property}/audienceLists/{audience_list}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
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:
getAudiencein interfaceAudienceListOrBuilder- 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:
getAudienceBytesin interfaceAudienceListOrBuilder- Returns:
- The bytes for audience.
-
setAudience
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];- Parameters:
value- The audience to set.- Returns:
- This builder for chaining.
-
clearAudience
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:
- This builder for chaining.
-
setAudienceBytes
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];- Parameters:
value- The bytes for audience to set.- Returns:
- This builder for chaining.
-
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:
getAudienceDisplayNamein interfaceAudienceListOrBuilder- 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:
getAudienceDisplayNameBytesin interfaceAudienceListOrBuilder- Returns:
- The bytes for audienceDisplayName.
-
setAudienceDisplayName
Output only. The descriptive display name for this audience. For example, "Purchasers".
string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The audienceDisplayName to set.- Returns:
- This builder for chaining.
-
clearAudienceDisplayName
Output only. The descriptive display name for this audience. For example, "Purchasers".
string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
setAudienceDisplayNameBytes
Output only. The descriptive display name for this audience. For example, "Purchasers".
string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The bytes for audienceDisplayName to set.- Returns:
- This builder for chaining.
-
getDimensionsList
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDimensionsListin interfaceAudienceListOrBuilder
-
getDimensionsCount
public int getDimensionsCount()Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDimensionsCountin interfaceAudienceListOrBuilder
-
getDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDimensionsin interfaceAudienceListOrBuilder
-
setDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
setDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addAllDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
clearDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
removeDimensions
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
getDimensionsBuilder
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
getDimensionsOrBuilder
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDimensionsOrBuilderin interfaceAudienceListOrBuilder
-
getDimensionsOrBuilderList
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDimensionsOrBuilderListin interfaceAudienceListOrBuilder
-
addDimensionsBuilder
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensionsBuilder
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
getDimensionsBuilderList
Required. The dimensions requested and displayed in the query response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
hasState
public boolean hasState()Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasStatein interfaceAudienceListOrBuilder- Returns:
- Whether the state field is set.
-
getStateValue
public int getStateValue()Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein interfaceAudienceListOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
setStateValue
Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for state to set.- Returns:
- This builder for chaining.
-
getState
Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceAudienceListOrBuilder- Returns:
- The state.
-
setState
Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The state to set.- Returns:
- This builder for chaining.
-
clearState
Output only. The current state for this AudienceList.
optional .google.analytics.data.v1alpha.AudienceList.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasBeginCreatingTime
public boolean hasBeginCreatingTime()Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasBeginCreatingTimein interfaceAudienceListOrBuilder- Returns:
- Whether the beginCreatingTime field is set.
-
getBeginCreatingTime
public com.google.protobuf.Timestamp getBeginCreatingTime()Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getBeginCreatingTimein interfaceAudienceListOrBuilder- Returns:
- The beginCreatingTime.
-
setBeginCreatingTime
Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
setBeginCreatingTime
public AudienceList.Builder setBeginCreatingTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
mergeBeginCreatingTime
Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
clearBeginCreatingTime
Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getBeginCreatingTimeBuilder
public com.google.protobuf.Timestamp.Builder getBeginCreatingTimeBuilder()Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getBeginCreatingTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getBeginCreatingTimeOrBuilder()Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state.
optional .google.protobuf.Timestamp begin_creating_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getBeginCreatingTimeOrBuilderin interfaceAudienceListOrBuilder
-
getCreationQuotaTokensCharged
public int getCreationQuotaTokensCharged()Output only. The total quota tokens charged during creation of the AudienceList. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceList enters the `ACTIVE` or `FAILED` states.
int32 creation_quota_tokens_charged = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreationQuotaTokensChargedin interfaceAudienceListOrBuilder- Returns:
- The creationQuotaTokensCharged.
-
setCreationQuotaTokensCharged
Output only. The total quota tokens charged during creation of the AudienceList. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceList enters the `ACTIVE` or `FAILED` states.
int32 creation_quota_tokens_charged = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The creationQuotaTokensCharged to set.- Returns:
- This builder for chaining.
-
clearCreationQuotaTokensCharged
Output only. The total quota tokens charged during creation of the AudienceList. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceList enters the `ACTIVE` or `FAILED` states.
int32 creation_quota_tokens_charged = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasRowCount
public boolean hasRowCount()Output only. The total number of rows in the AudienceList result.
optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasRowCountin interfaceAudienceListOrBuilder- Returns:
- Whether the rowCount field is set.
-
getRowCount
public int getRowCount()Output only. The total number of rows in the AudienceList result.
optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRowCountin interfaceAudienceListOrBuilder- Returns:
- The rowCount.
-
setRowCount
Output only. The total number of rows in the AudienceList result.
optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The rowCount to set.- Returns:
- This builder for chaining.
-
clearRowCount
Output only. The total number of rows in the AudienceList result.
optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasErrorMessage
public boolean hasErrorMessage()Output only. Error message is populated when an audience list fails during creation. A common reason for such a failure is quota exhaustion.
optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasErrorMessagein interfaceAudienceListOrBuilder- Returns:
- Whether the errorMessage field is set.
-
getErrorMessage
Output only. Error message is populated when an audience list fails during creation. A common reason for such a failure is quota exhaustion.
optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getErrorMessagein interfaceAudienceListOrBuilder- Returns:
- The errorMessage.
-
getErrorMessageBytes
public com.google.protobuf.ByteString getErrorMessageBytes()Output only. Error message is populated when an audience list fails during creation. A common reason for such a failure is quota exhaustion.
optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getErrorMessageBytesin interfaceAudienceListOrBuilder- Returns:
- The bytes for errorMessage.
-
setErrorMessage
Output only. Error message is populated when an audience list fails during creation. A common reason for such a failure is quota exhaustion.
optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The errorMessage to set.- Returns:
- This builder for chaining.
-
clearErrorMessage
Output only. Error message is populated when an audience list fails during creation. A common reason for such a failure is quota exhaustion.
optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
setErrorMessageBytes
Output only. Error message is populated when an audience list fails during creation. A common reason for such a failure is quota exhaustion.
optional string error_message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The bytes for errorMessage to set.- Returns:
- This builder for chaining.
-
hasPercentageCompleted
public boolean hasPercentageCompleted()Output only. The percentage completed for this audience export ranging between 0 to 100.
optional double percentage_completed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasPercentageCompletedin interfaceAudienceListOrBuilder- Returns:
- Whether the percentageCompleted field is set.
-
getPercentageCompleted
public double getPercentageCompleted()Output only. The percentage completed for this audience export ranging between 0 to 100.
optional double percentage_completed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPercentageCompletedin interfaceAudienceListOrBuilder- Returns:
- The percentageCompleted.
-
setPercentageCompleted
Output only. The percentage completed for this audience export ranging between 0 to 100.
optional double percentage_completed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The percentageCompleted to set.- Returns:
- This builder for chaining.
-
clearPercentageCompleted
Output only. The percentage completed for this audience export ranging between 0 to 100.
optional double percentage_completed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasRecurringAudienceList
public boolean hasRecurringAudienceList()Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.
optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasRecurringAudienceListin interfaceAudienceListOrBuilder- Returns:
- Whether the recurringAudienceList field is set.
-
getRecurringAudienceList
Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.
optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRecurringAudienceListin interfaceAudienceListOrBuilder- Returns:
- The recurringAudienceList.
-
getRecurringAudienceListBytes
public com.google.protobuf.ByteString getRecurringAudienceListBytes()Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.
optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRecurringAudienceListBytesin interfaceAudienceListOrBuilder- Returns:
- The bytes for recurringAudienceList.
-
setRecurringAudienceList
Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.
optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The recurringAudienceList to set.- Returns:
- This builder for chaining.
-
clearRecurringAudienceList
Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.
optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
setRecurringAudienceListBytes
Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank.
optional string recurring_audience_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The bytes for recurringAudienceList to set.- Returns:
- This builder for chaining.
-
hasWebhookNotification
public boolean hasWebhookNotification()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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasWebhookNotificationin interfaceAudienceListOrBuilder- Returns:
- Whether the webhookNotification field is set.
-
getWebhookNotification
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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getWebhookNotificationin interfaceAudienceListOrBuilder- Returns:
- The webhookNotification.
-
setWebhookNotification
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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL]; -
setWebhookNotification
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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL]; -
mergeWebhookNotification
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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL]; -
clearWebhookNotification
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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL]; -
getWebhookNotificationBuilder
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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL]; -
getWebhookNotificationOrBuilder
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 an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook.
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getWebhookNotificationOrBuilderin interfaceAudienceListOrBuilder
-