Show / Hide Table of Contents

Class PropertiesResource

The "properties" collection of methods.

Inheritance
object
PropertiesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.GoogleAnalyticsAdmin.v1alpha
Assembly: Google.Apis.GoogleAnalyticsAdmin.v1alpha.dll
Syntax
public class PropertiesResource

Constructors

PropertiesResource(IClientService)

Constructs a new resource.

Declaration
public PropertiesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

AccessBindings

Gets the AccessBindings resource.

Declaration
public virtual PropertiesResource.AccessBindingsResource AccessBindings { get; }
Property Value
Type Description
PropertiesResource.AccessBindingsResource

AdSenseLinks

Gets the AdSenseLinks resource.

Declaration
public virtual PropertiesResource.AdSenseLinksResource AdSenseLinks { get; }
Property Value
Type Description
PropertiesResource.AdSenseLinksResource

Audiences

Gets the Audiences resource.

Declaration
public virtual PropertiesResource.AudiencesResource Audiences { get; }
Property Value
Type Description
PropertiesResource.AudiencesResource

BigQueryLinks

Gets the BigQueryLinks resource.

Declaration
public virtual PropertiesResource.BigQueryLinksResource BigQueryLinks { get; }
Property Value
Type Description
PropertiesResource.BigQueryLinksResource

CalculatedMetrics

Gets the CalculatedMetrics resource.

Declaration
public virtual PropertiesResource.CalculatedMetricsResource CalculatedMetrics { get; }
Property Value
Type Description
PropertiesResource.CalculatedMetricsResource

ChannelGroups

Gets the ChannelGroups resource.

Declaration
public virtual PropertiesResource.ChannelGroupsResource ChannelGroups { get; }
Property Value
Type Description
PropertiesResource.ChannelGroupsResource

ConversionEvents

Gets the ConversionEvents resource.

Declaration
public virtual PropertiesResource.ConversionEventsResource ConversionEvents { get; }
Property Value
Type Description
PropertiesResource.ConversionEventsResource

CustomDimensions

Gets the CustomDimensions resource.

Declaration
public virtual PropertiesResource.CustomDimensionsResource CustomDimensions { get; }
Property Value
Type Description
PropertiesResource.CustomDimensionsResource

CustomMetrics

Gets the CustomMetrics resource.

Declaration
public virtual PropertiesResource.CustomMetricsResource CustomMetrics { get; }
Property Value
Type Description
PropertiesResource.CustomMetricsResource

DataStreams

Gets the DataStreams resource.

Declaration
public virtual PropertiesResource.DataStreamsResource DataStreams { get; }
Property Value
Type Description
PropertiesResource.DataStreamsResource

DisplayVideo360AdvertiserLinkProposals

Gets the DisplayVideo360AdvertiserLinkProposals resource.

Declaration
public virtual PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource DisplayVideo360AdvertiserLinkProposals { get; }
Property Value
Type Description
PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource

DisplayVideo360AdvertiserLinks

Gets the DisplayVideo360AdvertiserLinks resource.

Declaration
public virtual PropertiesResource.DisplayVideo360AdvertiserLinksResource DisplayVideo360AdvertiserLinks { get; }
Property Value
Type Description
PropertiesResource.DisplayVideo360AdvertiserLinksResource

ExpandedDataSets

Gets the ExpandedDataSets resource.

Declaration
public virtual PropertiesResource.ExpandedDataSetsResource ExpandedDataSets { get; }
Property Value
Type Description
PropertiesResource.ExpandedDataSetsResource

FirebaseLinks

Gets the FirebaseLinks resource.

Declaration
public virtual PropertiesResource.FirebaseLinksResource FirebaseLinks { get; }
Property Value
Type Description
PropertiesResource.FirebaseLinksResource

GoogleAdsLinks

Gets the GoogleAdsLinks resource.

Declaration
public virtual PropertiesResource.GoogleAdsLinksResource GoogleAdsLinks { get; }
Property Value
Type Description
PropertiesResource.GoogleAdsLinksResource

KeyEvents

Gets the KeyEvents resource.

Declaration
public virtual PropertiesResource.KeyEventsResource KeyEvents { get; }
Property Value
Type Description
PropertiesResource.KeyEventsResource

ReportingDataAnnotations

Gets the ReportingDataAnnotations resource.

Declaration
public virtual PropertiesResource.ReportingDataAnnotationsResource ReportingDataAnnotations { get; }
Property Value
Type Description
PropertiesResource.ReportingDataAnnotationsResource

RollupPropertySourceLinks

Gets the RollupPropertySourceLinks resource.

Declaration
public virtual PropertiesResource.RollupPropertySourceLinksResource RollupPropertySourceLinks { get; }
Property Value
Type Description
PropertiesResource.RollupPropertySourceLinksResource

SearchAds360Links

Gets the SearchAds360Links resource.

Declaration
public virtual PropertiesResource.SearchAds360LinksResource SearchAds360Links { get; }
Property Value
Type Description
PropertiesResource.SearchAds360LinksResource

SubpropertyEventFilters

Gets the SubpropertyEventFilters resource.

Declaration
public virtual PropertiesResource.SubpropertyEventFiltersResource SubpropertyEventFilters { get; }
Property Value
Type Description
PropertiesResource.SubpropertyEventFiltersResource

Methods

AcknowledgeUserDataCollection(GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest, string)

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.

Declaration
public virtual PropertiesResource.AcknowledgeUserDataCollectionRequest AcknowledgeUserDataCollection(GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest body, string property)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest body

The body of the request.

string property

Required. The property for which to acknowledge user data collection.

Returns
Type Description
PropertiesResource.AcknowledgeUserDataCollectionRequest

Create(GoogleAnalyticsAdminV1alphaProperty)

Creates a Google Analytics property with the specified location and attributes.

Declaration
public virtual PropertiesResource.CreateRequest Create(GoogleAnalyticsAdminV1alphaProperty body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaProperty body

The body of the request.

Returns
Type Description
PropertiesResource.CreateRequest

CreateConnectedSiteTag(GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest)

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.

Declaration
public virtual PropertiesResource.CreateConnectedSiteTagRequest CreateConnectedSiteTag(GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest body

The body of the request.

Returns
Type Description
PropertiesResource.CreateConnectedSiteTagRequest

CreateRollupProperty(GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest)

Create a roll-up property and all roll-up property source links.

Declaration
public virtual PropertiesResource.CreateRollupPropertyRequest CreateRollupProperty(GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest body

The body of the request.

Returns
Type Description
PropertiesResource.CreateRollupPropertyRequest

Delete(string)

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.

Declaration
public virtual PropertiesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

Returns
Type Description
PropertiesResource.DeleteRequest

DeleteConnectedSiteTag(GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest)

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Declaration
public virtual PropertiesResource.DeleteConnectedSiteTagRequest DeleteConnectedSiteTag(GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest body

The body of the request.

Returns
Type Description
PropertiesResource.DeleteConnectedSiteTagRequest

FetchAutomatedGa4ConfigurationOptOut(GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest)

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Declaration
public virtual PropertiesResource.FetchAutomatedGa4ConfigurationOptOutRequest FetchAutomatedGa4ConfigurationOptOut(GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest body

The body of the request.

Returns
Type Description
PropertiesResource.FetchAutomatedGa4ConfigurationOptOutRequest

FetchConnectedGa4Property()

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

Declaration
public virtual PropertiesResource.FetchConnectedGa4PropertyRequest FetchConnectedGa4Property()
Returns
Type Description
PropertiesResource.FetchConnectedGa4PropertyRequest

Get(string)

Lookup for a single GA Property.

Declaration
public virtual PropertiesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

Returns
Type Description
PropertiesResource.GetRequest

GetAttributionSettings(string)

Lookup for a AttributionSettings singleton.

Declaration
public virtual PropertiesResource.GetAttributionSettingsRequest GetAttributionSettings(string name)
Parameters
Type Name Description
string name

Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings

Returns
Type Description
PropertiesResource.GetAttributionSettingsRequest

GetDataRetentionSettings(string)

Returns the singleton data retention settings for this property.

Declaration
public virtual PropertiesResource.GetDataRetentionSettingsRequest GetDataRetentionSettings(string name)
Parameters
Type Name Description
string name

Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

Returns
Type Description
PropertiesResource.GetDataRetentionSettingsRequest

GetGoogleSignalsSettings(string)

Lookup for Google Signals settings for a property.

Declaration
public virtual PropertiesResource.GetGoogleSignalsSettingsRequest GetGoogleSignalsSettings(string name)
Parameters
Type Name Description
string name

Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

Returns
Type Description
PropertiesResource.GetGoogleSignalsSettingsRequest

List()

Returns child Properties under the specified parent Account. 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.

Declaration
public virtual PropertiesResource.ListRequest List()
Returns
Type Description
PropertiesResource.ListRequest

ListConnectedSiteTags(GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest)

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.

Declaration
public virtual PropertiesResource.ListConnectedSiteTagsRequest ListConnectedSiteTags(GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest body

The body of the request.

Returns
Type Description
PropertiesResource.ListConnectedSiteTagsRequest

Patch(GoogleAnalyticsAdminV1alphaProperty, string)

Updates a property.

Declaration
public virtual PropertiesResource.PatchRequest Patch(GoogleAnalyticsAdminV1alphaProperty body, string name)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaProperty body

The body of the request.

string name

Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"

Returns
Type Description
PropertiesResource.PatchRequest

ProvisionSubproperty(GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest)

Create a subproperty and a subproperty event filter that applies to the created subproperty.

Declaration
public virtual PropertiesResource.ProvisionSubpropertyRequest ProvisionSubproperty(GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest body

The body of the request.

Returns
Type Description
PropertiesResource.ProvisionSubpropertyRequest

RunAccessReport(GoogleAnalyticsAdminV1alphaRunAccessReportRequest, string)

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 GA UI Reporting, GA UI Explorations, GA 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. To give your feedback on this API, complete the Google Analytics Access Reports feedback form.

Declaration
public virtual PropertiesResource.RunAccessReportRequest RunAccessReport(GoogleAnalyticsAdminV1alphaRunAccessReportRequest body, string entity)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaRunAccessReportRequest body

The body of the request.

string entity

The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID.

Returns
Type Description
PropertiesResource.RunAccessReportRequest

SetAutomatedGa4ConfigurationOptOut(GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest)

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Declaration
public virtual PropertiesResource.SetAutomatedGa4ConfigurationOptOutRequest SetAutomatedGa4ConfigurationOptOut(GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest body

The body of the request.

Returns
Type Description
PropertiesResource.SetAutomatedGa4ConfigurationOptOutRequest

UpdateAttributionSettings(GoogleAnalyticsAdminV1alphaAttributionSettings, string)

Updates attribution settings on a property.

Declaration
public virtual PropertiesResource.UpdateAttributionSettingsRequest UpdateAttributionSettings(GoogleAnalyticsAdminV1alphaAttributionSettings body, string name)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaAttributionSettings body

The body of the request.

string name

Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"

Returns
Type Description
PropertiesResource.UpdateAttributionSettingsRequest

UpdateDataRetentionSettings(GoogleAnalyticsAdminV1alphaDataRetentionSettings, string)

Updates the singleton data retention settings for this property.

Declaration
public virtual PropertiesResource.UpdateDataRetentionSettingsRequest UpdateDataRetentionSettings(GoogleAnalyticsAdminV1alphaDataRetentionSettings body, string name)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaDataRetentionSettings body

The body of the request.

string name

Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings

Returns
Type Description
PropertiesResource.UpdateDataRetentionSettingsRequest

UpdateGoogleSignalsSettings(GoogleAnalyticsAdminV1alphaGoogleSignalsSettings, string)

Updates Google Signals settings for a property.

Declaration
public virtual PropertiesResource.UpdateGoogleSignalsSettingsRequest UpdateGoogleSignalsSettings(GoogleAnalyticsAdminV1alphaGoogleSignalsSettings body, string name)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaGoogleSignalsSettings body

The body of the request.

string name

Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"

Returns
Type Description
PropertiesResource.UpdateGoogleSignalsSettingsRequest
In this article
Back to top Generated by DocFX