googleapis
Version:
Google APIs Client Library for Node.js
1,111 lines • 485 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, 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
*
*
*
* @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 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. 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 GA4 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 {
}
/**
* 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;
/**
* 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 a GA4 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;
/**
* 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. null 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.
*/
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 (i.e., 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 (i.e., 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 (i.e., users satisfying the filter clause are included in the Audience) or exclusive (i.e., 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 (i.e., 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 (i.e., 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;
}
/**
* Read-only resource used to summarize a principal's effective roles.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAuditUserLink {
/**
* Roles directly assigned to this user for this entity. Format: predefinedRoles/viewer Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.
*/
directRoles?: string[] | null;
/**
* Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/viewer
*/
effectiveRoles?: string[] | null;
/**
* Email address of the linked user
*/
emailAddress?: string | null;
/**
* Example format: properties/1234/userLinks/5678
*/
name?: string | null;
}
/**
* Request message for AuditUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAuditUserLinksRequest {
/**
* The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.
*/
pageSize?: number | null;
/**
* A page token, received from a previous `AuditUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `AuditUserLinks` must match the call that provided the page token.
*/
pageToken?: string | null;
}
/**
* Response message for AuditUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaAuditUserLinksResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.
*/
userLinks?: Schema$GoogleAnalyticsAdminV1alphaAuditUserLink[];
}
/**
* Request message for BatchCreateUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest {
/**
* Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.
*/
notifyNewUsers?: boolean | null;
/**
* Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.
*/
requests?: Schema$GoogleAnalyticsAdminV1alphaCreateUserLinkRequest[];
}
/**
* Response message for BatchCreateUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse {
/**
* The user links created.
*/
userLinks?: Schema$GoogleAnalyticsAdminV1alphaUserLink[];
}
/**
* Request message for BatchDeleteUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest {
/**
* Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
*/
requests?: Schema$GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest[];
}
/**
* Response message for BatchGetUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse {
/**
* The requested user links.
*/
userLinks?: Schema$GoogleAnalyticsAdminV1alphaUserLink[];
}
/**
* Request message for BatchUpdateUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest {
/**
* Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
*/
requests?: Schema$GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest[];
}
/**
* Response message for BatchUpdateUserLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse {
/**
* The user links updated.
*/
userLinks?: Schema$GoogleAnalyticsAdminV1alphaUserLink[];
}
/**
* 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 AttributionSettings resource in change history.
*/
attributionSettings?: Schema$GoogleAnalyticsAdminV1alphaAttributionSettings;
/**
* 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 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 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 MeasurementProtocolSecret resource in change history.
*/
measurementProtocolSecret?: Schema$GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret;
/**
* A snapshot of a Property resource in change history.
*/
property?: Schema$GoogleAnalyticsAdminV1alphaProperty;
/**
* A snapshot of a SearchAds360Link resource in change history.
*/
searchAds360Link?: Schema$GoogleAnalyticsAdminV1alphaSearchAds360Link;
}
/**
* 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 conversion event in a Google Analytics property.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaConversionEvent {
/**
* Output only. Time when this conversion event was created in the property.
*/
createTime?: string | null;
/**
* Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
*/
custom?: boolean | null;
/**
* Output only. If set, this event can currently be deleted via DeleteConversionEvent.
*/
deletable?: boolean | null;
/**
* Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
*/
eventName?: string | null;
/**
* Output only. Resource name of this conversion event. Format: properties/{property\}/conversionEvents/{conversion_event\}
*/
name?: string | null;
}
/**
* Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the "primary" email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the "primary" email address. As a result, the input and output email address for this request may differ.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaCreateUserLinkRequest {
/**
* Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.
*/
notifyNewUser?: boolean | null;
/**
* Required. Example format: accounts/1234
*/
parent?: string | null;
/**
* Required. The user link to create.
*/
userLink?: Schema$GoogleAnalyticsAdminV1alphaUserLink;
}
/**
* A definition for a CustomDimension.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaCustomDimension {
/**
* Optional. Description for this custom dimension. Max length of 150 characters.
*/
description?: string | null;
/**
* Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
*/
disallowAdsPersonalization?: boolean | null;
/**
* Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
*/
displayName?: string | null;
/**
* Output only. Resource name for this CustomDimension resource. Format: properties/{property\}/customDimensions/{customDimension\}
*/
name?: string | null;
/**
* Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
*/
parameterName?: string | null;
/**
* Required. Immutable. The scope of this dimension.
*/
scope?: string | null;
}
/**
* A definition for a custom metric.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaCustomMetric {
/**
* Optional. Description for this custom dimension. Max length of 150 characters.
*/
description?: string | null;
/**
* Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
*/
displayName?: string | null;
/**
* Required. The type for the custom metric's value.
*/
measurementUnit?: string | null;
/**
* Output only. Resource name for this CustomMetric resource. Format: properties/{property\}/customMetrics/{customMetric\}
*/
name?: string | null;
/**
* Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
*/
parameterName?: string | null;
/**
* Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
*/
restrictedMetricType?: string[] | null;
/**
* Required. Immutable. The scope of this custom metric.
*/
scope?: string | null;
}
/**
* Settings values for data retention. This is a singleton resource.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaDataRetentionSettings {
/**
* The length of time that event-level data is retained.
*/
eventDataRetention?: string | null;
/**
* Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property\}/dataRetentionSettings
*/
name?: string | null;
/**
* If true, reset the retention period for the user identifier with every event from that user.
*/
resetUserDataOnNewActivity?: boolean | null;
}
/**
* A resource message representing data sharing settings of a Google Analytics account.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaDataSharingSettings {
/**
* Output only. Resource name. Format: accounts/{account\}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
*/
name?: string | null;
/**
* Allows any of Google sales to access the data in order to suggest configuration changes to improve results.
*/
sharingWithGoogleAnySalesEnabled?: boolean | null;
/**
* Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.
*/
sharingWithGoogleAssignedSalesEnabled?: boolean | null;
/**
* Allows Google to use the data to improve other Google products or services.
*/
sharingWithGoogleProductsEnabled?: boolean | null;
/**
* Allows Google support to access the data in order to help troubleshoot issues.
*/
sharingWithGoogleSupportEnabled?: boolean | null;
/**
* Allows Google to share the data anonymously in aggregate form with others.
*/
sharingWithOthersEnabled?: boolean | null;
}
/**
* A resource message representing a data stream.
*/
export interface Schema$GoogleAnalyticsAdminV1alphaDataStream {
/**
* Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
*/
androidAppStreamData?: Schema$GoogleAnalyticsAdminV1alphaDataStreamAndroidA