- 0.65.0 (latest)
- 0.64.0
- 0.63.0
- 0.62.0
- 0.61.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
public abstract static class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceImplBase implements BindableService
Service Interface for the Analytics Admin API (GA4).
Implements
io.grpc.BindableServiceInherited Members
Constructors
AnalyticsAdminServiceImplBase()
public AnalyticsAdminServiceImplBase()
Methods
acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)
public void acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
Name | Description |
request | AcknowledgeUserDataCollectionRequest |
responseObserver | io.grpc.stub.StreamObserver<AcknowledgeUserDataCollectionResponse> |
approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse> responseObserver)
public void approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse> responseObserver)
Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.
Name | Description |
request | ApproveDisplayVideo360AdvertiserLinkProposalRequest |
responseObserver | io.grpc.stub.StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse> |
archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)
public void archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)
Archives an Audience on a property.
Name | Description |
request | ArchiveAudienceRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)
public void archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)
Archives a CustomDimension on a property.
Name | Description |
request | ArchiveCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)
public void archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)
Archives a CustomMetric on a property.
Name | Description |
request | ArchiveCustomMetricRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
auditUserLinks(AuditUserLinksRequest request, StreamObserver<AuditUserLinksResponse> responseObserver)
public void auditUserLinks(AuditUserLinksRequest request, StreamObserver<AuditUserLinksResponse> responseObserver)
Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.
Name | Description |
request | AuditUserLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<AuditUserLinksResponse> |
batchCreateUserLinks(BatchCreateUserLinksRequest request, StreamObserver<BatchCreateUserLinksResponse> responseObserver)
public void batchCreateUserLinks(BatchCreateUserLinksRequest request, StreamObserver<BatchCreateUserLinksResponse> responseObserver)
Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.
Name | Description |
request | BatchCreateUserLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<BatchCreateUserLinksResponse> |
batchDeleteUserLinks(BatchDeleteUserLinksRequest request, StreamObserver<Empty> responseObserver)
public void batchDeleteUserLinks(BatchDeleteUserLinksRequest request, StreamObserver<Empty> responseObserver)
Deletes information about multiple users' links to an account or property.
Name | Description |
request | BatchDeleteUserLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
batchGetUserLinks(BatchGetUserLinksRequest request, StreamObserver<BatchGetUserLinksResponse> responseObserver)
public void batchGetUserLinks(BatchGetUserLinksRequest request, StreamObserver<BatchGetUserLinksResponse> responseObserver)
Gets information about multiple users' links to an account or property.
Name | Description |
request | BatchGetUserLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<BatchGetUserLinksResponse> |
batchUpdateUserLinks(BatchUpdateUserLinksRequest request, StreamObserver<BatchUpdateUserLinksResponse> responseObserver)
public void batchUpdateUserLinks(BatchUpdateUserLinksRequest request, StreamObserver<BatchUpdateUserLinksResponse> responseObserver)
Updates information about multiple users' links to an account or property.
Name | Description |
request | BatchUpdateUserLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<BatchUpdateUserLinksResponse> |
bindService()
public final ServerServiceDefinition bindService()
Type | Description |
io.grpc.ServerServiceDefinition |
cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
public void cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either:
- Declining a proposal initiated from Display & Video 360
- Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.
Name | Description |
request | CancelDisplayVideo360AdvertiserLinkProposalRequest |
responseObserver | io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal> |
createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)
public void createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)
Creates an Audience.
Name | Description |
request | CreateAudienceRequest |
responseObserver | io.grpc.stub.StreamObserver<Audience> |
createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
public void createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
Creates a conversion event with the specified attributes.
Name | Description |
request | CreateConversionEventRequest |
responseObserver | io.grpc.stub.StreamObserver<ConversionEvent> |
createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
public void createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
Creates a CustomDimension.
Name | Description |
request | CreateCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomDimension> |
createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
public void createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
Creates a CustomMetric.
Name | Description |
request | CreateCustomMetricRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomMetric> |
createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)
public void createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)
Creates a DataStream.
Name | Description |
request | CreateDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<DataStream> |
createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)
public void createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)
Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.
Name | Description |
request | CreateDisplayVideo360AdvertiserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink> |
createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
public void createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
Creates a DisplayVideo360AdvertiserLinkProposal.
Name | Description |
request | CreateDisplayVideo360AdvertiserLinkProposalRequest |
responseObserver | io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal> |
createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver<FirebaseLink> responseObserver)
public void createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver<FirebaseLink> responseObserver)
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
Name | Description |
request | CreateFirebaseLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<FirebaseLink> |
createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)
public void createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)
Creates a GoogleAdsLink.
Name | Description |
request | CreateGoogleAdsLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<GoogleAdsLink> |
createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
public void createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
Creates a measurement protocol secret.
Name | Description |
request | CreateMeasurementProtocolSecretRequest |
responseObserver | io.grpc.stub.StreamObserver<MeasurementProtocolSecret> |
createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)
public void createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)
Creates an "GA4" property with the specified location and attributes.
Name | Description |
request | CreatePropertyRequest |
responseObserver | io.grpc.stub.StreamObserver<Property> |
createUserLink(CreateUserLinkRequest request, StreamObserver<UserLink> responseObserver)
public void createUserLink(CreateUserLinkRequest request, StreamObserver<UserLink> responseObserver)
Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.
Name | Description |
request | CreateUserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<UserLink> |
deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)
public void deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)
Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
Name | Description |
request | DeleteAccountRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver)
public void deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver)
Deletes a conversion event in a property.
Name | Description |
request | DeleteConversionEventRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)
public void deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)
Deletes a DataStream on a property.
Name | Description |
request | DeleteDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a DisplayVideo360AdvertiserLink on a property.
Name | Description |
request | DeleteDisplayVideo360AdvertiserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<Empty> responseObserver)
public void deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<Empty> responseObserver)
Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.
Name | Description |
request | DeleteDisplayVideo360AdvertiserLinkProposalRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a FirebaseLink on a property
Name | Description |
request | DeleteFirebaseLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a GoogleAdsLink on a property
Name | Description |
request | DeleteGoogleAdsLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)
public void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)
Deletes target MeasurementProtocolSecret.
Name | Description |
request | DeleteMeasurementProtocolSecretRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
deleteProperty(DeletePropertyRequest request, StreamObserver<Property> responseObserver)
public void deleteProperty(DeletePropertyRequest request, StreamObserver<Property> responseObserver)
Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.
Name | Description |
request | DeletePropertyRequest |
responseObserver | io.grpc.stub.StreamObserver<Property> |
deleteUserLink(DeleteUserLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteUserLink(DeleteUserLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a user link on an account or property.
Name | Description |
request | DeleteUserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)
public void getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)
Lookup for a single Account.
Name | Description |
request | GetAccountRequest |
responseObserver | io.grpc.stub.StreamObserver<Account> |
getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)
public void getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)
Lookup for a AttributionSettings singleton.
Name | Description |
request | GetAttributionSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<AttributionSettings> |
getAudience(GetAudienceRequest request, StreamObserver<Audience> responseObserver)
public void getAudience(GetAudienceRequest request, StreamObserver<Audience> responseObserver)
Lookup for a single Audience. Audiences created before 2020 may not be supported.
Name | Description |
request | GetAudienceRequest |
responseObserver | io.grpc.stub.StreamObserver<Audience> |
getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
public void getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
Retrieve a single conversion event.
Name | Description |
request | GetConversionEventRequest |
responseObserver | io.grpc.stub.StreamObserver<ConversionEvent> |
getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
public void getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
Lookup for a single CustomDimension.
Name | Description |
request | GetCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomDimension> |
getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
public void getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
Lookup for a single CustomMetric.
Name | Description |
request | GetCustomMetricRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomMetric> |
getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)
public void getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)
Returns the singleton data retention settings for this property.
Name | Description |
request | GetDataRetentionSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<DataRetentionSettings> |
getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver<DataSharingSettings> responseObserver)
public void getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver<DataSharingSettings> responseObserver)
Get data sharing settings on an account. Data sharing settings are singletons.
Name | Description |
request | GetDataSharingSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<DataSharingSettings> |
getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)
public void getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)
Lookup for a single DataStream.
Name | Description |
request | GetDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<DataStream> |
getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)
public void getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)
Look up a single DisplayVideo360AdvertiserLink
Name | Description |
request | GetDisplayVideo360AdvertiserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink> |
getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
public void getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
Name | Description |
request | GetDisplayVideo360AdvertiserLinkProposalRequest |
responseObserver | io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal> |
getGlobalSiteTag(GetGlobalSiteTagRequest request, StreamObserver<GlobalSiteTag> responseObserver)
public void getGlobalSiteTag(GetGlobalSiteTagRequest request, StreamObserver<GlobalSiteTag> responseObserver)
Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
Name | Description |
request | GetGlobalSiteTagRequest |
responseObserver | io.grpc.stub.StreamObserver<GlobalSiteTag> |
getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)
public void getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)
Lookup for Google Signals settings for a property.
Name | Description |
request | GetGoogleSignalsSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<GoogleSignalsSettings> |
getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
public void getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
Lookup for a single "GA4" MeasurementProtocolSecret.
Name | Description |
request | GetMeasurementProtocolSecretRequest |
responseObserver | io.grpc.stub.StreamObserver<MeasurementProtocolSecret> |
getProperty(GetPropertyRequest request, StreamObserver<Property> responseObserver)
public void getProperty(GetPropertyRequest request, StreamObserver<Property> responseObserver)
Lookup for a single "GA4" Property.
Name | Description |
request | GetPropertyRequest |
responseObserver | io.grpc.stub.StreamObserver<Property> |
getUserLink(GetUserLinkRequest request, StreamObserver<UserLink> responseObserver)
public void getUserLink(GetUserLinkRequest request, StreamObserver<UserLink> responseObserver)
Gets information about a user's link to an account or property.
Name | Description |
request | GetUserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<UserLink> |
listAccountSummaries(ListAccountSummariesRequest request, StreamObserver<ListAccountSummariesResponse> responseObserver)
public void listAccountSummaries(ListAccountSummariesRequest request, StreamObserver<ListAccountSummariesResponse> responseObserver)
Returns summaries of all accounts accessible by the caller.
Name | Description |
request | ListAccountSummariesRequest |
responseObserver | io.grpc.stub.StreamObserver<ListAccountSummariesResponse> |
listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)
public void listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)
Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Name | Description |
request | ListAccountsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListAccountsResponse> |
listAudiences(ListAudiencesRequest request, StreamObserver<ListAudiencesResponse> responseObserver)
public void listAudiences(ListAudiencesRequest request, StreamObserver<ListAudiencesResponse> responseObserver)
Lists Audiences on a property. Audiences created before 2020 may not be supported.
Name | Description |
request | ListAudiencesRequest |
responseObserver | io.grpc.stub.StreamObserver<ListAudiencesResponse> |
listConversionEvents(ListConversionEventsRequest request, StreamObserver<ListConversionEventsResponse> responseObserver)
public void listConversionEvents(ListConversionEventsRequest request, StreamObserver<ListConversionEventsResponse> responseObserver)
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
Name | Description |
request | ListConversionEventsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListConversionEventsResponse> |
listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver<ListCustomDimensionsResponse> responseObserver)
public void listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver<ListCustomDimensionsResponse> responseObserver)
Lists CustomDimensions on a property.
Name | Description |
request | ListCustomDimensionsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListCustomDimensionsResponse> |
listCustomMetrics(ListCustomMetricsRequest request, StreamObserver<ListCustomMetricsResponse> responseObserver)
public void listCustomMetrics(ListCustomMetricsRequest request, StreamObserver<ListCustomMetricsResponse> responseObserver)
Lists CustomMetrics on a property.
Name | Description |
request | ListCustomMetricsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListCustomMetricsResponse> |
listDataStreams(ListDataStreamsRequest request, StreamObserver<ListDataStreamsResponse> responseObserver)
public void listDataStreams(ListDataStreamsRequest request, StreamObserver<ListDataStreamsResponse> responseObserver)
Lists DataStreams on a property.
Name | Description |
request | ListDataStreamsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListDataStreamsResponse> |
listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse> responseObserver)
public void listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse> responseObserver)
Lists DisplayVideo360AdvertiserLinkProposals on a property.
Name | Description |
request | ListDisplayVideo360AdvertiserLinkProposalsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse> |
listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinksResponse> responseObserver)
public void listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinksResponse> responseObserver)
Lists all DisplayVideo360AdvertiserLinks on a property.
Name | Description |
request | ListDisplayVideo360AdvertiserLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<ListDisplayVideo360AdvertiserLinksResponse> |
listFirebaseLinks(ListFirebaseLinksRequest request, StreamObserver<ListFirebaseLinksResponse> responseObserver)
public void listFirebaseLinks(ListFirebaseLinksRequest request, StreamObserver<ListFirebaseLinksResponse> responseObserver)
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Name | Description |
request | ListFirebaseLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<ListFirebaseLinksResponse> |
listGoogleAdsLinks(ListGoogleAdsLinksRequest request, StreamObserver<ListGoogleAdsLinksResponse> responseObserver)
public void listGoogleAdsLinks(ListGoogleAdsLinksRequest request, StreamObserver<ListGoogleAdsLinksResponse> responseObserver)
Lists GoogleAdsLinks on a property.
Name | Description |
request | ListGoogleAdsLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<ListGoogleAdsLinksResponse> |
listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver<ListMeasurementProtocolSecretsResponse> responseObserver)
public void listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver<ListMeasurementProtocolSecretsResponse> responseObserver)
Returns child MeasurementProtocolSecrets under the specified parent Property.
Name | Description |
request | ListMeasurementProtocolSecretsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListMeasurementProtocolSecretsResponse> |
listProperties(ListPropertiesRequest request, StreamObserver<ListPropertiesResponse> responseObserver)
public void listProperties(ListPropertiesRequest request, StreamObserver<ListPropertiesResponse> responseObserver)
Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
Name | Description |
request | ListPropertiesRequest |
responseObserver | io.grpc.stub.StreamObserver<ListPropertiesResponse> |
listUserLinks(ListUserLinksRequest request, StreamObserver<ListUserLinksResponse> responseObserver)
public void listUserLinks(ListUserLinksRequest request, StreamObserver<ListUserLinksResponse> responseObserver)
Lists all user links on an account or property.
Name | Description |
request | ListUserLinksRequest |
responseObserver | io.grpc.stub.StreamObserver<ListUserLinksResponse> |
provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver<ProvisionAccountTicketResponse> responseObserver)
public void provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver<ProvisionAccountTicketResponse> responseObserver)
Requests a ticket for creating an account.
Name | Description |
request | ProvisionAccountTicketRequest |
responseObserver | io.grpc.stub.StreamObserver<ProvisionAccountTicketResponse> |
runAccessReport(RunAccessReportRequest request, StreamObserver<RunAccessReportResponse> responseObserver)
public void runAccessReport(RunAccessReportRequest request, StreamObserver<RunAccessReportResponse> responseObserver)
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.
Name | Description |
request | RunAccessReportRequest |
responseObserver | io.grpc.stub.StreamObserver<RunAccessReportResponse> |
searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver<SearchChangeHistoryEventsResponse> responseObserver)
public void searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver<SearchChangeHistoryEventsResponse> responseObserver)
Searches through all changes to an account or its children given the specified set of filters.
Name | Description |
request | SearchChangeHistoryEventsRequest |
responseObserver | io.grpc.stub.StreamObserver<SearchChangeHistoryEventsResponse> |
updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)
public void updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)
Updates an account.
Name | Description |
request | UpdateAccountRequest |
responseObserver | io.grpc.stub.StreamObserver<Account> |
updateAttributionSettings(UpdateAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)
public void updateAttributionSettings(UpdateAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)
Updates attribution settings on a property.
Name | Description |
request | UpdateAttributionSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<AttributionSettings> |
updateAudience(UpdateAudienceRequest request, StreamObserver<Audience> responseObserver)
public void updateAudience(UpdateAudienceRequest request, StreamObserver<Audience> responseObserver)
Updates an Audience on a property.
Name | Description |
request | UpdateAudienceRequest |
responseObserver | io.grpc.stub.StreamObserver<Audience> |
updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
public void updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
Updates a CustomDimension on a property.
Name | Description |
request | UpdateCustomDimensionRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomDimension> |
updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
public void updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
Updates a CustomMetric on a property.
Name | Description |
request | UpdateCustomMetricRequest |
responseObserver | io.grpc.stub.StreamObserver<CustomMetric> |
updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)
public void updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)
Updates the singleton data retention settings for this property.
Name | Description |
request | UpdateDataRetentionSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<DataRetentionSettings> |
updateDataStream(UpdateDataStreamRequest request, StreamObserver<DataStream> responseObserver)
public void updateDataStream(UpdateDataStreamRequest request, StreamObserver<DataStream> responseObserver)
Updates a DataStream on a property.
Name | Description |
request | UpdateDataStreamRequest |
responseObserver | io.grpc.stub.StreamObserver<DataStream> |
updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)
public void updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)
Updates a DisplayVideo360AdvertiserLink on a property.
Name | Description |
request | UpdateDisplayVideo360AdvertiserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink> |
updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)
public void updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)
Updates a GoogleAdsLink on a property
Name | Description |
request | UpdateGoogleAdsLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<GoogleAdsLink> |
updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)
public void updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)
Updates Google Signals settings for a property.
Name | Description |
request | UpdateGoogleSignalsSettingsRequest |
responseObserver | io.grpc.stub.StreamObserver<GoogleSignalsSettings> |
updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
public void updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
Updates a measurement protocol secret.
Name | Description |
request | UpdateMeasurementProtocolSecretRequest |
responseObserver | io.grpc.stub.StreamObserver<MeasurementProtocolSecret> |
updateProperty(UpdatePropertyRequest request, StreamObserver<Property> responseObserver)
public void updateProperty(UpdatePropertyRequest request, StreamObserver<Property> responseObserver)
Updates a property.
Name | Description |
request | UpdatePropertyRequest |
responseObserver | io.grpc.stub.StreamObserver<Property> |
updateUserLink(UpdateUserLinkRequest request, StreamObserver<UserLink> responseObserver)
public void updateUserLink(UpdateUserLinkRequest request, StreamObserver<UserLink> responseObserver)
Updates a user link on an account or property.
Name | Description |
request | UpdateUserLinkRequest |
responseObserver | io.grpc.stub.StreamObserver<UserLink> |