Class RecurringAudienceList.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RecurringAudienceList.Builder>
com.google.analytics.data.v1alpha.RecurringAudienceList.Builder
- All Implemented Interfaces:
RecurringAudienceListOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- RecurringAudienceList
public static final class RecurringAudienceList.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RecurringAudienceList.Builder>
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-
Method Summary
Modifier and TypeMethodDescriptionaddAllAudienceLists(Iterable<String> values) Output only.addAllDimensions(Iterable<? extends AudienceDimension> values) Required.addAudienceLists(String value) Output only.addAudienceListsBytes(com.google.protobuf.ByteString value) Output only.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()Optional.Required.Output only.Output only.Required.Output only.Optional.intOptional.Required.com.google.protobuf.ByteStringRequired.Output only.com.google.protobuf.ByteStringOutput only.getAudienceLists(int index) Output only.com.google.protobuf.ByteStringgetAudienceListsBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput 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.getName()Output only.com.google.protobuf.ByteStringOutput only.Optional.Optional.Optional.booleanOptional.booleanOptional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(RecurringAudienceList other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Optional.removeDimensions(int index) Required.setActiveDaysRemaining(int value) Optional.setAudience(String value) Required.setAudienceBytes(com.google.protobuf.ByteString value) Required.setAudienceDisplayName(String value) Output only.setAudienceDisplayNameBytes(com.google.protobuf.ByteString value) Output only.setAudienceLists(int index, String value) Output only.setDimensions(int index, AudienceDimension value) Required.setDimensions(int index, AudienceDimension.Builder builderForValue) Required.Output only.setNameBytes(com.google.protobuf.ByteString 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<RecurringAudienceList.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<RecurringAudienceList.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<RecurringAudienceList.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<RecurringAudienceList.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<RecurringAudienceList.Builder>
-
mergeFrom
public RecurringAudienceList.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<RecurringAudienceList.Builder>- Throws:
IOException
-
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:
getNamein interfaceRecurringAudienceListOrBuilder- 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:
getNameBytesin interfaceRecurringAudienceListOrBuilder- Returns:
- The bytes for name.
-
setName
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];- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
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:
- This builder for chaining.
-
setNameBytes
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];- 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 interfaceRecurringAudienceListOrBuilder- 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 interfaceRecurringAudienceListOrBuilder- 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 interfaceRecurringAudienceListOrBuilder- 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 interfaceRecurringAudienceListOrBuilder- 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
public RecurringAudienceList.Builder setAudienceDisplayNameBytes(com.google.protobuf.ByteString value) 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 audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDimensionsListin interfaceRecurringAudienceListOrBuilder
-
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:
getDimensionsCountin interfaceRecurringAudienceListOrBuilder
-
getDimensions
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:
getDimensionsin interfaceRecurringAudienceListOrBuilder
-
setDimensions
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
setDimensions
public RecurringAudienceList.Builder setDimensions(int index, AudienceDimension.Builder builderForValue) Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensions
public RecurringAudienceList.Builder addDimensions(int index, AudienceDimension.Builder builderForValue) Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addAllDimensions
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
clearDimensions
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
removeDimensions
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
getDimensionsBuilder
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
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:
getDimensionsOrBuilderin interfaceRecurringAudienceListOrBuilder
-
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:
getDimensionsOrBuilderListin interfaceRecurringAudienceListOrBuilder
-
addDimensionsBuilder
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
addDimensionsBuilder
Required. The dimensions requested and displayed in the audience list response.
repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED]; -
getDimensionsBuilderList
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
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:
hasActiveDaysRemainingin interfaceRecurringAudienceListOrBuilder- 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:
getActiveDaysRemainingin interfaceRecurringAudienceListOrBuilder- Returns:
- The activeDaysRemaining.
-
setActiveDaysRemaining
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];- Parameters:
value- The activeDaysRemaining to set.- Returns:
- This builder for chaining.
-
clearActiveDaysRemaining
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:
- This builder for chaining.
-
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:
getAudienceListsListin interfaceRecurringAudienceListOrBuilder- 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:
getAudienceListsCountin interfaceRecurringAudienceListOrBuilder- Returns:
- The count of audienceLists.
-
getAudienceLists
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:
getAudienceListsin interfaceRecurringAudienceListOrBuilder- 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:
getAudienceListsBytesin interfaceRecurringAudienceListOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the audienceLists at the given index.
-
setAudienceLists
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 to set the value at.value- The audienceLists to set.- Returns:
- This builder for chaining.
-
addAudienceLists
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:
value- The audienceLists to add.- Returns:
- This builder for chaining.
-
addAllAudienceLists
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:
values- The audienceLists to add.- Returns:
- This builder for chaining.
-
clearAudienceLists
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:
- This builder for chaining.
-
addAudienceListsBytes
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:
value- The bytes of the audienceLists to add.- 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 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasWebhookNotificationin interfaceRecurringAudienceListOrBuilder- 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 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getWebhookNotificationin interfaceRecurringAudienceListOrBuilder- 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 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL]; -
setWebhookNotification
public RecurringAudienceList.Builder setWebhookNotification(WebhookNotification.Builder builderForValue) 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.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 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.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 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.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 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.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 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).
optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getWebhookNotificationOrBuilderin interfaceRecurringAudienceListOrBuilder
-