google-api-dotnet-client / Src /Generated /Google.Apis.AnalyticsData.v1beta /Google.Apis.AnalyticsData.v1beta.cs
| // Copyright 2024 Google LLC | |
| // | |
| // Licensed under the Apache License, Version 2.0 (the "License"); | |
| // you may not use this file except in compliance with the License. | |
| // You may obtain a copy of the License at | |
| // | |
| // https://www.apache.org/licenses/LICENSE-2.0 | |
| // | |
| // Unless required by applicable law or agreed to in writing, software | |
| // distributed under the License is distributed on an "AS IS" BASIS, | |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| // See the License for the specific language governing permissions and | |
| // limitations under the License. | |
| // Generated code. DO NOT EDIT! | |
| namespace Google.Apis.AnalyticsData.v1beta | |
| { | |
| /// <summary>The AnalyticsData Service.</summary> | |
| public class AnalyticsDataService : Google.Apis.Services.BaseClientService | |
| { | |
| /// <summary>The API version.</summary> | |
| public const string Version = "v1beta"; | |
| /// <summary>The discovery version used to generate this service.</summary> | |
| public static Google.Apis.Discovery.DiscoveryVersion DiscoveryVersionUsed = Google.Apis.Discovery.DiscoveryVersion.Version_1_0; | |
| /// <summary>Constructs a new service.</summary> | |
| public AnalyticsDataService() : this(new Google.Apis.Services.BaseClientService.Initializer()) | |
| { | |
| } | |
| /// <summary>Constructs a new service.</summary> | |
| /// <param name="initializer">The service initializer.</param> | |
| public AnalyticsDataService(Google.Apis.Services.BaseClientService.Initializer initializer) : base(initializer) | |
| { | |
| Properties = new PropertiesResource(this); | |
| BaseUri = GetEffectiveUri(BaseUriOverride, "https://analyticsdata.googleapis.com/"); | |
| BatchUri = GetEffectiveUri(null, "https://analyticsdata.googleapis.com/batch"); | |
| } | |
| /// <summary>Gets the service supported features.</summary> | |
| public override System.Collections.Generic.IList<string> Features => new string[0]; | |
| /// <summary>Gets the service name.</summary> | |
| public override string Name => "analyticsdata"; | |
| /// <summary>Gets the service base URI.</summary> | |
| public override string BaseUri { get; } | |
| /// <summary>Gets the service base path.</summary> | |
| public override string BasePath => ""; | |
| /// <summary>Gets the batch base URI; <c>null</c> if unspecified.</summary> | |
| public override string BatchUri { get; } | |
| /// <summary>Gets the batch base path; <c>null</c> if unspecified.</summary> | |
| public override string BatchPath => "batch"; | |
| /// <summary>Available OAuth 2.0 scopes for use with the Google Analytics Data API.</summary> | |
| public class Scope | |
| { | |
| /// <summary>View and manage your Google Analytics data</summary> | |
| public static string Analytics = "https://www.googleapis.com/auth/analytics"; | |
| /// <summary>See and download your Google Analytics data</summary> | |
| public static string AnalyticsReadonly = "https://www.googleapis.com/auth/analytics.readonly"; | |
| } | |
| /// <summary>Available OAuth 2.0 scope constants for use with the Google Analytics Data API.</summary> | |
| public static class ScopeConstants | |
| { | |
| /// <summary>View and manage your Google Analytics data</summary> | |
| public const string Analytics = "https://www.googleapis.com/auth/analytics"; | |
| /// <summary>See and download your Google Analytics data</summary> | |
| public const string AnalyticsReadonly = "https://www.googleapis.com/auth/analytics.readonly"; | |
| } | |
| /// <summary>Gets the Properties resource.</summary> | |
| public virtual PropertiesResource Properties { get; } | |
| } | |
| /// <summary>A base abstract class for AnalyticsData requests.</summary> | |
| public abstract class AnalyticsDataBaseServiceRequest<TResponse> : Google.Apis.Requests.ClientServiceRequest<TResponse> | |
| { | |
| /// <summary>Constructs a new AnalyticsDataBaseServiceRequest instance.</summary> | |
| protected AnalyticsDataBaseServiceRequest(Google.Apis.Services.IClientService service) : base(service) | |
| { | |
| } | |
| /// <summary>V1 error format.</summary> | |
| [] | |
| public virtual System.Nullable<XgafvEnum> Xgafv { get; set; } | |
| /// <summary>V1 error format.</summary> | |
| public enum XgafvEnum | |
| { | |
| /// <summary>v1 error format</summary> | |
| [] | |
| Value1 = 0, | |
| /// <summary>v2 error format</summary> | |
| [] | |
| Value2 = 1, | |
| } | |
| /// <summary>OAuth access token.</summary> | |
| [] | |
| public virtual string AccessToken { get; set; } | |
| /// <summary>Data format for response.</summary> | |
| [] | |
| public virtual System.Nullable<AltEnum> Alt { get; set; } | |
| /// <summary>Data format for response.</summary> | |
| public enum AltEnum | |
| { | |
| /// <summary>Responses with Content-Type of application/json</summary> | |
| [] | |
| Json = 0, | |
| /// <summary>Media download with context-dependent Content-Type</summary> | |
| [] | |
| Media = 1, | |
| /// <summary>Responses with Content-Type of application/x-protobuf</summary> | |
| [] | |
| Proto = 2, | |
| } | |
| /// <summary>JSONP</summary> | |
| [] | |
| public virtual string Callback { get; set; } | |
| /// <summary>Selector specifying which fields to include in a partial response.</summary> | |
| [] | |
| public virtual string Fields { get; set; } | |
| /// <summary> | |
| /// API key. Your API key identifies your project and provides you with API access, quota, and reports. Required | |
| /// unless you provide an OAuth 2.0 token. | |
| /// </summary> | |
| [] | |
| public virtual string Key { get; set; } | |
| /// <summary>OAuth 2.0 token for the current user.</summary> | |
| [] | |
| public virtual string OauthToken { get; set; } | |
| /// <summary>Returns response with indentations and line breaks.</summary> | |
| [] | |
| public virtual System.Nullable<bool> PrettyPrint { get; set; } | |
| /// <summary> | |
| /// Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a | |
| /// user, but should not exceed 40 characters. | |
| /// </summary> | |
| [] | |
| public virtual string QuotaUser { get; set; } | |
| /// <summary>Legacy upload protocol for media (e.g. "media", "multipart").</summary> | |
| [] | |
| public virtual string UploadType { get; set; } | |
| /// <summary>Upload protocol for media (e.g. "raw", "multipart").</summary> | |
| [] | |
| public virtual string UploadProtocol { get; set; } | |
| /// <summary>Initializes AnalyticsData parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("$.xgafv", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "$.xgafv", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("access_token", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "access_token", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("alt", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "alt", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = "json", | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("callback", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "callback", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("fields", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "fields", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("key", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "key", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("oauth_token", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "oauth_token", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("prettyPrint", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "prettyPrint", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = "true", | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("quotaUser", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "quotaUser", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("uploadType", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "uploadType", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("upload_protocol", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "upload_protocol", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| } | |
| } | |
| /// <summary>The "properties" collection of methods.</summary> | |
| public class PropertiesResource | |
| { | |
| private const string Resource = "properties"; | |
| /// <summary>The service which this resource belongs to.</summary> | |
| private readonly Google.Apis.Services.IClientService service; | |
| /// <summary>Constructs a new resource.</summary> | |
| public PropertiesResource(Google.Apis.Services.IClientService service) | |
| { | |
| this.service = service; | |
| AudienceExports = new AudienceExportsResource(service); | |
| } | |
| /// <summary>Gets the AudienceExports resource.</summary> | |
| public virtual AudienceExportsResource AudienceExports { get; } | |
| /// <summary>The "audienceExports" collection of methods.</summary> | |
| public class AudienceExportsResource | |
| { | |
| private const string Resource = "audienceExports"; | |
| /// <summary>The service which this resource belongs to.</summary> | |
| private readonly Google.Apis.Services.IClientService service; | |
| /// <summary>Constructs a new resource.</summary> | |
| public AudienceExportsResource(Google.Apis.Services.IClientService service) | |
| { | |
| this.service = service; | |
| } | |
| /// <summary> | |
| /// Creates an audience export for later retrieval. This method quickly returns the audience export's | |
| /// resource name and initiates a long running asynchronous request to form an audience export. To export | |
| /// the users in an audience export, first create the audience export through this method and then send the | |
| /// audience resource name to the `QueryAudienceExport` method. See [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. An audience export is a snapshot of the users currently | |
| /// in the audience at the time of audience export creation. Creating audience exports for one audience on | |
| /// different days will return different results as users enter and exit the audience. Audiences in Google | |
| /// Analytics 4 allow you to segment your users in the ways that are important to your business. To learn | |
| /// more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in | |
| /// each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The | |
| /// intention is to advance methods to beta stability after some feedback and adoption. To give your | |
| /// feedback on this API, complete the [Google Analytics Audience Export API | |
| /// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="parent"> | |
| /// Required. The parent resource where this audience export will be created. Format: | |
| /// `properties/{property}` | |
| /// </param> | |
| public virtual CreateRequest Create(Google.Apis.AnalyticsData.v1beta.Data.AudienceExport body, string parent) | |
| { | |
| return new CreateRequest(this.service, body, parent); | |
| } | |
| /// <summary> | |
| /// Creates an audience export for later retrieval. This method quickly returns the audience export's | |
| /// resource name and initiates a long running asynchronous request to form an audience export. To export | |
| /// the users in an audience export, first create the audience export through this method and then send the | |
| /// audience resource name to the `QueryAudienceExport` method. See [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. An audience export is a snapshot of the users currently | |
| /// in the audience at the time of audience export creation. Creating audience exports for one audience on | |
| /// different days will return different results as users enter and exit the audience. Audiences in Google | |
| /// Analytics 4 allow you to segment your users in the ways that are important to your business. To learn | |
| /// more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in | |
| /// each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The | |
| /// intention is to advance methods to beta stability after some feedback and adoption. To give your | |
| /// feedback on this API, complete the [Google Analytics Audience Export API | |
| /// Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| public class CreateRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.Operation> | |
| { | |
| /// <summary>Constructs a new Create request.</summary> | |
| public CreateRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.AudienceExport body, string parent) : base(service) | |
| { | |
| Parent = parent; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// Required. The parent resource where this audience export will be created. Format: | |
| /// `properties/{property}` | |
| /// </summary> | |
| [] | |
| public virtual string Parent { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.AudienceExport Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "create"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+parent}/audienceExports"; | |
| /// <summary>Initializes Create parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "parent", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Gets configuration metadata about a specific audience export. This method can be used to understand an | |
| /// audience export after it has been created. See [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and | |
| /// other methods at beta stability. The intention is to advance methods to beta stability after some | |
| /// feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export | |
| /// API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| /// <param name="name"> | |
| /// Required. The audience export resource name. Format: | |
| /// `properties/{property}/audienceExports/{audience_export}` | |
| /// </param> | |
| public virtual GetRequest Get(string name) | |
| { | |
| return new GetRequest(this.service, name); | |
| } | |
| /// <summary> | |
| /// Gets configuration metadata about a specific audience export. This method can be used to understand an | |
| /// audience export after it has been created. See [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and | |
| /// other methods at beta stability. The intention is to advance methods to beta stability after some | |
| /// feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export | |
| /// API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| public class GetRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.AudienceExport> | |
| { | |
| /// <summary>Constructs a new Get request.</summary> | |
| public GetRequest(Google.Apis.Services.IClientService service, string name) : base(service) | |
| { | |
| Name = name; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// Required. The audience export resource name. Format: | |
| /// `properties/{property}/audienceExports/{audience_export}` | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; private set; } | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "get"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "GET"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+name}"; | |
| /// <summary>Initializes Get parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("name", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "name", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+/audienceExports/[^/]+$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Lists all audience exports for a property. This method can be used for you to find and reuse existing | |
| /// audience exports rather than creating unnecessary new audience exports. The same audience can have | |
| /// multiple audience exports that represent the export of users that were in an audience on different days. | |
| /// See [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and | |
| /// other methods at beta stability. The intention is to advance methods to beta stability after some | |
| /// feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export | |
| /// API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| /// <param name="parent"> | |
| /// Required. All audience exports for this property will be listed in the response. Format: | |
| /// `properties/{property}` | |
| /// </param> | |
| public virtual ListRequest List(string parent) | |
| { | |
| return new ListRequest(this.service, parent); | |
| } | |
| /// <summary> | |
| /// Lists all audience exports for a property. This method can be used for you to find and reuse existing | |
| /// audience exports rather than creating unnecessary new audience exports. The same audience can have | |
| /// multiple audience exports that represent the export of users that were in an audience on different days. | |
| /// See [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and | |
| /// other methods at beta stability. The intention is to advance methods to beta stability after some | |
| /// feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export | |
| /// API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| public class ListRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.ListAudienceExportsResponse> | |
| { | |
| /// <summary>Constructs a new List request.</summary> | |
| public ListRequest(Google.Apis.Services.IClientService service, string parent) : base(service) | |
| { | |
| Parent = parent; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// Required. All audience exports for this property will be listed in the response. Format: | |
| /// `properties/{property}` | |
| /// </summary> | |
| [] | |
| public virtual string Parent { get; private set; } | |
| /// <summary> | |
| /// Optional. The maximum number of audience exports to return. The service may return fewer than this | |
| /// value. If unspecified, at most 200 audience exports will be returned. The maximum value is 1000 | |
| /// (higher values will be coerced to the maximum). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> PageSize { get; set; } | |
| /// <summary> | |
| /// Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to | |
| /// retrieve the subsequent page. When paginating, all other parameters provided to | |
| /// `ListAudienceExports` must match the call that provided the page token. | |
| /// </summary> | |
| [] | |
| public virtual string PageToken { get; set; } | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "list"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "GET"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+parent}/audienceExports"; | |
| /// <summary>Initializes List parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("parent", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "parent", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| RequestParameters.Add("pageSize", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "pageSize", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| RequestParameters.Add("pageToken", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "pageToken", | |
| IsRequired = false, | |
| ParameterType = "query", | |
| DefaultValue = null, | |
| Pattern = null, | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Retrieves an audience export of users. After creating an audience, the users are not immediately | |
| /// available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience | |
| /// export of users, and then second, this method is used to retrieve the users in the audience export. See | |
| /// [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment | |
| /// your users in the ways that are important to your business. To learn more, see | |
| /// https://support.google.com/analytics/answer/9267572. Audience Export APIs have some methods at alpha and | |
| /// other methods at beta stability. The intention is to advance methods to beta stability after some | |
| /// feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export | |
| /// API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="name"> | |
| /// Required. The name of the audience export to retrieve users from. Format: | |
| /// `properties/{property}/audienceExports/{audience_export}` | |
| /// </param> | |
| public virtual QueryRequest Query(Google.Apis.AnalyticsData.v1beta.Data.QueryAudienceExportRequest body, string name) | |
| { | |
| return new QueryRequest(this.service, body, name); | |
| } | |
| /// <summary> | |
| /// Retrieves an audience export of users. After creating an audience, the users are not immediately | |
| /// available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience | |
| /// export of users, and then second, this method is used to retrieve the users in the audience export. See | |
| /// [Creating an Audience | |
| /// Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an | |
| /// introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment | |
| /// your users in the ways that are important to your business. To learn more, see | |
| /// https://support.google.com/analytics/answer/9267572. Audience Export APIs have some methods at alpha and | |
| /// other methods at beta stability. The intention is to advance methods to beta stability after some | |
| /// feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export | |
| /// API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. | |
| /// </summary> | |
| public class QueryRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.QueryAudienceExportResponse> | |
| { | |
| /// <summary>Constructs a new Query request.</summary> | |
| public QueryRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.QueryAudienceExportRequest body, string name) : base(service) | |
| { | |
| Name = name; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// Required. The name of the audience export to retrieve users from. Format: | |
| /// `properties/{property}/audienceExports/{audience_export}` | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.QueryAudienceExportRequest Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "query"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+name}:query"; | |
| /// <summary>Initializes Query parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("name", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "name", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+/audienceExports/[^/]+$", | |
| }); | |
| } | |
| } | |
| } | |
| /// <summary> | |
| /// Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property. | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="property"> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. | |
| /// To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be | |
| /// specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent | |
| /// with this property. Example: properties/1234 | |
| /// </param> | |
| public virtual BatchRunPivotReportsRequest BatchRunPivotReports(Google.Apis.AnalyticsData.v1beta.Data.BatchRunPivotReportsRequest body, string property) | |
| { | |
| return new BatchRunPivotReportsRequest(this.service, body, property); | |
| } | |
| /// <summary> | |
| /// Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property. | |
| /// </summary> | |
| public class BatchRunPivotReportsRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.BatchRunPivotReportsResponse> | |
| { | |
| /// <summary>Constructs a new BatchRunPivotReports request.</summary> | |
| public BatchRunPivotReportsRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.BatchRunPivotReportsRequest body, string property) : base(service) | |
| { | |
| Property = property; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the | |
| /// body. To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must | |
| /// be specified for the batch. The property within RunPivotReportRequest may either be unspecified or | |
| /// consistent with this property. Example: properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.BatchRunPivotReportsRequest Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "batchRunPivotReports"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+property}:batchRunPivotReports"; | |
| /// <summary>Initializes BatchRunPivotReports parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("property", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "property", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Returns multiple reports in a batch. All reports must be for the same Google Analytics property. | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="property"> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. | |
| /// To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be | |
| /// specified for the batch. The property within RunReportRequest may either be unspecified or consistent with | |
| /// this property. Example: properties/1234 | |
| /// </param> | |
| public virtual BatchRunReportsRequest BatchRunReports(Google.Apis.AnalyticsData.v1beta.Data.BatchRunReportsRequest body, string property) | |
| { | |
| return new BatchRunReportsRequest(this.service, body, property); | |
| } | |
| /// <summary> | |
| /// Returns multiple reports in a batch. All reports must be for the same Google Analytics property. | |
| /// </summary> | |
| public class BatchRunReportsRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.BatchRunReportsResponse> | |
| { | |
| /// <summary>Constructs a new BatchRunReports request.</summary> | |
| public BatchRunReportsRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.BatchRunReportsRequest body, string property) : base(service) | |
| { | |
| Property = property; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the | |
| /// body. To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must | |
| /// be specified for the batch. The property within RunReportRequest may either be unspecified or consistent | |
| /// with this property. Example: properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.BatchRunReportsRequest Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "batchRunReports"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+property}:batchRunReports"; | |
| /// <summary>Initializes BatchRunReports parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("property", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "property", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// This compatibility method lists dimensions and metrics that can be added to a report request and maintain | |
| /// compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google | |
| /// Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need | |
| /// to remove dimensions and/or metrics from the incompatible report until the report is compatible. The | |
| /// Realtime and Core reports have different compatibility rules. This method checks compatibility for Core | |
| /// reports. | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="property"> | |
| /// A Google Analytics property identifier whose events are tracked. To learn more, see [where to find your | |
| /// Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` | |
| /// should be the same value as in your `runReport` request. Example: properties/1234 | |
| /// </param> | |
| public virtual CheckCompatibilityRequest CheckCompatibility(Google.Apis.AnalyticsData.v1beta.Data.CheckCompatibilityRequest body, string property) | |
| { | |
| return new CheckCompatibilityRequest(this.service, body, property); | |
| } | |
| /// <summary> | |
| /// This compatibility method lists dimensions and metrics that can be added to a report request and maintain | |
| /// compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google | |
| /// Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need | |
| /// to remove dimensions and/or metrics from the incompatible report until the report is compatible. The | |
| /// Realtime and Core reports have different compatibility rules. This method checks compatibility for Core | |
| /// reports. | |
| /// </summary> | |
| public class CheckCompatibilityRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.CheckCompatibilityResponse> | |
| { | |
| /// <summary>Constructs a new CheckCompatibility request.</summary> | |
| public CheckCompatibilityRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.CheckCompatibilityRequest body, string property) : base(service) | |
| { | |
| Property = property; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. To learn more, see [where to find your | |
| /// Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). | |
| /// `property` should be the same value as in your `runReport` request. Example: properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.CheckCompatibilityRequest Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "checkCompatibility"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+property}:checkCompatibility"; | |
| /// <summary>Initializes CheckCompatibility parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("property", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "property", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions | |
| /// and metrics. In this method, a Google Analytics property identifier is specified in the request, and the | |
| /// metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a | |
| /// custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will | |
| /// contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any | |
| /// property such as `country` and `totalUsers`. | |
| /// </summary> | |
| /// <param name="name"> | |
| /// Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and | |
| /// not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see [where to | |
| /// find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). | |
| /// Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all | |
| /// properties. In this special mode, this method will not return custom dimensions and metrics. | |
| /// </param> | |
| public virtual GetMetadataRequest GetMetadata(string name) | |
| { | |
| return new GetMetadataRequest(this.service, name); | |
| } | |
| /// <summary> | |
| /// Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions | |
| /// and metrics. In this method, a Google Analytics property identifier is specified in the request, and the | |
| /// metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a | |
| /// custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will | |
| /// contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any | |
| /// property such as `country` and `totalUsers`. | |
| /// </summary> | |
| public class GetMetadataRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.Metadata> | |
| { | |
| /// <summary>Constructs a new GetMetadata request.</summary> | |
| public GetMetadataRequest(Google.Apis.Services.IClientService service, string name) : base(service) | |
| { | |
| Name = name; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// Required. The resource name of the metadata to retrieve. This name field is specified in the URL path | |
| /// and not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see | |
| /// [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: | |
| /// properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. | |
| /// In this special mode, this method will not return custom dimensions and metrics. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; private set; } | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "getMetadata"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "GET"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+name}"; | |
| /// <summary>Initializes GetMetadata parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("name", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "name", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+/metadata$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and | |
| /// expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included | |
| /// in a pivot. Multiple pivots can be specified to further dissect your data. | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="property"> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. | |
| /// To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch | |
| /// request, this property should either be unspecified or consistent with the batch-level property. Example: | |
| /// properties/1234 | |
| /// </param> | |
| public virtual RunPivotReportRequest RunPivotReport(Google.Apis.AnalyticsData.v1beta.Data.RunPivotReportRequest body, string property) | |
| { | |
| return new RunPivotReportRequest(this.service, body, property); | |
| } | |
| /// <summary> | |
| /// Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and | |
| /// expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included | |
| /// in a pivot. Multiple pivots can be specified to further dissect your data. | |
| /// </summary> | |
| public class RunPivotReportRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.RunPivotReportResponse> | |
| { | |
| /// <summary>Constructs a new RunPivotReport request.</summary> | |
| public RunPivotReportRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.RunPivotReportRequest body, string property) : base(service) | |
| { | |
| Property = property; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the | |
| /// body. To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch | |
| /// request, this property should either be unspecified or consistent with the batch-level property. | |
| /// Example: properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.RunPivotReportRequest Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "runPivotReport"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+property}:runPivotReport"; | |
| /// <summary>Initializes RunPivotReport parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("property", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "property", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Returns a customized report of realtime event data for your property. Events appear in realtime reports | |
| /// seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for | |
| /// the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics | |
| /// 360 properties). For a guide to constructing realtime requests &amp; understanding responses, see | |
| /// [Creating a Realtime | |
| /// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="property"> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. | |
| /// To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: | |
| /// properties/1234 | |
| /// </param> | |
| public virtual RunRealtimeReportRequest RunRealtimeReport(Google.Apis.AnalyticsData.v1beta.Data.RunRealtimeReportRequest body, string property) | |
| { | |
| return new RunRealtimeReportRequest(this.service, body, property); | |
| } | |
| /// <summary> | |
| /// Returns a customized report of realtime event data for your property. Events appear in realtime reports | |
| /// seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for | |
| /// the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics | |
| /// 360 properties). For a guide to constructing realtime requests &amp; understanding responses, see | |
| /// [Creating a Realtime | |
| /// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). | |
| /// </summary> | |
| public class RunRealtimeReportRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.RunRealtimeReportResponse> | |
| { | |
| /// <summary>Constructs a new RunRealtimeReport request.</summary> | |
| public RunRealtimeReportRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.RunRealtimeReportRequest body, string property) : base(service) | |
| { | |
| Property = property; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the | |
| /// body. To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: | |
| /// properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.RunRealtimeReportRequest Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "runRealtimeReport"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+property}:runRealtimeReport"; | |
| /// <summary>Initializes RunRealtimeReport parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("property", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "property", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| } | |
| } | |
| /// <summary> | |
| /// Returns a customized report of your Google Analytics event data. Reports contain statistics derived from | |
| /// data collected by the Google Analytics tracking code. The data returned from the API is as a table with | |
| /// columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on | |
| /// your property, such as active users or event count. Dimensions break down metrics across some common | |
| /// criteria, such as country or event name. For a guide to constructing requests &amp; understanding | |
| /// responses, see [Creating a | |
| /// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). | |
| /// </summary> | |
| /// <param name="body">The body of the request.</param> | |
| /// <param name="property"> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. | |
| /// To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch | |
| /// request, this property should either be unspecified or consistent with the batch-level property. Example: | |
| /// properties/1234 | |
| /// </param> | |
| public virtual RunReportRequest RunReport(Google.Apis.AnalyticsData.v1beta.Data.RunReportRequest body, string property) | |
| { | |
| return new RunReportRequest(this.service, body, property); | |
| } | |
| /// <summary> | |
| /// Returns a customized report of your Google Analytics event data. Reports contain statistics derived from | |
| /// data collected by the Google Analytics tracking code. The data returned from the API is as a table with | |
| /// columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on | |
| /// your property, such as active users or event count. Dimensions break down metrics across some common | |
| /// criteria, such as country or event name. For a guide to constructing requests &amp; understanding | |
| /// responses, see [Creating a | |
| /// Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). | |
| /// </summary> | |
| public class RunReportRequest : AnalyticsDataBaseServiceRequest<Google.Apis.AnalyticsData.v1beta.Data.RunReportResponse> | |
| { | |
| /// <summary>Constructs a new RunReport request.</summary> | |
| public RunReportRequest(Google.Apis.Services.IClientService service, Google.Apis.AnalyticsData.v1beta.Data.RunReportRequest body, string property) : base(service) | |
| { | |
| Property = property; | |
| Body = body; | |
| InitParameters(); | |
| } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the | |
| /// body. To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch | |
| /// request, this property should either be unspecified or consistent with the batch-level property. | |
| /// Example: properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; private set; } | |
| /// <summary>Gets or sets the body of this request.</summary> | |
| Google.Apis.AnalyticsData.v1beta.Data.RunReportRequest Body { get; set; } | |
| /// <summary>Returns the body of the request.</summary> | |
| protected override object GetBody() => Body; | |
| /// <summary>Gets the method name.</summary> | |
| public override string MethodName => "runReport"; | |
| /// <summary>Gets the HTTP method.</summary> | |
| public override string HttpMethod => "POST"; | |
| /// <summary>Gets the REST path.</summary> | |
| public override string RestPath => "v1beta/{+property}:runReport"; | |
| /// <summary>Initializes RunReport parameter list.</summary> | |
| protected override void InitParameters() | |
| { | |
| base.InitParameters(); | |
| RequestParameters.Add("property", new Google.Apis.Discovery.Parameter | |
| { | |
| Name = "property", | |
| IsRequired = true, | |
| ParameterType = "path", | |
| DefaultValue = null, | |
| Pattern = @"^properties/[^/]+$", | |
| }); | |
| } | |
| } | |
| } | |
| } | |
| namespace Google.Apis.AnalyticsData.v1beta.Data | |
| { | |
| /// <summary>A metric actively restricted in creating the report.</summary> | |
| public class ActiveMetricRestriction : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The name of the restricted metric.</summary> | |
| [] | |
| public virtual string MetricName { get; set; } | |
| /// <summary>The reason for this metric's restriction.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> RestrictedMetricTypes { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// An audience export is a list of users in an audience at the time of the list's creation. One audience may have | |
| /// multiple audience exports created for different days. | |
| /// </summary> | |
| public class AudienceExport : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Required. The audience resource name. This resource name identifies the audience being listed and is shared | |
| /// between the Analytics Data &amp; Admin APIs. Format: `properties/{property}/audiences/{audience}` | |
| /// </summary> | |
| [] | |
| public virtual string Audience { get; set; } | |
| /// <summary>Output only. The descriptive display name for this audience. For example, "Purchasers".</summary> | |
| [] | |
| public virtual string AudienceDisplayName { get; set; } | |
| private string _beginCreatingTimeRaw; | |
| private object _beginCreatingTime; | |
| /// <summary> | |
| /// Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` | |
| /// state. | |
| /// </summary> | |
| [] | |
| public virtual string BeginCreatingTimeRaw | |
| { | |
| get => _beginCreatingTimeRaw; | |
| set | |
| { | |
| _beginCreatingTime = Google.Apis.Util.Utilities.DeserializeForGoogleFormat(value); | |
| _beginCreatingTimeRaw = value; | |
| } | |
| } | |
| /// <summary><seealso cref="object"/> representation of <see cref="BeginCreatingTimeRaw"/>.</summary> | |
| [] | |
| [] | |
| public virtual object BeginCreatingTime | |
| { | |
| get => _beginCreatingTime; | |
| set | |
| { | |
| _beginCreatingTimeRaw = Google.Apis.Util.Utilities.SerializeForGoogleFormat(value); | |
| _beginCreatingTime = value; | |
| } | |
| } | |
| /// <summary> | |
| /// <seealso cref="System.DateTimeOffset"/> representation of <see cref="BeginCreatingTimeRaw"/>. | |
| /// </summary> | |
| [] | |
| public virtual System.DateTimeOffset? BeginCreatingTimeDateTimeOffset | |
| { | |
| get => Google.Apis.Util.DiscoveryFormat.ParseGoogleDateTimeToDateTimeOffset(BeginCreatingTimeRaw); | |
| set => BeginCreatingTimeRaw = Google.Apis.Util.DiscoveryFormat.FormatDateTimeOffsetToGoogleDateTime(value); | |
| } | |
| /// <summary> | |
| /// Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count | |
| /// is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport | |
| /// enters the `ACTIVE` or `FAILED` states. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> CreationQuotaTokensCharged { get; set; } | |
| /// <summary>Required. The dimensions requested and displayed in the query response.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<V1betaAudienceDimension> Dimensions { get; set; } | |
| /// <summary> | |
| /// Output only. Error message is populated when an audience export fails during creation. A common reason for | |
| /// such a failure is quota exhaustion. | |
| /// </summary> | |
| [] | |
| public virtual string ErrorMessage { get; set; } | |
| /// <summary> | |
| /// Output only. Identifier. The audience export resource name assigned during creation. This resource name | |
| /// identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}` | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>Output only. The percentage completed for this audience export ranging between 0 to 100.</summary> | |
| [] | |
| public virtual System.Nullable<double> PercentageCompleted { get; set; } | |
| /// <summary>Output only. The total number of rows in the AudienceExport result.</summary> | |
| [] | |
| public virtual System.Nullable<int> RowCount { get; set; } | |
| /// <summary>Output only. The current state for this AudienceExport.</summary> | |
| [] | |
| public virtual string State { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>This metadata is currently blank.</summary> | |
| public class AudienceListMetadata : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The batch request containing multiple pivot report requests.</summary> | |
| public class BatchRunPivotReportsRequest : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to | |
| /// 5 requests. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<RunPivotReportRequest> Requests { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The batch response containing multiple pivot reports.</summary> | |
| public class BatchRunPivotReportsResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Identifies what kind of resource this message is. This `kind` is always the fixed string | |
| /// "analyticsData#batchRunPivotReports". Useful to distinguish between response types in JSON. | |
| /// </summary> | |
| [] | |
| public virtual string Kind { get; set; } | |
| /// <summary>Individual responses. Each response has a separate pivot report request.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<RunPivotReportResponse> PivotReports { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The batch request containing multiple report requests.</summary> | |
| public class BatchRunReportsRequest : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 | |
| /// requests. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<RunReportRequest> Requests { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The batch response containing multiple reports.</summary> | |
| public class BatchRunReportsResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Identifies what kind of resource this message is. This `kind` is always the fixed string | |
| /// "analyticsData#batchRunReports". Useful to distinguish between response types in JSON. | |
| /// </summary> | |
| [] | |
| public virtual string Kind { get; set; } | |
| /// <summary>Individual responses. Each response has a separate report request.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<RunReportResponse> Reports { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>To express that the result needs to be between two numbers (inclusive).</summary> | |
| public class BetweenFilter : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Begins with this number.</summary> | |
| [] | |
| public virtual NumericValue FromValue { get; set; } | |
| /// <summary>Ends with this number.</summary> | |
| [] | |
| public virtual NumericValue ToValue { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Used to convert a dimension value to a single case.</summary> | |
| public class CaseExpression : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Name of a dimension. The name must refer back to a name in dimensions field of the request. | |
| /// </summary> | |
| [] | |
| public virtual string DimensionName { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a | |
| /// preview of the compatibility of a report; fields shared with the `runReport` request should be the same values | |
| /// as in your `runReport` request. | |
| /// </summary> | |
| public class CheckCompatibilityRequest : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Filters the dimensions and metrics in the response to just this compatibility. Commonly used as | |
| /// `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions &amp; metrics. | |
| /// </summary> | |
| [] | |
| public virtual string CompatibilityFilter { get; set; } | |
| /// <summary> | |
| /// The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request. | |
| /// </summary> | |
| [] | |
| public virtual FilterExpression DimensionFilter { get; set; } | |
| /// <summary> | |
| /// The dimensions in this report. `dimensions` should be the same value as in your `runReport` request. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Dimension> Dimensions { get; set; } | |
| /// <summary> | |
| /// The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request | |
| /// </summary> | |
| [] | |
| public virtual FilterExpression MetricFilter { get; set; } | |
| /// <summary> | |
| /// The metrics in this report. `metrics` should be the same value as in your `runReport` request. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Metric> Metrics { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The compatibility response with the compatibility of each dimension & metric.</summary> | |
| public class CheckCompatibilityResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The compatibility of each dimension.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DimensionCompatibility> DimensionCompatibilities { get; set; } | |
| /// <summary>The compatibility of each metric.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<MetricCompatibility> MetricCompatibilities { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For | |
| /// example, users with the same `firstSessionDate` belong to the same cohort. | |
| /// </summary> | |
| public class Cohort : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The cohort selects users whose first touch date is between start date and end date defined in the | |
| /// `dateRange`. This `dateRange` does not specify the full date range of event data that is present in a cohort | |
| /// report. In a cohort report, this `dateRange` is extended by the granularity and offset present in the | |
| /// `cohortsRange`; event data for the extended reporting date range is present in a cohort report. In a cohort | |
| /// request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or | |
| /// `RunPivotReportRequest` must be unspecified. This `dateRange` should generally be aligned with the cohort's | |
| /// granularity. If `CohortsRange` uses daily granularity, this `dateRange` can be a single day. If | |
| /// `CohortsRange` uses weekly granularity, this `dateRange` can be aligned to a week boundary, starting at | |
| /// Sunday and ending Saturday. If `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to a | |
| /// month, starting at the first and ending on the last day of the month. | |
| /// </summary> | |
| [] | |
| public virtual DateRange DateRange { get; set; } | |
| /// <summary>Dimension used by the cohort. Required and only supports `firstSessionDate`.</summary> | |
| [] | |
| public virtual string Dimension { get; set; } | |
| /// <summary> | |
| /// Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, | |
| /// cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index | |
| /// `cohort_0`, `cohort_1`, etc. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Optional settings of a cohort report.</summary> | |
| public class CohortReportSettings : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// If true, accumulates the result from first touch day to the end day. Not supported in `RunReportRequest`. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> Accumulate { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the | |
| /// cohort. For example, you could select the cohort of users that were acquired in the first week of September and | |
| /// follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is | |
| /// specified in the `cohort` object. Following that cohort for the next six weeks is specified in the | |
| /// `cohortsRange` object. For examples, see [Cohort Report | |
| /// Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). | |
| /// The report response could show a weekly time series where say your app has retained 60% of this cohort after | |
| /// three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric | |
| /// `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report. | |
| /// </summary> | |
| public class CohortSpec : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Optional settings for a cohort report.</summary> | |
| [] | |
| public virtual CohortReportSettings CohortReportSettings { get; set; } | |
| /// <summary> | |
| /// Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. | |
| /// If multiple cohorts are specified, each cohort can be recognized in the report by their name. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Cohort> Cohorts { get; set; } | |
| /// <summary> | |
| /// Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration | |
| /// to follow the cohorts over. | |
| /// </summary> | |
| [] | |
| public virtual CohortsRange CohortsRange { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the | |
| /// cohorts over. | |
| /// </summary> | |
| public class CohortsRange : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Required. `endOffset` specifies the end date of the extended reporting date range for a cohort report. | |
| /// `endOffset` can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the | |
| /// cohort for the next several granularity time periods. If `granularity` is `DAILY`, the `endDate` of the | |
| /// extended reporting date range is `endDate` of the cohort plus `endOffset` days. If `granularity` is | |
| /// `WEEKLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 7` | |
| /// days. If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the | |
| /// cohort plus `endOffset * 30` days. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> EndOffset { get; set; } | |
| /// <summary> | |
| /// Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting | |
| /// date range for a cohort report. | |
| /// </summary> | |
| [] | |
| public virtual string Granularity { get; set; } | |
| /// <summary> | |
| /// `startOffset` specifies the start date of the extended reporting date range for a cohort report. | |
| /// `startOffset` is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. | |
| /// If `granularity` is `DAILY`, the `startDate` of the extended reporting date range is `startDate` of the | |
| /// cohort plus `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of the extended reporting date | |
| /// range is `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is `MONTHLY`, the | |
| /// `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> StartOffset { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Defines an individual comparison. Most requests will include multiple comparisons so that the report compares | |
| /// between the comparisons. | |
| /// </summary> | |
| public class Comparison : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// A saved comparison identified by the comparison's resource name. For example, 'comparisons/1234'. | |
| /// </summary> | |
| [] | |
| public virtual string ComparisonValue { get; set; } | |
| /// <summary>A basic comparison.</summary> | |
| [] | |
| public virtual FilterExpression DimensionFilter { get; set; } | |
| /// <summary> | |
| /// Each comparison produces separate rows in the response. In the response, this comparison is identified by | |
| /// this name. If name is unspecified, we will use the saved comparisons display name. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The metadata for a single comparison.</summary> | |
| public class ComparisonMetadata : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// This comparison's resource name. Useable in [Comparison](#Comparison)'s `comparison` field. For example, | |
| /// 'comparisons/1234'. | |
| /// </summary> | |
| [] | |
| public virtual string ApiName { get; set; } | |
| /// <summary>This comparison's description.</summary> | |
| [] | |
| public virtual string Description { get; set; } | |
| /// <summary>This comparison's name within the Google Analytics user interface.</summary> | |
| [] | |
| public virtual string UiName { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Used to combine dimension values to a single dimension.</summary> | |
| public class ConcatenateExpression : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but | |
| /// can be longer strings. If a dimension value contains the delimiter, both will be present in response with no | |
| /// distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then | |
| /// the response will contain "US,FR,JP". | |
| /// </summary> | |
| [] | |
| public virtual string Delimiter { get; set; } | |
| /// <summary> | |
| /// Names of dimensions. The names must refer back to names in the dimensions field of the request. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> DimensionNames { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`. Requests are allowed up to 4 date | |
| /// ranges. | |
| /// </summary> | |
| public class DateRange : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format | |
| /// `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the | |
| /// property's reporting time zone. | |
| /// </summary> | |
| [] | |
| public virtual string EndDate { get; set; } | |
| /// <summary> | |
| /// Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If | |
| /// set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based | |
| /// index in the request: `date_range_0`, `date_range_1`, etc. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary> | |
| /// The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format | |
| /// `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the | |
| /// property's reporting time zone. | |
| /// </summary> | |
| [] | |
| public virtual string StartDate { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event | |
| /// originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New | |
| /// York". Requests are allowed up to 9 dimensions. | |
| /// </summary> | |
| public class Dimension : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, | |
| /// city": concatenate(country, ", ", city). | |
| /// </summary> | |
| [] | |
| public virtual DimensionExpression DimensionExpression { get; set; } | |
| /// <summary> | |
| /// The name of the dimension. See the [API | |
| /// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for | |
| /// the list of dimension names supported by core reporting methods such as `runReport` and `batchRunReports`. | |
| /// See [Realtime | |
| /// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions) | |
| /// for the list of dimension names supported by the `runRealtimeReport` method. See [Funnel | |
| /// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions) | |
| /// for the list of dimension names supported by the `runFunnelReport` method. If `dimensionExpression` is | |
| /// specified, `name` can be any string that you would like within the allowed character set. For example if a | |
| /// `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. | |
| /// Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are | |
| /// referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The compatibility for a single dimension.</summary> | |
| public class DimensionCompatibility : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully | |
| /// added to the report. | |
| /// </summary> | |
| [] | |
| public virtual string Compatibility { get; set; } | |
| /// <summary> | |
| /// The dimension metadata contains the API name for this compatibility information. The dimension metadata also | |
| /// contains other helpful information like the UI name and description. | |
| /// </summary> | |
| [] | |
| public virtual DimensionMetadata DimensionMetadata { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) | |
| /// lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). | |
| /// </summary> | |
| public class DimensionExpression : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Used to combine dimension values to a single dimension. For example, dimension "country, city": | |
| /// concatenate(country, ", ", city). | |
| /// </summary> | |
| [] | |
| public virtual ConcatenateExpression Concatenate { get; set; } | |
| /// <summary>Used to convert a dimension value to lower case.</summary> | |
| [] | |
| public virtual CaseExpression LowerCase { get; set; } | |
| /// <summary>Used to convert a dimension value to upper case.</summary> | |
| [] | |
| public virtual CaseExpression UpperCase { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows | |
| /// and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns | |
| /// in a report; correspondingly, those dimensions do not produce headers. | |
| /// </summary> | |
| public class DimensionHeader : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The dimension's name.</summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Explains a dimension.</summary> | |
| public class DimensionMetadata : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`. | |
| /// </summary> | |
| [] | |
| public virtual string ApiName { get; set; } | |
| /// <summary> | |
| /// The display name of the category that this dimension belongs to. Similar dimensions and metrics are | |
| /// categorized together. | |
| /// </summary> | |
| [] | |
| public virtual string Category { get; set; } | |
| /// <summary> | |
| /// True if the dimension is custom to this property. This includes user, event, &amp; item scoped custom | |
| /// dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. | |
| /// This also include custom channel groups; to learn more about custom channel groups, see | |
| /// https://support.google.com/analytics/answer/13051316. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> CustomDefinition { get; set; } | |
| /// <summary> | |
| /// Still usable but deprecated names for this dimension. If populated, this dimension is available by either | |
| /// `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension | |
| /// will be available only by `apiName`. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> DeprecatedApiNames { get; set; } | |
| /// <summary>Description of how this dimension is used and calculated.</summary> | |
| [] | |
| public virtual string Description { get; set; } | |
| /// <summary> | |
| /// This dimension's name within the Google Analytics user interface. For example, `Event name`. | |
| /// </summary> | |
| [] | |
| public virtual string UiName { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Sorts by dimension values.</summary> | |
| public class DimensionOrderBy : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>A dimension name in the request to order by.</summary> | |
| [] | |
| public virtual string DimensionName { get; set; } | |
| /// <summary>Controls the rule for dimension value ordering.</summary> | |
| [] | |
| public virtual string OrderType { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The value of a dimension.</summary> | |
| public class DimensionValue : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Value as a string if the dimension type is a string.</summary> | |
| [] | |
| public virtual string Value { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Filter for empty values.</summary> | |
| public class EmptyFilter : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>An expression to filter dimension or metric values.</summary> | |
| public class Filter : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>A filter for two values.</summary> | |
| [] | |
| public virtual BetweenFilter BetweenFilter { get; set; } | |
| /// <summary>A filter for empty values such as "(not set)" and "" values.</summary> | |
| [] | |
| public virtual EmptyFilter EmptyFilter { get; set; } | |
| /// <summary> | |
| /// The dimension name or metric name. In most methods, dimensions &amp; metrics can be used for the first | |
| /// time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in | |
| /// the RunPivotReportRequest's dimensions or metrics. | |
| /// </summary> | |
| [] | |
| public virtual string FieldName { get; set; } | |
| /// <summary>A filter for in list values.</summary> | |
| [] | |
| public virtual InListFilter InListFilter { get; set; } | |
| /// <summary>A filter for numeric or date values.</summary> | |
| [] | |
| public virtual NumericFilter NumericFilter { get; set; } | |
| /// <summary>Strings related filter.</summary> | |
| [] | |
| public virtual StringFilter StringFilter { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions | |
| /// or all metrics. | |
| /// </summary> | |
| public class FilterExpression : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The FilterExpressions in and_group have an AND relationship.</summary> | |
| [] | |
| public virtual FilterExpressionList AndGroup { get; set; } | |
| /// <summary> | |
| /// A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all | |
| /// dimensions or all metrics. | |
| /// </summary> | |
| [] | |
| public virtual Filter Filter { get; set; } | |
| /// <summary>The FilterExpression is NOT of not_expression.</summary> | |
| [] | |
| public virtual FilterExpression NotExpression { get; set; } | |
| /// <summary>The FilterExpressions in or_group have an OR relationship.</summary> | |
| [] | |
| public virtual FilterExpressionList OrGroup { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>A list of filter expressions.</summary> | |
| public class FilterExpressionList : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>A list of filter expressions.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<FilterExpression> Expressions { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The result needs to be in a list of string values.</summary> | |
| public class InListFilter : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>If true, the string value is case sensitive.</summary> | |
| [] | |
| public virtual System.Nullable<bool> CaseSensitive { get; set; } | |
| /// <summary>The list of string values. Must be non-empty.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> Values { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>A list of all audience exports for a property.</summary> | |
| public class ListAudienceExportsResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Each audience export for a property.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<AudienceExport> AudienceExports { get; set; } | |
| /// <summary> | |
| /// A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no | |
| /// subsequent pages. | |
| /// </summary> | |
| [] | |
| public virtual string NextPageToken { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The dimensions, metrics and comparisons currently accepted in reporting methods.</summary> | |
| public class Metadata : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The comparison descriptions.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<ComparisonMetadata> Comparisons { get; set; } | |
| /// <summary>The dimension descriptions.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DimensionMetadata> Dimensions { get; set; } | |
| /// <summary>The metric descriptions.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<MetricMetadata> Metrics { get; set; } | |
| /// <summary>Resource name of this metadata.</summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. | |
| /// Requests are allowed up to 10 metrics. | |
| /// </summary> | |
| public class Metric : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// A mathematical expression for derived metrics. For example, the metric Event count per user is | |
| /// `eventCount/totalUsers`. | |
| /// </summary> | |
| [] | |
| public virtual string Expression { get; set; } | |
| /// <summary> | |
| /// Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not | |
| /// produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> Invisible { get; set; } | |
| /// <summary> | |
| /// The name of the metric. See the [API | |
| /// Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the | |
| /// list of metric names supported by core reporting methods such as `runReport` and `batchRunReports`. See | |
| /// [Realtime | |
| /// Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics) | |
| /// for the list of metric names supported by the `runRealtimeReport` method. See [Funnel | |
| /// Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics) | |
| /// for the list of metric names supported by the `runFunnelReport` method. If `expression` is specified, `name` | |
| /// can be any string that you would like within the allowed character set. For example if `expression` is | |
| /// `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you | |
| /// choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in | |
| /// `metricFilter`, `orderBys`, and metric `expression`. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The compatibility for a single metric.</summary> | |
| public class MetricCompatibility : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added | |
| /// to the report. | |
| /// </summary> | |
| [] | |
| public virtual string Compatibility { get; set; } | |
| /// <summary> | |
| /// The metric metadata contains the API name for this compatibility information. The metric metadata also | |
| /// contains other helpful information like the UI name and description. | |
| /// </summary> | |
| [] | |
| public virtual MetricMetadata MetricMetadata { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Describes a metric column in the report. Visible metrics requested in a report produce column entries within | |
| /// rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns | |
| /// in a report; correspondingly, those metrics do not produce headers. | |
| /// </summary> | |
| public class MetricHeader : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The metric's name.</summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary>The metric's data type.</summary> | |
| [] | |
| public virtual string Type { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Explains a metric.</summary> | |
| public class MetricMetadata : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.</summary> | |
| [] | |
| public virtual string ApiName { get; set; } | |
| /// <summary> | |
| /// If reasons are specified, your access is blocked to this metric for this property. API requests from you to | |
| /// this property for this metric will succeed; however, the report will contain only zeros for this metric. API | |
| /// requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this | |
| /// metric. To learn more, see [Access and data-restriction | |
| /// management](https://support.google.com/analytics/answer/10851388). | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> BlockedReasons { get; set; } | |
| /// <summary> | |
| /// The display name of the category that this metrics belongs to. Similar dimensions and metrics are | |
| /// categorized together. | |
| /// </summary> | |
| [] | |
| public virtual string Category { get; set; } | |
| /// <summary>True if the metric is a custom metric for this property.</summary> | |
| [] | |
| public virtual System.Nullable<bool> CustomDefinition { get; set; } | |
| /// <summary> | |
| /// Still usable but deprecated names for this metric. If populated, this metric is available by either | |
| /// `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will | |
| /// be available only by `apiName`. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> DeprecatedApiNames { get; set; } | |
| /// <summary>Description of how this metric is used and calculated.</summary> | |
| [] | |
| public virtual string Description { get; set; } | |
| /// <summary> | |
| /// The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field | |
| /// for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty. | |
| /// </summary> | |
| [] | |
| public virtual string Expression { get; set; } | |
| /// <summary>The type of this metric.</summary> | |
| [] | |
| public virtual string Type { get; set; } | |
| /// <summary> | |
| /// This metric's name within the Google Analytics user interface. For example, `Event count`. | |
| /// </summary> | |
| [] | |
| public virtual string UiName { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Sorts by metric values.</summary> | |
| public class MetricOrderBy : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>A metric name in the request to order by.</summary> | |
| [] | |
| public virtual string MetricName { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The value of a metric.</summary> | |
| public class MetricValue : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Measurement value. See MetricHeader for type.</summary> | |
| [] | |
| public virtual string Value { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ..., `endMinutesAgo`. Requests are | |
| /// allowed up to 2 minute ranges. | |
| /// </summary> | |
| public class MinuteRange : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The inclusive end minute for the query as a number of minutes before now. Cannot be before | |
| /// `startMinutesAgo`. For example, `"endMinutesAgo": 15` specifies the report should include event data from | |
| /// prior to 15 minutes ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics properties | |
| /// can request any minute in the last 30 minutes of event data (`endMinutesAgo &lt;= 29`), and 360 | |
| /// Analytics properties can request any minute in the last 60 minutes of event data (`endMinutesAgo &lt;= | |
| /// 59`). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> EndMinutesAgo { get; set; } | |
| /// <summary> | |
| /// Assigns a name to this minute range. The dimension `dateRange` is valued to this name in a report response. | |
| /// If set, cannot begin with `date_range_` or `RESERVED_`. If not set, minute ranges are named by their zero | |
| /// based index in the request: `date_range_0`, `date_range_1`, etc. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary> | |
| /// The inclusive start minute for the query as a number of minutes before now. For example, `"startMinutesAgo": | |
| /// 29` specifies the report should include event data from 29 minutes ago and after. Cannot be after | |
| /// `endMinutesAgo`. If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics properties can | |
| /// request up to the last 30 minutes of event data (`startMinutesAgo &lt;= 29`), and 360 Analytics | |
| /// properties can request up to the last 60 minutes of event data (`startMinutesAgo &lt;= 59`). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> StartMinutesAgo { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Filters for numeric or date values.</summary> | |
| public class NumericFilter : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The operation type for this filter.</summary> | |
| [] | |
| public virtual string Operation { get; set; } | |
| /// <summary>A numeric value or a date value.</summary> | |
| [] | |
| public virtual NumericValue Value { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>To represent a number.</summary> | |
| public class NumericValue : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Double value</summary> | |
| [] | |
| public virtual System.Nullable<double> DoubleValue { get; set; } | |
| /// <summary>Integer value</summary> | |
| [] | |
| public virtual System.Nullable<long> Int64Value { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>This resource represents a long-running operation that is the result of a network API call.</summary> | |
| public class Operation : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, | |
| /// and either `error` or `response` is available. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> Done { get; set; } | |
| /// <summary>The error result of the operation in case of failure or cancellation.</summary> | |
| [] | |
| public virtual Status Error { get; set; } | |
| /// <summary> | |
| /// Service-specific metadata associated with the operation. It typically contains progress information and | |
| /// common metadata such as create time. Some services might not provide such metadata. Any method that returns | |
| /// a long-running operation should document the metadata type, if any. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IDictionary<string, object> Metadata { get; set; } | |
| /// <summary> | |
| /// The server-assigned name, which is only unique within the same service that originally returns it. If you | |
| /// use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | |
| /// </summary> | |
| [] | |
| public virtual string Name { get; set; } | |
| /// <summary> | |
| /// The normal, successful response of the operation. If the original method returns no data on success, such as | |
| /// `Delete`, the response is `google.protobuf.Empty`. If the original method is standard | |
| /// `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have | |
| /// the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is | |
| /// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IDictionary<string, object> Response { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count | |
| /// is one ordering, and ordering rows by the event name string is a different ordering. | |
| /// </summary> | |
| public class OrderBy : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>If true, sorts by descending order.</summary> | |
| [] | |
| public virtual System.Nullable<bool> Desc { get; set; } | |
| /// <summary>Sorts results by a dimension's values.</summary> | |
| [] | |
| public virtual DimensionOrderBy Dimension { get; set; } | |
| /// <summary>Sorts results by a metric's values.</summary> | |
| [] | |
| public virtual MetricOrderBy Metric { get; set; } | |
| /// <summary>Sorts results by a metric's values within a pivot column group.</summary> | |
| [] | |
| public virtual PivotOrderBy Pivot { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Describes the visible dimension columns and rows in the report response.</summary> | |
| public class Pivot : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Dimension names for visible columns in the report response. Including "dateRange" produces a date range | |
| /// column; for each row in the response, dimension values in the date range column will indicate the | |
| /// corresponding date range from the request. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> FieldNames { get; set; } | |
| /// <summary> | |
| /// The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is | |
| /// required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each | |
| /// `pivot` in a `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot request with `limit: | |
| /// 1000` in each pivot will fail because the product is `1,000,000`. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> Limit { get; set; } | |
| /// <summary> | |
| /// Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> MetricAggregations { get; set; } | |
| /// <summary>The row count of the start row. The first row is counted as row 0.</summary> | |
| [] | |
| public virtual System.Nullable<long> Offset { get; set; } | |
| /// <summary> | |
| /// Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and | |
| /// PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader | |
| /// ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<OrderBy> OrderBys { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Summarizes dimension values from a row for this pivot.</summary> | |
| public class PivotDimensionHeader : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Values of multiple dimensions in a pivot.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DimensionValue> DimensionValues { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Dimensions' values in a single pivot.</summary> | |
| public class PivotHeader : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The size is the same as the cardinality of the corresponding dimension combinations.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<PivotDimensionHeader> PivotDimensionHeaders { get; set; } | |
| /// <summary> | |
| /// The cardinality of the pivot. The total number of rows for this pivot's fields regardless of how the | |
| /// parameters `offset` and `limit` are specified in the request. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> RowCount { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Sorts by a pivot column group.</summary> | |
| public class PivotOrderBy : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// In the response to order by, order rows by this column. Must be a metric name from the request. | |
| /// </summary> | |
| [] | |
| public virtual string MetricName { get; set; } | |
| /// <summary> | |
| /// Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on | |
| /// rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<PivotSelection> PivotSelections { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For | |
| /// example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on | |
| /// Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | |
| /// | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | | |
| /// Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 | |
| /// ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 | |
| /// ---------|----------|----------------|----------|---------------- | |
| /// </summary> | |
| public class PivotSelection : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Must be a dimension name from the request.</summary> | |
| [] | |
| public virtual string DimensionName { get; set; } | |
| /// <summary>Order by only when the named dimension is this value.</summary> | |
| [] | |
| public virtual string DimensionValue { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests | |
| /// to that property will return Resource Exhausted errors. | |
| /// </summary> | |
| public class PropertyQuota : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to | |
| /// 50 concurrent requests. | |
| /// </summary> | |
| [] | |
| public virtual QuotaStatus ConcurrentRequests { get; set; } | |
| /// <summary> | |
| /// Analytics Properties can send up to 120 requests with potentially thresholded dimensions per hour. In a | |
| /// batch request, each report request is individually counted for this quota if the request contains | |
| /// potentially thresholded dimensions. | |
| /// </summary> | |
| [] | |
| public virtual QuotaStatus PotentiallyThresholdedRequestsPerHour { get; set; } | |
| /// <summary> | |
| /// Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics | |
| /// 360 Properties and cloud project pairs can have up to 50 server errors per hour. | |
| /// </summary> | |
| [] | |
| public virtual QuotaStatus ServerErrorsPerProjectPerHour { get; set; } | |
| /// <summary> | |
| /// Standard Analytics Properties can use up to 200,000 tokens per day; Analytics 360 Properties can use | |
| /// 2,000,000 tokens per day. Most requests consume fewer than 10 tokens. | |
| /// </summary> | |
| [] | |
| public virtual QuotaStatus TokensPerDay { get; set; } | |
| /// <summary> | |
| /// Standard Analytics Properties can use up to 40,000 tokens per hour; Analytics 360 Properties can use 400,000 | |
| /// tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of | |
| /// the hourly, daily, and per project hourly quotas. | |
| /// </summary> | |
| [] | |
| public virtual QuotaStatus TokensPerHour { get; set; } | |
| /// <summary> | |
| /// Analytics Properties can use up to 35% of their tokens per project per hour. This amounts to standard | |
| /// Analytics Properties can use up to 14,000 tokens per project per hour, and Analytics 360 Properties can use | |
| /// 140,000 tokens per project per hour. An API request consumes a single number of tokens, and that number is | |
| /// deducted from all of the hourly, daily, and per project hourly quotas. | |
| /// </summary> | |
| [] | |
| public virtual QuotaStatus TokensPerProjectPerHour { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>A request to list users in an audience export.</summary> | |
| public class QueryAudienceExportRequest : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum | |
| /// of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also | |
| /// return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. To | |
| /// learn more about this pagination parameter, see | |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> Limit { get; set; } | |
| /// <summary> | |
| /// Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request | |
| /// does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of | |
| /// rows. The second request sets offset to the `limit` of the first request; the second request returns the | |
| /// second `limit` of rows. To learn more about this pagination parameter, see | |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> Offset { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>A list of users in an audience export.</summary> | |
| public class QueryAudienceExportResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Configuration data about AudienceExport being queried. Returned to help interpret the audience rows in this | |
| /// response. For example, the dimensions in this AudienceExport correspond to the columns in the AudienceRows. | |
| /// </summary> | |
| [] | |
| public virtual AudienceExport AudienceExport { get; set; } | |
| /// <summary> | |
| /// Rows for each user in an audience export. The number of rows in this response will be less than or equal to | |
| /// request's page size. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<V1betaAudienceRow> AudienceRows { get; set; } | |
| /// <summary> | |
| /// The total number of rows in the AudienceExport result. `rowCount` is independent of the number of rows | |
| /// returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if | |
| /// a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` | |
| /// of 175 but only 50 rows. To learn more about this pagination parameter, see | |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> RowCount { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Current state for a particular quota group.</summary> | |
| public class QuotaStatus : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Quota consumed by this request.</summary> | |
| [] | |
| public virtual System.Nullable<int> Consumed { get; set; } | |
| /// <summary>Quota remaining after this request.</summary> | |
| [] | |
| public virtual System.Nullable<int> Remaining { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Response's metadata carrying additional information about the report content.</summary> | |
| public class ResponseMetaData : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The currency code used in this report. Intended to be used in formatting currency metrics like | |
| /// `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter | |
| /// will echo the request parameter; otherwise, this response parameter is the property's current currency_code. | |
| /// Currency codes are string encodings of currency types from the ISO 4217 standard | |
| /// (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see | |
| /// https://support.google.com/analytics/answer/9796179. | |
| /// </summary> | |
| [] | |
| public virtual string CurrencyCode { get; set; } | |
| /// <summary> | |
| /// If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for | |
| /// high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated | |
| /// data table used in the report. The parameter will be accurately populated regardless of the filters and | |
| /// limits in the report. For example, the (other) row could be dropped from the report because the request | |
| /// contains a filter on sessionSource = google. This parameter will still be populated if data loss from other | |
| /// row was present in the input aggregate data used to generate this report. To learn more, see [About the | |
| /// (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> DataLossFromOtherRow { get; set; } | |
| /// <summary>If empty reason is specified, the report is empty for this reason.</summary> | |
| [] | |
| public virtual string EmptyReason { get; set; } | |
| /// <summary> | |
| /// If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes | |
| /// the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each | |
| /// `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. | |
| /// However if the results are not sampled, this field will not be defined. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<SamplingMetadata> SamplingMetadatas { get; set; } | |
| /// <summary> | |
| /// Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and | |
| /// data-restriction management](https://support.google.com/analytics/answer/10851388). | |
| /// </summary> | |
| [] | |
| public virtual SchemaRestrictionResponse SchemaRestrictionResponse { get; set; } | |
| /// <summary> | |
| /// If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets | |
| /// the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding | |
| /// and no data is absent from the report, and this happens when all data is above the thresholds. To learn | |
| /// more, see [Data thresholds](https://support.google.com/analytics/answer/9383630). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> SubjectToThresholding { get; set; } | |
| /// <summary> | |
| /// The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and | |
| /// `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for | |
| /// example "America/New_York" or "Asia/Tokyo". | |
| /// </summary> | |
| [] | |
| public virtual string TimeZone { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// Report data for each row. For example if RunReportRequest contains: | |
| /// ``` | |
| /// none "dimensions": [ { "name": | |
| /// "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] | |
| /// ``` | |
| /// One row with | |
| /// 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: | |
| /// ``` | |
| /// none | |
| /// "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] | |
| /// ``` | |
| /// </summary> | |
| public class Row : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions | |
| /// included in a pivot. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DimensionValue> DimensionValues { get; set; } | |
| /// <summary>List of requested visible metric values.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<MetricValue> MetricValues { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The request to generate a pivot report.</summary> | |
| public class RunPivotReportRequest : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension | |
| /// must be present. | |
| /// </summary> | |
| [] | |
| public virtual CohortSpec CohortSpec { get; set; } | |
| /// <summary> | |
| /// Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons | |
| /// field and a comparisons dimension to receive a comparison column in the response. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Comparison> Comparisons { get; set; } | |
| /// <summary> | |
| /// A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the | |
| /// property's default currency. | |
| /// </summary> | |
| [] | |
| public virtual string CurrencyCode { get; set; } | |
| /// <summary> | |
| /// The date range to retrieve event data for the report. If multiple date ranges are specified, event data from | |
| /// each date range is used in the report. A special dimension with field name "dateRange" can be included in a | |
| /// Pivot's field names; if included, the report compares between date ranges. In a cohort request, this | |
| /// `dateRanges` must be unspecified. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DateRange> DateRanges { get; set; } | |
| /// <summary> | |
| /// The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be | |
| /// used in this filter. | |
| /// </summary> | |
| [] | |
| public virtual FilterExpression DimensionFilter { get; set; } | |
| /// <summary> | |
| /// The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, | |
| /// dimension_filter, pivots, order_bys. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Dimension> Dimensions { get; set; } | |
| /// <summary> | |
| /// If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will | |
| /// be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, | |
| /// only data recorded by the Google Analytics property can be displayed in a report. For example if a property | |
| /// never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not | |
| /// have a row eventName: "purchase" and eventCount: 0. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> KeepEmptyRows { get; set; } | |
| /// <summary> | |
| /// The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must | |
| /// be requested to be used in this filter. Dimensions cannot be used in this filter. | |
| /// </summary> | |
| [] | |
| public virtual FilterExpression MetricFilter { get; set; } | |
| /// <summary> | |
| /// The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of | |
| /// the following: metric_expression, metric_filter, order_bys. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Metric> Metrics { get; set; } | |
| /// <summary> | |
| /// Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames | |
| /// (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can | |
| /// share a dimension. A dimension is only visible if it appears in a pivot. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Pivot> Pivots { get; set; } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. | |
| /// To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch | |
| /// request, this property should either be unspecified or consistent with the batch-level property. Example: | |
| /// properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; set; } | |
| /// <summary> | |
| /// Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in | |
| /// [PropertyQuota](#PropertyQuota). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> ReturnPropertyQuota { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The response pivot report table corresponding to a pivot request.</summary> | |
| public class RunPivotReportResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled | |
| /// by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the | |
| /// dimension_values which are set to "RESERVED_". | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Aggregates { get; set; } | |
| /// <summary> | |
| /// Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the | |
| /// dimensions present in rows. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DimensionHeader> DimensionHeaders { get; set; } | |
| /// <summary> | |
| /// Identifies what kind of resource this message is. This `kind` is always the fixed string | |
| /// "analyticsData#runPivotReport". Useful to distinguish between response types in JSON. | |
| /// </summary> | |
| [] | |
| public virtual string Kind { get; set; } | |
| /// <summary>Metadata for the report.</summary> | |
| [] | |
| public virtual ResponseMetaData Metadata { get; set; } | |
| /// <summary> | |
| /// Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics | |
| /// present in rows. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<MetricHeader> MetricHeaders { get; set; } | |
| /// <summary> | |
| /// Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the | |
| /// response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": | |
| /// "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ | |
| /// "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { | |
| /// "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ | |
| /// "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }] | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<PivotHeader> PivotHeaders { get; set; } | |
| /// <summary>This Google Analytics property's quota state including this request.</summary> | |
| [] | |
| public virtual PropertyQuota PropertyQuota { get; set; } | |
| /// <summary>Rows of dimension value combinations and metric values in the report.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Rows { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The request to generate a realtime report.</summary> | |
| public class RunRealtimeReportRequest : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The filter clause of dimensions. Metrics cannot be used in this filter.</summary> | |
| [] | |
| public virtual FilterExpression DimensionFilter { get; set; } | |
| /// <summary>The dimensions requested and displayed.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Dimension> Dimensions { get; set; } | |
| /// <summary> | |
| /// The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 | |
| /// rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer | |
| /// rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, | |
| /// there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, | |
| /// you can't get more than 300 rows, even if you set `limit` to a higher value. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> Limit { get; set; } | |
| /// <summary> | |
| /// Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to | |
| /// "RESERVED_(MetricAggregation)". | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> MetricAggregations { get; set; } | |
| /// <summary> | |
| /// The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions | |
| /// cannot be used in this filter. | |
| /// </summary> | |
| [] | |
| public virtual FilterExpression MetricFilter { get; set; } | |
| /// <summary>The metrics requested and displayed.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Metric> Metrics { get; set; } | |
| /// <summary> | |
| /// The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be | |
| /// used. If multiple minute ranges are requested, each response row will contain a zero based minute range | |
| /// index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response | |
| /// rows for both minute ranges. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<MinuteRange> MinuteRanges { get; set; } | |
| /// <summary>Specifies how rows are ordered in the response.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<OrderBy> OrderBys { get; set; } | |
| /// <summary> | |
| /// Toggles whether to return the current state of this Google Analytics property's Realtime quota. Quota is | |
| /// returned in [PropertyQuota](#PropertyQuota). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> ReturnPropertyQuota { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The response realtime report table corresponding to a request.</summary> | |
| public class RunRealtimeReportResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the | |
| /// dimensions present in rows. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DimensionHeader> DimensionHeaders { get; set; } | |
| /// <summary> | |
| /// Identifies what kind of resource this message is. This `kind` is always the fixed string | |
| /// "analyticsData#runRealtimeReport". Useful to distinguish between response types in JSON. | |
| /// </summary> | |
| [] | |
| public virtual string Kind { get; set; } | |
| /// <summary>If requested, the maximum values of metrics.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Maximums { get; set; } | |
| /// <summary> | |
| /// Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics | |
| /// present in rows. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<MetricHeader> MetricHeaders { get; set; } | |
| /// <summary>If requested, the minimum values of metrics.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Minimums { get; set; } | |
| /// <summary>This Google Analytics property's Realtime quota state including this request.</summary> | |
| [] | |
| public virtual PropertyQuota PropertyQuota { get; set; } | |
| /// <summary> | |
| /// The total number of rows in the query result. `rowCount` is independent of the number of rows returned in | |
| /// the response and the `limit` request parameter. For example if a query returns 175 rows and includes `limit` | |
| /// of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> RowCount { get; set; } | |
| /// <summary>Rows of dimension value combinations and metric values in the report.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Rows { get; set; } | |
| /// <summary>If requested, the totaled values of metrics.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Totals { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The request to generate a report.</summary> | |
| public class RunReportRequest : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension | |
| /// must be present. | |
| /// </summary> | |
| [] | |
| public virtual CohortSpec CohortSpec { get; set; } | |
| /// <summary> | |
| /// Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons | |
| /// field in order to receive a comparison column in the response. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Comparison> Comparisons { get; set; } | |
| /// <summary> | |
| /// A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the | |
| /// property's default currency. | |
| /// </summary> | |
| [] | |
| public virtual string CurrencyCode { get; set; } | |
| /// <summary> | |
| /// Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero | |
| /// based date range index. If two date ranges overlap, the event data for the overlapping days is included in | |
| /// the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DateRange> DateRanges { get; set; } | |
| /// <summary> | |
| /// Dimension filters let you ask for only specific dimension values in the report. To learn more, see | |
| /// [Fundamentals of Dimension | |
| /// Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for | |
| /// examples. Metrics cannot be used in this filter. | |
| /// </summary> | |
| [] | |
| public virtual FilterExpression DimensionFilter { get; set; } | |
| /// <summary>The dimensions requested and displayed.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Dimension> Dimensions { get; set; } | |
| /// <summary> | |
| /// If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will | |
| /// be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, | |
| /// only data recorded by the Google Analytics property can be displayed in a report. For example if a property | |
| /// never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not | |
| /// have a row eventName: "purchase" and eventCount: 0. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> KeepEmptyRows { get; set; } | |
| /// <summary> | |
| /// The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 | |
| /// rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer | |
| /// rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, | |
| /// there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, | |
| /// you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this | |
| /// pagination parameter, see | |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> Limit { get; set; } | |
| /// <summary> | |
| /// Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to | |
| /// "RESERVED_(MetricAggregation)". Aggregates including both comparisons and multiple date ranges will be | |
| /// aggregated based on the date ranges. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<string> MetricAggregations { get; set; } | |
| /// <summary> | |
| /// The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. | |
| /// Dimensions cannot be used in this filter. | |
| /// </summary> | |
| [] | |
| public virtual FilterExpression MetricFilter { get; set; } | |
| /// <summary>The metrics requested and displayed.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Metric> Metrics { get; set; } | |
| /// <summary> | |
| /// The row count of the start row. The first row is counted as row 0. When paging, the first request does not | |
| /// specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The | |
| /// second request sets offset to the `limit` of the first request; the second request returns the second | |
| /// `limit` of rows. To learn more about this pagination parameter, see | |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> Offset { get; set; } | |
| /// <summary> | |
| /// Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges | |
| /// will have order bys applied on the comparisons. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<OrderBy> OrderBys { get; set; } | |
| /// <summary> | |
| /// A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. | |
| /// To learn more, see [where to find your Property | |
| /// ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch | |
| /// request, this property should either be unspecified or consistent with the batch-level property. Example: | |
| /// properties/1234 | |
| /// </summary> | |
| [] | |
| public virtual string Property { get; set; } | |
| /// <summary> | |
| /// Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in | |
| /// [PropertyQuota](#PropertyQuota). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<bool> ReturnPropertyQuota { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The response report table corresponding to a request.</summary> | |
| public class RunReportResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the | |
| /// dimensions present in rows. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<DimensionHeader> DimensionHeaders { get; set; } | |
| /// <summary> | |
| /// Identifies what kind of resource this message is. This `kind` is always the fixed string | |
| /// "analyticsData#runReport". Useful to distinguish between response types in JSON. | |
| /// </summary> | |
| [] | |
| public virtual string Kind { get; set; } | |
| /// <summary>If requested, the maximum values of metrics.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Maximums { get; set; } | |
| /// <summary>Metadata for the report.</summary> | |
| [] | |
| public virtual ResponseMetaData Metadata { get; set; } | |
| /// <summary> | |
| /// Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics | |
| /// present in rows. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<MetricHeader> MetricHeaders { get; set; } | |
| /// <summary>If requested, the minimum values of metrics.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Minimums { get; set; } | |
| /// <summary>This Google Analytics property's quota state including this request.</summary> | |
| [] | |
| public virtual PropertyQuota PropertyQuota { get; set; } | |
| /// <summary> | |
| /// The total number of rows in the query result. `rowCount` is independent of the number of rows returned in | |
| /// the response, the `limit` request parameter, and the `offset` request parameter. For example if a query | |
| /// returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 | |
| /// but only 50 rows. To learn more about this pagination parameter, see | |
| /// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<int> RowCount { get; set; } | |
| /// <summary>Rows of dimension value combinations and metric values in the report.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Rows { get; set; } | |
| /// <summary>If requested, the totaled values of metrics.</summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<Row> Totals { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the | |
| /// percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to | |
| /// uncover the meaningful information in the larger data set. | |
| /// </summary> | |
| public class SamplingMetadata : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// The total number of events read in this sampled report for a date range. This is the size of the subset this | |
| /// property's data that was analyzed in this report. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> SamplesReadCount { get; set; } | |
| /// <summary> | |
| /// The total number of events present in this property's data that could have been analyzed in this report for | |
| /// a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size | |
| /// of the larger data set. To calculate the percentage of available data that was used in this report, compute | |
| /// `samplesReadCount/samplingSpaceSize`. | |
| /// </summary> | |
| [] | |
| public virtual System.Nullable<long> SamplingSpaceSize { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// The schema restrictions actively enforced in creating this report. To learn more, see [Access and | |
| /// data-restriction management](https://support.google.com/analytics/answer/10851388). | |
| /// </summary> | |
| public class SchemaRestrictionResponse : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the | |
| /// restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's | |
| /// custom role disallows access to `REVENUE_DATA`. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<ActiveMetricRestriction> ActiveMetricRestrictions { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// The `Status` type defines a logical error model that is suitable for different programming environments, | |
| /// including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| /// three pieces of data: error code, error message, and error details. You can find out more about this error model | |
| /// and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| /// </summary> | |
| public class Status : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>The status code, which should be an enum value of google.rpc.Code.</summary> | |
| [] | |
| public virtual System.Nullable<int> Code { get; set; } | |
| /// <summary> | |
| /// A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<System.Collections.Generic.IDictionary<string, object>> Details { get; set; } | |
| /// <summary> | |
| /// A developer-facing error message, which should be in English. Any user-facing error message should be | |
| /// localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| /// </summary> | |
| [] | |
| public virtual string Message { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The filter for string</summary> | |
| public class StringFilter : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>If true, the string value is case sensitive.</summary> | |
| [] | |
| public virtual System.Nullable<bool> CaseSensitive { get; set; } | |
| /// <summary>The match type for this filter.</summary> | |
| [] | |
| public virtual string MatchType { get; set; } | |
| /// <summary>The string value used for the matching.</summary> | |
| [] | |
| public virtual string Value { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary> | |
| /// An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the | |
| /// `QueryAudienceExportResponse`. | |
| /// </summary> | |
| public class V1betaAudienceDimension : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Optional. The API name of the dimension. See the [API | |
| /// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) | |
| /// for the list of dimension names. | |
| /// </summary> | |
| [] | |
| public virtual string DimensionName { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>The value of a dimension.</summary> | |
| public class V1betaAudienceDimensionValue : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary>Value as a string if the dimension type is a string.</summary> | |
| [] | |
| public virtual string Value { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| /// <summary>Dimension value attributes for the audience user row.</summary> | |
| public class V1betaAudienceRow : Google.Apis.Requests.IDirectResponseSchema | |
| { | |
| /// <summary> | |
| /// Each dimension value attribute for an audience user. One dimension value will be added for each dimension | |
| /// column requested. | |
| /// </summary> | |
| [] | |
| public virtual System.Collections.Generic.IList<V1betaAudienceDimensionValue> DimensionValues { get; set; } | |
| /// <summary>The ETag of the item.</summary> | |
| public virtual string ETag { get; set; } | |
| } | |
| } | |