Skip to content
This repository was archived by the owner on Sep 9, 2023. It is now read-only.

Commit 0d74509

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add RunAccessReport method to the Admin API v1alpha (#442)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 465589484 Source-Link: googleapis/googleapis@80bf613 Source-Link: https://github.com/googleapis/googleapis-gen/commit/c015f3c725de4de9015dd83c55b2ec7eb05338dc Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYzAxNWYzYzcyNWRlNGRlOTAxNWRkODNjNTViMmVjN2ViMDUzMzhkYyJ9
1 parent 4a762b4 commit 0d74509

File tree

57 files changed

+32594
-894
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+32594
-894
lines changed

‎google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/AnalyticsAdminServiceClient.java

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8777,6 +8777,99 @@ public final AttributionSettings updateAttributionSettings(
87778777
return stub.updateAttributionSettingsCallable();
87788778
}
87798779

8780+
// AUTO-GENERATED DOCUMENTATION AND METHOD.
8781+
/**
8782+
* Returns a customized report of data access records. The report provides records of each time a
8783+
* user reads Google Analytics reporting data. Access records are retained for up to 2 years.
8784+
*
8785+
* <p>Data Access Reports can be requested for a property. The property must be in Google
8786+
* Analytics 360. This method is only available to Administrators.
8787+
*
8788+
* <p>These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and
8789+
* other products like Firebase &amp; Admob that can retrieve data from Google Analytics through a
8790+
* linkage. These records don't include property configuration changes like adding a stream or
8791+
* changing a property's time zone. For configuration change history, see
8792+
* [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
8793+
*
8794+
* <p>Sample code:
8795+
*
8796+
* <pre>{@code
8797+
* // This snippet has been automatically generated for illustrative purposes only.
8798+
* // It may require modifications to work in your environment.
8799+
* try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
8800+
* AnalyticsAdminServiceClient.create()) {
8801+
* RunAccessReportRequest request =
8802+
* RunAccessReportRequest.newBuilder()
8803+
* .setEntity("entity-1298275357")
8804+
* .addAllDimensions(new ArrayList<AccessDimension>())
8805+
* .addAllMetrics(new ArrayList<AccessMetric>())
8806+
* .addAllDateRanges(new ArrayList<AccessDateRange>())
8807+
* .setDimensionFilter(AccessFilterExpression.newBuilder().build())
8808+
* .setMetricFilter(AccessFilterExpression.newBuilder().build())
8809+
* .setOffset(-1019779949)
8810+
* .setLimit(102976443)
8811+
* .setTimeZone("timeZone-2077180903")
8812+
* .addAllOrderBys(new ArrayList<AccessOrderBy>())
8813+
* .setReturnEntityQuota(true)
8814+
* .build();
8815+
* RunAccessReportResponse response = analyticsAdminServiceClient.runAccessReport(request);
8816+
* }
8817+
* }</pre>
8818+
*
8819+
* @param request The request object containing all of the parameters for the API call.
8820+
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
8821+
*/
8822+
public final RunAccessReportResponse runAccessReport(RunAccessReportRequest request) {
8823+
return runAccessReportCallable().call(request);
8824+
}
8825+
8826+
// AUTO-GENERATED DOCUMENTATION AND METHOD.
8827+
/**
8828+
* Returns a customized report of data access records. The report provides records of each time a
8829+
* user reads Google Analytics reporting data. Access records are retained for up to 2 years.
8830+
*
8831+
* <p>Data Access Reports can be requested for a property. The property must be in Google
8832+
* Analytics 360. This method is only available to Administrators.
8833+
*
8834+
* <p>These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and
8835+
* other products like Firebase &amp; Admob that can retrieve data from Google Analytics through a
8836+
* linkage. These records don't include property configuration changes like adding a stream or
8837+
* changing a property's time zone. For configuration change history, see
8838+
* [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
8839+
*
8840+
* <p>Sample code:
8841+
*
8842+
* <pre>{@code
8843+
* // This snippet has been automatically generated for illustrative purposes only.
8844+
* // It may require modifications to work in your environment.
8845+
* try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
8846+
* AnalyticsAdminServiceClient.create()) {
8847+
* RunAccessReportRequest request =
8848+
* RunAccessReportRequest.newBuilder()
8849+
* .setEntity("entity-1298275357")
8850+
* .addAllDimensions(new ArrayList<AccessDimension>())
8851+
* .addAllMetrics(new ArrayList<AccessMetric>())
8852+
* .addAllDateRanges(new ArrayList<AccessDateRange>())
8853+
* .setDimensionFilter(AccessFilterExpression.newBuilder().build())
8854+
* .setMetricFilter(AccessFilterExpression.newBuilder().build())
8855+
* .setOffset(-1019779949)
8856+
* .setLimit(102976443)
8857+
* .setTimeZone("timeZone-2077180903")
8858+
* .addAllOrderBys(new ArrayList<AccessOrderBy>())
8859+
* .setReturnEntityQuota(true)
8860+
* .build();
8861+
* ApiFuture<RunAccessReportResponse> future =
8862+
* analyticsAdminServiceClient.runAccessReportCallable().futureCall(request);
8863+
* // Do something.
8864+
* RunAccessReportResponse response = future.get();
8865+
* }
8866+
* }</pre>
8867+
*/
8868+
public final UnaryCallable<RunAccessReportRequest, RunAccessReportResponse>
8869+
runAccessReportCallable() {
8870+
return stub.runAccessReportCallable();
8871+
}
8872+
87808873
@Override
87818874
public final void close() {
87828875
stub.close();

‎google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/AnalyticsAdminServiceSettings.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,12 @@ public UnaryCallSettings<ArchiveAudienceRequest, Empty> archiveAudienceSettings(
605605
.updateAttributionSettingsSettings();
606606
}
607607

608+
/** Returns the object with the settings used for calls to runAccessReport. */
609+
public UnaryCallSettings<RunAccessReportRequest, RunAccessReportResponse>
610+
runAccessReportSettings() {
611+
return ((AnalyticsAdminServiceStubSettings) getStubSettings()).runAccessReportSettings();
612+
}
613+
608614
public static final AnalyticsAdminServiceSettings create(AnalyticsAdminServiceStubSettings stub)
609615
throws IOException {
610616
return new AnalyticsAdminServiceSettings.Builder(stub.toBuilder()).build();
@@ -1241,6 +1247,12 @@ public UnaryCallSettings.Builder<ArchiveAudienceRequest, Empty> archiveAudienceS
12411247
return getStubSettingsBuilder().updateAttributionSettingsSettings();
12421248
}
12431249

1250+
/** Returns the builder for the settings used for calls to runAccessReport. */
1251+
public UnaryCallSettings.Builder<RunAccessReportRequest, RunAccessReportResponse>
1252+
runAccessReportSettings() {
1253+
return getStubSettingsBuilder().runAccessReportSettings();
1254+
}
1255+
12441256
@Override
12451257
public AnalyticsAdminServiceSettings build() throws IOException {
12461258
return new AnalyticsAdminServiceSettings(this);

‎google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/gapic_metadata.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,9 @@
202202
"ProvisionAccountTicket": {
203203
"methods": ["provisionAccountTicket", "provisionAccountTicketCallable"]
204204
},
205+
"RunAccessReport": {
206+
"methods": ["runAccessReport", "runAccessReportCallable"]
207+
},
205208
"SearchChangeHistoryEvents": {
206209
"methods": ["searchChangeHistoryEvents", "searchChangeHistoryEventsPagedCallable", "searchChangeHistoryEventsCallable"]
207210
},

‎google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/stub/AnalyticsAdminServiceStub.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@
135135
import com.google.analytics.admin.v1alpha.Property;
136136
import com.google.analytics.admin.v1alpha.ProvisionAccountTicketRequest;
137137
import com.google.analytics.admin.v1alpha.ProvisionAccountTicketResponse;
138+
import com.google.analytics.admin.v1alpha.RunAccessReportRequest;
139+
import com.google.analytics.admin.v1alpha.RunAccessReportResponse;
138140
import com.google.analytics.admin.v1alpha.SearchChangeHistoryEventsRequest;
139141
import com.google.analytics.admin.v1alpha.SearchChangeHistoryEventsResponse;
140142
import com.google.analytics.admin.v1alpha.UpdateAccountRequest;
@@ -633,6 +635,10 @@ public UnaryCallable<ArchiveAudienceRequest, Empty> archiveAudienceCallable() {
633635
throw new UnsupportedOperationException("Not implemented: updateAttributionSettingsCallable()");
634636
}
635637

638+
public UnaryCallable<RunAccessReportRequest, RunAccessReportResponse> runAccessReportCallable() {
639+
throw new UnsupportedOperationException("Not implemented: runAccessReportCallable()");
640+
}
641+
636642
@Override
637643
public abstract void close();
638644
}

‎google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/stub/AnalyticsAdminServiceStubSettings.java

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@
138138
import com.google.analytics.admin.v1alpha.Property;
139139
import com.google.analytics.admin.v1alpha.ProvisionAccountTicketRequest;
140140
import com.google.analytics.admin.v1alpha.ProvisionAccountTicketResponse;
141+
import com.google.analytics.admin.v1alpha.RunAccessReportRequest;
142+
import com.google.analytics.admin.v1alpha.RunAccessReportResponse;
141143
import com.google.analytics.admin.v1alpha.SearchChangeHistoryEventsRequest;
142144
import com.google.analytics.admin.v1alpha.SearchChangeHistoryEventsResponse;
143145
import com.google.analytics.admin.v1alpha.UpdateAccountRequest;
@@ -408,6 +410,8 @@ public class AnalyticsAdminServiceStubSettings
408410
getAttributionSettingsSettings;
409411
private final UnaryCallSettings<UpdateAttributionSettingsRequest, AttributionSettings>
410412
updateAttributionSettingsSettings;
413+
private final UnaryCallSettings<RunAccessReportRequest, RunAccessReportResponse>
414+
runAccessReportSettings;
411415

412416
private static final PagedListDescriptor<ListAccountsRequest, ListAccountsResponse, Account>
413417
LIST_ACCOUNTS_PAGE_STR_DESC =
@@ -1927,6 +1931,12 @@ public UnaryCallSettings<ArchiveAudienceRequest, Empty> archiveAudienceSettings(
19271931
return updateAttributionSettingsSettings;
19281932
}
19291933

1934+
/** Returns the object with the settings used for calls to runAccessReport. */
1935+
public UnaryCallSettings<RunAccessReportRequest, RunAccessReportResponse>
1936+
runAccessReportSettings() {
1937+
return runAccessReportSettings;
1938+
}
1939+
19301940
public AnalyticsAdminServiceStub createStub() throws IOException {
19311941
if (getTransportChannelProvider()
19321942
.getTransportName()
@@ -2130,6 +2140,7 @@ protected AnalyticsAdminServiceStubSettings(Builder settingsBuilder) throws IOEx
21302140
archiveAudienceSettings = settingsBuilder.archiveAudienceSettings().build();
21312141
getAttributionSettingsSettings = settingsBuilder.getAttributionSettingsSettings().build();
21322142
updateAttributionSettingsSettings = settingsBuilder.updateAttributionSettingsSettings().build();
2143+
runAccessReportSettings = settingsBuilder.runAccessReportSettings().build();
21332144
}
21342145

21352146
/** Builder for AnalyticsAdminServiceStubSettings. */
@@ -2326,6 +2337,8 @@ public static class Builder
23262337
getAttributionSettingsSettings;
23272338
private final UnaryCallSettings.Builder<UpdateAttributionSettingsRequest, AttributionSettings>
23282339
updateAttributionSettingsSettings;
2340+
private final UnaryCallSettings.Builder<RunAccessReportRequest, RunAccessReportResponse>
2341+
runAccessReportSettings;
23292342
private static final ImmutableMap<String, ImmutableSet<StatusCode.Code>>
23302343
RETRYABLE_CODE_DEFINITIONS;
23312344

@@ -2458,6 +2471,7 @@ protected Builder(ClientContext clientContext) {
24582471
archiveAudienceSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
24592472
getAttributionSettingsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
24602473
updateAttributionSettingsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
2474+
runAccessReportSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
24612475

24622476
unaryMethodSettingsBuilders =
24632477
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
@@ -2538,7 +2552,8 @@ protected Builder(ClientContext clientContext) {
25382552
updateAudienceSettings,
25392553
archiveAudienceSettings,
25402554
getAttributionSettingsSettings,
2541-
updateAttributionSettingsSettings);
2555+
updateAttributionSettingsSettings,
2556+
runAccessReportSettings);
25422557
initDefaults(this);
25432558
}
25442559

@@ -2642,6 +2657,7 @@ protected Builder(AnalyticsAdminServiceStubSettings settings) {
26422657
archiveAudienceSettings = settings.archiveAudienceSettings.toBuilder();
26432658
getAttributionSettingsSettings = settings.getAttributionSettingsSettings.toBuilder();
26442659
updateAttributionSettingsSettings = settings.updateAttributionSettingsSettings.toBuilder();
2660+
runAccessReportSettings = settings.runAccessReportSettings.toBuilder();
26452661

26462662
unaryMethodSettingsBuilders =
26472663
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
@@ -2722,7 +2738,8 @@ protected Builder(AnalyticsAdminServiceStubSettings settings) {
27222738
updateAudienceSettings,
27232739
archiveAudienceSettings,
27242740
getAttributionSettingsSettings,
2725-
updateAttributionSettingsSettings);
2741+
updateAttributionSettingsSettings,
2742+
runAccessReportSettings);
27262743
}
27272744

27282745
private static Builder createDefault() {
@@ -3142,6 +3159,11 @@ private static Builder initDefaults(Builder builder) {
31423159
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
31433160
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
31443161

3162+
builder
3163+
.runAccessReportSettings()
3164+
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
3165+
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
3166+
31453167
return builder;
31463168
}
31473169

@@ -3680,6 +3702,12 @@ public UnaryCallSettings.Builder<ArchiveAudienceRequest, Empty> archiveAudienceS
36803702
return updateAttributionSettingsSettings;
36813703
}
36823704

3705+
/** Returns the builder for the settings used for calls to runAccessReport. */
3706+
public UnaryCallSettings.Builder<RunAccessReportRequest, RunAccessReportResponse>
3707+
runAccessReportSettings() {
3708+
return runAccessReportSettings;
3709+
}
3710+
36833711
@Override
36843712
public AnalyticsAdminServiceStubSettings build() throws IOException {
36853713
return new AnalyticsAdminServiceStubSettings(this);

‎google-analytics-admin/src/main/java/com/google/analytics/admin/v1alpha/stub/GrpcAnalyticsAdminServiceStub.java

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@
135135
import com.google.analytics.admin.v1alpha.Property;
136136
import com.google.analytics.admin.v1alpha.ProvisionAccountTicketRequest;
137137
import com.google.analytics.admin.v1alpha.ProvisionAccountTicketResponse;
138+
import com.google.analytics.admin.v1alpha.RunAccessReportRequest;
139+
import com.google.analytics.admin.v1alpha.RunAccessReportResponse;
138140
import com.google.analytics.admin.v1alpha.SearchChangeHistoryEventsRequest;
139141
import com.google.analytics.admin.v1alpha.SearchChangeHistoryEventsResponse;
140142
import com.google.analytics.admin.v1alpha.UpdateAccountRequest;
@@ -1124,6 +1126,18 @@ public class GrpcAnalyticsAdminServiceStub extends AnalyticsAdminServiceStub {
11241126
ProtoUtils.marshaller(AttributionSettings.getDefaultInstance()))
11251127
.build();
11261128

1129+
private static final MethodDescriptor<RunAccessReportRequest, RunAccessReportResponse>
1130+
runAccessReportMethodDescriptor =
1131+
MethodDescriptor.<RunAccessReportRequest, RunAccessReportResponse>newBuilder()
1132+
.setType(MethodDescriptor.MethodType.UNARY)
1133+
.setFullMethodName(
1134+
"google.analytics.admin.v1alpha.AnalyticsAdminService/RunAccessReport")
1135+
.setRequestMarshaller(
1136+
ProtoUtils.marshaller(RunAccessReportRequest.getDefaultInstance()))
1137+
.setResponseMarshaller(
1138+
ProtoUtils.marshaller(RunAccessReportResponse.getDefaultInstance()))
1139+
.build();
1140+
11271141
private final UnaryCallable<GetAccountRequest, Account> getAccountCallable;
11281142
private final UnaryCallable<ListAccountsRequest, ListAccountsResponse> listAccountsCallable;
11291143
private final UnaryCallable<ListAccountsRequest, ListAccountsPagedResponse>
@@ -1296,6 +1310,8 @@ public class GrpcAnalyticsAdminServiceStub extends AnalyticsAdminServiceStub {
12961310
getAttributionSettingsCallable;
12971311
private final UnaryCallable<UpdateAttributionSettingsRequest, AttributionSettings>
12981312
updateAttributionSettingsCallable;
1313+
private final UnaryCallable<RunAccessReportRequest, RunAccessReportResponse>
1314+
runAccessReportCallable;
12991315

13001316
private final BackgroundResource backgroundResources;
13011317
private final GrpcOperationsStub operationsStub;
@@ -2194,6 +2210,17 @@ protected GrpcAnalyticsAdminServiceStub(
21942210
return params.build();
21952211
})
21962212
.build();
2213+
GrpcCallSettings<RunAccessReportRequest, RunAccessReportResponse>
2214+
runAccessReportTransportSettings =
2215+
GrpcCallSettings.<RunAccessReportRequest, RunAccessReportResponse>newBuilder()
2216+
.setMethodDescriptor(runAccessReportMethodDescriptor)
2217+
.setParamsExtractor(
2218+
request -> {
2219+
ImmutableMap.Builder<String, String> params = ImmutableMap.builder();
2220+
params.put("entity", String.valueOf(request.getEntity()));
2221+
return params.build();
2222+
})
2223+
.build();
21972224

21982225
this.getAccountCallable =
21992226
callableFactory.createUnaryCallable(
@@ -2599,6 +2626,9 @@ protected GrpcAnalyticsAdminServiceStub(
25992626
updateAttributionSettingsTransportSettings,
26002627
settings.updateAttributionSettingsSettings(),
26012628
clientContext);
2629+
this.runAccessReportCallable =
2630+
callableFactory.createUnaryCallable(
2631+
runAccessReportTransportSettings, settings.runAccessReportSettings(), clientContext);
26022632

26032633
this.backgroundResources =
26042634
new BackgroundResourceAggregation(clientContext.getBackgroundResources());
@@ -3145,6 +3175,11 @@ public UnaryCallable<ArchiveAudienceRequest, Empty> archiveAudienceCallable() {
31453175
return updateAttributionSettingsCallable;
31463176
}
31473177

3178+
@Override
3179+
public UnaryCallable<RunAccessReportRequest, RunAccessReportResponse> runAccessReportCallable() {
3180+
return runAccessReportCallable;
3181+
}
3182+
31483183
@Override
31493184
public final void close() {
31503185
try {

0 commit comments

Comments
 (0)