public final class RecurringAudienceList extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACTIVE_DAYS_REMAINING_FIELD_NUMBER
public static final int ACTIVE_DAYS_REMAINING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
public static final int AUDIENCE_DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
AUDIENCE_FIELD_NUMBER
public static final int AUDIENCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
AUDIENCE_LISTS_FIELD_NUMBER
public static final int AUDIENCE_LISTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WEBHOOK_NOTIFICATION_FIELD_NUMBER
public static final int WEBHOOK_NOTIFICATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static RecurringAudienceList getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RecurringAudienceList.Builder newBuilder()
newBuilder(RecurringAudienceList prototype)
public static RecurringAudienceList.Builder newBuilder(RecurringAudienceList prototype)
public static RecurringAudienceList parseDelimitedFrom(InputStream input)
public static RecurringAudienceList parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RecurringAudienceList parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RecurringAudienceList parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RecurringAudienceList parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecurringAudienceList parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecurringAudienceList parseFrom(CodedInputStream input)
public static RecurringAudienceList parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RecurringAudienceList parseFrom(InputStream input)
public static RecurringAudienceList parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RecurringAudienceList parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RecurringAudienceList parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RecurringAudienceList> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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];
| Returns |
|---|
| Type | Description |
int | The activeDaysRemaining.
|
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];
| Returns |
|---|
| Type | Description |
String | The audience.
|
getAudienceBytes()
public ByteString getAudienceBytes()
Required. The audience resource name. This resource name identifies the
audience being listed and is shared between the Analytics Data & Admin
APIs.
Format: properties/{property}/audiences/{audience}
string audience = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | 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];
| Returns |
|---|
| Type | Description |
String | The audienceDisplayName.
|
getAudienceDisplayNameBytes()
public ByteString getAudienceDisplayNameBytes()
Output only. The descriptive display name for this audience. For example,
"Purchasers".
string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for audienceDisplayName.
|
getAudienceLists(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The audienceLists at the given index.
|
getAudienceListsBytes(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the audienceLists at the given index.
|
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];
| Returns |
|---|
| Type | Description |
int | The count of audienceLists.
|
getAudienceListsList()
public 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];
getDefaultInstanceForType()
public RecurringAudienceList getDefaultInstanceForType()
getDimensions(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
int | |
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];
getDimensionsOrBuilder(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.analytics.data.v1alpha.AudienceDimensionOrBuilder> | |
getName()
Output only. Identifier. The recurring audience list resource name assigned
during creation. This resource name identifies this
RecurringAudienceList.
Format:
properties/{property}/recurringAudienceLists/{recurring_audience_list}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Identifier. The recurring audience list resource name assigned
during creation. This resource name identifies this
RecurringAudienceList.
Format:
properties/{property}/recurringAudienceLists/{recurring_audience_list}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<RecurringAudienceList> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getWebhookNotification()
public WebhookNotification 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];
getWebhookNotificationOrBuilder()
public WebhookNotificationOrBuilder 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];
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];
| Returns |
|---|
| Type | Description |
boolean | Whether the activeDaysRemaining field is set.
|
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];
| Returns |
|---|
| Type | Description |
boolean | Whether the webhookNotification field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RecurringAudienceList.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RecurringAudienceList.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RecurringAudienceList.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
