public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub extends AbstractAsyncStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub>
Service Interface for the Analytics Admin API (GA4).
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractAsyncStub >
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub
Inherited Members
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
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.
Parameters
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.
Parameters
archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)
public void archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)
Archives an Audience on a property.
Parameters
archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)
public void archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)
Archives a CustomDimension on a property.
Parameters
archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)
public void archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)
Archives a CustomMetric on a property.
Parameters
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.
Parameters
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.
Parameters
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.
Parameters
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.
Parameters
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.
Parameters
build(Channel channel, CallOptions callOptions)
protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceStub build(Channel channel, CallOptions callOptions)
Parameters
Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
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.
Parameters
createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)
public void createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)
Parameters
createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
public void createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
Creates a conversion event with the specified attributes.
Parameters
createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
public void createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
Creates a CustomDimension.
Parameters
createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
public void createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
Parameters
createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)
public void createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)
Parameters
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.
Parameters
createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
public void createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)
Creates a DisplayVideo360AdvertiserLinkProposal.
Parameters
createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver<FirebaseLink> responseObserver)
public void createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver<FirebaseLink> responseObserver)
Creates a FirebaseLink.
Properties can have at most one FirebaseLink.
Parameters
createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)
public void createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)
Parameters
createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
public void createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)
Creates a measurement protocol secret.
Parameters
createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)
public void createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)
Creates an "GA4" property with the specified location and attributes.
Parameters
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.
Parameters
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.
Parameters
deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver)
public void deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver)
Deletes a conversion event in a property.
Parameters
deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)
public void deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)
Deletes a DataStream on a property.
Parameters
deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a DisplayVideo360AdvertiserLink on a property.
Parameters
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.
Parameters
deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a FirebaseLink on a property
Parameters
deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a GoogleAdsLink on a property
Parameters
deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)
public void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)
Deletes target MeasurementProtocolSecret.
Parameters
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.
Parameters
deleteUserLink(DeleteUserLinkRequest request, StreamObserver<Empty> responseObserver)
public void deleteUserLink(DeleteUserLinkRequest request, StreamObserver<Empty> responseObserver)
Deletes a user link on an account or property.
Parameters
getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)
public void getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)
Lookup for a single Account.
Parameters
getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)
public void getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)
Lookup for a AttributionSettings singleton.
Parameters
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.
Parameters
getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
public void getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)
Retrieve a single conversion event.
Parameters
getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
public void getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)
Lookup for a single CustomDimension.
Parameters
getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
public void getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)
Lookup for a single CustomMetric.
Parameters
getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)
public void getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)
Returns the singleton data retention settings for this property.
Parameters
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.
Parameters
getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)
public void getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)
Lookup for a single DataStream.
Parameters
getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)