See [Creating an Audience + * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) + * for an introduction to Audience Lists with examples. + * *
An audience list is a snapshot of the users currently in the audience at the time of * audience list creation. Creating audience lists for one audience on different days will return * different results as users enter and exit the audience. @@ -330,6 +334,10 @@ public final RunFunnelReportResponse runFunnelReport(RunFunnelReportRequest requ * https://support.google.com/analytics/answer/9267572. Audience lists contain the users in each * audience. * + *
This method is introduced at alpha stability with the intention of gathering feedback on + * syntax and capabilities before entering beta. To give your feedback on this API, complete the + * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. + * *
Sample code: * *
{@code
@@ -339,7 +347,7 @@ public final RunFunnelReportResponse runFunnelReport(RunFunnelReportRequest requ
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * PropertyName parent = PropertyName.of("[PROPERTYID]");
+ * PropertyName parent = PropertyName.of("[PROPERTY]");
* AudienceList audienceList = AudienceList.newBuilder().build();
* AudienceList response =
* alphaAnalyticsDataClient.createAudienceListAsync(parent, audienceList).get();
@@ -347,7 +355,7 @@ public final RunFunnelReportResponse runFunnelReport(RunFunnelReportRequest requ
* }
*
* @param parent Required. The parent resource where this audience list will be created. Format:
- * `properties/{propertyId}`
+ * `properties/{property}`
* @param audienceList Required. The audience list to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -368,6 +376,10 @@ public final OperationFutureSee [Creating an Audience + * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) + * for an introduction to Audience Lists with examples. + * *
An audience list is a snapshot of the users currently in the audience at the time of
* audience list creation. Creating audience lists for one audience on different days will return
* different results as users enter and exit the audience.
@@ -377,6 +389,10 @@ public final OperationFuture This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
* An audience list is a snapshot of the users currently in the audience at the time of
* audience list creation. Creating audience lists for one audience on different days will return
* different results as users enter and exit the audience.
@@ -424,6 +444,10 @@ public final OperationFuture This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
* An audience list is a snapshot of the users currently in the audience at the time of
* audience list creation. Creating audience lists for one audience on different days will return
* different results as users enter and exit the audience.
@@ -466,6 +494,10 @@ public final OperationFuture This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
* An audience list is a snapshot of the users currently in the audience at the time of
* audience list creation. Creating audience lists for one audience on different days will return
* different results as users enter and exit the audience.
@@ -508,6 +544,10 @@ public final OperationFuture This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
*
* Audiences in Google Analytics 4 allow you to segment your users in the ways that are
* important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572.
*
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
*
* Audiences in Google Analytics 4 allow you to segment your users in the ways that are
* important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572.
*
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
*
* Audiences in Google Analytics 4 allow you to segment your users in the ways that are
* important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572.
*
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways that are
+ * important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ * Sample code:
+ *
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways that are
+ * important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ * Sample code:
+ *
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways that are
+ * important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ * Sample code:
+ *
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways that are
+ * important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ * Sample code:
+ *
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ *
+ * This method is introduced at alpha stability with the intention of gathering feedback on
+ * syntax and capabilities before entering beta. To give your feedback on this API, complete the
+ * [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
* Sample code:
*
* {@code
@@ -386,7 +402,7 @@ public final OperationFuture
*
* @param parent Required. The parent resource where this audience list will be created. Format:
- * `properties/{propertyId}`
+ * `properties/{property}`
* @param audienceList Required. The audience list to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -415,6 +431,10 @@ public final OperationFuture{@code
@@ -435,7 +459,7 @@ public final OperationFuture
*/
public com.google.common.util.concurrent.ListenableFuture{@code
@@ -477,7 +509,7 @@ public final OperationFuture
*/
public com.google.analytics.data.v1alpha.ListAudienceListsResponse listAudienceLists(
@@ -764,6 +1007,9 @@ protected AlphaAnalyticsDataFutureStub build(
* request to form an audience list. To list the users in an audience list,
* first create the audience list through this method and then send the
* audience resource name to the `QueryAudienceList` method.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
* An audience list is a snapshot of the users currently in the audience at
* the time of audience list creation. Creating audience lists for one
* audience on different days will return different results as users enter and
@@ -772,6 +1018,11 @@ protected AlphaAnalyticsDataFutureStub build(
* that are important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572. Audience lists contain
* the users in each audience.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
* {@code
@@ -519,7 +559,7 @@ public final OperationFuture
*/
public com.google.analytics.data.v1alpha.QueryAudienceListResponse queryAudienceList(
@@ -678,12 +876,49 @@ public com.google.analytics.data.v1alpha.QueryAudienceListResponse queryAudience
getChannel(), getQueryAudienceListMethod(), getCallOptions(), request);
}
+ /**
+ *
+ *
+ * {@code
@@ -558,8 +606,8 @@ public final UnaryCallable
*
- * @param name The name of the audience list to retrieve users from. Format:
- * `properties/{propertyId}/audienceLists/{audienceListId}`
+ * @param name Required. The name of the audience list to retrieve users from. Format:
+ * `properties/{property}/audienceLists/{audience_list}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final QueryAudienceListResponse queryAudienceList(String name) {
@@ -572,12 +620,20 @@ public final QueryAudienceListResponse queryAudienceList(String name) {
* Retrieves an audience list of users. After creating an audience, the users are not immediately
* available for listing. First, a request to `CreateAudienceList` is necessary to create an
* audience list of users, and then second, this method is used to retrieve the users in the
- * audience.
+ * audience list.
+ *
+ * {@code
@@ -609,12 +665,20 @@ public final QueryAudienceListResponse queryAudienceList(QueryAudienceListReques
* Retrieves an audience list of users. After creating an audience, the users are not immediately
* available for listing. First, a request to `CreateAudienceList` is necessary to create an
* audience list of users, and then second, this method is used to retrieve the users in the
- * audience.
+ * audience list.
+ *
+ *
*/
public com.google.longrunning.Operation createAudienceList(
@@ -666,10 +855,19 @@ public com.google.longrunning.Operation createAudienceList(
* Retrieves an audience list of users. After creating an audience, the users
* are not immediately available for listing. First, a request to
* `CreateAudienceList` is necessary to create an audience list of users, and
- * then second, this method is used to retrieve the users in the audience.
+ * then second, this method is used to retrieve the users in the audience
+ * list.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
* Audiences in Google Analytics 4 allow you to segment your users in the ways
* that are important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
* {@code
@@ -642,11 +706,202 @@ public final QueryAudienceListResponse queryAudienceList(QueryAudienceListReques
return stub.queryAudienceListCallable();
}
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports an audience list of users to a Google Sheet. After creating an audience, the users are
+ * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to
+ * create an audience list of users, and then second, this method is used to export those users in
+ * the audience list to a Google Sheet.
+ *
+ *
*/
public void listAudienceLists(
@@ -643,6 +824,9 @@ public com.google.analytics.data.v1alpha.RunFunnelReportResponse runFunnelReport
* request to form an audience list. To list the users in an audience list,
* first create the audience list through this method and then send the
* audience resource name to the `QueryAudienceList` method.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
* An audience list is a snapshot of the users currently in the audience at
* the time of audience list creation. Creating audience lists for one
* audience on different days will return different results as users enter and
@@ -651,6 +835,11 @@ public com.google.analytics.data.v1alpha.RunFunnelReportResponse runFunnelReport
* that are important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572. Audience lists contain
* the users in each audience.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
* {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * AudienceListName name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]");
+ * SheetExportAudienceListResponse response =
+ * alphaAnalyticsDataClient.sheetExportAudienceList(name);
+ * }
+ * }
+ *
+ * @param name Required. The name of the audience list to retrieve users from. Format:
+ * `properties/{property}/audienceLists/{audience_list}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SheetExportAudienceListResponse sheetExportAudienceList(AudienceListName name) {
+ SheetExportAudienceListRequest request =
+ SheetExportAudienceListRequest.newBuilder()
+ .setName(name == null ? null : name.toString())
+ .build();
+ return sheetExportAudienceList(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports an audience list of users to a Google Sheet. After creating an audience, the users are
+ * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to
+ * create an audience list of users, and then second, this method is used to export those users in
+ * the audience list to a Google Sheet.
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * String name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString();
+ * SheetExportAudienceListResponse response =
+ * alphaAnalyticsDataClient.sheetExportAudienceList(name);
+ * }
+ * }
+ *
+ * @param name Required. The name of the audience list to retrieve users from. Format:
+ * `properties/{property}/audienceLists/{audience_list}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SheetExportAudienceListResponse sheetExportAudienceList(String name) {
+ SheetExportAudienceListRequest request =
+ SheetExportAudienceListRequest.newBuilder().setName(name).build();
+ return sheetExportAudienceList(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports an audience list of users to a Google Sheet. After creating an audience, the users are
+ * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to
+ * create an audience list of users, and then second, this method is used to export those users in
+ * the audience list to a Google Sheet.
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * SheetExportAudienceListRequest request =
+ * SheetExportAudienceListRequest.newBuilder()
+ * .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
+ * .setOffset(-1019779949)
+ * .setLimit(102976443)
+ * .build();
+ * SheetExportAudienceListResponse response =
+ * alphaAnalyticsDataClient.sheetExportAudienceList(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SheetExportAudienceListResponse sheetExportAudienceList(
+ SheetExportAudienceListRequest request) {
+ return sheetExportAudienceListCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports an audience list of users to a Google Sheet. After creating an audience, the users are
+ * not immediately available for listing. First, a request to `CreateAudienceList` is necessary to
+ * create an audience list of users, and then second, this method is used to export those users in
+ * the audience list to a Google Sheet.
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
+ * SheetExportAudienceListRequest request =
+ * SheetExportAudienceListRequest.newBuilder()
+ * .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
+ * .setOffset(-1019779949)
+ * .setLimit(102976443)
+ * .build();
+ * ApiFuture
+ */
+ public final UnaryCallable{@code
@@ -656,13 +911,13 @@ public final QueryAudienceListResponse queryAudienceList(QueryAudienceListReques
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * AudienceListName name = AudienceListName.of("[PROPERTYID]", "[AUDIENCELISTID]");
+ * AudienceListName name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]");
* AudienceList response = alphaAnalyticsDataClient.getAudienceList(name);
* }
* }
*
* @param name Required. The audience list resource name. Format:
- * `properties/{propertyId}/audienceLists/{audienceListId}`
+ * `properties/{property}/audienceLists/{audience_list}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AudienceList getAudienceList(AudienceListName name) {
@@ -676,6 +931,14 @@ public final AudienceList getAudienceList(AudienceListName name) {
* Gets configuration metadata about a specific audience list. This method can be used to
* understand an audience list after it has been created.
*
+ * {@code
@@ -685,13 +948,13 @@ public final AudienceList getAudienceList(AudienceListName name) {
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * String name = AudienceListName.of("[PROPERTYID]", "[AUDIENCELISTID]").toString();
+ * String name = AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString();
* AudienceList response = alphaAnalyticsDataClient.getAudienceList(name);
* }
* }
*
* @param name Required. The audience list resource name. Format:
- * `properties/{propertyId}/audienceLists/{audienceListId}`
+ * `properties/{property}/audienceLists/{audience_list}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AudienceList getAudienceList(String name) {
@@ -704,6 +967,14 @@ public final AudienceList getAudienceList(String name) {
* Gets configuration metadata about a specific audience list. This method can be used to
* understand an audience list after it has been created.
*
+ * {@code
@@ -715,7 +986,7 @@ public final AudienceList getAudienceList(String name) {
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
* GetAudienceListRequest request =
* GetAudienceListRequest.newBuilder()
- * .setName(AudienceListName.of("[PROPERTYID]", "[AUDIENCELISTID]").toString())
+ * .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
* .build();
* AudienceList response = alphaAnalyticsDataClient.getAudienceList(request);
* }
@@ -733,6 +1004,14 @@ public final AudienceList getAudienceList(GetAudienceListRequest request) {
* Gets configuration metadata about a specific audience list. This method can be used to
* understand an audience list after it has been created.
*
+ *
*/
public void queryAudienceList(
@@ -549,12 +681,53 @@ public void queryAudienceList(
responseObserver);
}
+ /**
+ *
+ *
+ * {@code
@@ -744,7 +1023,7 @@ public final AudienceList getAudienceList(GetAudienceListRequest request) {
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
* GetAudienceListRequest request =
* GetAudienceListRequest.newBuilder()
- * .setName(AudienceListName.of("[PROPERTYID]", "[AUDIENCELISTID]").toString())
+ * .setName(AudienceListName.of("[PROPERTY]", "[AUDIENCE_LIST]").toString())
* .build();
* ApiFuture
*/
public void createAudienceList(
@@ -533,10 +656,19 @@ public void createAudienceList(
* Retrieves an audience list of users. After creating an audience, the users
* are not immediately available for listing. First, a request to
* `CreateAudienceList` is necessary to create an audience list of users, and
- * then second, this method is used to retrieve the users in the audience.
+ * then second, this method is used to retrieve the users in the audience
+ * list.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
* Audiences in Google Analytics 4 allow you to segment your users in the ways
* that are important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
* {@code
@@ -773,7 +1060,7 @@ public final UnaryCallable
*
* @param parent Required. All audience lists for this property will be listed in the response.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAudienceListsPagedResponse listAudienceLists(PropertyName parent) {
@@ -799,6 +1086,14 @@ public final ListAudienceListsPagedResponse listAudienceLists(PropertyName paren
* can have multiple audience lists that represent the list of users that were in an audience on
* different days.
*
+ * {@code
@@ -808,7 +1103,7 @@ public final ListAudienceListsPagedResponse listAudienceLists(PropertyName paren
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
- * String parent = PropertyName.of("[PROPERTYID]").toString();
+ * String parent = PropertyName.of("[PROPERTY]").toString();
* for (AudienceList element : alphaAnalyticsDataClient.listAudienceLists(parent).iterateAll()) {
* // doThingsWith(element);
* }
@@ -816,7 +1111,7 @@ public final ListAudienceListsPagedResponse listAudienceLists(PropertyName paren
* }
*
* @param parent Required. All audience lists for this property will be listed in the response.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAudienceListsPagedResponse listAudienceLists(String parent) {
@@ -832,6 +1127,14 @@ public final ListAudienceListsPagedResponse listAudienceLists(String parent) {
* can have multiple audience lists that represent the list of users that were in an audience on
* different days.
*
+ * {@code
@@ -843,7 +1146,7 @@ public final ListAudienceListsPagedResponse listAudienceLists(String parent) {
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
* ListAudienceListsRequest request =
* ListAudienceListsRequest.newBuilder()
- * .setParent(PropertyName.of("[PROPERTYID]").toString())
+ * .setParent(PropertyName.of("[PROPERTY]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
@@ -868,6 +1171,14 @@ public final ListAudienceListsPagedResponse listAudienceLists(ListAudienceListsR
* can have multiple audience lists that represent the list of users that were in an audience on
* different days.
*
+ *
*/
default void listAudienceLists(
@@ -507,6 +622,9 @@ public void runFunnelReport(
* request to form an audience list. To list the users in an audience list,
* first create the audience list through this method and then send the
* audience resource name to the `QueryAudienceList` method.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
* An audience list is a snapshot of the users currently in the audience at
* the time of audience list creation. Creating audience lists for one
* audience on different days will return different results as users enter and
@@ -515,6 +633,11 @@ public void runFunnelReport(
* that are important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572. Audience lists contain
* the users in each audience.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
* {@code
@@ -879,7 +1190,7 @@ public final ListAudienceListsPagedResponse listAudienceLists(ListAudienceListsR
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
* ListAudienceListsRequest request =
* ListAudienceListsRequest.newBuilder()
- * .setParent(PropertyName.of("[PROPERTYID]").toString())
+ * .setParent(PropertyName.of("[PROPERTY]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
@@ -904,6 +1215,14 @@ public final ListAudienceListsPagedResponse listAudienceLists(ListAudienceListsR
* can have multiple audience lists that represent the list of users that were in an audience on
* different days.
*
+ *
*/
default void queryAudienceList(
@@ -398,12 +466,51 @@ default void queryAudienceList(
getQueryAudienceListMethod(), responseObserver);
}
+ /**
+ *
+ *
+ * {@code
@@ -915,7 +1234,7 @@ public final ListAudienceListsPagedResponse listAudienceLists(ListAudienceListsR
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
* ListAudienceListsRequest request =
* ListAudienceListsRequest.newBuilder()
- * .setParent(PropertyName.of("[PROPERTYID]").toString())
+ * .setParent(PropertyName.of("[PROPERTY]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
diff --git a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataSettings.java b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataSettings.java
index bd2766e04e64..dbab0fd954fa 100644
--- a/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataSettings.java
+++ b/java-analytics-data/google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataSettings.java
@@ -103,6 +103,12 @@ public UnaryCallSettings
*/
default void createAudienceList(
@@ -384,10 +443,19 @@ default void createAudienceList(
* Retrieves an audience list of users. After creating an audience, the users
* are not immediately available for listing. First, a request to
* `CreateAudienceList` is necessary to create an audience list of users, and
- * then second, this method is used to retrieve the users in the audience.
+ * then second, this method is used to retrieve the users in the audience
+ * list.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
* Audiences in Google Analytics 4 allow you to segment your users in the ways
* that are important to your business. To learn more, see
* https://support.google.com/analytics/answer/9267572.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
+ * Exports an audience list of users to a Google Sheet. After creating an
+ * audience, the users are not immediately available for listing. First, a
+ * request to `CreateAudienceList` is necessary to create an audience list of
+ * users, and then second, this method is used to export those users in the
+ * audience list to a Google Sheet.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways
+ * that are important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ */
+ default void sheetExportAudienceList(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request,
+ io.grpc.stub.StreamObserver<
+ com.google.analytics.data.v1alpha.SheetExportAudienceListResponse>
+ responseObserver) {
+ io.grpc.stub.ServerCalls.asyncUnimplementedUnaryCall(
+ getSheetExportAudienceListMethod(), responseObserver);
+ }
+
/**
*
*
*
* Gets configuration metadata about a specific audience list. This method
* can be used to understand an audience list after it has been created.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
*/
default void getAudienceList(
@@ -422,6 +529,14 @@ default void getAudienceList(
* find and reuse existing audience lists rather than creating unnecessary new
* audience lists. The same audience can have multiple audience lists that
* represent the list of users that were in an audience on different days.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
+ * Exports an audience list of users to a Google Sheet. After creating an
+ * audience, the users are not immediately available for listing. First, a
+ * request to `CreateAudienceList` is necessary to create an audience list of
+ * users, and then second, this method is used to export those users in the
+ * audience list to a Google Sheet.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways
+ * that are important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ */
+ public void sheetExportAudienceList(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request,
+ io.grpc.stub.StreamObserver<
+ com.google.analytics.data.v1alpha.SheetExportAudienceListResponse>
+ responseObserver) {
+ io.grpc.stub.ClientCalls.asyncUnaryCall(
+ getChannel().newCall(getSheetExportAudienceListMethod(), getCallOptions()),
+ request,
+ responseObserver);
+ }
+
/**
*
*
*
* Gets configuration metadata about a specific audience list. This method
* can be used to understand an audience list after it has been created.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
*/
public void getAudienceList(
@@ -575,6 +748,14 @@ public void getAudienceList(
* find and reuse existing audience lists rather than creating unnecessary new
* audience lists. The same audience can have multiple audience lists that
* represent the list of users that were in an audience on different days.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
+ * Exports an audience list of users to a Google Sheet. After creating an
+ * audience, the users are not immediately available for listing. First, a
+ * request to `CreateAudienceList` is necessary to create an audience list of
+ * users, and then second, this method is used to export those users in the
+ * audience list to a Google Sheet.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways
+ * that are important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ */
+ public com.google.analytics.data.v1alpha.SheetExportAudienceListResponse
+ sheetExportAudienceList(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request) {
+ return io.grpc.stub.ClientCalls.blockingUnaryCall(
+ getChannel(), getSheetExportAudienceListMethod(), getCallOptions(), request);
+ }
+
/**
*
*
*
* Gets configuration metadata about a specific audience list. This method
* can be used to understand an audience list after it has been created.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
*/
public com.google.analytics.data.v1alpha.AudienceList getAudienceList(
@@ -700,6 +935,14 @@ public com.google.analytics.data.v1alpha.AudienceList getAudienceList(
* find and reuse existing audience lists rather than creating unnecessary new
* audience lists. The same audience can have multiple audience lists that
* represent the list of users that were in an audience on different days.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
+ * Exports an audience list of users to a Google Sheet. After creating an
+ * audience, the users are not immediately available for listing. First, a
+ * request to `CreateAudienceList` is necessary to create an audience list of
+ * users, and then second, this method is used to export those users in the
+ * audience list to a Google Sheet.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways
+ * that are important to your business. To learn more, see
+ * https://support.google.com/analytics/answer/9267572.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ *
+ */
+ public com.google.common.util.concurrent.ListenableFuture<
+ com.google.analytics.data.v1alpha.SheetExportAudienceListResponse>
+ sheetExportAudienceList(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest request) {
+ return io.grpc.stub.ClientCalls.futureUnaryCall(
+ getChannel().newCall(getSheetExportAudienceListMethod(), getCallOptions()), request);
+ }
+
/**
*
*
*
* Gets configuration metadata about a specific audience list. This method
* can be used to understand an audience list after it has been created.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
*/
public com.google.common.util.concurrent.ListenableFuture<
@@ -823,6 +1121,14 @@ protected AlphaAnalyticsDataFutureStub build(
* find and reuse existing audience lists rather than creating unnecessary new
* audience lists. The same audience can have multiple audience lists that
* represent the list of users that were in an audience on different days.
+ * See [Creating an Audience
+ * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ * for an introduction to Audience Lists with examples.
+ * This method is introduced at alpha stability with the intention of
+ * gathering feedback on syntax and capabilities before entering beta. To give
+ * your feedback on this API, complete the
+ * [Google Analytics Audience Export API
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
*
*/
public com.google.common.util.concurrent.ListenableFuture<
@@ -836,8 +1142,9 @@ protected AlphaAnalyticsDataFutureStub build(
private static final int METHODID_RUN_FUNNEL_REPORT = 0;
private static final int METHODID_CREATE_AUDIENCE_LIST = 1;
private static final int METHODID_QUERY_AUDIENCE_LIST = 2;
- private static final int METHODID_GET_AUDIENCE_LIST = 3;
- private static final int METHODID_LIST_AUDIENCE_LISTS = 4;
+ private static final int METHODID_SHEET_EXPORT_AUDIENCE_LIST = 3;
+ private static final int METHODID_GET_AUDIENCE_LIST = 4;
+ private static final int METHODID_LIST_AUDIENCE_LISTS = 5;
private static final class MethodHandlers
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The dimensionName.
*/
@@ -96,12 +96,12 @@ public java.lang.String getDimensionName() {
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for dimensionName.
*/
@@ -466,12 +466,12 @@ public Builder mergeFrom(
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The dimensionName.
*/
@@ -490,12 +490,12 @@ public java.lang.String getDimensionName() {
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for dimensionName.
*/
@@ -514,12 +514,12 @@ public com.google.protobuf.ByteString getDimensionNameBytes() {
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The dimensionName to set.
* @return This builder for chaining.
@@ -537,12 +537,12 @@ public Builder setDimensionName(java.lang.String value) {
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
@@ -556,12 +556,12 @@ public Builder clearDimensionName() {
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The bytes for dimensionName to set.
* @return This builder for chaining.
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceDimensionOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceDimensionOrBuilder.java
index 53987818c9cd..af60b2ccb2dd 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceDimensionOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceDimensionOrBuilder.java
@@ -27,12 +27,12 @@ public interface AudienceDimensionOrBuilder
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The dimensionName.
*/
@@ -41,12 +41,12 @@ public interface AudienceDimensionOrBuilder
*
*
*
- * The API name of the dimension. See the [API
+ * Optional. The API name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
* for the list of dimension names.
*
*
- * string dimension_name = 1;
+ * string dimension_name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for dimensionName.
*/
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceList.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceList.java
index 86dc21ccbf89..99e1fba9f995 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceList.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceList.java
@@ -45,6 +45,7 @@ private AudienceList() {
audienceDisplayName_ = "";
dimensions_ = java.util.Collections.emptyList();
state_ = 0;
+ errorMessage_ = "";
}
@java.lang.Override
@@ -264,13 +265,15 @@ private State(int value) {
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The name.
*/
@@ -290,13 +293,15 @@ public java.lang.String getName() {
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The bytes for name.
*/
@@ -325,7 +330,7 @@ public com.google.protobuf.ByteString getNameBytes() {
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -352,7 +357,7 @@ public java.lang.String getAudience() {
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -624,6 +629,130 @@ public com.google.protobuf.TimestampOrBuilder getBeginCreatingTimeOrBuilder() {
: beginCreatingTime_;
}
+ public static final int CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER = 7;
+ private int creationQuotaTokensCharged_ = 0;
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ *
+ * @return The creationQuotaTokensCharged.
+ */
+ @java.lang.Override
+ public int getCreationQuotaTokensCharged() {
+ return creationQuotaTokensCharged_;
+ }
+
+ public static final int ROW_COUNT_FIELD_NUMBER = 8;
+ private int rowCount_ = 0;
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return Whether the rowCount field is set.
+ */
+ @java.lang.Override
+ public boolean hasRowCount() {
+ return ((bitField0_ & 0x00000004) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return The rowCount.
+ */
+ @java.lang.Override
+ public int getRowCount() {
+ return rowCount_;
+ }
+
+ public static final int ERROR_MESSAGE_FIELD_NUMBER = 9;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object errorMessage_ = "";
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return Whether the errorMessage field is set.
+ */
+ @java.lang.Override
+ public boolean hasErrorMessage() {
+ return ((bitField0_ & 0x00000008) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return The errorMessage.
+ */
+ @java.lang.Override
+ public java.lang.String getErrorMessage() {
+ java.lang.Object ref = errorMessage_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ errorMessage_ = s;
+ return s;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return The bytes for errorMessage.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getErrorMessageBytes() {
+ java.lang.Object ref = errorMessage_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ errorMessage_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
private byte memoizedIsInitialized = -1;
@java.lang.Override
@@ -656,6 +785,15 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (((bitField0_ & 0x00000002) != 0)) {
output.writeMessage(6, getBeginCreatingTime());
}
+ if (creationQuotaTokensCharged_ != 0) {
+ output.writeInt32(7, creationQuotaTokensCharged_);
+ }
+ if (((bitField0_ & 0x00000004) != 0)) {
+ output.writeInt32(8, rowCount_);
+ }
+ if (((bitField0_ & 0x00000008) != 0)) {
+ com.google.protobuf.GeneratedMessageV3.writeString(output, 9, errorMessage_);
+ }
getUnknownFields().writeTo(output);
}
@@ -683,6 +821,16 @@ public int getSerializedSize() {
if (((bitField0_ & 0x00000002) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(6, getBeginCreatingTime());
}
+ if (creationQuotaTokensCharged_ != 0) {
+ size +=
+ com.google.protobuf.CodedOutputStream.computeInt32Size(7, creationQuotaTokensCharged_);
+ }
+ if (((bitField0_ & 0x00000004) != 0)) {
+ size += com.google.protobuf.CodedOutputStream.computeInt32Size(8, rowCount_);
+ }
+ if (((bitField0_ & 0x00000008) != 0)) {
+ size += com.google.protobuf.GeneratedMessageV3.computeStringSize(9, errorMessage_);
+ }
size += getUnknownFields().getSerializedSize();
memoizedSize = size;
return size;
@@ -711,6 +859,15 @@ public boolean equals(final java.lang.Object obj) {
if (hasBeginCreatingTime()) {
if (!getBeginCreatingTime().equals(other.getBeginCreatingTime())) return false;
}
+ if (getCreationQuotaTokensCharged() != other.getCreationQuotaTokensCharged()) return false;
+ if (hasRowCount() != other.hasRowCount()) return false;
+ if (hasRowCount()) {
+ if (getRowCount() != other.getRowCount()) return false;
+ }
+ if (hasErrorMessage() != other.hasErrorMessage()) return false;
+ if (hasErrorMessage()) {
+ if (!getErrorMessage().equals(other.getErrorMessage())) return false;
+ }
if (!getUnknownFields().equals(other.getUnknownFields())) return false;
return true;
}
@@ -740,6 +897,16 @@ public int hashCode() {
hash = (37 * hash) + BEGIN_CREATING_TIME_FIELD_NUMBER;
hash = (53 * hash) + getBeginCreatingTime().hashCode();
}
+ hash = (37 * hash) + CREATION_QUOTA_TOKENS_CHARGED_FIELD_NUMBER;
+ hash = (53 * hash) + getCreationQuotaTokensCharged();
+ if (hasRowCount()) {
+ hash = (37 * hash) + ROW_COUNT_FIELD_NUMBER;
+ hash = (53 * hash) + getRowCount();
+ }
+ if (hasErrorMessage()) {
+ hash = (37 * hash) + ERROR_MESSAGE_FIELD_NUMBER;
+ hash = (53 * hash) + getErrorMessage().hashCode();
+ }
hash = (29 * hash) + getUnknownFields().hashCode();
memoizedHashCode = hash;
return hash;
@@ -907,6 +1074,9 @@ public Builder clear() {
beginCreatingTimeBuilder_.dispose();
beginCreatingTimeBuilder_ = null;
}
+ creationQuotaTokensCharged_ = 0;
+ rowCount_ = 0;
+ errorMessage_ = "";
return this;
}
@@ -977,6 +1147,17 @@ private void buildPartial0(com.google.analytics.data.v1alpha.AudienceList result
: beginCreatingTimeBuilder_.build();
to_bitField0_ |= 0x00000002;
}
+ if (((from_bitField0_ & 0x00000040) != 0)) {
+ result.creationQuotaTokensCharged_ = creationQuotaTokensCharged_;
+ }
+ if (((from_bitField0_ & 0x00000080) != 0)) {
+ result.rowCount_ = rowCount_;
+ to_bitField0_ |= 0x00000004;
+ }
+ if (((from_bitField0_ & 0x00000100) != 0)) {
+ result.errorMessage_ = errorMessage_;
+ to_bitField0_ |= 0x00000008;
+ }
result.bitField0_ |= to_bitField0_;
}
@@ -1073,6 +1254,17 @@ public Builder mergeFrom(com.google.analytics.data.v1alpha.AudienceList other) {
if (other.hasBeginCreatingTime()) {
mergeBeginCreatingTime(other.getBeginCreatingTime());
}
+ if (other.getCreationQuotaTokensCharged() != 0) {
+ setCreationQuotaTokensCharged(other.getCreationQuotaTokensCharged());
+ }
+ if (other.hasRowCount()) {
+ setRowCount(other.getRowCount());
+ }
+ if (other.hasErrorMessage()) {
+ errorMessage_ = other.errorMessage_;
+ bitField0_ |= 0x00000100;
+ onChanged();
+ }
this.mergeUnknownFields(other.getUnknownFields());
onChanged();
return this;
@@ -1144,6 +1336,24 @@ public Builder mergeFrom(
bitField0_ |= 0x00000020;
break;
} // case 50
+ case 56:
+ {
+ creationQuotaTokensCharged_ = input.readInt32();
+ bitField0_ |= 0x00000040;
+ break;
+ } // case 56
+ case 64:
+ {
+ rowCount_ = input.readInt32();
+ bitField0_ |= 0x00000080;
+ break;
+ } // case 64
+ case 74:
+ {
+ errorMessage_ = input.readStringRequireUtf8();
+ bitField0_ |= 0x00000100;
+ break;
+ } // case 74
default:
{
if (!super.parseUnknownField(input, extensionRegistry, tag)) {
@@ -1168,13 +1378,15 @@ public Builder mergeFrom(
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The name.
*/
@@ -1193,13 +1405,15 @@ public java.lang.String getName() {
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The bytes for name.
*/
@@ -1218,13 +1432,15 @@ public com.google.protobuf.ByteString getNameBytes() {
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @param value The name to set.
* @return This builder for chaining.
@@ -1242,13 +1458,15 @@ public Builder setName(java.lang.String value) {
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return This builder for chaining.
*/
@@ -1262,13 +1480,15 @@ public Builder clearName() {
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @param value The bytes for name to set.
* @return This builder for chaining.
@@ -1293,7 +1513,7 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -1319,7 +1539,7 @@ public java.lang.String getAudience() {
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -1345,7 +1565,7 @@ public com.google.protobuf.ByteString getAudienceBytes() {
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -1370,7 +1590,7 @@ public Builder setAudience(java.lang.String value) {
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -1391,7 +1611,7 @@ public Builder clearAudience() {
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -2244,6 +2464,265 @@ public com.google.protobuf.TimestampOrBuilder getBeginCreatingTimeOrBuilder() {
return beginCreatingTimeBuilder_;
}
+ private int creationQuotaTokensCharged_;
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ *
+ * @return The creationQuotaTokensCharged.
+ */
+ @java.lang.Override
+ public int getCreationQuotaTokensCharged() {
+ return creationQuotaTokensCharged_;
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ *
+ * @param value The creationQuotaTokensCharged to set.
+ * @return This builder for chaining.
+ */
+ public Builder setCreationQuotaTokensCharged(int value) {
+
+ creationQuotaTokensCharged_ = value;
+ bitField0_ |= 0x00000040;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearCreationQuotaTokensCharged() {
+ bitField0_ = (bitField0_ & ~0x00000040);
+ creationQuotaTokensCharged_ = 0;
+ onChanged();
+ return this;
+ }
+
+ private int rowCount_;
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return Whether the rowCount field is set.
+ */
+ @java.lang.Override
+ public boolean hasRowCount() {
+ return ((bitField0_ & 0x00000080) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return The rowCount.
+ */
+ @java.lang.Override
+ public int getRowCount() {
+ return rowCount_;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @param value The rowCount to set.
+ * @return This builder for chaining.
+ */
+ public Builder setRowCount(int value) {
+
+ rowCount_ = value;
+ bitField0_ |= 0x00000080;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearRowCount() {
+ bitField0_ = (bitField0_ & ~0x00000080);
+ rowCount_ = 0;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object errorMessage_ = "";
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return Whether the errorMessage field is set.
+ */
+ public boolean hasErrorMessage() {
+ return ((bitField0_ & 0x00000100) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return The errorMessage.
+ */
+ public java.lang.String getErrorMessage() {
+ java.lang.Object ref = errorMessage_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ errorMessage_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return The bytes for errorMessage.
+ */
+ public com.google.protobuf.ByteString getErrorMessageBytes() {
+ java.lang.Object ref = errorMessage_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ errorMessage_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @param value The errorMessage to set.
+ * @return This builder for chaining.
+ */
+ public Builder setErrorMessage(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ errorMessage_ = value;
+ bitField0_ |= 0x00000100;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearErrorMessage() {
+ errorMessage_ = getDefaultInstance().getErrorMessage();
+ bitField0_ = (bitField0_ & ~0x00000100);
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @param value The bytes for errorMessage to set.
+ * @return This builder for chaining.
+ */
+ public Builder setErrorMessageBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ errorMessage_ = value;
+ bitField0_ |= 0x00000100;
+ onChanged();
+ return this;
+ }
+
@java.lang.Override
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceListName.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceListName.java
index a5ad5a03cbd8..2dd702ff4da2 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceListName.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/AudienceListName.java
@@ -29,30 +29,29 @@
// AUTO-GENERATED DOCUMENTATION AND CLASS.
@Generated("by gapic-generator-java")
public class AudienceListName implements ResourceName {
- private static final PathTemplate PROPERTYID_AUDIENCELISTID =
- PathTemplate.createWithoutUrlEncoding(
- "properties/{propertyId}/audienceLists/{audienceListId}");
+ private static final PathTemplate PROPERTY_AUDIENCE_LIST =
+ PathTemplate.createWithoutUrlEncoding("properties/{property}/audienceLists/{audience_list}");
private volatile Map
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The name.
*/
@@ -42,13 +44,15 @@ public interface AudienceListOrBuilder
*
*
*
- * Output only. The audience list resource name assigned during creation. This
- * resource name identifies this `AudienceList`.
+ * Output only. Identifier. The audience list resource name assigned during
+ * creation. This resource name identifies this `AudienceList`.
*
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The bytes for name.
*/
@@ -62,7 +66,7 @@ public interface AudienceListOrBuilder
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -78,7 +82,7 @@ public interface AudienceListOrBuilder
* audience being listed and is shared between the Analytics Data & Admin
* APIs.
*
- * Format: `properties/{propertyId}/audiences/{audienceId}`
+ * Format: `properties/{property}/audiences/{audience}`
*
*
* string audience = 2 [(.google.api.field_behavior) = REQUIRED];
@@ -262,4 +266,86 @@ public interface AudienceListOrBuilder
*
*/
com.google.protobuf.TimestampOrBuilder getBeginCreatingTimeOrBuilder();
+
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ *
+ * @return The creationQuotaTokensCharged.
+ */
+ int getCreationQuotaTokensCharged();
+
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return Whether the rowCount field is set.
+ */
+ boolean hasRowCount();
+ /**
+ *
+ *
+ *
+ * Output only. The total number of rows in the AudienceList result.
+ *
+ *
+ * optional int32 row_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return The rowCount.
+ */
+ int getRowCount();
+
+ /**
+ *
+ *
+ *
+ * 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];
+ *
+ * @return Whether the errorMessage field is set.
+ */
+ 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];
+ *
+ * @return The errorMessage.
+ */
+ java.lang.String 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];
+ *
+ * @return The bytes for errorMessage.
+ */
+ com.google.protobuf.ByteString getErrorMessageBytes();
}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequest.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequest.java
index cb6e76a9567e..76fc42355e6c 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequest.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequest.java
@@ -71,7 +71,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
@@ -97,7 +97,7 @@ public java.lang.String getParent() {
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
@@ -556,7 +556,7 @@ public Builder mergeFrom(
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
@@ -581,7 +581,7 @@ public java.lang.String getParent() {
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
@@ -606,7 +606,7 @@ public com.google.protobuf.ByteString getParentBytes() {
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
@@ -630,7 +630,7 @@ public Builder setParent(java.lang.String value) {
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
@@ -650,7 +650,7 @@ public Builder clearParent() {
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequestOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequestOrBuilder.java
index d5f7906739e1..f124d4d991c0 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequestOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/CreateAudienceListRequestOrBuilder.java
@@ -28,7 +28,7 @@ public interface CreateAudienceListRequestOrBuilder
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
@@ -43,7 +43,7 @@ public interface CreateAudienceListRequestOrBuilder
*
*
* Required. The parent resource where this audience list will be created.
- * Format: `properties/{propertyId}`
+ * Format: `properties/{property}`
*
*
*
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DateRange.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DateRange.java
index cb88119898ab..27db45d94d01 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DateRange.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DateRange.java
@@ -22,8 +22,8 @@
*
*
*
- * A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
- * are allowed up to 4 date ranges.
+ * A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
+ * Requests are allowed up to 4 date ranges.
*
*
* Protobuf type {@code google.analytics.data.v1alpha.DateRange}
@@ -417,8 +417,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
*
- * A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
- * are allowed up to 4 date ranges.
+ * A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
+ * Requests are allowed up to 4 date ranges.
*
*
* Protobuf type {@code google.analytics.data.v1alpha.DateRange}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/Dimension.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/Dimension.java
index f800e2a4af02..c84370a6d9fa 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/Dimension.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/Dimension.java
@@ -74,7 +74,16 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
@@ -108,7 +117,16 @@ public java.lang.String getName() {
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
@@ -576,7 +594,16 @@ public Builder mergeFrom(
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
@@ -609,7 +636,16 @@ public java.lang.String getName() {
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
@@ -642,7 +678,16 @@ public com.google.protobuf.ByteString getNameBytes() {
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
@@ -674,7 +719,16 @@ public Builder setName(java.lang.String value) {
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
@@ -702,7 +756,16 @@ public Builder clearName() {
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DimensionOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DimensionOrBuilder.java
index b4938ef1ade2..2e8a7462000f 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DimensionOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/DimensionOrBuilder.java
@@ -29,7 +29,16 @@ public interface DimensionOrBuilder
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
@@ -52,7 +61,16 @@ public interface DimensionOrBuilder
*
* The name of the dimension. See the [API
* Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- * for the list of dimension names.
+ * for the list of dimension names supported by core reporting methods such
+ * as `runReport` and `batchRunReports`. See
+ * [Realtime
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ * for the list of dimension names supported by the `runRealtimeReport`
+ * method. See
+ * [Funnel
+ * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ * for the list of dimension names supported by the `runFunnelReport`
+ * method.
*
* If `dimensionExpression` is specified, `name` can be any string that you
* would like within the allowed character set. For example if a
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadata.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadata.java
index 550a553eaf8f..152fad8ef71f 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadata.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadata.java
@@ -72,7 +72,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -93,7 +93,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -114,7 +114,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -134,7 +134,7 @@ public int getSamplingMetadatasCount() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -154,7 +154,7 @@ public com.google.analytics.data.v1alpha.SamplingMetadata getSamplingMetadatas(i
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -588,7 +588,7 @@ private void ensureSamplingMetadatasIsMutable() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -612,7 +612,7 @@ private void ensureSamplingMetadatasIsMutable() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -635,7 +635,7 @@ public int getSamplingMetadatasCount() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -658,7 +658,7 @@ public com.google.analytics.data.v1alpha.SamplingMetadata getSamplingMetadatas(i
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -688,7 +688,7 @@ public Builder setSamplingMetadatas(
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -715,7 +715,7 @@ public Builder setSamplingMetadatas(
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -744,7 +744,7 @@ public Builder addSamplingMetadatas(com.google.analytics.data.v1alpha.SamplingMe
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -774,7 +774,7 @@ public Builder addSamplingMetadatas(
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -801,7 +801,7 @@ public Builder addSamplingMetadatas(
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -828,7 +828,7 @@ public Builder addSamplingMetadatas(
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -855,7 +855,7 @@ public Builder addAllSamplingMetadatas(
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -881,7 +881,7 @@ public Builder clearSamplingMetadatas() {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -907,7 +907,7 @@ public Builder removeSamplingMetadatas(int index) {
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -927,7 +927,7 @@ public com.google.analytics.data.v1alpha.SamplingMetadata.Builder getSamplingMet
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -951,7 +951,7 @@ public com.google.analytics.data.v1alpha.SamplingMetadata.Builder getSamplingMet
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -975,7 +975,7 @@ public com.google.analytics.data.v1alpha.SamplingMetadata.Builder getSamplingMet
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -996,7 +996,7 @@ public com.google.analytics.data.v1alpha.SamplingMetadata.Builder getSamplingMet
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -1018,7 +1018,7 @@ public com.google.analytics.data.v1alpha.SamplingMetadata.Builder addSamplingMet
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadataOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadataOrBuilder.java
index 9aecb1d55e86..88027ec2ece9 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadataOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/FunnelResponseMetadataOrBuilder.java
@@ -28,7 +28,7 @@ public interface FunnelResponseMetadataOrBuilder
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -45,7 +45,7 @@ public interface FunnelResponseMetadataOrBuilder
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -62,7 +62,7 @@ public interface FunnelResponseMetadataOrBuilder
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -79,7 +79,7 @@ public interface FunnelResponseMetadataOrBuilder
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -97,7 +97,7 @@ public interface FunnelResponseMetadataOrBuilder
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* describes what percentage of events were used in this funnel report. One
* `samplingMetadatas` is populated for each date range. Each
* `samplingMetadatas` corresponds to a date range in order that date ranges
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequest.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequest.java
index 3e3361153108..281693d8106c 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequest.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequest.java
@@ -71,7 +71,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
@@ -97,7 +97,7 @@ public java.lang.String getName() {
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
@@ -468,7 +468,7 @@ public Builder mergeFrom(
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
@@ -493,7 +493,7 @@ public java.lang.String getName() {
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
@@ -518,7 +518,7 @@ public com.google.protobuf.ByteString getNameBytes() {
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
@@ -542,7 +542,7 @@ public Builder setName(java.lang.String value) {
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
@@ -562,7 +562,7 @@ public Builder clearName() {
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequestOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequestOrBuilder.java
index e4f45e740b33..2ed05903f0f8 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequestOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/GetAudienceListRequestOrBuilder.java
@@ -28,7 +28,7 @@ public interface GetAudienceListRequestOrBuilder
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
@@ -43,7 +43,7 @@ public interface GetAudienceListRequestOrBuilder
*
*
* Required. The audience list resource name.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
*
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequest.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequest.java
index 17f20e58af55..96ad863cea9e 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequest.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequest.java
@@ -72,7 +72,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -98,7 +98,7 @@ public java.lang.String getParent() {
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -126,13 +126,13 @@ public com.google.protobuf.ByteString getParentBytes() {
*
*
*
- * The maximum number of audience lists to return. The service may return
- * fewer than this value. If unspecified, at most 200 audience lists will be
- * returned. The maximum value is 1000 (higher values will be coerced to the
- * maximum).
+ * Optional. The maximum number of audience lists to return. The service may
+ * return fewer than this value. If unspecified, at most 200 audience lists
+ * will be returned. The maximum value is 1000 (higher values will be coerced
+ * to the maximum).
*
*
- * int32 page_size = 2;
+ * int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageSize.
*/
@@ -149,14 +149,14 @@ public int getPageSize() {
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageToken.
*/
@@ -176,14 +176,14 @@ public java.lang.String getPageToken() {
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for pageToken.
*/
@@ -595,7 +595,7 @@ public Builder mergeFrom(
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -620,7 +620,7 @@ public java.lang.String getParent() {
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -645,7 +645,7 @@ public com.google.protobuf.ByteString getParentBytes() {
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -669,7 +669,7 @@ public Builder setParent(java.lang.String value) {
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -689,7 +689,7 @@ public Builder clearParent() {
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -715,13 +715,13 @@ public Builder setParentBytes(com.google.protobuf.ByteString value) {
*
*
*
- * The maximum number of audience lists to return. The service may return
- * fewer than this value. If unspecified, at most 200 audience lists will be
- * returned. The maximum value is 1000 (higher values will be coerced to the
- * maximum).
+ * Optional. The maximum number of audience lists to return. The service may
+ * return fewer than this value. If unspecified, at most 200 audience lists
+ * will be returned. The maximum value is 1000 (higher values will be coerced
+ * to the maximum).
*
*
- * int32 page_size = 2;
+ * int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageSize.
*/
@@ -733,13 +733,13 @@ public int getPageSize() {
*
*
*
- * The maximum number of audience lists to return. The service may return
- * fewer than this value. If unspecified, at most 200 audience lists will be
- * returned. The maximum value is 1000 (higher values will be coerced to the
- * maximum).
+ * Optional. The maximum number of audience lists to return. The service may
+ * return fewer than this value. If unspecified, at most 200 audience lists
+ * will be returned. The maximum value is 1000 (higher values will be coerced
+ * to the maximum).
*
*
- * int32 page_size = 2;
+ * int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The pageSize to set.
* @return This builder for chaining.
@@ -755,13 +755,13 @@ public Builder setPageSize(int value) {
*
*
*
- * The maximum number of audience lists to return. The service may return
- * fewer than this value. If unspecified, at most 200 audience lists will be
- * returned. The maximum value is 1000 (higher values will be coerced to the
- * maximum).
+ * Optional. The maximum number of audience lists to return. The service may
+ * return fewer than this value. If unspecified, at most 200 audience lists
+ * will be returned. The maximum value is 1000 (higher values will be coerced
+ * to the maximum).
*
*
- * int32 page_size = 2;
+ * int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
@@ -777,14 +777,14 @@ public Builder clearPageSize() {
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageToken.
*/
@@ -803,14 +803,14 @@ public java.lang.String getPageToken() {
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for pageToken.
*/
@@ -829,14 +829,14 @@ public com.google.protobuf.ByteString getPageTokenBytes() {
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The pageToken to set.
* @return This builder for chaining.
@@ -854,14 +854,14 @@ public Builder setPageToken(java.lang.String value) {
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
@@ -875,14 +875,14 @@ public Builder clearPageToken() {
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The bytes for pageToken to set.
* @return This builder for chaining.
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequestOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequestOrBuilder.java
index 71fdb4ee6a8d..661a32f552b7 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequestOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/ListAudienceListsRequestOrBuilder.java
@@ -28,7 +28,7 @@ public interface ListAudienceListsRequestOrBuilder
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -43,7 +43,7 @@ public interface ListAudienceListsRequestOrBuilder
*
*
* Required. All audience lists for this property will be listed in the
- * response. Format: `properties/{propertyId}`
+ * response. Format: `properties/{property}`
*
*
*
@@ -58,13 +58,13 @@ public interface ListAudienceListsRequestOrBuilder
*
*
*
- * The maximum number of audience lists to return. The service may return
- * fewer than this value. If unspecified, at most 200 audience lists will be
- * returned. The maximum value is 1000 (higher values will be coerced to the
- * maximum).
+ * Optional. The maximum number of audience lists to return. The service may
+ * return fewer than this value. If unspecified, at most 200 audience lists
+ * will be returned. The maximum value is 1000 (higher values will be coerced
+ * to the maximum).
*
*
- * int32 page_size = 2;
+ * int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageSize.
*/
@@ -74,14 +74,14 @@ public interface ListAudienceListsRequestOrBuilder
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageToken.
*/
@@ -90,14 +90,14 @@ public interface ListAudienceListsRequestOrBuilder
*
*
*
- * A page token, received from a previous `ListAudienceLists` call. Provide
- * this to retrieve the subsequent page.
+ * Optional. A page token, received from a previous `ListAudienceLists` call.
+ * Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*
*
- * string page_token = 3;
+ * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for pageToken.
*/
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/PropertyName.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/PropertyName.java
index 99b096cbd636..a8dc683f9b63 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/PropertyName.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/PropertyName.java
@@ -29,22 +29,22 @@
// AUTO-GENERATED DOCUMENTATION AND CLASS.
@Generated("by gapic-generator-java")
public class PropertyName implements ResourceName {
- private static final PathTemplate PROPERTY_ID =
- PathTemplate.createWithoutUrlEncoding("properties/{propertyId}");
+ private static final PathTemplate PROPERTY =
+ PathTemplate.createWithoutUrlEncoding("properties/{property}");
private volatile Map
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The name.
*/
@@ -94,11 +94,11 @@ public java.lang.String getName() {
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for name.
*/
@@ -121,7 +121,8 @@ public com.google.protobuf.ByteString getNameBytes() {
*
*
*
- * The row count of the start row. The first row is counted as row 0.
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
*
* When paging, the first request does not specify offset; or equivalently,
* sets offset to 0; the first request returns the first `limit` of rows. The
@@ -132,7 +133,7 @@ public com.google.protobuf.ByteString getNameBytes() {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 offset = 2;
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The offset.
*/
@@ -147,9 +148,9 @@ public long getOffset() {
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
@@ -158,7 +159,7 @@ public long getOffset() {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 limit = 3;
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The limit.
*/
@@ -559,11 +560,11 @@ public Builder mergeFrom(
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The name.
*/
@@ -582,11 +583,11 @@ public java.lang.String getName() {
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for name.
*/
@@ -605,11 +606,11 @@ public com.google.protobuf.ByteString getNameBytes() {
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @param value The name to set.
* @return This builder for chaining.
@@ -627,11 +628,11 @@ public Builder setName(java.lang.String value) {
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return This builder for chaining.
*/
@@ -645,11 +646,11 @@ public Builder clearName() {
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @param value The bytes for name to set.
* @return This builder for chaining.
@@ -670,7 +671,8 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
*
*
*
- * The row count of the start row. The first row is counted as row 0.
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
*
* When paging, the first request does not specify offset; or equivalently,
* sets offset to 0; the first request returns the first `limit` of rows. The
@@ -681,7 +683,7 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 offset = 2;
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The offset.
*/
@@ -693,7 +695,8 @@ public long getOffset() {
*
*
*
- * The row count of the start row. The first row is counted as row 0.
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
*
* When paging, the first request does not specify offset; or equivalently,
* sets offset to 0; the first request returns the first `limit` of rows. The
@@ -704,7 +707,7 @@ public long getOffset() {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 offset = 2;
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The offset to set.
* @return This builder for chaining.
@@ -720,7 +723,8 @@ public Builder setOffset(long value) {
*
*
*
- * The row count of the start row. The first row is counted as row 0.
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
*
* When paging, the first request does not specify offset; or equivalently,
* sets offset to 0; the first request returns the first `limit` of rows. The
@@ -731,7 +735,7 @@ public Builder setOffset(long value) {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 offset = 2;
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
@@ -747,9 +751,9 @@ public Builder clearOffset() {
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
@@ -758,7 +762,7 @@ public Builder clearOffset() {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 limit = 3;
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The limit.
*/
@@ -770,9 +774,9 @@ public long getLimit() {
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
@@ -781,7 +785,7 @@ public long getLimit() {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 limit = 3;
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The limit to set.
* @return This builder for chaining.
@@ -797,9 +801,9 @@ public Builder setLimit(long value) {
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
@@ -808,7 +812,7 @@ public Builder setLimit(long value) {
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 limit = 3;
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListRequestOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListRequestOrBuilder.java
index 1da21e0b7854..3003f11e1775 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListRequestOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListRequestOrBuilder.java
@@ -27,11 +27,11 @@ public interface QueryAudienceListRequestOrBuilder
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The name.
*/
@@ -40,11 +40,11 @@ public interface QueryAudienceListRequestOrBuilder
*
*
*
- * The name of the audience list to retrieve users from.
- * Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for name.
*/
@@ -54,7 +54,8 @@ public interface QueryAudienceListRequestOrBuilder
*
*
*
- * The row count of the start row. The first row is counted as row 0.
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
*
* When paging, the first request does not specify offset; or equivalently,
* sets offset to 0; the first request returns the first `limit` of rows. The
@@ -65,7 +66,7 @@ public interface QueryAudienceListRequestOrBuilder
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 offset = 2;
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The offset.
*/
@@ -75,9 +76,9 @@ public interface QueryAudienceListRequestOrBuilder
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
@@ -86,7 +87,7 @@ public interface QueryAudienceListRequestOrBuilder
* [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*
*
- * int64 limit = 3;
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The limit.
*/
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponse.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponse.java
index 22d152430af1..9a27c16be4d6 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponse.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponse.java
@@ -202,10 +202,10 @@ public com.google.analytics.data.v1alpha.AudienceRowOrBuilder getAudienceRowsOrB
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
@@ -224,10 +224,10 @@ public boolean hasRowCount() {
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
@@ -1285,10 +1285,10 @@ public com.google.analytics.data.v1alpha.AudienceRow.Builder addAudienceRowsBuil
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
@@ -1307,10 +1307,10 @@ public boolean hasRowCount() {
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
@@ -1329,10 +1329,10 @@ public int getRowCount() {
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
@@ -1355,10 +1355,10 @@ public Builder setRowCount(int value) {
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponseOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponseOrBuilder.java
index 798f3b445623..74d670eb357e 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponseOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/QueryAudienceListResponseOrBuilder.java
@@ -125,10 +125,10 @@ public interface QueryAudienceListResponseOrBuilder
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
@@ -144,10 +144,10 @@ public interface QueryAudienceListResponseOrBuilder
*
*
*
- * The total number of rows in the query result. `rowCount` is independent of
- * the number of rows returned in the response, the `limit` request
- * parameter, and the `offset` request parameter. For example if a query
- * returns 175 rows and includes `limit` of 50 in the API request, the
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
* response will contain `rowCount` of 175 but only 50 rows.
*
* To learn more about this pagination parameter, see
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequest.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequest.java
index d0a394476bf5..93a1bc5a5f66 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequest.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequest.java
@@ -241,9 +241,9 @@ private FunnelVisualizationType(int value) {
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -251,7 +251,7 @@ private FunnelVisualizationType(int value) {
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The property.
*/
@@ -271,9 +271,9 @@ public java.lang.String getProperty() {
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -281,7 +281,7 @@ public java.lang.String getProperty() {
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for property.
*/
@@ -306,13 +306,15 @@ public com.google.protobuf.ByteString getPropertyBytes() {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public java.util.List
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public java.util.List
@@ -339,13 +343,15 @@ public java.util.List
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public int getDateRangesCount() {
@@ -355,13 +361,15 @@ public int getDateRangesCount() {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.DateRange getDateRanges(int index) {
@@ -371,13 +379,15 @@ public com.google.analytics.data.v1alpha.DateRange getDateRanges(int index) {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.DateRangeOrBuilder getDateRangesOrBuilder(int index) {
@@ -390,11 +400,13 @@ public com.google.analytics.data.v1alpha.DateRangeOrBuilder getDateRangesOrBuild
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnel field is set.
*/
@@ -406,11 +418,13 @@ public boolean hasFunnel() {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnel.
*/
@@ -424,11 +438,13 @@ public com.google.analytics.data.v1alpha.Funnel getFunnel() {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.FunnelOrBuilder getFunnelOrBuilder() {
@@ -443,14 +459,16 @@ public com.google.analytics.data.v1alpha.FunnelOrBuilder getFunnelOrBuilder() {
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnelBreakdown field is set.
*/
@@ -462,14 +480,16 @@ public boolean hasFunnelBreakdown() {
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnelBreakdown.
*/
@@ -483,14 +503,16 @@ public com.google.analytics.data.v1alpha.FunnelBreakdown getFunnelBreakdown() {
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.FunnelBreakdownOrBuilder getFunnelBreakdownOrBuilder() {
@@ -505,17 +527,19 @@ public com.google.analytics.data.v1alpha.FunnelBreakdownOrBuilder getFunnelBreak
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnelNextAction field is set.
*/
@@ -527,17 +551,19 @@ public boolean hasFunnelNextAction() {
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnelNextAction.
*/
@@ -551,17 +577,19 @@ public com.google.analytics.data.v1alpha.FunnelNextAction getFunnelNextAction()
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.FunnelNextActionOrBuilder
@@ -577,13 +605,13 @@ public com.google.analytics.data.v1alpha.FunnelNextAction getFunnelNextAction()
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for funnelVisualizationType.
@@ -596,13 +624,13 @@ public int getFunnelVisualizationTypeValue() {
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The funnelVisualizationType.
@@ -627,8 +655,9 @@ public int getFunnelVisualizationTypeValue() {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -637,7 +666,9 @@ public int getFunnelVisualizationTypeValue() {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public java.util.List
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -657,7 +689,9 @@ public java.util.List
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public java.util.List
@@ -668,8 +702,9 @@ public java.util.List
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -678,7 +713,9 @@ public java.util.List
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public int getSegmentsCount() {
@@ -688,8 +725,9 @@ public int getSegmentsCount() {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -698,7 +736,9 @@ public int getSegmentsCount() {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.Segment getSegments(int index) {
@@ -708,8 +748,9 @@ public com.google.analytics.data.v1alpha.Segment getSegments(int index) {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -718,7 +759,9 @@ public com.google.analytics.data.v1alpha.Segment getSegments(int index) {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(int index) {
@@ -731,15 +774,15 @@ public com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(i
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
*
*
- * int64 limit = 9;
+ * int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The limit.
*/
@@ -754,13 +797,15 @@ public long getLimit() {
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the dimensionFilter field is set.
*/
@@ -772,13 +817,15 @@ public boolean hasDimensionFilter() {
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The dimensionFilter.
*/
@@ -792,13 +839,15 @@ public com.google.analytics.data.v1alpha.FilterExpression getDimensionFilter() {
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
@java.lang.Override
public com.google.analytics.data.v1alpha.FilterExpressionOrBuilder getDimensionFilterOrBuilder() {
@@ -813,11 +862,11 @@ public com.google.analytics.data.v1alpha.FilterExpressionOrBuilder getDimensionF
*
*
*
- * Toggles whether to return the current state of this Analytics Property's
- * quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+ * Optional. Toggles whether to return the current state of this Analytics
+ * Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
*
- * bool return_property_quota = 12;
+ * bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The returnPropertyQuota.
*/
@@ -1513,9 +1562,9 @@ public Builder mergeFrom(
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -1523,7 +1572,7 @@ public Builder mergeFrom(
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The property.
*/
@@ -1542,9 +1591,9 @@ public java.lang.String getProperty() {
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -1552,7 +1601,7 @@ public java.lang.String getProperty() {
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for property.
*/
@@ -1571,9 +1620,9 @@ public com.google.protobuf.ByteString getPropertyBytes() {
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -1581,7 +1630,7 @@ public com.google.protobuf.ByteString getPropertyBytes() {
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The property to set.
* @return This builder for chaining.
@@ -1599,9 +1648,9 @@ public Builder setProperty(java.lang.String value) {
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -1609,7 +1658,7 @@ public Builder setProperty(java.lang.String value) {
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
@@ -1623,9 +1672,9 @@ public Builder clearProperty() {
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -1633,7 +1682,7 @@ public Builder clearProperty() {
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The bytes for property to set.
* @return This builder for chaining.
@@ -1670,13 +1719,15 @@ private void ensureDateRangesIsMutable() {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public java.util.List
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public int getDateRangesCount() {
if (dateRangesBuilder_ == null) {
@@ -1708,13 +1761,15 @@ public int getDateRangesCount() {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.DateRange getDateRanges(int index) {
if (dateRangesBuilder_ == null) {
@@ -1727,13 +1782,15 @@ public com.google.analytics.data.v1alpha.DateRange getDateRanges(int index) {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setDateRanges(int index, com.google.analytics.data.v1alpha.DateRange value) {
if (dateRangesBuilder_ == null) {
@@ -1752,13 +1809,15 @@ public Builder setDateRanges(int index, com.google.analytics.data.v1alpha.DateRa
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setDateRanges(
int index, com.google.analytics.data.v1alpha.DateRange.Builder builderForValue) {
@@ -1775,13 +1834,15 @@ public Builder setDateRanges(
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addDateRanges(com.google.analytics.data.v1alpha.DateRange value) {
if (dateRangesBuilder_ == null) {
@@ -1800,13 +1861,15 @@ public Builder addDateRanges(com.google.analytics.data.v1alpha.DateRange value)
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addDateRanges(int index, com.google.analytics.data.v1alpha.DateRange value) {
if (dateRangesBuilder_ == null) {
@@ -1825,13 +1888,15 @@ public Builder addDateRanges(int index, com.google.analytics.data.v1alpha.DateRa
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addDateRanges(
com.google.analytics.data.v1alpha.DateRange.Builder builderForValue) {
@@ -1848,13 +1913,15 @@ public Builder addDateRanges(
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addDateRanges(
int index, com.google.analytics.data.v1alpha.DateRange.Builder builderForValue) {
@@ -1871,13 +1938,15 @@ public Builder addDateRanges(
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addAllDateRanges(
java.lang.Iterable values) {
@@ -1894,13 +1963,15 @@ public Builder addAllDateRanges(
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder clearDateRanges() {
if (dateRangesBuilder_ == null) {
@@ -1916,13 +1987,15 @@ public Builder clearDateRanges() {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder removeDateRanges(int index) {
if (dateRangesBuilder_ == null) {
@@ -1938,13 +2011,15 @@ public Builder removeDateRanges(int index) {
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.DateRange.Builder getDateRangesBuilder(int index) {
return getDateRangesFieldBuilder().getBuilder(index);
@@ -1953,13 +2028,15 @@ public com.google.analytics.data.v1alpha.DateRange.Builder getDateRangesBuilder(
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.DateRangeOrBuilder getDateRangesOrBuilder(int index) {
if (dateRangesBuilder_ == null) {
@@ -1972,13 +2049,15 @@ public com.google.analytics.data.v1alpha.DateRangeOrBuilder getDateRangesOrBuild
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public java.util.List
getDateRangesOrBuilderList() {
@@ -1992,13 +2071,15 @@ public com.google.analytics.data.v1alpha.DateRangeOrBuilder getDateRangesOrBuild
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.DateRange.Builder addDateRangesBuilder() {
return getDateRangesFieldBuilder()
@@ -2008,13 +2089,15 @@ public com.google.analytics.data.v1alpha.DateRange.Builder addDateRangesBuilder(
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.DateRange.Builder addDateRangesBuilder(int index) {
return getDateRangesFieldBuilder()
@@ -2024,13 +2107,15 @@ public com.google.analytics.data.v1alpha.DateRange.Builder addDateRangesBuilder(
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public java.util.List
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnel field is set.
*/
@@ -2079,11 +2166,13 @@ public boolean hasFunnel() {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnel.
*/
@@ -2100,11 +2189,13 @@ public com.google.analytics.data.v1alpha.Funnel getFunnel() {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setFunnel(com.google.analytics.data.v1alpha.Funnel value) {
if (funnelBuilder_ == null) {
@@ -2123,11 +2214,13 @@ public Builder setFunnel(com.google.analytics.data.v1alpha.Funnel value) {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setFunnel(com.google.analytics.data.v1alpha.Funnel.Builder builderForValue) {
if (funnelBuilder_ == null) {
@@ -2143,11 +2236,13 @@ public Builder setFunnel(com.google.analytics.data.v1alpha.Funnel.Builder builde
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder mergeFunnel(com.google.analytics.data.v1alpha.Funnel value) {
if (funnelBuilder_ == null) {
@@ -2169,11 +2264,13 @@ public Builder mergeFunnel(com.google.analytics.data.v1alpha.Funnel value) {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder clearFunnel() {
bitField0_ = (bitField0_ & ~0x00000004);
@@ -2189,11 +2286,13 @@ public Builder clearFunnel() {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.Funnel.Builder getFunnelBuilder() {
bitField0_ |= 0x00000004;
@@ -2204,11 +2303,13 @@ public com.google.analytics.data.v1alpha.Funnel.Builder getFunnelBuilder() {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.FunnelOrBuilder getFunnelOrBuilder() {
if (funnelBuilder_ != null) {
@@ -2223,11 +2324,13 @@ public com.google.analytics.data.v1alpha.FunnelOrBuilder getFunnelOrBuilder() {
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.analytics.data.v1alpha.Funnel,
@@ -2256,14 +2359,16 @@ public com.google.analytics.data.v1alpha.FunnelOrBuilder getFunnelOrBuilder() {
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnelBreakdown field is set.
*/
@@ -2274,14 +2379,16 @@ public boolean hasFunnelBreakdown() {
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnelBreakdown.
*/
@@ -2298,14 +2405,16 @@ public com.google.analytics.data.v1alpha.FunnelBreakdown getFunnelBreakdown() {
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setFunnelBreakdown(com.google.analytics.data.v1alpha.FunnelBreakdown value) {
if (funnelBreakdownBuilder_ == null) {
@@ -2324,14 +2433,16 @@ public Builder setFunnelBreakdown(com.google.analytics.data.v1alpha.FunnelBreakd
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setFunnelBreakdown(
com.google.analytics.data.v1alpha.FunnelBreakdown.Builder builderForValue) {
@@ -2348,14 +2459,16 @@ public Builder setFunnelBreakdown(
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder mergeFunnelBreakdown(com.google.analytics.data.v1alpha.FunnelBreakdown value) {
if (funnelBreakdownBuilder_ == null) {
@@ -2378,14 +2491,16 @@ public Builder mergeFunnelBreakdown(com.google.analytics.data.v1alpha.FunnelBrea
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder clearFunnelBreakdown() {
bitField0_ = (bitField0_ & ~0x00000008);
@@ -2401,14 +2516,16 @@ public Builder clearFunnelBreakdown() {
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.FunnelBreakdown.Builder getFunnelBreakdownBuilder() {
bitField0_ |= 0x00000008;
@@ -2419,14 +2536,16 @@ public com.google.analytics.data.v1alpha.FunnelBreakdown.Builder getFunnelBreakd
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.FunnelBreakdownOrBuilder
getFunnelBreakdownOrBuilder() {
@@ -2442,14 +2561,16 @@ public com.google.analytics.data.v1alpha.FunnelBreakdown.Builder getFunnelBreakd
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.analytics.data.v1alpha.FunnelBreakdown,
@@ -2478,17 +2599,19 @@ public com.google.analytics.data.v1alpha.FunnelBreakdown.Builder getFunnelBreakd
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnelNextAction field is set.
*/
@@ -2499,17 +2622,19 @@ public boolean hasFunnelNextAction() {
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnelNextAction.
*/
@@ -2526,17 +2651,19 @@ public com.google.analytics.data.v1alpha.FunnelNextAction getFunnelNextAction()
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setFunnelNextAction(com.google.analytics.data.v1alpha.FunnelNextAction value) {
if (funnelNextActionBuilder_ == null) {
@@ -2555,17 +2682,19 @@ public Builder setFunnelNextAction(com.google.analytics.data.v1alpha.FunnelNextA
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setFunnelNextAction(
com.google.analytics.data.v1alpha.FunnelNextAction.Builder builderForValue) {
@@ -2582,17 +2711,19 @@ public Builder setFunnelNextAction(
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder mergeFunnelNextAction(com.google.analytics.data.v1alpha.FunnelNextAction value) {
if (funnelNextActionBuilder_ == null) {
@@ -2615,17 +2746,19 @@ public Builder mergeFunnelNextAction(com.google.analytics.data.v1alpha.FunnelNex
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder clearFunnelNextAction() {
bitField0_ = (bitField0_ & ~0x00000010);
@@ -2641,17 +2774,19 @@ public Builder clearFunnelNextAction() {
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.FunnelNextAction.Builder getFunnelNextActionBuilder() {
bitField0_ |= 0x00000010;
@@ -2662,17 +2797,19 @@ public com.google.analytics.data.v1alpha.FunnelNextAction.Builder getFunnelNextA
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.FunnelNextActionOrBuilder
getFunnelNextActionOrBuilder() {
@@ -2688,17 +2825,19 @@ public com.google.analytics.data.v1alpha.FunnelNextAction.Builder getFunnelNextA
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.analytics.data.v1alpha.FunnelNextAction,
@@ -2722,13 +2861,13 @@ public com.google.analytics.data.v1alpha.FunnelNextAction.Builder getFunnelNextA
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for funnelVisualizationType.
@@ -2741,13 +2880,13 @@ public int getFunnelVisualizationTypeValue() {
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param value The enum numeric value on the wire for funnelVisualizationType to set.
@@ -2763,13 +2902,13 @@ public Builder setFunnelVisualizationTypeValue(int value) {
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The funnelVisualizationType.
@@ -2789,13 +2928,13 @@ public Builder setFunnelVisualizationTypeValue(int value) {
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param value The funnelVisualizationType to set.
@@ -2815,13 +2954,13 @@ public Builder setFunnelVisualizationType(
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return This builder for chaining.
@@ -2853,8 +2992,9 @@ private void ensureSegmentsIsMutable() {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -2863,7 +3003,9 @@ private void ensureSegmentsIsMutable() {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public java.util.List
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -2886,7 +3029,9 @@ public java.util.List
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public int getSegmentsCount() {
if (segmentsBuilder_ == null) {
@@ -2899,8 +3044,9 @@ public int getSegmentsCount() {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -2909,7 +3055,9 @@ public int getSegmentsCount() {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.Segment getSegments(int index) {
if (segmentsBuilder_ == null) {
@@ -2922,8 +3070,9 @@ public com.google.analytics.data.v1alpha.Segment getSegments(int index) {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -2932,7 +3081,9 @@ public com.google.analytics.data.v1alpha.Segment getSegments(int index) {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setSegments(int index, com.google.analytics.data.v1alpha.Segment value) {
if (segmentsBuilder_ == null) {
@@ -2951,8 +3102,9 @@ public Builder setSegments(int index, com.google.analytics.data.v1alpha.Segment
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -2961,7 +3113,9 @@ public Builder setSegments(int index, com.google.analytics.data.v1alpha.Segment
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setSegments(
int index, com.google.analytics.data.v1alpha.Segment.Builder builderForValue) {
@@ -2978,8 +3132,9 @@ public Builder setSegments(
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -2988,7 +3143,9 @@ public Builder setSegments(
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addSegments(com.google.analytics.data.v1alpha.Segment value) {
if (segmentsBuilder_ == null) {
@@ -3007,8 +3164,9 @@ public Builder addSegments(com.google.analytics.data.v1alpha.Segment value) {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3017,7 +3175,9 @@ public Builder addSegments(com.google.analytics.data.v1alpha.Segment value) {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addSegments(int index, com.google.analytics.data.v1alpha.Segment value) {
if (segmentsBuilder_ == null) {
@@ -3036,8 +3196,9 @@ public Builder addSegments(int index, com.google.analytics.data.v1alpha.Segment
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3046,7 +3207,9 @@ public Builder addSegments(int index, com.google.analytics.data.v1alpha.Segment
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addSegments(com.google.analytics.data.v1alpha.Segment.Builder builderForValue) {
if (segmentsBuilder_ == null) {
@@ -3062,8 +3225,9 @@ public Builder addSegments(com.google.analytics.data.v1alpha.Segment.Builder bui
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3072,7 +3236,9 @@ public Builder addSegments(com.google.analytics.data.v1alpha.Segment.Builder bui
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addSegments(
int index, com.google.analytics.data.v1alpha.Segment.Builder builderForValue) {
@@ -3089,8 +3255,9 @@ public Builder addSegments(
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3099,7 +3266,9 @@ public Builder addSegments(
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder addAllSegments(
java.lang.Iterable values) {
@@ -3116,8 +3285,9 @@ public Builder addAllSegments(
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3126,7 +3296,9 @@ public Builder addAllSegments(
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder clearSegments() {
if (segmentsBuilder_ == null) {
@@ -3142,8 +3314,9 @@ public Builder clearSegments() {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3152,7 +3325,9 @@ public Builder clearSegments() {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder removeSegments(int index) {
if (segmentsBuilder_ == null) {
@@ -3168,8 +3343,9 @@ public Builder removeSegments(int index) {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3178,7 +3354,9 @@ public Builder removeSegments(int index) {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.Segment.Builder getSegmentsBuilder(int index) {
return getSegmentsFieldBuilder().getBuilder(index);
@@ -3187,8 +3365,9 @@ public com.google.analytics.data.v1alpha.Segment.Builder getSegmentsBuilder(int
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3197,7 +3376,9 @@ public com.google.analytics.data.v1alpha.Segment.Builder getSegmentsBuilder(int
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(int index) {
if (segmentsBuilder_ == null) {
@@ -3210,8 +3391,9 @@ public com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(i
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3220,7 +3402,9 @@ public com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(i
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public java.util.List
getSegmentsOrBuilderList() {
@@ -3234,8 +3418,9 @@ public com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(i
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3244,7 +3429,9 @@ public com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(i
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.Segment.Builder addSegmentsBuilder() {
return getSegmentsFieldBuilder()
@@ -3254,8 +3441,9 @@ public com.google.analytics.data.v1alpha.Segment.Builder addSegmentsBuilder() {
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3264,7 +3452,9 @@ public com.google.analytics.data.v1alpha.Segment.Builder addSegmentsBuilder() {
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.Segment.Builder addSegmentsBuilder(int index) {
return getSegmentsFieldBuilder()
@@ -3274,8 +3464,9 @@ public com.google.analytics.data.v1alpha.Segment.Builder addSegmentsBuilder(int
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -3284,7 +3475,9 @@ public com.google.analytics.data.v1alpha.Segment.Builder addSegmentsBuilder(int
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public java.util.List
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
*
*
- * int64 limit = 9;
+ * int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The limit.
*/
@@ -3333,15 +3526,15 @@ public long getLimit() {
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
*
*
- * int64 limit = 9;
+ * int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The limit to set.
* @return This builder for chaining.
@@ -3357,15 +3550,15 @@ public Builder setLimit(long value) {
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
*
*
- * int64 limit = 9;
+ * int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
@@ -3386,13 +3579,15 @@ public Builder clearLimit() {
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the dimensionFilter field is set.
*/
@@ -3403,13 +3598,15 @@ public boolean hasDimensionFilter() {
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The dimensionFilter.
*/
@@ -3426,13 +3623,15 @@ public com.google.analytics.data.v1alpha.FilterExpression getDimensionFilter() {
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setDimensionFilter(com.google.analytics.data.v1alpha.FilterExpression value) {
if (dimensionFilterBuilder_ == null) {
@@ -3451,13 +3650,15 @@ public Builder setDimensionFilter(com.google.analytics.data.v1alpha.FilterExpres
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder setDimensionFilter(
com.google.analytics.data.v1alpha.FilterExpression.Builder builderForValue) {
@@ -3474,13 +3675,15 @@ public Builder setDimensionFilter(
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder mergeDimensionFilter(com.google.analytics.data.v1alpha.FilterExpression value) {
if (dimensionFilterBuilder_ == null) {
@@ -3503,13 +3706,15 @@ public Builder mergeDimensionFilter(com.google.analytics.data.v1alpha.FilterExpr
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public Builder clearDimensionFilter() {
bitField0_ = (bitField0_ & ~0x00000100);
@@ -3525,13 +3730,15 @@ public Builder clearDimensionFilter() {
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.FilterExpression.Builder getDimensionFilterBuilder() {
bitField0_ |= 0x00000100;
@@ -3542,13 +3749,15 @@ public com.google.analytics.data.v1alpha.FilterExpression.Builder getDimensionFi
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
public com.google.analytics.data.v1alpha.FilterExpressionOrBuilder
getDimensionFilterOrBuilder() {
@@ -3564,13 +3773,15 @@ public com.google.analytics.data.v1alpha.FilterExpression.Builder getDimensionFi
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.analytics.data.v1alpha.FilterExpression,
@@ -3594,11 +3805,11 @@ public com.google.analytics.data.v1alpha.FilterExpression.Builder getDimensionFi
*
*
*
- * Toggles whether to return the current state of this Analytics Property's
- * quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+ * Optional. Toggles whether to return the current state of this Analytics
+ * Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
*
- * bool return_property_quota = 12;
+ * bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The returnPropertyQuota.
*/
@@ -3610,11 +3821,11 @@ public boolean getReturnPropertyQuota() {
*
*
*
- * Toggles whether to return the current state of this Analytics Property's
- * quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+ * Optional. Toggles whether to return the current state of this Analytics
+ * Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
*
- * bool return_property_quota = 12;
+ * bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The returnPropertyQuota to set.
* @return This builder for chaining.
@@ -3630,11 +3841,11 @@ public Builder setReturnPropertyQuota(boolean value) {
*
*
*
- * Toggles whether to return the current state of this Analytics Property's
- * quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+ * Optional. Toggles whether to return the current state of this Analytics
+ * Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
*
- * bool return_property_quota = 12;
+ * bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequestOrBuilder.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequestOrBuilder.java
index 516865b7e2b0..23bec358b330 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequestOrBuilder.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/RunFunnelReportRequestOrBuilder.java
@@ -27,9 +27,9 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -37,7 +37,7 @@ public interface RunFunnelReportRequestOrBuilder
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The property.
*/
@@ -46,9 +46,9 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * A Google Analytics GA4 property identifier whose events are tracked.
- * Specified in the URL path and not the body. To learn more, see [where to
- * find your Property
+ * Optional. A Google Analytics GA4 property identifier whose events are
+ * tracked. Specified in the URL path and not the body. To learn more, see
+ * [where to find your Property
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
* Within a batch request, this property should either be unspecified or
* consistent with the batch-level property.
@@ -56,7 +56,7 @@ public interface RunFunnelReportRequestOrBuilder
* Example: properties/1234
*
*
- * string property = 1;
+ * string property = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for property.
*/
@@ -66,52 +66,60 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
java.util.List
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.DateRange getDateRanges(int index);
/**
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
int getDateRangesCount();
/**
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
java.util.List
getDateRangesOrBuilderList();
@@ -119,13 +127,15 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * Date ranges of data to read. If multiple date ranges are requested, each
- * response row will contain a zero based date range index. If two date
- * ranges overlap, the event data for the overlapping days is included in the
- * response rows for both date ranges.
+ * Optional. Date ranges of data to read. If multiple date ranges are
+ * requested, each response row will contain a zero based date range index. If
+ * two date ranges overlap, the event data for the overlapping days is
+ * included in the response rows for both date ranges.
*
*
- * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2;
+ *
+ * repeated .google.analytics.data.v1alpha.DateRange date_ranges = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.DateRangeOrBuilder getDateRangesOrBuilder(int index);
@@ -133,11 +143,13 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnel field is set.
*/
@@ -146,11 +158,13 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnel.
*/
@@ -159,11 +173,13 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The configuration of this request's funnel. This funnel configuration is
- * required.
+ * Optional. The configuration of this request's funnel. This funnel
+ * configuration is required.
*
*
- * .google.analytics.data.v1alpha.Funnel funnel = 3;
+ *
+ * .google.analytics.data.v1alpha.Funnel funnel = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.FunnelOrBuilder getFunnelOrBuilder();
@@ -171,14 +187,16 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnelBreakdown field is set.
*/
@@ -187,14 +205,16 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnelBreakdown.
*/
@@ -203,14 +223,16 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * If specified, this breakdown adds a dimension to the funnel table sub
- * report response. This breakdown dimension expands each funnel step to the
- * unique values of the breakdown dimension. For example, a breakdown by the
- * `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ * Optional. If specified, this breakdown adds a dimension to the funnel table
+ * sub report response. This breakdown dimension expands each funnel step to
+ * the unique values of the breakdown dimension. For example, a breakdown by
+ * the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
* `desktop`, and the total.
*
*
- * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4;
+ *
+ * .google.analytics.data.v1alpha.FunnelBreakdown funnel_breakdown = 4 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.FunnelBreakdownOrBuilder getFunnelBreakdownOrBuilder();
@@ -218,17 +240,19 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the funnelNextAction field is set.
*/
@@ -237,17 +261,19 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The funnelNextAction.
*/
@@ -256,17 +282,19 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * If specified, next action adds a dimension to the funnel visualization sub
- * report response. This next action dimension expands each funnel step to the
- * unique values of the next action. For example a next action of the
- * `eventName` dimension will create rows for several events (for example
- * `session_start` & `click`) and the total.
+ * Optional. If specified, next action adds a dimension to the funnel
+ * visualization sub report response. This next action dimension expands each
+ * funnel step to the unique values of the next action. For example a next
+ * action of the `eventName` dimension will create rows for several events
+ * (for example `session_start` & `click`) and the total.
*
* Next action only supports `eventName` and most Page / Screen dimensions
* like `pageTitle` and `pagePath`.
*
*
- * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5;
+ *
+ * .google.analytics.data.v1alpha.FunnelNextAction funnel_next_action = 5 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.FunnelNextActionOrBuilder getFunnelNextActionOrBuilder();
@@ -274,13 +302,13 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for funnelVisualizationType.
@@ -290,13 +318,13 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The funnel visualization type controls the dimensions present in the funnel
- * visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- * used.
+ * Optional. The funnel visualization type controls the dimensions present in
+ * the funnel visualization sub report response. If not specified,
+ * `STANDARD_FUNNEL` is used.
*
*
*
- * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6;
+ * .google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType funnel_visualization_type = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The funnelVisualizationType.
@@ -308,8 +336,9 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -318,15 +347,18 @@ public interface RunFunnelReportRequestOrBuilder
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
java.util.List
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -335,15 +367,18 @@ public interface RunFunnelReportRequestOrBuilder
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.Segment getSegments(int index);
/**
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -352,15 +387,18 @@ public interface RunFunnelReportRequestOrBuilder
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
int getSegmentsCount();
/**
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -369,7 +407,9 @@ public interface RunFunnelReportRequestOrBuilder
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
java.util.List
getSegmentsOrBuilderList();
@@ -377,8 +417,9 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The configurations of segments. Segments are subsets of a property's data.
- * In a funnel report with segments, the funnel is evaluated in each segment.
+ * Optional. The configurations of segments. Segments are subsets of a
+ * property's data. In a funnel report with segments, the funnel is evaluated
+ * in each segment.
*
* Each segment specified in this request
* produces a separate row in the response; in the response, each segment
@@ -387,7 +428,9 @@ public interface RunFunnelReportRequestOrBuilder
* The segments parameter is optional. Requests are limited to 4 segments.
*
*
- * repeated .google.analytics.data.v1alpha.Segment segments = 7;
+ *
+ * repeated .google.analytics.data.v1alpha.Segment segments = 7 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.SegmentOrBuilder getSegmentsOrBuilder(int index);
@@ -395,15 +438,15 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * The number of rows to return. If unspecified, 10,000 rows are returned. The
- * API returns a maximum of 250,000 rows per request, no matter how many you
- * ask for. `limit` must be positive.
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
*
* The API can also return fewer rows than the requested `limit`, if there
* aren't as many dimension values as the `limit`.
*
*
- * int64 limit = 9;
+ * int64 limit = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The limit.
*/
@@ -413,13 +456,15 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return Whether the dimensionFilter field is set.
*/
@@ -428,13 +473,15 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*
* @return The dimensionFilter.
*/
@@ -443,13 +490,15 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * Dimension filters allow you to ask for only specific dimension values in
- * the report. To learn more, see [Creating a Report: Dimension
+ * Optional. Dimension filters allow you to ask for only specific dimension
+ * values in the report. To learn more, see [Creating a Report: Dimension
* Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*
*
- * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10;
+ *
+ * .google.analytics.data.v1alpha.FilterExpression dimension_filter = 10 [(.google.api.field_behavior) = OPTIONAL];
+ *
*/
com.google.analytics.data.v1alpha.FilterExpressionOrBuilder getDimensionFilterOrBuilder();
@@ -457,11 +506,11 @@ public interface RunFunnelReportRequestOrBuilder
*
*
*
- * Toggles whether to return the current state of this Analytics Property's
- * quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+ * Optional. Toggles whether to return the current state of this Analytics
+ * Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
*
*
- * bool return_property_quota = 12;
+ * bool return_property_quota = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The returnPropertyQuota.
*/
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SamplingMetadata.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SamplingMetadata.java
index ed3a534d584a..72b2de25c10d 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SamplingMetadata.java
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SamplingMetadata.java
@@ -23,7 +23,7 @@
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* metadata describes what percentage of events were used in this funnel
* report for a date range. Sampling is the practice of analyzing a subset of
* all data in order to uncover the meaningful information in the larger data
@@ -282,7 +282,7 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* If funnel report results are
- * [sampled](https://support.google.com/analytics/answer/2637192), this
+ * [sampled](https://support.google.com/analytics/answer/13331292), this
* metadata describes what percentage of events were used in this funnel
* report for a date range. Sampling is the practice of analyzing a subset of
* all data in order to uncover the meaningful information in the larger data
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SheetExportAudienceListRequest.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SheetExportAudienceListRequest.java
new file mode 100644
index 000000000000..303bdc39df47
--- /dev/null
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SheetExportAudienceListRequest.java
@@ -0,0 +1,908 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// Generated by the protocol buffer compiler. DO NOT EDIT!
+// source: google/analytics/data/v1alpha/analytics_data_api.proto
+
+package com.google.analytics.data.v1alpha;
+
+/**
+ *
+ *
+ *
+ * A request to export users in an audience list to a Google Sheet.
+ *
+ *
+ * Protobuf type {@code google.analytics.data.v1alpha.SheetExportAudienceListRequest}
+ */
+public final class SheetExportAudienceListRequest extends com.google.protobuf.GeneratedMessageV3
+ implements
+ // @@protoc_insertion_point(message_implements:google.analytics.data.v1alpha.SheetExportAudienceListRequest)
+ SheetExportAudienceListRequestOrBuilder {
+ private static final long serialVersionUID = 0L;
+ // Use SheetExportAudienceListRequest.newBuilder() to construct.
+ private SheetExportAudienceListRequest(
+ com.google.protobuf.GeneratedMessageV3.Builder builder) {
+ super(builder);
+ }
+
+ private SheetExportAudienceListRequest() {
+ name_ = "";
+ }
+
+ @java.lang.Override
+ @SuppressWarnings({"unused"})
+ protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
+ return new SheetExportAudienceListRequest();
+ }
+
+ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
+ return com.google.analytics.data.v1alpha.AnalyticsDataApiProto
+ .internal_static_google_analytics_data_v1alpha_SheetExportAudienceListRequest_descriptor;
+ }
+
+ @java.lang.Override
+ protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
+ internalGetFieldAccessorTable() {
+ return com.google.analytics.data.v1alpha.AnalyticsDataApiProto
+ .internal_static_google_analytics_data_v1alpha_SheetExportAudienceListRequest_fieldAccessorTable
+ .ensureFieldAccessorsInitialized(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest.class,
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest.Builder.class);
+ }
+
+ public static final int NAME_FIELD_NUMBER = 1;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object name_ = "";
+ /**
+ *
+ *
+ *
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @return The name.
+ */
+ @java.lang.Override
+ public java.lang.String getName() {
+ java.lang.Object ref = name_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ name_ = s;
+ return s;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @return The bytes for name.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getNameBytes() {
+ java.lang.Object ref = name_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ name_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int OFFSET_FIELD_NUMBER = 2;
+ private long offset_ = 0L;
+ /**
+ *
+ *
+ *
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
+ *
+ * When paging, the first request does not specify offset; or equivalently,
+ * sets offset to 0; the first request returns the first `limit` of rows. The
+ * second request sets offset to the `limit` of the first request; the second
+ * request returns the second `limit` of rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The offset.
+ */
+ @java.lang.Override
+ public long getOffset() {
+ return offset_;
+ }
+
+ public static final int LIMIT_FIELD_NUMBER = 3;
+ private long limit_ = 0L;
+ /**
+ *
+ *
+ *
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
+ *
+ * The API can also return fewer rows than the requested `limit`, if there
+ * aren't as many dimension values as the `limit`.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The limit.
+ */
+ @java.lang.Override
+ public long getLimit() {
+ return limit_;
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(name_)) {
+ com.google.protobuf.GeneratedMessageV3.writeString(output, 1, name_);
+ }
+ if (offset_ != 0L) {
+ output.writeInt64(2, offset_);
+ }
+ if (limit_ != 0L) {
+ output.writeInt64(3, limit_);
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(name_)) {
+ size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, name_);
+ }
+ if (offset_ != 0L) {
+ size += com.google.protobuf.CodedOutputStream.computeInt64Size(2, offset_);
+ }
+ if (limit_ != 0L) {
+ size += com.google.protobuf.CodedOutputStream.computeInt64Size(3, limit_);
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.analytics.data.v1alpha.SheetExportAudienceListRequest)) {
+ return super.equals(obj);
+ }
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest other =
+ (com.google.analytics.data.v1alpha.SheetExportAudienceListRequest) obj;
+
+ if (!getName().equals(other.getName())) return false;
+ if (getOffset() != other.getOffset()) return false;
+ if (getLimit() != other.getLimit()) return false;
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ hash = (37 * hash) + NAME_FIELD_NUMBER;
+ hash = (53 * hash) + getName().hashCode();
+ hash = (37 * hash) + OFFSET_FIELD_NUMBER;
+ hash = (53 * hash) + com.google.protobuf.Internal.hashLong(getOffset());
+ hash = (37 * hash) + LIMIT_FIELD_NUMBER;
+ hash = (53 * hash) + com.google.protobuf.Internal.hashLong(getLimit());
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ byte[] data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListRequest prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+ /**
+ *
+ *
+ *
+ * A request to export users in an audience list to a Google Sheet.
+ *
+ *
+ * Protobuf type {@code google.analytics.data.v1alpha.SheetExportAudienceListRequest}
+ */
+ public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @return The name.
+ */
+ public java.lang.String getName() {
+ java.lang.Object ref = name_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ name_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @return The bytes for name.
+ */
+ public com.google.protobuf.ByteString getNameBytes() {
+ java.lang.Object ref = name_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ name_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @param value The name to set.
+ * @return This builder for chaining.
+ */
+ public Builder setName(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ name_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearName() {
+ name_ = getDefaultInstance().getName();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @param value The bytes for name to set.
+ * @return This builder for chaining.
+ */
+ public Builder setNameBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ name_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private long offset_;
+ /**
+ *
+ *
+ *
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
+ *
+ * When paging, the first request does not specify offset; or equivalently,
+ * sets offset to 0; the first request returns the first `limit` of rows. The
+ * second request sets offset to the `limit` of the first request; the second
+ * request returns the second `limit` of rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The offset.
+ */
+ @java.lang.Override
+ public long getOffset() {
+ return offset_;
+ }
+ /**
+ *
+ *
+ *
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
+ *
+ * When paging, the first request does not specify offset; or equivalently,
+ * sets offset to 0; the first request returns the first `limit` of rows. The
+ * second request sets offset to the `limit` of the first request; the second
+ * request returns the second `limit` of rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @param value The offset to set.
+ * @return This builder for chaining.
+ */
+ public Builder setOffset(long value) {
+
+ offset_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
+ *
+ * When paging, the first request does not specify offset; or equivalently,
+ * sets offset to 0; the first request returns the first `limit` of rows. The
+ * second request sets offset to the `limit` of the first request; the second
+ * request returns the second `limit` of rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearOffset() {
+ bitField0_ = (bitField0_ & ~0x00000002);
+ offset_ = 0L;
+ onChanged();
+ return this;
+ }
+
+ private long limit_;
+ /**
+ *
+ *
+ *
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
+ *
+ * The API can also return fewer rows than the requested `limit`, if there
+ * aren't as many dimension values as the `limit`.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The limit.
+ */
+ @java.lang.Override
+ public long getLimit() {
+ return limit_;
+ }
+ /**
+ *
+ *
+ *
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
+ *
+ * The API can also return fewer rows than the requested `limit`, if there
+ * aren't as many dimension values as the `limit`.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @param value The limit to set.
+ * @return This builder for chaining.
+ */
+ public Builder setLimit(long value) {
+
+ limit_ = value;
+ bitField0_ |= 0x00000004;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
+ *
+ * The API can also return fewer rows than the requested `limit`, if there
+ * aren't as many dimension values as the `limit`.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearLimit() {
+ bitField0_ = (bitField0_ & ~0x00000004);
+ limit_ = 0L;
+ onChanged();
+ return this;
+ }
+
+ @java.lang.Override
+ public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
+ return super.setUnknownFields(unknownFields);
+ }
+
+ @java.lang.Override
+ public final Builder mergeUnknownFields(
+ final com.google.protobuf.UnknownFieldSet unknownFields) {
+ return super.mergeUnknownFields(unknownFields);
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.analytics.data.v1alpha.SheetExportAudienceListRequest)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.analytics.data.v1alpha.SheetExportAudienceListRequest)
+ private static final com.google.analytics.data.v1alpha.SheetExportAudienceListRequest
+ DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.analytics.data.v1alpha.SheetExportAudienceListRequest();
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListRequest
+ getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @return The name.
+ */
+ java.lang.String getName();
+ /**
+ *
+ *
+ *
+ * Required. The name of the audience list to retrieve users from.
+ * Format: `properties/{property}/audienceLists/{audience_list}`
+ *
+ *
+ *
+ * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
+ *
+ *
+ * @return The bytes for name.
+ */
+ com.google.protobuf.ByteString getNameBytes();
+
+ /**
+ *
+ *
+ *
+ * Optional. The row count of the start row. The first row is counted as row
+ * 0.
+ *
+ * When paging, the first request does not specify offset; or equivalently,
+ * sets offset to 0; the first request returns the first `limit` of rows. The
+ * second request sets offset to the `limit` of the first request; the second
+ * request returns the second `limit` of rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The offset.
+ */
+ long getOffset();
+
+ /**
+ *
+ *
+ *
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
+ * how many you ask for. `limit` must be positive.
+ *
+ * The API can also return fewer rows than the requested `limit`, if there
+ * aren't as many dimension values as the `limit`.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
+ *
+ * @return The limit.
+ */
+ long getLimit();
+}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SheetExportAudienceListResponse.java b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SheetExportAudienceListResponse.java
new file mode 100644
index 000000000000..600738881a58
--- /dev/null
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/java/com/google/analytics/data/v1alpha/SheetExportAudienceListResponse.java
@@ -0,0 +1,1410 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// Generated by the protocol buffer compiler. DO NOT EDIT!
+// source: google/analytics/data/v1alpha/analytics_data_api.proto
+
+package com.google.analytics.data.v1alpha;
+
+/**
+ *
+ *
+ *
+ * The created Google Sheet with the list of users in an audience list.
+ *
+ *
+ * Protobuf type {@code google.analytics.data.v1alpha.SheetExportAudienceListResponse}
+ */
+public final class SheetExportAudienceListResponse extends com.google.protobuf.GeneratedMessageV3
+ implements
+ // @@protoc_insertion_point(message_implements:google.analytics.data.v1alpha.SheetExportAudienceListResponse)
+ SheetExportAudienceListResponseOrBuilder {
+ private static final long serialVersionUID = 0L;
+ // Use SheetExportAudienceListResponse.newBuilder() to construct.
+ private SheetExportAudienceListResponse(
+ com.google.protobuf.GeneratedMessageV3.Builder builder) {
+ super(builder);
+ }
+
+ private SheetExportAudienceListResponse() {
+ spreadsheetUri_ = "";
+ spreadsheetId_ = "";
+ }
+
+ @java.lang.Override
+ @SuppressWarnings({"unused"})
+ protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
+ return new SheetExportAudienceListResponse();
+ }
+
+ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
+ return com.google.analytics.data.v1alpha.AnalyticsDataApiProto
+ .internal_static_google_analytics_data_v1alpha_SheetExportAudienceListResponse_descriptor;
+ }
+
+ @java.lang.Override
+ protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
+ internalGetFieldAccessorTable() {
+ return com.google.analytics.data.v1alpha.AnalyticsDataApiProto
+ .internal_static_google_analytics_data_v1alpha_SheetExportAudienceListResponse_fieldAccessorTable
+ .ensureFieldAccessorsInitialized(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListResponse.class,
+ com.google.analytics.data.v1alpha.SheetExportAudienceListResponse.Builder.class);
+ }
+
+ private int bitField0_;
+ public static final int SPREADSHEET_URI_FIELD_NUMBER = 1;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object spreadsheetUri_ = "";
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return Whether the spreadsheetUri field is set.
+ */
+ @java.lang.Override
+ public boolean hasSpreadsheetUri() {
+ return ((bitField0_ & 0x00000001) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return The spreadsheetUri.
+ */
+ @java.lang.Override
+ public java.lang.String getSpreadsheetUri() {
+ java.lang.Object ref = spreadsheetUri_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ spreadsheetUri_ = s;
+ return s;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return The bytes for spreadsheetUri.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getSpreadsheetUriBytes() {
+ java.lang.Object ref = spreadsheetUri_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ spreadsheetUri_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int SPREADSHEET_ID_FIELD_NUMBER = 2;
+
+ @SuppressWarnings("serial")
+ private volatile java.lang.Object spreadsheetId_ = "";
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return Whether the spreadsheetId field is set.
+ */
+ @java.lang.Override
+ public boolean hasSpreadsheetId() {
+ return ((bitField0_ & 0x00000002) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return The spreadsheetId.
+ */
+ @java.lang.Override
+ public java.lang.String getSpreadsheetId() {
+ java.lang.Object ref = spreadsheetId_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ spreadsheetId_ = s;
+ return s;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return The bytes for spreadsheetId.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getSpreadsheetIdBytes() {
+ java.lang.Object ref = spreadsheetId_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ spreadsheetId_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int ROW_COUNT_FIELD_NUMBER = 3;
+ private int rowCount_ = 0;
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @return Whether the rowCount field is set.
+ */
+ @java.lang.Override
+ public boolean hasRowCount() {
+ return ((bitField0_ & 0x00000004) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @return The rowCount.
+ */
+ @java.lang.Override
+ public int getRowCount() {
+ return rowCount_;
+ }
+
+ public static final int AUDIENCE_LIST_FIELD_NUMBER = 4;
+ private com.google.analytics.data.v1alpha.AudienceList audienceList_;
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ *
+ * @return Whether the audienceList field is set.
+ */
+ @java.lang.Override
+ public boolean hasAudienceList() {
+ return ((bitField0_ & 0x00000008) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ *
+ * @return The audienceList.
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.AudienceList getAudienceList() {
+ return audienceList_ == null
+ ? com.google.analytics.data.v1alpha.AudienceList.getDefaultInstance()
+ : audienceList_;
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ @java.lang.Override
+ public com.google.analytics.data.v1alpha.AudienceListOrBuilder getAudienceListOrBuilder() {
+ return audienceList_ == null
+ ? com.google.analytics.data.v1alpha.AudienceList.getDefaultInstance()
+ : audienceList_;
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (((bitField0_ & 0x00000001) != 0)) {
+ com.google.protobuf.GeneratedMessageV3.writeString(output, 1, spreadsheetUri_);
+ }
+ if (((bitField0_ & 0x00000002) != 0)) {
+ com.google.protobuf.GeneratedMessageV3.writeString(output, 2, spreadsheetId_);
+ }
+ if (((bitField0_ & 0x00000004) != 0)) {
+ output.writeInt32(3, rowCount_);
+ }
+ if (((bitField0_ & 0x00000008) != 0)) {
+ output.writeMessage(4, getAudienceList());
+ }
+ getUnknownFields().writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (((bitField0_ & 0x00000001) != 0)) {
+ size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, spreadsheetUri_);
+ }
+ if (((bitField0_ & 0x00000002) != 0)) {
+ size += com.google.protobuf.GeneratedMessageV3.computeStringSize(2, spreadsheetId_);
+ }
+ if (((bitField0_ & 0x00000004) != 0)) {
+ size += com.google.protobuf.CodedOutputStream.computeInt32Size(3, rowCount_);
+ }
+ if (((bitField0_ & 0x00000008) != 0)) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, getAudienceList());
+ }
+ size += getUnknownFields().getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.analytics.data.v1alpha.SheetExportAudienceListResponse)) {
+ return super.equals(obj);
+ }
+ com.google.analytics.data.v1alpha.SheetExportAudienceListResponse other =
+ (com.google.analytics.data.v1alpha.SheetExportAudienceListResponse) obj;
+
+ if (hasSpreadsheetUri() != other.hasSpreadsheetUri()) return false;
+ if (hasSpreadsheetUri()) {
+ if (!getSpreadsheetUri().equals(other.getSpreadsheetUri())) return false;
+ }
+ if (hasSpreadsheetId() != other.hasSpreadsheetId()) return false;
+ if (hasSpreadsheetId()) {
+ if (!getSpreadsheetId().equals(other.getSpreadsheetId())) return false;
+ }
+ if (hasRowCount() != other.hasRowCount()) return false;
+ if (hasRowCount()) {
+ if (getRowCount() != other.getRowCount()) return false;
+ }
+ if (hasAudienceList() != other.hasAudienceList()) return false;
+ if (hasAudienceList()) {
+ if (!getAudienceList().equals(other.getAudienceList())) return false;
+ }
+ if (!getUnknownFields().equals(other.getUnknownFields())) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ if (hasSpreadsheetUri()) {
+ hash = (37 * hash) + SPREADSHEET_URI_FIELD_NUMBER;
+ hash = (53 * hash) + getSpreadsheetUri().hashCode();
+ }
+ if (hasSpreadsheetId()) {
+ hash = (37 * hash) + SPREADSHEET_ID_FIELD_NUMBER;
+ hash = (53 * hash) + getSpreadsheetId().hashCode();
+ }
+ if (hasRowCount()) {
+ hash = (37 * hash) + ROW_COUNT_FIELD_NUMBER;
+ hash = (53 * hash) + getRowCount();
+ }
+ if (hasAudienceList()) {
+ hash = (37 * hash) + AUDIENCE_LIST_FIELD_NUMBER;
+ hash = (53 * hash) + getAudienceList().hashCode();
+ }
+ hash = (29 * hash) + getUnknownFields().hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ byte[] data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse
+ parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse
+ parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(
+ com.google.analytics.data.v1alpha.SheetExportAudienceListResponse prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+ /**
+ *
+ *
+ *
+ * The created Google Sheet with the list of users in an audience list.
+ *
+ *
+ * Protobuf type {@code google.analytics.data.v1alpha.SheetExportAudienceListResponse}
+ */
+ public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return Whether the spreadsheetUri field is set.
+ */
+ public boolean hasSpreadsheetUri() {
+ return ((bitField0_ & 0x00000001) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return The spreadsheetUri.
+ */
+ public java.lang.String getSpreadsheetUri() {
+ java.lang.Object ref = spreadsheetUri_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ spreadsheetUri_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return The bytes for spreadsheetUri.
+ */
+ public com.google.protobuf.ByteString getSpreadsheetUriBytes() {
+ java.lang.Object ref = spreadsheetUri_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ spreadsheetUri_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @param value The spreadsheetUri to set.
+ * @return This builder for chaining.
+ */
+ public Builder setSpreadsheetUri(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ spreadsheetUri_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearSpreadsheetUri() {
+ spreadsheetUri_ = getDefaultInstance().getSpreadsheetUri();
+ bitField0_ = (bitField0_ & ~0x00000001);
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @param value The bytes for spreadsheetUri to set.
+ * @return This builder for chaining.
+ */
+ public Builder setSpreadsheetUriBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ spreadsheetUri_ = value;
+ bitField0_ |= 0x00000001;
+ onChanged();
+ return this;
+ }
+
+ private java.lang.Object spreadsheetId_ = "";
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return Whether the spreadsheetId field is set.
+ */
+ public boolean hasSpreadsheetId() {
+ return ((bitField0_ & 0x00000002) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return The spreadsheetId.
+ */
+ public java.lang.String getSpreadsheetId() {
+ java.lang.Object ref = spreadsheetId_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ spreadsheetId_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return The bytes for spreadsheetId.
+ */
+ public com.google.protobuf.ByteString getSpreadsheetIdBytes() {
+ java.lang.Object ref = spreadsheetId_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ spreadsheetId_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @param value The spreadsheetId to set.
+ * @return This builder for chaining.
+ */
+ public Builder setSpreadsheetId(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ spreadsheetId_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearSpreadsheetId() {
+ spreadsheetId_ = getDefaultInstance().getSpreadsheetId();
+ bitField0_ = (bitField0_ & ~0x00000002);
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @param value The bytes for spreadsheetId to set.
+ * @return This builder for chaining.
+ */
+ public Builder setSpreadsheetIdBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+ spreadsheetId_ = value;
+ bitField0_ |= 0x00000002;
+ onChanged();
+ return this;
+ }
+
+ private int rowCount_;
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @return Whether the rowCount field is set.
+ */
+ @java.lang.Override
+ public boolean hasRowCount() {
+ return ((bitField0_ & 0x00000004) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @return The rowCount.
+ */
+ @java.lang.Override
+ public int getRowCount() {
+ return rowCount_;
+ }
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @param value The rowCount to set.
+ * @return This builder for chaining.
+ */
+ public Builder setRowCount(int value) {
+
+ rowCount_ = value;
+ bitField0_ |= 0x00000004;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearRowCount() {
+ bitField0_ = (bitField0_ & ~0x00000004);
+ rowCount_ = 0;
+ onChanged();
+ return this;
+ }
+
+ private com.google.analytics.data.v1alpha.AudienceList audienceList_;
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.analytics.data.v1alpha.AudienceList,
+ com.google.analytics.data.v1alpha.AudienceList.Builder,
+ com.google.analytics.data.v1alpha.AudienceListOrBuilder>
+ audienceListBuilder_;
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ *
+ * @return Whether the audienceList field is set.
+ */
+ public boolean hasAudienceList() {
+ return ((bitField0_ & 0x00000008) != 0);
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ *
+ * @return The audienceList.
+ */
+ public com.google.analytics.data.v1alpha.AudienceList getAudienceList() {
+ if (audienceListBuilder_ == null) {
+ return audienceList_ == null
+ ? com.google.analytics.data.v1alpha.AudienceList.getDefaultInstance()
+ : audienceList_;
+ } else {
+ return audienceListBuilder_.getMessage();
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ public Builder setAudienceList(com.google.analytics.data.v1alpha.AudienceList value) {
+ if (audienceListBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ audienceList_ = value;
+ } else {
+ audienceListBuilder_.setMessage(value);
+ }
+ bitField0_ |= 0x00000008;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ public Builder setAudienceList(
+ com.google.analytics.data.v1alpha.AudienceList.Builder builderForValue) {
+ if (audienceListBuilder_ == null) {
+ audienceList_ = builderForValue.build();
+ } else {
+ audienceListBuilder_.setMessage(builderForValue.build());
+ }
+ bitField0_ |= 0x00000008;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ public Builder mergeAudienceList(com.google.analytics.data.v1alpha.AudienceList value) {
+ if (audienceListBuilder_ == null) {
+ if (((bitField0_ & 0x00000008) != 0)
+ && audienceList_ != null
+ && audienceList_
+ != com.google.analytics.data.v1alpha.AudienceList.getDefaultInstance()) {
+ getAudienceListBuilder().mergeFrom(value);
+ } else {
+ audienceList_ = value;
+ }
+ } else {
+ audienceListBuilder_.mergeFrom(value);
+ }
+ bitField0_ |= 0x00000008;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ public Builder clearAudienceList() {
+ bitField0_ = (bitField0_ & ~0x00000008);
+ audienceList_ = null;
+ if (audienceListBuilder_ != null) {
+ audienceListBuilder_.dispose();
+ audienceListBuilder_ = null;
+ }
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ public com.google.analytics.data.v1alpha.AudienceList.Builder getAudienceListBuilder() {
+ bitField0_ |= 0x00000008;
+ onChanged();
+ return getAudienceListFieldBuilder().getBuilder();
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ public com.google.analytics.data.v1alpha.AudienceListOrBuilder getAudienceListOrBuilder() {
+ if (audienceListBuilder_ != null) {
+ return audienceListBuilder_.getMessageOrBuilder();
+ } else {
+ return audienceList_ == null
+ ? com.google.analytics.data.v1alpha.AudienceList.getDefaultInstance()
+ : audienceList_;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.analytics.data.v1alpha.AudienceList,
+ com.google.analytics.data.v1alpha.AudienceList.Builder,
+ com.google.analytics.data.v1alpha.AudienceListOrBuilder>
+ getAudienceListFieldBuilder() {
+ if (audienceListBuilder_ == null) {
+ audienceListBuilder_ =
+ new com.google.protobuf.SingleFieldBuilderV3<
+ com.google.analytics.data.v1alpha.AudienceList,
+ com.google.analytics.data.v1alpha.AudienceList.Builder,
+ com.google.analytics.data.v1alpha.AudienceListOrBuilder>(
+ getAudienceList(), getParentForChildren(), isClean());
+ audienceList_ = null;
+ }
+ return audienceListBuilder_;
+ }
+
+ @java.lang.Override
+ public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
+ return super.setUnknownFields(unknownFields);
+ }
+
+ @java.lang.Override
+ public final Builder mergeUnknownFields(
+ final com.google.protobuf.UnknownFieldSet unknownFields) {
+ return super.mergeUnknownFields(unknownFields);
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.analytics.data.v1alpha.SheetExportAudienceListResponse)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.analytics.data.v1alpha.SheetExportAudienceListResponse)
+ private static final com.google.analytics.data.v1alpha.SheetExportAudienceListResponse
+ DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.analytics.data.v1alpha.SheetExportAudienceListResponse();
+ }
+
+ public static com.google.analytics.data.v1alpha.SheetExportAudienceListResponse
+ getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return Whether the spreadsheetUri field is set.
+ */
+ boolean hasSpreadsheetUri();
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return The spreadsheetUri.
+ */
+ java.lang.String getSpreadsheetUri();
+ /**
+ *
+ *
+ *
+ * A uri for you to visit in your browser to view the Google Sheet.
+ *
+ *
+ * optional string spreadsheet_uri = 1;
+ *
+ * @return The bytes for spreadsheetUri.
+ */
+ com.google.protobuf.ByteString getSpreadsheetUriBytes();
+
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return Whether the spreadsheetId field is set.
+ */
+ boolean hasSpreadsheetId();
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return The spreadsheetId.
+ */
+ java.lang.String getSpreadsheetId();
+ /**
+ *
+ *
+ *
+ * An ID that identifies the created Google Sheet resource.
+ *
+ *
+ * optional string spreadsheet_id = 2;
+ *
+ * @return The bytes for spreadsheetId.
+ */
+ com.google.protobuf.ByteString getSpreadsheetIdBytes();
+
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @return Whether the rowCount field is set.
+ */
+ boolean hasRowCount();
+ /**
+ *
+ *
+ *
+ * The total number of rows in the AudienceList result. `rowCount` is
+ * independent of the number of rows returned in the response, the `limit`
+ * request parameter, and the `offset` request parameter. For example if a
+ * query returns 175 rows and includes `limit` of 50 in the API request, the
+ * response will contain `rowCount` of 175 but only 50 rows.
+ *
+ * To learn more about this pagination parameter, see
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ *
+ *
+ * optional int32 row_count = 3;
+ *
+ * @return The rowCount.
+ */
+ int getRowCount();
+
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ *
+ * @return Whether the audienceList field is set.
+ */
+ boolean hasAudienceList();
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ *
+ * @return The audienceList.
+ */
+ com.google.analytics.data.v1alpha.AudienceList getAudienceList();
+ /**
+ *
+ *
+ *
+ * Configuration data about AudienceList being exported. Returned to help
+ * interpret the AudienceList in the Google Sheet of this response.
+ *
+ * For example, the AudienceList may have more rows than are present in the
+ * Google Sheet, and in that case, you may want to send an additional sheet
+ * export request with a different `offset` value to retrieve the next page of
+ * rows in an additional Google Sheet.
+ *
+ *
+ * optional .google.analytics.data.v1alpha.AudienceList audience_list = 4;
+ */
+ com.google.analytics.data.v1alpha.AudienceListOrBuilder getAudienceListOrBuilder();
+}
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/analytics_data_api.proto b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/analytics_data_api.proto
index ef0f8bbe9dc0..9faf7f9bcbb2 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/analytics_data_api.proto
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/analytics_data_api.proto
@@ -30,7 +30,7 @@ option java_outer_classname = "AnalyticsDataApiProto";
option java_package = "com.google.analytics.data.v1alpha";
option (google.api.resource_definition) = {
type: "analyticsadmin.googleapis.com/Property"
- pattern: "properties/{propertyId}"
+ pattern: "properties/{property}"
};
// Google Analytics reporting data service.
@@ -38,7 +38,10 @@ service AlphaAnalyticsData {
option (google.api.default_host) = "analyticsdata.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/analytics,"
- "https://www.googleapis.com/auth/analytics.readonly";
+ "https://www.googleapis.com/auth/analytics.readonly,"
+ "https://www.googleapis.com/auth/drive,"
+ "https://www.googleapis.com/auth/drive.file,"
+ "https://www.googleapis.com/auth/spreadsheets";
// Returns a customized funnel report of your Google Analytics event data. The
// data returned from the API is as a table with columns for the requested
@@ -70,6 +73,10 @@ service AlphaAnalyticsData {
// first create the audience list through this method and then send the
// audience resource name to the `QueryAudienceList` method.
//
+ // See [Creating an Audience
+ // List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ // for an introduction to Audience Lists with examples.
+ //
// An audience list is a snapshot of the users currently in the audience at
// the time of audience list creation. Creating audience lists for one
// audience on different days will return different results as users enter and
@@ -79,6 +86,12 @@ service AlphaAnalyticsData {
// that are important to your business. To learn more, see
// https://support.google.com/analytics/answer/9267572. Audience lists contain
// the users in each audience.
+ //
+ // This method is introduced at alpha stability with the intention of
+ // gathering feedback on syntax and capabilities before entering beta. To give
+ // your feedback on this API, complete the
+ // [Google Analytics Audience Export API
+ // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
rpc CreateAudienceList(CreateAudienceListRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
@@ -95,11 +108,22 @@ service AlphaAnalyticsData {
// Retrieves an audience list of users. After creating an audience, the users
// are not immediately available for listing. First, a request to
// `CreateAudienceList` is necessary to create an audience list of users, and
- // then second, this method is used to retrieve the users in the audience.
+ // then second, this method is used to retrieve the users in the audience
+ // list.
+ //
+ // See [Creating an Audience
+ // List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ // for an introduction to Audience Lists with examples.
//
// Audiences in Google Analytics 4 allow you to segment your users in the ways
// that are important to your business. To learn more, see
// https://support.google.com/analytics/answer/9267572.
+ //
+ // This method is introduced at alpha stability with the intention of
+ // gathering feedback on syntax and capabilities before entering beta. To give
+ // your feedback on this API, complete the
+ // [Google Analytics Audience Export API
+ // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
rpc QueryAudienceList(QueryAudienceListRequest)
returns (QueryAudienceListResponse) {
option (google.api.http) = {
@@ -109,8 +133,46 @@ service AlphaAnalyticsData {
option (google.api.method_signature) = "name";
}
+ // Exports an audience list of users to a Google Sheet. After creating an
+ // audience, the users are not immediately available for listing. First, a
+ // request to `CreateAudienceList` is necessary to create an audience list of
+ // users, and then second, this method is used to export those users in the
+ // audience list to a Google Sheet.
+ //
+ // See [Creating an Audience
+ // List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ // for an introduction to Audience Lists with examples.
+ //
+ // Audiences in Google Analytics 4 allow you to segment your users in the ways
+ // that are important to your business. To learn more, see
+ // https://support.google.com/analytics/answer/9267572.
+ //
+ // This method is introduced at alpha stability with the intention of
+ // gathering feedback on syntax and capabilities before entering beta. To give
+ // your feedback on this API, complete the
+ // [Google Analytics Audience Export API
+ // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+ rpc SheetExportAudienceList(SheetExportAudienceListRequest)
+ returns (SheetExportAudienceListResponse) {
+ option (google.api.http) = {
+ post: "/v1alpha/{name=properties/*/audienceLists/*}:exportSheet"
+ body: "*"
+ };
+ option (google.api.method_signature) = "name";
+ }
+
// Gets configuration metadata about a specific audience list. This method
// can be used to understand an audience list after it has been created.
+ //
+ // See [Creating an Audience
+ // List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ // for an introduction to Audience Lists with examples.
+ //
+ // This method is introduced at alpha stability with the intention of
+ // gathering feedback on syntax and capabilities before entering beta. To give
+ // your feedback on this API, complete the
+ // [Google Analytics Audience Export API
+ // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
rpc GetAudienceList(GetAudienceListRequest) returns (AudienceList) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/audienceLists/*}"
@@ -122,6 +184,16 @@ service AlphaAnalyticsData {
// find and reuse existing audience lists rather than creating unnecessary new
// audience lists. The same audience can have multiple audience lists that
// represent the list of users that were in an audience on different days.
+ //
+ // See [Creating an Audience
+ // List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+ // for an introduction to Audience Lists with examples.
+ //
+ // This method is introduced at alpha stability with the intention of
+ // gathering feedback on syntax and capabilities before entering beta. To give
+ // your feedback on this API, complete the
+ // [Google Analytics Audience Export API
+ // Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
rpc ListAudienceLists(ListAudienceListsRequest)
returns (ListAudienceListsResponse) {
option (google.api.http) = {
@@ -134,7 +206,7 @@ service AlphaAnalyticsData {
// A request to retrieve configuration metadata about a specific audience list.
message GetAudienceListRequest {
// Required. The audience list resource name.
- // Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+ // Format: `properties/{property}/audienceLists/{audience_list}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -146,7 +218,7 @@ message GetAudienceListRequest {
// A request to list all audience lists for a property.
message ListAudienceListsRequest {
// Required. All audience lists for this property will be listed in the
- // response. Format: `properties/{propertyId}`
+ // response. Format: `properties/{property}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -154,18 +226,18 @@ message ListAudienceListsRequest {
}
];
- // The maximum number of audience lists to return. The service may return
- // fewer than this value. If unspecified, at most 200 audience lists will be
- // returned. The maximum value is 1000 (higher values will be coerced to the
- // maximum).
- int32 page_size = 2;
+ // Optional. The maximum number of audience lists to return. The service may
+ // return fewer than this value. If unspecified, at most 200 audience lists
+ // will be returned. The maximum value is 1000 (higher values will be coerced
+ // to the maximum).
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
- // A page token, received from a previous `ListAudienceLists` call. Provide
- // this to retrieve the subsequent page.
+ // Optional. A page token, received from a previous `ListAudienceLists` call.
+ // Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListAudienceLists` must
// match the call that provided the page token.
- string page_token = 3;
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
}
// A list of all audience lists for a property.
@@ -181,7 +253,7 @@ message ListAudienceListsResponse {
// A request to create a new audience list.
message CreateAudienceListRequest {
// Required. The parent resource where this audience list will be created.
- // Format: `properties/{propertyId}`
+ // Format: `properties/{property}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -199,7 +271,9 @@ message CreateAudienceListRequest {
message AudienceList {
option (google.api.resource) = {
type: "analyticsdata.googleapis.com/AudienceList"
- pattern: "properties/{propertyId}/audienceLists/{audienceListId}"
+ pattern: "properties/{property}/audienceLists/{audience_list}"
+ plural: "audienceLists"
+ singular: "audienceList"
};
// The AudienceList currently exists in this state.
@@ -221,17 +295,20 @@ message AudienceList {
FAILED = 3;
}
- // Output only. The audience list resource name assigned during creation. This
- // resource name identifies this `AudienceList`.
+ // Output only. Identifier. The audience list resource name assigned during
+ // creation. This resource name identifies this `AudienceList`.
//
- // Format: `properties/{propertyId}/audienceLists/{audienceListId}`
- string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+ // Format: `properties/{property}/audienceLists/{audience_list}`
+ string name = 1 [
+ (google.api.field_behavior) = IDENTIFIER,
+ (google.api.field_behavior) = OUTPUT_ONLY
+ ];
// Required. The audience resource name. This resource name identifies the
// audience being listed and is shared between the Analytics Data & Admin
// APIs.
//
- // Format: `properties/{propertyId}/audiences/{audienceId}`
+ // Format: `properties/{property}/audiences/{audience}`
string audience = 2 [(google.api.field_behavior) = REQUIRED];
// Output only. The descriptive display name for this audience. For example,
@@ -249,6 +326,20 @@ message AudienceList {
// AudienceList began the `CREATING` state.
optional google.protobuf.Timestamp begin_creating_time = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // 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];
+
+ // Output only. The total number of rows in the AudienceList result.
+ optional int32 row_count = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // 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];
}
// This metadata is currently blank.
@@ -256,11 +347,12 @@ message AudienceListMetadata {}
// A request to list users in an audience list.
message QueryAudienceListRequest {
- // The name of the audience list to retrieve users from.
- // Format: `properties/{propertyId}/audienceLists/{audienceListId}`
- string name = 1;
+ // Required. The name of the audience list to retrieve users from.
+ // Format: `properties/{property}/audienceLists/{audience_list}`
+ string name = 1 [(google.api.field_behavior) = REQUIRED];
- // The row count of the start row. The first row is counted as row 0.
+ // Optional. The row count of the start row. The first row is counted as row
+ // 0.
//
// When paging, the first request does not specify offset; or equivalently,
// sets offset to 0; the first request returns the first `limit` of rows. The
@@ -269,18 +361,18 @@ message QueryAudienceListRequest {
//
// To learn more about this pagination parameter, see
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
- int64 offset = 2;
+ int64 offset = 2 [(google.api.field_behavior) = OPTIONAL];
- // The number of rows to return. If unspecified, 10,000 rows are returned. The
- // API returns a maximum of 250,000 rows per request, no matter how many you
- // ask for. `limit` must be positive.
+ // Optional. The number of rows to return. If unspecified, 10,000 rows are
+ // returned. The API returns a maximum of 250,000 rows per request, no matter
+ // how many you ask for. `limit` must be positive.
//
// The API can also return fewer rows than the requested `limit`, if there
// aren't as many dimension values as the `limit`.
//
// To learn more about this pagination parameter, see
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
- int64 limit = 3;
+ int64 limit = 3 [(google.api.field_behavior) = OPTIONAL];
}
// A list of users in an audience list.
@@ -294,10 +386,10 @@ message QueryAudienceListResponse {
// response will be less than or equal to request's page size.
repeated AudienceRow audience_rows = 2;
- // The total number of rows in the query result. `rowCount` is independent of
- // the number of rows returned in the response, the `limit` request
- // parameter, and the `offset` request parameter. For example if a query
- // returns 175 rows and includes `limit` of 50 in the API request, the
+ // The total number of rows in the AudienceList result. `rowCount` is
+ // independent of the number of rows returned in the response, the `limit`
+ // request parameter, and the `offset` request parameter. For example if a
+ // query returns 175 rows and includes `limit` of 50 in the API request, the
// response will contain `rowCount` of 175 but only 50 rows.
//
// To learn more about this pagination parameter, see
@@ -305,6 +397,69 @@ message QueryAudienceListResponse {
optional int32 row_count = 3;
}
+// A request to export users in an audience list to a Google Sheet.
+message SheetExportAudienceListRequest {
+ // Required. The name of the audience list to retrieve users from.
+ // Format: `properties/{property}/audienceLists/{audience_list}`
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {
+ type: "analyticsdata.googleapis.com/AudienceList"
+ }
+ ];
+
+ // Optional. The row count of the start row. The first row is counted as row
+ // 0.
+ //
+ // When paging, the first request does not specify offset; or equivalently,
+ // sets offset to 0; the first request returns the first `limit` of rows. The
+ // second request sets offset to the `limit` of the first request; the second
+ // request returns the second `limit` of rows.
+ //
+ // To learn more about this pagination parameter, see
+ // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ int64 offset = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The number of rows to return. If unspecified, 10,000 rows are
+ // returned. The API returns a maximum of 250,000 rows per request, no matter
+ // how many you ask for. `limit` must be positive.
+ //
+ // The API can also return fewer rows than the requested `limit`, if there
+ // aren't as many dimension values as the `limit`.
+ //
+ // To learn more about this pagination parameter, see
+ // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ int64 limit = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// The created Google Sheet with the list of users in an audience list.
+message SheetExportAudienceListResponse {
+ // A uri for you to visit in your browser to view the Google Sheet.
+ optional string spreadsheet_uri = 1;
+
+ // An ID that identifies the created Google Sheet resource.
+ optional string spreadsheet_id = 2;
+
+ // The total number of rows in the AudienceList result. `rowCount` is
+ // independent of the number of rows returned in the response, the `limit`
+ // request parameter, and the `offset` request parameter. For example if a
+ // query returns 175 rows and includes `limit` of 50 in the API request, the
+ // response will contain `rowCount` of 175 but only 50 rows.
+ //
+ // To learn more about this pagination parameter, see
+ // [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+ optional int32 row_count = 3;
+
+ // Configuration data about AudienceList being exported. Returned to help
+ // interpret the AudienceList in the Google Sheet of this response.
+ //
+ // For example, the AudienceList may have more rows than are present in the
+ // Google Sheet, and in that case, you may want to send an additional sheet
+ // export request with a different `offset` value to retrieve the next page of
+ // rows in an additional Google Sheet.
+ optional AudienceList audience_list = 4;
+}
+
// Dimension value attributes for the audience user row.
message AudienceRow {
// Each dimension value attribute for an audience user. One dimension value
@@ -315,10 +470,10 @@ message AudienceRow {
// An audience dimension is a user attribute. Specific user attributed are
// requested and then later returned in the `QueryAudienceListResponse`.
message AudienceDimension {
- // The API name of the dimension. See the [API
+ // Optional. The API name of the dimension. See the [API
// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)
// for the list of dimension names.
- string dimension_name = 1;
+ string dimension_name = 1 [(google.api.field_behavior) = OPTIONAL];
}
// The value of a dimension.
@@ -347,75 +502,79 @@ message RunFunnelReportRequest {
TRENDED_FUNNEL = 2;
}
- // A Google Analytics GA4 property identifier whose events are tracked.
- // Specified in the URL path and not the body. To learn more, see [where to
- // find your Property
+ // Optional. A Google Analytics GA4 property identifier whose events are
+ // tracked. Specified in the URL path and not the body. To learn more, see
+ // [where to find your Property
// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
// Within a batch request, this property should either be unspecified or
// consistent with the batch-level property.
//
// Example: properties/1234
- string property = 1;
-
- // Date ranges of data to read. If multiple date ranges are requested, each
- // response row will contain a zero based date range index. If two date
- // ranges overlap, the event data for the overlapping days is included in the
- // response rows for both date ranges.
- repeated DateRange date_ranges = 2;
-
- // The configuration of this request's funnel. This funnel configuration is
- // required.
- Funnel funnel = 3;
-
- // If specified, this breakdown adds a dimension to the funnel table sub
- // report response. This breakdown dimension expands each funnel step to the
- // unique values of the breakdown dimension. For example, a breakdown by the
- // `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+ string property = 1 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. Date ranges of data to read. If multiple date ranges are
+ // requested, each response row will contain a zero based date range index. If
+ // two date ranges overlap, the event data for the overlapping days is
+ // included in the response rows for both date ranges.
+ repeated DateRange date_ranges = 2 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The configuration of this request's funnel. This funnel
+ // configuration is required.
+ Funnel funnel = 3 [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. If specified, this breakdown adds a dimension to the funnel table
+ // sub report response. This breakdown dimension expands each funnel step to
+ // the unique values of the breakdown dimension. For example, a breakdown by
+ // the `deviceCategory` dimension will create rows for `mobile`, `tablet`,
// `desktop`, and the total.
- FunnelBreakdown funnel_breakdown = 4;
+ FunnelBreakdown funnel_breakdown = 4 [(google.api.field_behavior) = OPTIONAL];
- // If specified, next action adds a dimension to the funnel visualization sub
- // report response. This next action dimension expands each funnel step to the
- // unique values of the next action. For example a next action of the
- // `eventName` dimension will create rows for several events (for example
- // `session_start` & `click`) and the total.
+ // Optional. If specified, next action adds a dimension to the funnel
+ // visualization sub report response. This next action dimension expands each
+ // funnel step to the unique values of the next action. For example a next
+ // action of the `eventName` dimension will create rows for several events
+ // (for example `session_start` & `click`) and the total.
//
// Next action only supports `eventName` and most Page / Screen dimensions
// like `pageTitle` and `pagePath`.
- FunnelNextAction funnel_next_action = 5;
-
- // The funnel visualization type controls the dimensions present in the funnel
- // visualization sub report response. If not specified, `STANDARD_FUNNEL` is
- // used.
- FunnelVisualizationType funnel_visualization_type = 6;
-
- // The configurations of segments. Segments are subsets of a property's data.
- // In a funnel report with segments, the funnel is evaluated in each segment.
+ FunnelNextAction funnel_next_action = 5
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The funnel visualization type controls the dimensions present in
+ // the funnel visualization sub report response. If not specified,
+ // `STANDARD_FUNNEL` is used.
+ FunnelVisualizationType funnel_visualization_type = 6
+ [(google.api.field_behavior) = OPTIONAL];
+
+ // Optional. The configurations of segments. Segments are subsets of a
+ // property's data. In a funnel report with segments, the funnel is evaluated
+ // in each segment.
//
// Each segment specified in this request
// produces a separate row in the response; in the response, each segment
// identified by its name.
//
// The segments parameter is optional. Requests are limited to 4 segments.
- repeated Segment segments = 7;
+ repeated Segment segments = 7 [(google.api.field_behavior) = OPTIONAL];
- // The number of rows to return. If unspecified, 10,000 rows are returned. The
- // API returns a maximum of 250,000 rows per request, no matter how many you
- // ask for. `limit` must be positive.
+ // Optional. The number of rows to return. If unspecified, 10,000 rows are
+ // returned. The API returns a maximum of 250,000 rows per request, no matter
+ // how many you ask for. `limit` must be positive.
//
// The API can also return fewer rows than the requested `limit`, if there
// aren't as many dimension values as the `limit`.
- int64 limit = 9;
+ int64 limit = 9 [(google.api.field_behavior) = OPTIONAL];
- // Dimension filters allow you to ask for only specific dimension values in
- // the report. To learn more, see [Creating a Report: Dimension
+ // Optional. Dimension filters allow you to ask for only specific dimension
+ // values in the report. To learn more, see [Creating a Report: Dimension
// Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
// for examples. Metrics cannot be used in this filter.
- FilterExpression dimension_filter = 10;
+ FilterExpression dimension_filter = 10
+ [(google.api.field_behavior) = OPTIONAL];
- // Toggles whether to return the current state of this Analytics Property's
- // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
- bool return_property_quota = 12;
+ // Optional. Toggles whether to return the current state of this Analytics
+ // Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+ bool return_property_quota = 12 [(google.api.field_behavior) = OPTIONAL];
}
// The funnel report response contains two sub reports. The two sub reports are
diff --git a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/data.proto b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/data.proto
index 95e4254a4eb8..dc862ddd3263 100644
--- a/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/data.proto
+++ b/java-analytics-data/proto-google-analytics-data-v1alpha/src/main/proto/google/analytics/data/v1alpha/data.proto
@@ -23,8 +23,8 @@ option java_multiple_files = true;
option java_outer_classname = "ReportingApiProto";
option java_package = "com.google.analytics.data.v1alpha";
-// A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
-// are allowed up to 4 date ranges.
+// A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
+// Requests are allowed up to 4 date ranges.
message DateRange {
// The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
// be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
@@ -51,7 +51,16 @@ message DateRange {
message Dimension {
// The name of the dimension. See the [API
// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
- // for the list of dimension names.
+ // for the list of dimension names supported by core reporting methods such
+ // as `runReport` and `batchRunReports`. See
+ // [Realtime
+ // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)
+ // for the list of dimension names supported by the `runRealtimeReport`
+ // method. See
+ // [Funnel
+ // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)
+ // for the list of dimension names supported by the `runFunnelReport`
+ // method.
//
// If `dimensionExpression` is specified, `name` can be any string that you
// would like within the allowed character set. For example if a
@@ -1168,7 +1177,7 @@ message FunnelParameterFilter {
// the funnel report.
message FunnelResponseMetadata {
// If funnel report results are
- // [sampled](https://support.google.com/analytics/answer/2637192), this
+ // [sampled](https://support.google.com/analytics/answer/13331292), this
// describes what percentage of events were used in this funnel report. One
// `samplingMetadatas` is populated for each date range. Each
// `samplingMetadatas` corresponds to a date range in order that date ranges
@@ -1179,7 +1188,7 @@ message FunnelResponseMetadata {
}
// If funnel report results are
-// [sampled](https://support.google.com/analytics/answer/2637192), this
+// [sampled](https://support.google.com/analytics/answer/13331292), this
// metadata describes what percentage of events were used in this funnel
// report for a date range. Sampling is the practice of analyzing a subset of
// all data in order to uncover the meaningful information in the larger data
diff --git a/java-analytics-data/samples/snippets/generated/com/google/analytics/data/v1alpha/alphaanalyticsdata/createaudiencelist/AsyncCreateAudienceList.java b/java-analytics-data/samples/snippets/generated/com/google/analytics/data/v1alpha/alphaanalyticsdata/createaudiencelist/AsyncCreateAudienceList.java
index cdade3a3cc1d..dd24268ac4ad 100644
--- a/java-analytics-data/samples/snippets/generated/com/google/analytics/data/v1alpha/alphaanalyticsdata/createaudiencelist/AsyncCreateAudienceList.java
+++ b/java-analytics-data/samples/snippets/generated/com/google/analytics/data/v1alpha/alphaanalyticsdata/createaudiencelist/AsyncCreateAudienceList.java
@@ -39,7 +39,7 @@ public static void asyncCreateAudienceList() throws Exception {
try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
CreateAudienceListRequest request =
CreateAudienceListRequest.newBuilder()
- .setParent(PropertyName.of("[PROPERTYID]").toString())
+ .setParent(PropertyName.of("[PROPERTY]").toString())
.setAudienceList(AudienceList.newBuilder().build())
.build();
ApiFuture