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.v1beta

Assembly: Google.Apis.GoogleAnalyticsAdmin.v1beta.dll

Syntax

public class PropertiesResource

Constructors

PropertiesResource(IClientService)

Constructs a new resource.

Declaration

public PropertiesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

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

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

Methods

AcknowledgeUserDataCollection(GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest, 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(GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest body, string property)

Parameters

Type	Name	Description
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest	body	The body of the request.
string	property	Required. The property for which to acknowledge user data collection.

Returns

Type	Description
PropertiesResource.AcknowledgeUserDataCollectionRequest

Create(GoogleAnalyticsAdminV1betaProperty)

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

Declaration

public virtual PropertiesResource.CreateRequest Create(GoogleAnalyticsAdminV1betaProperty body)

Parameters

Type	Name	Description
GoogleAnalyticsAdminV1betaProperty	body	The body of the request.

Returns

Type	Description
PropertiesResource.CreateRequest

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

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

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

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

Patch(GoogleAnalyticsAdminV1betaProperty, string)

Updates a property.

Declaration

public virtual PropertiesResource.PatchRequest Patch(GoogleAnalyticsAdminV1betaProperty body, string name)

Parameters

Type	Name	Description
GoogleAnalyticsAdminV1betaProperty	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

RunAccessReport(GoogleAnalyticsAdminV1betaRunAccessReportRequest, 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(GoogleAnalyticsAdminV1betaRunAccessReportRequest body, string entity)

Parameters

Type	Name	Description
GoogleAnalyticsAdminV1betaRunAccessReportRequest	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

UpdateDataRetentionSettings(GoogleAnalyticsAdminV1betaDataRetentionSettings, string)

Updates the singleton data retention settings for this property.

Declaration

public virtual PropertiesResource.UpdateDataRetentionSettingsRequest UpdateDataRetentionSettings(GoogleAnalyticsAdminV1betaDataRetentionSettings body, string name)

Parameters

Type	Name	Description
GoogleAnalyticsAdminV1betaDataRetentionSettings	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