googleapis
Version:
Google APIs Client Library for Node.js
1,095 lines • 867 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace analyticsadmin_v1alpha {
export interface Options extends GlobalOptions {
version: 'v1alpha';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Analytics Admin API
*
* Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.
*
* @example
* ```js
* const {google} = require('googleapis');
* const analyticsadmin = google.analyticsadmin('v1alpha');
* ```
*/
export class Analyticsadmin {
context: APIRequestContext;
accounts: Resource$Accounts;
accountSummaries: Resource$Accountsummaries;
properties: Resource$Properties;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* To express that the result needs to be between two numbers (inclusive).
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessBetweenFilter {
/**
* Begins with this number.
*/
fromValue?: Schema$GoogleAnalyticsAdminV1alphaNumericValue;
/**
* Ends with this number.
*/
toValue?: Schema$GoogleAnalyticsAdminV1alphaNumericValue;
}
/**
* A binding of a user to a set of roles.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessBinding {
/**
* Output only. Resource name of this binding. Format: accounts/{account\}/accessBindings/{access_binding\} or properties/{property\}/accessBindings/{access_binding\} Example: "accounts/100/accessBindings/200"
*/
name?: string | null;
/**
* A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
*/
roles?: string[] | null;
/**
* If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
*/
user?: string | null;
}
/**
* A contiguous range of days: startDate, startDate + 1, ..., endDate.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessDateRange {
/**
* The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.
*/
endDate?: string | null;
/**
* The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone.
*/
startDate?: string | null;
}
/**
* Dimensions are attributes of your data. For example, the dimension `userEmail` indicates the email of the user that accessed reporting data. Dimension values in report responses are strings.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessDimension {
/**
* The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`.
*/
dimensionName?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessDimensionHeader {
/**
* The dimension's name; for example 'userEmail'.
*/
dimensionName?: string | null;
}
/**
* The value of a dimension.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessDimensionValue {
/**
* The dimension value. For example, this value may be 'France' for the 'country' dimension.
*/
value?: string | null;
}
/**
* An expression to filter dimension or metric values.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessFilter {
/**
* A filter for two values.
*/
betweenFilter?: Schema$GoogleAnalyticsAdminV1alphaAccessBetweenFilter;
/**
* The dimension name or metric name.
*/
fieldName?: string | null;
/**
* A filter for in list values.
*/
inListFilter?: Schema$GoogleAnalyticsAdminV1alphaAccessInListFilter;
/**
* A filter for numeric or date values.
*/
numericFilter?: Schema$GoogleAnalyticsAdminV1alphaAccessNumericFilter;
/**
* Strings related filter.
*/
stringFilter?: Schema$GoogleAnalyticsAdminV1alphaAccessStringFilter;
}
/**
* Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessFilterExpression {
/**
* A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.
*/
accessFilter?: Schema$GoogleAnalyticsAdminV1alphaAccessFilter;
/**
* Each of the FilterExpressions in the and_group has an AND relationship.
*/
andGroup?: Schema$GoogleAnalyticsAdminV1alphaAccessFilterExpressionList;
/**
* The FilterExpression is NOT of not_expression.
*/
notExpression?: Schema$GoogleAnalyticsAdminV1alphaAccessFilterExpression;
/**
* Each of the FilterExpressions in the or_group has an OR relationship.
*/
orGroup?: Schema$GoogleAnalyticsAdminV1alphaAccessFilterExpressionList;
}
/**
* A list of filter expressions.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessFilterExpressionList {
/**
* A list of filter expressions.
*/
expressions?: Schema$GoogleAnalyticsAdminV1alphaAccessFilterExpression[];
}
/**
* The result needs to be in a list of string values.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessInListFilter {
/**
* If true, the string value is case sensitive.
*/
caseSensitive?: boolean | null;
/**
* The list of string values. Must be non-empty.
*/
values?: string[] | null;
}
/**
* The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessMetric {
/**
* The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`.
*/
metricName?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessMetricHeader {
/**
* The metric's name; for example 'accessCount'.
*/
metricName?: string | null;
}
/**
* The value of a metric.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessMetricValue {
/**
* The measurement value. For example, this value may be '13'.
*/
value?: string | null;
}
/**
* Filters for numeric or date values.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessNumericFilter {
/**
* The operation type for this filter.
*/
operation?: string | null;
/**
* A numeric value or a date value.
*/
value?: Schema$GoogleAnalyticsAdminV1alphaNumericValue;
}
/**
* Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessOrderBy {
/**
* If true, sorts by descending order. If false or unspecified, sorts in ascending order.
*/
desc?: boolean | null;
/**
* Sorts results by a dimension's values.
*/
dimension?: Schema$GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy;
/**
* Sorts results by a metric's values.
*/
metric?: Schema$GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy;
}
/**
* Sorts by dimension values.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy {
/**
* A dimension name in the request to order by.
*/
dimensionName?: string | null;
/**
* Controls the rule for dimension value ordering.
*/
orderType?: string | null;
}
/**
* Sorts by metric values.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy {
/**
* A metric name in the request to order by.
*/
metricName?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessQuota {
/**
* Properties can use up to 50 concurrent requests.
*/
concurrentRequests?: Schema$GoogleAnalyticsAdminV1alphaAccessQuotaStatus;
/**
* Properties and cloud project pairs can have up to 50 server errors per hour.
*/
serverErrorsPerProjectPerHour?: Schema$GoogleAnalyticsAdminV1alphaAccessQuotaStatus;
/**
* Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
*/
tokensPerDay?: Schema$GoogleAnalyticsAdminV1alphaAccessQuotaStatus;
/**
* Properties can use 50,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.
*/
tokensPerHour?: Schema$GoogleAnalyticsAdminV1alphaAccessQuotaStatus;
/**
* Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 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.
*/
tokensPerProjectPerHour?: Schema$GoogleAnalyticsAdminV1alphaAccessQuotaStatus;
}
/**
* Current state for a particular quota group.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessQuotaStatus {
/**
* Quota consumed by this request.
*/
consumed?: number | null;
/**
* Quota remaining after this request.
*/
remaining?: number | null;
}
/**
* Access report data for each row.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessRow {
/**
* List of dimension values. These values are in the same order as specified in the request.
*/
dimensionValues?: Schema$GoogleAnalyticsAdminV1alphaAccessDimensionValue[];
/**
* List of metric values. These values are in the same order as specified in the request.
*/
metricValues?: Schema$GoogleAnalyticsAdminV1alphaAccessMetricValue[];
}
/**
* The filter for strings.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccessStringFilter {
/**
* If true, the string value is case sensitive.
*/
caseSensitive?: boolean | null;
/**
* The match type for this filter.
*/
matchType?: string | null;
/**
* The string value used for the matching.
*/
value?: string | null;
}
/**
* A resource message representing a Google Analytics account.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccount {
/**
* Output only. Time when this account was originally created.
*/
createTime?: string | null;
/**
* Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
*/
deleted?: boolean | null;
/**
* Required. Human-readable display name for this account.
*/
displayName?: string | null;
/**
* Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id\}
*/
gmpOrganization?: string | null;
/**
* Output only. Resource name of this account. Format: accounts/{account\} Example: "accounts/100"
*/
name?: string | null;
/**
* Country of business. Must be a Unicode CLDR region code.
*/
regionCode?: string | null;
/**
* Output only. Time when account payload fields were last updated.
*/
updateTime?: string | null;
}
/**
* A virtual resource representing an overview of an account and all its child Google Analytics properties.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAccountSummary {
/**
* Resource name of account referred to by this account summary Format: accounts/{account_id\} Example: "accounts/1000"
*/
account?: string | null;
/**
* Display name for the account referred to in this account summary.
*/
displayName?: string | null;
/**
* Resource name for this account summary. Format: accountSummaries/{account_id\} Example: "accountSummaries/1000"
*/
name?: string | null;
/**
* List of summaries for child accounts of this account.
*/
propertySummaries?: Schema$GoogleAnalyticsAdminV1alphaPropertySummary[];
}
/**
* Request message for AcknowledgeUserDataCollection RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest {
/**
* Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."
*/
acknowledgement?: string | null;
}
/**
* Response message for AcknowledgeUserDataCollection RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse {
}
/**
* A link between a Google Analytics property and an AdSense for Content ad client.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAdSenseLink {
/**
* Immutable. The AdSense ad client code that the Google Analytics property is linked to. Example format: "ca-pub-1234567890"
*/
adClientCode?: string | null;
/**
* Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId\}/adSenseLinks/{linkId\} Example: properties/1234/adSenseLinks/6789
*/
name?: string | null;
}
/**
* Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest {
}
/**
* Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse {
/**
* The DisplayVideo360AdvertiserLink created as a result of approving the proposal.
*/
displayVideo360AdvertiserLink?: Schema$GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink;
}
/**
* Request message for ArchiveAudience RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaArchiveAudienceRequest {
}
/**
* Request message for ArchiveCustomDimension RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest {
}
/**
* Request message for ArchiveCustomMetric RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest {
}
/**
* The attribution settings used for a given property. This is a singleton resource.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAttributionSettings {
/**
* Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.
*/
acquisitionConversionEventLookbackWindow?: string | null;
/**
* Required. The Conversion Export Scope for data exported to linked Ads Accounts.
*/
adsWebConversionDataExportScope?: string | null;
/**
* Output only. Resource name of this attribution settings resource. Format: properties/{property_id\}/attributionSettings Example: "properties/1000/attributionSettings"
*/
name?: string | null;
/**
* Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.
*/
otherConversionEventLookbackWindow?: string | null;
/**
* Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.
*/
reportingAttributionModel?: string | null;
}
/**
* A resource message representing an Audience.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudience {
/**
* Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
*/
adsPersonalizationEnabled?: boolean | null;
/**
* Output only. Time when the Audience was created.
*/
createTime?: string | null;
/**
* Required. The description of the Audience.
*/
description?: string | null;
/**
* Required. The display name of the Audience.
*/
displayName?: string | null;
/**
* Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
*/
eventTrigger?: Schema$GoogleAnalyticsAdminV1alphaAudienceEventTrigger;
/**
* Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.
*/
exclusionDurationMode?: string | null;
/**
* Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
*/
filterClauses?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterClause[];
/**
* Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
*/
membershipDurationDays?: number | null;
/**
* Output only. The resource name for this Audience resource. Format: properties/{propertyId\}/audiences/{audienceId\}
*/
name?: string | null;
}
/**
* A specific filter for a single dimension or metric.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter {
/**
* Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
*/
atAnyPointInTime?: boolean | null;
/**
* A filter for numeric or date values between certain values on a dimension or metric.
*/
betweenFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter;
/**
* Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).
*/
fieldName?: string | null;
/**
* Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
*/
inAnyNDayPeriod?: number | null;
/**
* A filter for a string dimension that matches a particular list of options.
*/
inListFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter;
/**
* A filter for numeric or date values on a dimension or metric.
*/
numericFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter;
/**
* A filter for a string-type dimension that matches a particular pattern.
*/
stringFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter;
}
/**
* A filter for numeric or date values between certain values on a dimension or metric.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter {
/**
* Required. Begins with this number, inclusive.
*/
fromValue?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue;
/**
* Required. Ends with this number, inclusive.
*/
toValue?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue;
}
/**
* A filter for a string dimension that matches a particular list of options.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter {
/**
* Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
*/
caseSensitive?: boolean | null;
/**
* Required. The list of possible string values to match against. Must be non-empty.
*/
values?: string[] | null;
}
/**
* A filter for numeric or date values on a dimension or metric.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter {
/**
* Required. The operation applied to a numeric filter.
*/
operation?: string | null;
/**
* Required. The numeric or date value to match against.
*/
value?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue;
}
/**
* To represent a number.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue {
/**
* Double value.
*/
doubleValue?: number | null;
/**
* Integer value.
*/
int64Value?: string | null;
}
/**
* A filter for a string-type dimension that matches a particular pattern.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter {
/**
* Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
*/
caseSensitive?: boolean | null;
/**
* Required. The match type for the string filter.
*/
matchType?: string | null;
/**
* Required. The string value to be matched against.
*/
value?: string | null;
}
/**
* A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceEventFilter {
/**
* Required. Immutable. The name of the event to match against.
*/
eventName?: string | null;
/**
* Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored.
*/
eventParameterFilterExpression?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpression;
}
/**
* Specifies an event to log when a user joins the Audience.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceEventTrigger {
/**
* Required. The event name that will be logged.
*/
eventName?: string | null;
/**
* Required. When to log the event.
*/
logCondition?: string | null;
}
/**
* A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience).
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceFilterClause {
/**
* Required. Specifies whether this is an include or exclude filter clause.
*/
clauseType?: string | null;
/**
* Filters that must occur in a specific order for the user to be a member of the Audience.
*/
sequenceFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceSequenceFilter;
/**
* A simple filter that a user must satisfy to be a member of the Audience.
*/
simpleFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceSimpleFilter;
}
/**
* A logical expression of Audience dimension, metric, or event filters.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpression {
/**
* A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression.
*/
andGroup?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList;
/**
* A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression.
*/
dimensionOrMetricFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter;
/**
* Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression.
*/
eventFilter?: Schema$GoogleAnalyticsAdminV1alphaAudienceEventFilter;
/**
* A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
*/
notExpression?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpression;
/**
* A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
*/
orGroup?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList;
}
/**
* A list of Audience filter expressions.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList {
/**
* A list of Audience filter expressions.
*/
filterExpressions?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpression[];
}
/**
* Defines filters that must occur in a specific order for the user to be a member of the Audience.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceSequenceFilter {
/**
* Required. Immutable. Specifies the scope for this filter.
*/
scope?: string | null;
/**
* Optional. Defines the time period in which the whole sequence must occur.
*/
sequenceMaximumDuration?: string | null;
/**
* Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
*/
sequenceSteps?: Schema$GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep[];
}
/**
* A condition that must occur in the specified step order for this user to match the sequence.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep {
/**
* Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
*/
constraintDuration?: string | null;
/**
* Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step.
*/
filterExpression?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpression;
/**
* Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step.
*/
immediatelyFollows?: boolean | null;
/**
* Required. Immutable. Specifies the scope for this step.
*/
scope?: string | null;
}
/**
* Defines a simple filter that a user must satisfy to be a member of the Audience.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAudienceSimpleFilter {
/**
* Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
*/
filterExpression?: Schema$GoogleAnalyticsAdminV1alphaAudienceFilterExpression;
/**
* Required. Immutable. Specifies the scope for this filter.
*/
scope?: string | null;
}
/**
* Request message for BatchCreateAccessBindings RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest {
/**
* Required. The requests specifying the access bindings to create. A maximum of 1000 access bindings can be created in a batch.
*/
requests?: Schema$GoogleAnalyticsAdminV1alphaCreateAccessBindingRequest[];
}
/**
* Response message for BatchCreateAccessBindings RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse {
/**
* The access bindings created.
*/
accessBindings?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding[];
}
/**
* Request message for BatchDeleteAccessBindings RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest {
/**
* Required. The requests specifying the access bindings to delete. A maximum of 1000 access bindings can be deleted in a batch.
*/
requests?: Schema$GoogleAnalyticsAdminV1alphaDeleteAccessBindingRequest[];
}
/**
* Response message for BatchGetAccessBindings RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse {
/**
* The requested access bindings.
*/
accessBindings?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding[];
}
/**
* Request message for BatchUpdateAccessBindings RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest {
/**
* Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch.
*/
requests?: Schema$GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest[];
}
/**
* Response message for BatchUpdateAccessBindings RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse {
/**
* The access bindings updated.
*/
accessBindings?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding[];
}
/**
* A link between a Google Analytics property and BigQuery project.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBigQueryLink {
/**
* Output only. Time when the link was created.
*/
createTime?: string | null;
/**
* If set true, enables daily data export to the linked Google Cloud project.
*/
dailyExportEnabled?: boolean | null;
/**
* Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
*/
datasetLocation?: string | null;
/**
* The list of event names that will be excluded from exports.
*/
excludedEvents?: string[] | null;
/**
* The list of streams under the parent property for which data will be exported. Format: properties/{property_id\}/dataStreams/{stream_id\} Example: ['properties/1000/dataStreams/2000']
*/
exportStreams?: string[] | null;
/**
* If set true, enables fresh daily export to the linked Google Cloud project.
*/
freshDailyExportEnabled?: boolean | null;
/**
* If set true, exported data will include advertising identifiers for mobile app streams.
*/
includeAdvertisingId?: boolean | null;
/**
* Output only. Resource name of this BigQuery link. Format: 'properties/{property_id\}/bigQueryLinks/{bigquery_link_id\}' Format: 'properties/1234/bigQueryLinks/abc567'
*/
name?: string | null;
/**
* Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number\}' Example: 'projects/1234'
*/
project?: string | null;
/**
* If set true, enables streaming export to the linked Google Cloud project.
*/
streamingExportEnabled?: boolean | null;
}
/**
* A definition for a calculated metric.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaCalculatedMetric {
/**
* Output only. The ID to use for the calculated metric. In the UI, this is referred to as the "API name." The calculated_metric_id is used when referencing this calculated metric from external APIs. For example, "calcMetric:{calculated_metric_id\}".
*/
calculatedMetricId?: string | null;
/**
* Optional. Description for this calculated metric. Max length of 4096 characters.
*/
description?: string | null;
/**
* Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.
*/
displayName?: string | null;
/**
* Required. The calculated metric's definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"
*/
formula?: string | null;
/**
* Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results.
*/
invalidMetricReference?: boolean | null;
/**
* Required. The type for the calculated metric's value.
*/
metricUnit?: string | null;
/**
* Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id\}/calculatedMetrics/{calculated_metric_id\}'
*/
name?: string | null;
/**
* Output only. Types of restricted data that this metric contains.
*/
restrictedMetricType?: string[] | null;
}
/**
* Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest {
}
/**
* A description of a change to a single Google Analytics resource.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaChangeHistoryChange {
/**
* The type of action that changed this resource.
*/
action?: string | null;
/**
* Resource name of the resource whose changes are described by this entry.
*/
resource?: string | null;
/**
* Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.
*/
resourceAfterChange?: Schema$GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource;
/**
* Resource contents from before the change was made. If this resource was created in this change, this field will be missing.
*/
resourceBeforeChange?: Schema$GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource;
}
/**
* A snapshot of a resource as before or after the result of a change in change history.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource {
/**
* A snapshot of an Account resource in change history.
*/
account?: Schema$GoogleAnalyticsAdminV1alphaAccount;
/**
* A snapshot of an AdSenseLink resource in change history.
*/
adsenseLink?: Schema$GoogleAnalyticsAdminV1alphaAdSenseLink;
/**
* A snapshot of AttributionSettings resource in change history.
*/
attributionSettings?: Schema$GoogleAnalyticsAdminV1alphaAttributionSettings;
/**
* A snapshot of an Audience resource in change history.
*/
audience?: Schema$GoogleAnalyticsAdminV1alphaAudience;
/**
* A snapshot of a BigQuery link resource in change history.
*/
bigqueryLink?: Schema$GoogleAnalyticsAdminV1alphaBigQueryLink;
/**
* A snapshot of a CalculatedMetric resource in change history.
*/
calculatedMetric?: Schema$GoogleAnalyticsAdminV1alphaCalculatedMetric;
/**
* A snapshot of a ChannelGroup resource in change history.
*/
channelGroup?: Schema$GoogleAnalyticsAdminV1alphaChannelGroup;
/**
* A snapshot of a ConversionEvent resource in change history.
*/
conversionEvent?: Schema$GoogleAnalyticsAdminV1alphaConversionEvent;
/**
* A snapshot of a CustomDimension resource in change history.
*/
customDimension?: Schema$GoogleAnalyticsAdminV1alphaCustomDimension;
/**
* A snapshot of a CustomMetric resource in change history.
*/
customMetric?: Schema$GoogleAnalyticsAdminV1alphaCustomMetric;
/**
* A snapshot of DataRedactionSettings resource in change history.
*/
dataRedactionSettings?: Schema$GoogleAnalyticsAdminV1alphaDataRedactionSettings;
/**
* A snapshot of a data retention settings resource in change history.
*/
dataRetentionSettings?: Schema$GoogleAnalyticsAdminV1alphaDataRetentionSettings;
/**
* A snapshot of a DataStream resource in change history.
*/
dataStream?: Schema$GoogleAnalyticsAdminV1alphaDataStream;
/**
* A snapshot of a DisplayVideo360AdvertiserLink resource in change history.
*/
displayVideo360AdvertiserLink?: Schema$GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink;
/**
* A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history.
*/
displayVideo360AdvertiserLinkProposal?: Schema$GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal;
/**
* A snapshot of EnhancedMeasurementSettings resource in change history.
*/
enhancedMeasurementSettings?: Schema$GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings;
/**
* A snapshot of an EventCreateRule resource in change history.
*/
eventCreateRule?: Schema$GoogleAnalyticsAdminV1alphaEventCreateRule;
/**
* A snapshot of an ExpandedDataSet resource in change history.
*/
expandedDataSet?: Schema$GoogleAnalyticsAdminV1alphaExpandedDataSet;
/**
* A snapshot of a FirebaseLink resource in change history.
*/
firebaseLink?: Schema$GoogleAnalyticsAdminV1alphaFirebaseLink;
/**
* A snapshot of a GoogleAdsLink resource in change history.
*/
googleAdsLink?: Schema$GoogleAnalyticsAdminV1alphaGoogleAdsLink;
/**
* A snapshot of a GoogleSignalsSettings resource in change history.
*/
googleSignalsSettings?: Schema$GoogleAnalyticsAdminV1alphaGoogleSignalsSettings;
/**
* A snapshot of a KeyEvent resource in change history.
*/
keyEvent?: Schema$GoogleAnalyticsAdminV1alphaKeyEvent;
/**
* A snapshot of a MeasurementProtocolSecret resource in change history.
*/
measurementProtocolSecret?: Schema$GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret;
/**
* A snapshot of a Property resource in change history.
*/
property?: Schema$GoogleAnalyticsAdminV1alphaProperty;
/**
* A snapshot of a ReportingDataAnnotation resource in change history.
*/
reportingDataAnnotation?: Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotation;
/**
* A snapshot of a ReportingIdentitySettings resource in change history.
*/
reportingIdentitySettings?: Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings;
/**
* A snapshot of a SearchAds360Link resource in change history.
*/
searchAds360Link?: Schema$GoogleAnalyticsAdminV1alphaSearchAds360Link;
/**
* A snapshot of SKAdNetworkConversionValueSchema resource in change history.
*/
skadnetworkConversionValueSchema?: Schema$GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema;
/**
* A snapshot of a SubpropertySyncConfig resource in change history.
*/
subpropertySyncConfig?: Schema$GoogleAnalyticsAdminV1alphaSubpropertySyncConfig;
}
/**
* A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaChangeHistoryEvent {
/**
* The type of actor that made this change.
*/
actorType?: string | null;
/**
* A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.
*/
changes?: Schema$GoogleAnalyticsAdminV1alphaChangeHistoryChange[];
/**
* If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.
*/
changesFiltered?: boolean | null;
/**
* Time when change was made.
*/
changeTime?: string | null;
/**
* ID of this change history event. This ID is unique across Google Analytics.
*/
id?: string | null;
/**
* Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.
*/
userActorEmail?: string | null;
}
/**
* A resource message representing a Channel Group.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaChannelGroup {
/**
* The description of the Channel Group. Max length of 256 characters.
*/
description?: string | null;
/**
* Required. The display name of the Channel Group. Max length of 80 characters.
*/
displayName?: string | null;
/**
* Required. The grouping rules of channels. Maximum number of rules is 50.
*/
groupingRule?: Schema$GoogleAnalyticsAdminV1alphaGroupingRule[];
/**
* Output only. The resource name for this Channel Group resource. Format: properties/{property\}/channelGroups/{ch