public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub extends AbstractBlockingStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub>
A stub to allow clients to do synchronous rpc calls to service AnalyticsAdminService.
Service Interface for the Analytics Admin API (GA4).
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<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(java.time.Duration)
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.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)
public AcknowledgeUserDataCollectionResponse acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)
Acknowledges the terms of user data collection for the specified property.
This acknowledgement must be completed (either in the Google Analytics UI
or through this API) before MeasurementProtocolSecret resources may be
created.
approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)
public ApproveDisplayVideo360AdvertiserLinkProposalResponse approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)
Approves a DisplayVideo360AdvertiserLinkProposal.
The DisplayVideo360AdvertiserLinkProposal will be deleted and a new
DisplayVideo360AdvertiserLink will be created.
archiveAudience(ArchiveAudienceRequest request)
public Empty archiveAudience(ArchiveAudienceRequest request)
Archives an Audience on a property.
| Returns |
| Type |
Description |
Empty |
|
archiveCustomDimension(ArchiveCustomDimensionRequest request)
public Empty archiveCustomDimension(ArchiveCustomDimensionRequest request)
Archives a CustomDimension on a property.
| Returns |
| Type |
Description |
Empty |
|
archiveCustomMetric(ArchiveCustomMetricRequest request)
public Empty archiveCustomMetric(ArchiveCustomMetricRequest request)
Archives a CustomMetric on a property.
| Returns |
| Type |
Description |
Empty |
|
batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)
public BatchCreateAccessBindingsResponse batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)
Creates information about multiple access bindings to an account or
property.
This method is transactional. If any AccessBinding cannot be created, none
of the AccessBindings will be created.
batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)
public Empty batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)
Deletes information about multiple users' links to an account or property.
| Returns |
| Type |
Description |
Empty |
|
batchGetAccessBindings(BatchGetAccessBindingsRequest request)
public BatchGetAccessBindingsResponse batchGetAccessBindings(BatchGetAccessBindingsRequest request)
Gets information about multiple access bindings to an account or property.
batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)
public BatchUpdateAccessBindingsResponse batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)
Updates information about multiple access bindings to an account or
property.
build(Channel channel, CallOptions callOptions)
protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceBlockingStub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)
public DisplayVideo360AdvertiserLinkProposal cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)
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.
createAccessBinding(CreateAccessBindingRequest request)
public AccessBinding createAccessBinding(CreateAccessBindingRequest request)
Creates an access binding on an account or property.
createAdSenseLink(CreateAdSenseLinkRequest request)
public AdSenseLink createAdSenseLink(CreateAdSenseLinkRequest request)
createAudience(CreateAudienceRequest request)
public Audience createAudience(CreateAudienceRequest request)
createBigQueryLink(CreateBigQueryLinkRequest request)
public BigQueryLink createBigQueryLink(CreateBigQueryLinkRequest request)
createCalculatedMetric(CreateCalculatedMetricRequest request)
public CalculatedMetric createCalculatedMetric(CreateCalculatedMetricRequest request)
Creates a CalculatedMetric.
createChannelGroup(CreateChannelGroupRequest request)
public ChannelGroup createChannelGroup(CreateChannelGroupRequest request)
createConnectedSiteTag(CreateConnectedSiteTagRequest request)
public CreateConnectedSiteTagResponse createConnectedSiteTag(CreateConnectedSiteTagRequest request)
Creates a connected site tag for a Universal Analytics property. You can
create a maximum of 20 connected site tags per property.
Note: This API cannot be used on GA4 properties.
createConversionEvent(CreateConversionEventRequest request) (deprecated)
public ConversionEvent createConversionEvent(CreateConversionEventRequest request)
Deprecated: Use CreateKeyEvent instead.
Creates a conversion event with the specified attributes.
createCustomDimension(CreateCustomDimensionRequest request)
public CustomDimension createCustomDimension(CreateCustomDimensionRequest request)
Creates a CustomDimension.
createCustomMetric(CreateCustomMetricRequest request)
public CustomMetric createCustomMetric(CreateCustomMetricRequest request)
createDataStream(CreateDataStreamRequest request)
public DataStream createDataStream(CreateDataStreamRequest request)
createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)
public DisplayVideo360AdvertiserLink createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)
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.
createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)
public DisplayVideo360AdvertiserLinkProposal createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)
Creates a DisplayVideo360AdvertiserLinkProposal.
createEventCreateRule(CreateEventCreateRuleRequest request)
public EventCreateRule createEventCreateRule(CreateEventCreateRuleRequest request)
Creates an EventCreateRule.
createEventEditRule(CreateEventEditRuleRequest request)
public EventEditRule createEventEditRule(CreateEventEditRuleRequest request)
Creates an EventEditRule.
createExpandedDataSet(CreateExpandedDataSetRequest request)
public ExpandedDataSet createExpandedDataSet(CreateExpandedDataSetRequest request)
Creates a ExpandedDataSet.
createFirebaseLink(CreateFirebaseLinkRequest request)
public FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request)
Creates a FirebaseLink.
Properties can have at most one FirebaseLink.
createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
public GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
createKeyEvent(CreateKeyEventRequest request)
public KeyEvent createKeyEvent(CreateKeyEventRequest request)
createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
public MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
Creates a measurement protocol secret.
createProperty(CreatePropertyRequest request)
public Property createProperty(CreatePropertyRequest request)
Creates an "GA4" property with the specified location and attributes.
createRollupProperty(CreateRollupPropertyRequest request)
public CreateRollupPropertyResponse createRollupProperty(CreateRollupPropertyRequest request)
Create a roll-up property and all roll-up property source links.
createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request)
public RollupPropertySourceLink createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request)
Creates a roll-up property source link.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)
public SKAdNetworkConversionValueSchema createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)
Creates a SKAdNetworkConversionValueSchema.
createSearchAds360Link(CreateSearchAds360LinkRequest request)
public SearchAds360Link createSearchAds360Link(CreateSearchAds360LinkRequest request)
Creates a SearchAds360Link.
createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)
public SubpropertyEventFilter createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)
Creates a subproperty Event Filter.
deleteAccessBinding(DeleteAccessBindingRequest request)
public Empty deleteAccessBinding(DeleteAccessBindingRequest request)
Deletes an access binding on an account or property.
| Returns |
| Type |
Description |
Empty |
|
deleteAccount(DeleteAccountRequest request)
public Empty deleteAccount(DeleteAccountRequest request)
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,
AccessBindings) will be permanently purged.
https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
| Returns |
| Type |
Description |
Empty |
|
deleteAdSenseLink(DeleteAdSenseLinkRequest request)
public Empty deleteAdSenseLink(DeleteAdSenseLinkRequest request)
| Returns |
| Type |
Description |
Empty |
|
deleteBigQueryLink(DeleteBigQueryLinkRequest request)
public Empty deleteBigQueryLink(DeleteBigQueryLinkRequest request)
Deletes a BigQueryLink on a property.
| Returns |
| Type |
Description |
Empty |
|
deleteCalculatedMetric(DeleteCalculatedMetricRequest request)
public Empty deleteCalculatedMetric(DeleteCalculatedMetricRequest request)
Deletes a CalculatedMetric on a property.
| Returns |
| Type |
Description |
Empty |
|
deleteChannelGroup(DeleteChannelGroupRequest request)
public Empty deleteChannelGroup(DeleteChannelGroupRequest request)
Deletes a ChannelGroup on a property.
| Returns |
| Type |
Description |
Empty |
|
deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)
public Empty deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)
Deletes a connected site tag for a Universal Analytics property.
Note: this has no effect on GA4 properties.
| Returns |
| Type |
Description |
Empty |
|
deleteConversionEvent(DeleteConversionEventRequest request) (deprecated)
public Empty deleteConversionEvent(DeleteConversionEventRequest request)
Deprecated: Use DeleteKeyEvent instead.
Deletes a conversion event in a property.
| Returns |
| Type |
Description |
Empty |
|
deleteDataStream(DeleteDataStreamRequest request)
public Empty deleteDataStream(DeleteDataStreamRequest request)
Deletes a DataStream on a property.
| Returns |
| Type |
Description |
Empty |
|
deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)
public Empty deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)
Deletes a DisplayVideo360AdvertiserLink on a property.
| Returns |
| Type |
Description |
Empty |
|
deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)
public Empty deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)
Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
This can only be used on cancelled proposals.
| Returns |
| Type |
Description |
Empty |
|
deleteEventCreateRule(DeleteEventCreateRuleRequest request)
public Empty deleteEventCreateRule(DeleteEventCreateRuleRequest request)
Deletes an EventCreateRule.
| Returns |
| Type |
Description |
Empty |
|
deleteEventEditRule(DeleteEventEditRuleRequest request)
public Empty deleteEventEditRule(DeleteEventEditRuleRequest request)
Deletes an EventEditRule.
| Returns |
| Type |
Description |
Empty |
|
deleteExpandedDataSet(DeleteExpandedDataSetRequest request)
public Empty deleteExpandedDataSet(DeleteExpandedDataSetRequest request)
Deletes a ExpandedDataSet on a property.
| Returns |
| Type |
Description |
Empty |
|
deleteFirebaseLink(DeleteFirebaseLinkRequest request)
public Empty deleteFirebaseLink(DeleteFirebaseLinkRequest request)
Deletes a FirebaseLink on a property
| Returns |
| Type |
Description |
Empty |
|
deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
public Empty deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
Deletes a GoogleAdsLink on a property
| Returns |
| Type |
Description |
Empty |
|
deleteKeyEvent(DeleteKeyEventRequest request)
public Empty deleteKeyEvent(DeleteKeyEventRequest request)
| Returns |
| Type |
Description |
Empty |
|
deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
public Empty deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
Deletes target MeasurementProtocolSecret.
| Returns |
| Type |
Description |
Empty |
|
deleteProperty(DeletePropertyRequest request)
public Property deleteProperty(DeletePropertyRequest request)
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, AccessBindings)
will be permanently purged.
https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found, or is not a GA4 Property.
deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request)
public Empty deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request)
Deletes a roll-up property source link.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
| Returns |
| Type |
Description |
Empty |
|
deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)
public Empty deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)
Deletes target SKAdNetworkConversionValueSchema.
| Returns |
| Type |
Description |
Empty |
|
deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)
public Empty deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)
Deletes a SearchAds360Link on a property.
| Returns |
| Type |
Description |
Empty |
|
deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)
public Empty deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)
Deletes a subproperty event filter.
| Returns |
| Type |
Description |
Empty |
|
fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request)
public FetchAutomatedGa4ConfigurationOptOutResponse fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request)
Fetches the opt out status for the automated GA4 setup process for a UA
property.
Note: this has no effect on GA4 property.
fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)
public FetchConnectedGa4PropertyResponse fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)
Given a specified UA property, looks up the GA4 property connected to it.
Note: this cannot be used with GA4 properties.
getAccessBinding(GetAccessBindingRequest request)
public AccessBinding getAccessBinding(GetAccessBindingRequest request)
Gets information about an access binding.
getAccount(GetAccountRequest request)
public Account getAccount(GetAccountRequest request)
Lookup for a single Account.
getAdSenseLink(GetAdSenseLinkRequest request)
public AdSenseLink getAdSenseLink(GetAdSenseLinkRequest request)
Looks up a single AdSenseLink.
getAttributionSettings(GetAttributionSettingsRequest request)
public AttributionSettings getAttributionSettings(GetAttributionSettingsRequest request)
Lookup for a AttributionSettings singleton.
getAudience(GetAudienceRequest request)
public Audience getAudience(GetAudienceRequest request)
Lookup for a single Audience.
Audiences created before 2020 may not be supported.
Default audiences will not show filter definitions.
getBigQueryLink(GetBigQueryLinkRequest request)
public BigQueryLink getBigQueryLink(GetBigQueryLinkRequest request)
Lookup for a single BigQuery Link.
getCalculatedMetric(GetCalculatedMetricRequest request)
public CalculatedMetric getCalculatedMetric(GetCalculatedMetricRequest request)
Lookup for a single CalculatedMetric.
getChannelGroup(GetChannelGroupRequest request)
public ChannelGroup getChannelGroup(GetChannelGroupRequest request)
Lookup for a single ChannelGroup.
getConversionEvent(GetConversionEventRequest request) (deprecated)
public ConversionEvent getConversionEvent(GetConversionEventRequest request)
Deprecated: Use GetKeyEvent instead.
Retrieve a single conversion event.
getCustomDimension(GetCustomDimensionRequest request)
public CustomDimension getCustomDimension(GetCustomDimensionRequest request)
Lookup for a single CustomDimension.
getCustomMetric(GetCustomMetricRequest request)
public CustomMetric getCustomMetric(GetCustomMetricRequest request)
Lookup for a single CustomMetric.
getDataRedactionSettings(GetDataRedactionSettingsRequest request)
public DataRedactionSettings getDataRedactionSettings(GetDataRedactionSettingsRequest request)
Lookup for a single DataRedactionSettings.
getDataRetentionSettings(GetDataRetentionSettingsRequest request)
public DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request)
Returns the singleton data retention settings for this property.
getDataSharingSettings(GetDataSharingSettingsRequest request)
public DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request)
Get data sharing settings on an account.
Data sharing settings are singletons.
getDataStream(GetDataStreamRequest request)
public DataStream getDataStream(GetDataStreamRequest request)
Lookup for a single DataStream.
getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)
public DisplayVideo360AdvertiserLink getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)
Look up a single DisplayVideo360AdvertiserLink
getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)
public DisplayVideo360AdvertiserLinkProposal getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)
public EnhancedMeasurementSettings getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)
Returns the enhanced measurement settings for this data stream.
Note that the stream must enable enhanced measurement for these settings to
take effect.
getEventCreateRule(GetEventCreateRuleRequest request)
public EventCreateRule getEventCreateRule(GetEventCreateRuleRequest request)
Lookup for a single EventCreateRule.
getEventEditRule(GetEventEditRuleRequest request)
public EventEditRule getEventEditRule(GetEventEditRuleRequest request)
Lookup for a single EventEditRule.
getExpandedDataSet(GetExpandedDataSetRequest request)
public ExpandedDataSet getExpandedDataSet(GetExpandedDataSetRequest request)
Lookup for a single ExpandedDataSet.
getGlobalSiteTag(GetGlobalSiteTagRequest request)
public GlobalSiteTag getGlobalSiteTag(GetGlobalSiteTagRequest request)
Returns the Site Tag for the specified web stream.
Site Tags are immutable singletons.
getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)
public GoogleSignalsSettings getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)
Lookup for Google Signals settings for a property.
getKeyEvent(GetKeyEventRequest request)
public KeyEvent getKeyEvent(GetKeyEventRequest request)
Retrieve a single Key Event.
getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
public MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
Lookup for a single "GA4" MeasurementProtocolSecret.
getProperty(GetPropertyRequest request)
public Property getProperty(GetPropertyRequest request)
Lookup for a single "GA4" Property.
getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request)
public RollupPropertySourceLink getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request)
Lookup for a single roll-up property source Link.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)
public SKAdNetworkConversionValueSchema getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)
Looks up a single SKAdNetworkConversionValueSchema.
getSearchAds360Link(GetSearchAds360LinkRequest request)
public SearchAds360Link getSearchAds360Link(GetSearchAds360LinkRequest request)
Look up a single SearchAds360Link
getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request)
public SubpropertyEventFilter getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request)
Lookup for a single subproperty Event Filter.
listAccessBindings(ListAccessBindingsRequest request)
public ListAccessBindingsResponse listAccessBindings(ListAccessBindingsRequest request)
Lists all access bindings on an account or property.
listAccountSummaries(ListAccountSummariesRequest request)
public ListAccountSummariesResponse listAccountSummaries(ListAccountSummariesRequest request)
Returns summaries of all accounts accessible by the caller.
listAccounts(ListAccountsRequest request)
public ListAccountsResponse listAccounts(ListAccountsRequest request)
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.
listAdSenseLinks(ListAdSenseLinksRequest request)
public ListAdSenseLinksResponse listAdSenseLinks(ListAdSenseLinksRequest request)
Lists AdSenseLinks on a property.
listAudiences(ListAudiencesRequest request)
public ListAudiencesResponse listAudiences(ListAudiencesRequest request)
Lists Audiences on a property.
Audiences created before 2020 may not be supported.
Default audiences will not show filter definitions.
listBigQueryLinks(ListBigQueryLinksRequest request)
public ListBigQueryLinksResponse listBigQueryLinks(ListBigQueryLinksRequest request)
Lists BigQuery Links on a property.
listCalculatedMetrics(ListCalculatedMetricsRequest request)
public ListCalculatedMetricsResponse listCalculatedMetrics(ListCalculatedMetricsRequest request)
Lists CalculatedMetrics on a property.
listChannelGroups(ListChannelGroupsRequest request)
public ListChannelGroupsResponse listChannelGroups(ListChannelGroupsRequest request)
Lists ChannelGroups on a property.
public ListConnectedSiteTagsResponse listConnectedSiteTags(ListConnectedSiteTagsRequest request)
Lists the connected site tags for a Universal Analytics property. A maximum
of 20 connected site tags will be returned. Note: this has no effect on GA4
property.
listConversionEvents(ListConversionEventsRequest request) (deprecated)
public ListConversionEventsResponse listConversionEvents(ListConversionEventsRequest request)
Deprecated: Use ListKeyEvents instead.
Returns a list of conversion events in the specified parent property.
Returns an empty list if no conversion events are found.
listCustomDimensions(ListCustomDimensionsRequest request)
public ListCustomDimensionsResponse listCustomDimensions(ListCustomDimensionsRequest request)
Lists CustomDimensions on a property.
listCustomMetrics(ListCustomMetricsRequest request)
public ListCustomMetricsResponse listCustomMetrics(ListCustomMetricsRequest request)
Lists CustomMetrics on a property.
listDataStreams(ListDataStreamsRequest request)
public ListDataStreamsResponse listDataStreams(ListDataStreamsRequest request)
Lists DataStreams on a property.
listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)
public ListDisplayVideo360AdvertiserLinkProposalsResponse listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)
Lists DisplayVideo360AdvertiserLinkProposals on a property.
listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)
public ListDisplayVideo360AdvertiserLinksResponse listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)
Lists all DisplayVideo360AdvertiserLinks on a property.
listEventCreateRules(ListEventCreateRulesRequest request)
public ListEventCreateRulesResponse listEventCreateRules(ListEventCreateRulesRequest request)
Lists EventCreateRules on a web data stream.
listEventEditRules(ListEventEditRulesRequest request)
public ListEventEditRulesResponse listEventEditRules(ListEventEditRulesRequest request)
Lists EventEditRules on a web data stream.
listExpandedDataSets(ListExpandedDataSetsRequest request)
public ListExpandedDataSetsResponse listExpandedDataSets(ListExpandedDataSetsRequest request)
Lists ExpandedDataSets on a property.
listFirebaseLinks(ListFirebaseLinksRequest request)
public ListFirebaseLinksResponse listFirebaseLinks(ListFirebaseLinksRequest request)
Lists FirebaseLinks on a property.
Properties can have at most one FirebaseLink.
listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
public ListGoogleAdsLinksResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
Lists GoogleAdsLinks on a property.
listKeyEvents(ListKeyEventsRequest request)
public ListKeyEventsResponse listKeyEvents(ListKeyEventsRequest request)
Returns a list of Key Events in the specified parent property.
Returns an empty list if no Key Events are found.
listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
public ListMeasurementProtocolSecretsResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
Returns child MeasurementProtocolSecrets under the specified parent
Property.
listProperties(ListPropertiesRequest request)
public ListPropertiesResponse listProperties(ListPropertiesRequest request)
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.
listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request)
public ListRollupPropertySourceLinksResponse listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request)
Lists roll-up property source Links on a property.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)
public ListSKAdNetworkConversionValueSchemasResponse listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)
Lists SKAdNetworkConversionValueSchema on a stream.
Properties can have at most one SKAdNetworkConversionValueSchema.
listSearchAds360Links(ListSearchAds360LinksRequest request)
public ListSearchAds360LinksResponse listSearchAds360Links(ListSearchAds360LinksRequest request)
Lists all SearchAds360Links on a property.
listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request)
public ListSubpropertyEventFiltersResponse listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request)
List all subproperty Event Filters on a property.
provisionAccountTicket(ProvisionAccountTicketRequest request)
public ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request)
Requests a ticket for creating an account.
provisionSubproperty(ProvisionSubpropertyRequest request)
public ProvisionSubpropertyResponse provisionSubproperty(ProvisionSubpropertyRequest request)
Create a subproperty and a subproperty event filter that applies to the
created subproperty.
reorderEventEditRules(ReorderEventEditRulesRequest request)
public Empty reorderEventEditRules(ReorderEventEditRulesRequest request)
Changes the processing order of event edit rules on the specified stream.
| Returns |
| Type |
Description |
Empty |
|
runAccessReport(RunAccessReportRequest request)
public RunAccessReportResponse runAccessReport(RunAccessReportRequest request)
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. Reports may be
requested for any property, but dimensions that aren't related to quota can
only be requested on Google Analytics 360 properties. 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.
searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
public SearchChangeHistoryEventsResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
Searches through all changes to an account or its children given the
specified set of filters.
setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request)
public SetAutomatedGa4ConfigurationOptOutResponse setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request)
Sets the opt out status for the automated GA4 setup process for a UA
property.
Note: this has no effect on GA4 property.
updateAccessBinding(UpdateAccessBindingRequest request)
public AccessBinding updateAccessBinding(UpdateAccessBindingRequest request)
Updates an access binding on an account or property.
updateAccount(UpdateAccountRequest request)
public Account updateAccount(UpdateAccountRequest request)
updateAttributionSettings(UpdateAttributionSettingsRequest request)
public AttributionSettings updateAttributionSettings(UpdateAttributionSettingsRequest request)
Updates attribution settings on a property.
updateAudience(UpdateAudienceRequest request)
public Audience updateAudience(UpdateAudienceRequest request)
Updates an Audience on a property.
updateBigQueryLink(UpdateBigQueryLinkRequest request)
public BigQueryLink updateBigQueryLink(UpdateBigQueryLinkRequest request)
updateCalculatedMetric(UpdateCalculatedMetricRequest request)
public CalculatedMetric updateCalculatedMetric(UpdateCalculatedMetricRequest request)
Updates a CalculatedMetric on a property.
updateChannelGroup(UpdateChannelGroupRequest request)
public ChannelGroup updateChannelGroup(UpdateChannelGroupRequest request)
updateConversionEvent(UpdateConversionEventRequest request) (deprecated)
public ConversionEvent updateConversionEvent(UpdateConversionEventRequest request)
Deprecated: Use UpdateKeyEvent instead.
Updates a conversion event with the specified attributes.
updateCustomDimension(UpdateCustomDimensionRequest request)
public CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request)
Updates a CustomDimension on a property.
updateCustomMetric(UpdateCustomMetricRequest request)
public CustomMetric updateCustomMetric(UpdateCustomMetricRequest request)
Updates a CustomMetric on a property.
updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)
public DataRedactionSettings updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)
Updates a DataRedactionSettings on a property.
updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
public DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
Updates the singleton data retention settings for this property.
updateDataStream(UpdateDataStreamRequest request)
public DataStream updateDataStream(UpdateDataStreamRequest request)
Updates a DataStream on a property.
updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)
public DisplayVideo360AdvertiserLink updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)
Updates a DisplayVideo360AdvertiserLink on a property.
updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)
public EnhancedMeasurementSettings updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)
Updates the enhanced measurement settings for this data stream.
Note that the stream must enable enhanced measurement for these settings to
take effect.
updateEventCreateRule(UpdateEventCreateRuleRequest request)
public EventCreateRule updateEventCreateRule(UpdateEventCreateRuleRequest request)
Updates an EventCreateRule.
updateEventEditRule(UpdateEventEditRuleRequest request)
public EventEditRule updateEventEditRule(UpdateEventEditRuleRequest request)
Updates an EventEditRule.
updateExpandedDataSet(UpdateExpandedDataSetRequest request)
public ExpandedDataSet updateExpandedDataSet(UpdateExpandedDataSetRequest request)
Updates a ExpandedDataSet on a property.
updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
public GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
Updates a GoogleAdsLink on a property
updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)
public GoogleSignalsSettings updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)
Updates Google Signals settings for a property.
updateKeyEvent(UpdateKeyEventRequest request)
public KeyEvent updateKeyEvent(UpdateKeyEventRequest request)
updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
public MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
Updates a measurement protocol secret.
updateProperty(UpdatePropertyRequest request)
public Property updateProperty(UpdatePropertyRequest request)
updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)
public SKAdNetworkConversionValueSchema updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)
Updates a SKAdNetworkConversionValueSchema.
updateSearchAds360Link(UpdateSearchAds360LinkRequest request)
public SearchAds360Link updateSearchAds360Link(UpdateSearchAds360LinkRequest request)
Updates a SearchAds360Link on a property.
updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request)
public SubpropertyEventFilter updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request)
Updates a subproperty Event Filter.
