googleapis
Version:
Google APIs Client Library for Node.js
1,120 lines • 302 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_v1beta {
export interface Options extends GlobalOptions {
version: 'v1beta';
}
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('v1beta');
* ```
*/
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$GoogleAnalyticsAdminV1betaAccessBetweenFilter {
/**
* Begins with this number.
*/
fromValue?: Schema$GoogleAnalyticsAdminV1betaNumericValue;
/**
* Ends with this number.
*/
toValue?: Schema$GoogleAnalyticsAdminV1betaNumericValue;
}
/**
* A contiguous range of days: startDate, startDate + 1, ..., endDate.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessDateRange {
/**
* 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$GoogleAnalyticsAdminV1betaAccessDimension {
/**
* 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$GoogleAnalyticsAdminV1betaAccessDimensionHeader {
/**
* The dimension's name; for example 'userEmail'.
*/
dimensionName?: string | null;
}
/**
* The value of a dimension.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessDimensionValue {
/**
* 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$GoogleAnalyticsAdminV1betaAccessFilter {
/**
* A filter for two values.
*/
betweenFilter?: Schema$GoogleAnalyticsAdminV1betaAccessBetweenFilter;
/**
* The dimension name or metric name.
*/
fieldName?: string | null;
/**
* A filter for in list values.
*/
inListFilter?: Schema$GoogleAnalyticsAdminV1betaAccessInListFilter;
/**
* A filter for numeric or date values.
*/
numericFilter?: Schema$GoogleAnalyticsAdminV1betaAccessNumericFilter;
/**
* Strings related filter.
*/
stringFilter?: Schema$GoogleAnalyticsAdminV1betaAccessStringFilter;
}
/**
* Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessFilterExpression {
/**
* 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$GoogleAnalyticsAdminV1betaAccessFilter;
/**
* Each of the FilterExpressions in the and_group has an AND relationship.
*/
andGroup?: Schema$GoogleAnalyticsAdminV1betaAccessFilterExpressionList;
/**
* The FilterExpression is NOT of not_expression.
*/
notExpression?: Schema$GoogleAnalyticsAdminV1betaAccessFilterExpression;
/**
* Each of the FilterExpressions in the or_group has an OR relationship.
*/
orGroup?: Schema$GoogleAnalyticsAdminV1betaAccessFilterExpressionList;
}
/**
* A list of filter expressions.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessFilterExpressionList {
/**
* A list of filter expressions.
*/
expressions?: Schema$GoogleAnalyticsAdminV1betaAccessFilterExpression[];
}
/**
* The result needs to be in a list of string values.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessInListFilter {
/**
* 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$GoogleAnalyticsAdminV1betaAccessMetric {
/**
* 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$GoogleAnalyticsAdminV1betaAccessMetricHeader {
/**
* The metric's name; for example 'accessCount'.
*/
metricName?: string | null;
}
/**
* The value of a metric.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessMetricValue {
/**
* The measurement value. For example, this value may be '13'.
*/
value?: string | null;
}
/**
* Filters for numeric or date values.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessNumericFilter {
/**
* The operation type for this filter.
*/
operation?: string | null;
/**
* A numeric value or a date value.
*/
value?: Schema$GoogleAnalyticsAdminV1betaNumericValue;
}
/**
* 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$GoogleAnalyticsAdminV1betaAccessOrderBy {
/**
* 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$GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy;
/**
* Sorts results by a metric's values.
*/
metric?: Schema$GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy;
}
/**
* Sorts by dimension values.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy {
/**
* 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$GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy {
/**
* 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$GoogleAnalyticsAdminV1betaAccessQuota {
/**
* Properties can use up to 50 concurrent requests.
*/
concurrentRequests?: Schema$GoogleAnalyticsAdminV1betaAccessQuotaStatus;
/**
* Properties and cloud project pairs can have up to 50 server errors per hour.
*/
serverErrorsPerProjectPerHour?: Schema$GoogleAnalyticsAdminV1betaAccessQuotaStatus;
/**
* Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
*/
tokensPerDay?: Schema$GoogleAnalyticsAdminV1betaAccessQuotaStatus;
/**
* 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$GoogleAnalyticsAdminV1betaAccessQuotaStatus;
/**
* 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$GoogleAnalyticsAdminV1betaAccessQuotaStatus;
}
/**
* Current state for a particular quota group.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessQuotaStatus {
/**
* 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$GoogleAnalyticsAdminV1betaAccessRow {
/**
* List of dimension values. These values are in the same order as specified in the request.
*/
dimensionValues?: Schema$GoogleAnalyticsAdminV1betaAccessDimensionValue[];
/**
* List of metric values. These values are in the same order as specified in the request.
*/
metricValues?: Schema$GoogleAnalyticsAdminV1betaAccessMetricValue[];
}
/**
* The filter for strings.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAccessStringFilter {
/**
* 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$GoogleAnalyticsAdminV1betaAccount {
/**
* 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$GoogleAnalyticsAdminV1betaAccountSummary {
/**
* 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$GoogleAnalyticsAdminV1betaPropertySummary[];
}
/**
* Request message for AcknowledgeUserDataCollection RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest {
/**
* 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$GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse {
}
/**
* Request message for ArchiveCustomDimension RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest {
}
/**
* Request message for ArchiveCustomMetric RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest {
}
/**
* A description of a change to a single Google Analytics resource.
*/
export interface Schema$GoogleAnalyticsAdminV1betaChangeHistoryChange {
/**
* 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$GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource;
/**
* Resource contents from before the change was made. If this resource was created in this change, this field will be missing.
*/
resourceBeforeChange?: Schema$GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource;
}
/**
* A snapshot of a resource as before or after the result of a change in change history.
*/
export interface Schema$GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource {
/**
* A snapshot of an Account resource in change history.
*/
account?: Schema$GoogleAnalyticsAdminV1betaAccount;
/**
* A snapshot of a ConversionEvent resource in change history.
*/
conversionEvent?: Schema$GoogleAnalyticsAdminV1betaConversionEvent;
/**
* A snapshot of a data retention settings resource in change history.
*/
dataRetentionSettings?: Schema$GoogleAnalyticsAdminV1betaDataRetentionSettings;
/**
* A snapshot of a DataStream resource in change history.
*/
dataStream?: Schema$GoogleAnalyticsAdminV1betaDataStream;
/**
* A snapshot of a FirebaseLink resource in change history.
*/
firebaseLink?: Schema$GoogleAnalyticsAdminV1betaFirebaseLink;
/**
* A snapshot of a GoogleAdsLink resource in change history.
*/
googleAdsLink?: Schema$GoogleAnalyticsAdminV1betaGoogleAdsLink;
/**
* A snapshot of a MeasurementProtocolSecret resource in change history.
*/
measurementProtocolSecret?: Schema$GoogleAnalyticsAdminV1betaMeasurementProtocolSecret;
/**
* A snapshot of a Property resource in change history.
*/
property?: Schema$GoogleAnalyticsAdminV1betaProperty;
}
/**
* 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$GoogleAnalyticsAdminV1betaChangeHistoryEvent {
/**
* 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$GoogleAnalyticsAdminV1betaChangeHistoryChange[];
/**
* 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$GoogleAnalyticsAdminV1betaConversionEvent {
/**
* Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to `ONCE_PER_EVENT`.
*/
countingMethod?: string | null;
/**
* 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;
/**
* Optional. Defines a default value/currency for a conversion event.
*/
defaultConversionValue?: Schema$GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue;
/**
* Output only. If set, this event can currently be deleted with 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;
}
/**
* Defines a default value/currency for a conversion event. Both value and currency must be provided.
*/
export interface Schema$GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue {
/**
* When a conversion event for this event_name has no set currency, this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
*/
currencyCode?: string | null;
/**
* This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset.
*/
value?: number | null;
}
/**
* A definition for a CustomDimension.
*/
export interface Schema$GoogleAnalyticsAdminV1betaCustomDimension {
/**
* 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. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. 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$GoogleAnalyticsAdminV1betaCustomMetric {
/**
* 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$GoogleAnalyticsAdminV1betaDataRetentionSettings {
/**
* Required. 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;
/**
* Required. The length of time that user-level data is retained.
*/
userDataRetention?: string | null;
}
/**
* A resource message representing data sharing settings of a Google Analytics account.
*/
export interface Schema$GoogleAnalyticsAdminV1betaDataSharingSettings {
/**
* Output only. Resource name. Format: accounts/{account\}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
*/
name?: string | null;
/**
* Deprecated. This field is no longer used and always returns false.
*/
sharingWithGoogleAnySalesEnabled?: boolean | null;
/**
* Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI.
*/
sharingWithGoogleAssignedSalesEnabled?: boolean | null;
/**
* Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI.
*/
sharingWithGoogleProductsEnabled?: boolean | null;
/**
* Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the "Technical support" field in the Google Analytics Admin UI.
*/
sharingWithGoogleSupportEnabled?: boolean | null;
/**
* Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the "Modeling contributions & business insights" field in the Google Analytics Admin UI.
*/
sharingWithOthersEnabled?: boolean | null;
}
/**
* A resource message representing a data stream.
*/
export interface Schema$GoogleAnalyticsAdminV1betaDataStream {
/**
* Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
*/
androidAppStreamData?: Schema$GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData;
/**
* Output only. Time when this stream was originally created.
*/
createTime?: string | null;
/**
* Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
*/
displayName?: string | null;
/**
* Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
*/
iosAppStreamData?: Schema$GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData;
/**
* Output only. Resource name of this Data Stream. Format: properties/{property_id\}/dataStreams/{stream_id\} Example: "properties/1000/dataStreams/2000"
*/
name?: string | null;
/**
* Required. Immutable. The type of this DataStream resource.
*/
type?: string | null;
/**
* Output only. Time when stream payload fields were last updated.
*/
updateTime?: string | null;
/**
* Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
*/
webStreamData?: Schema$GoogleAnalyticsAdminV1betaDataStreamWebStreamData;
}
/**
* Data specific to Android app streams.
*/
export interface Schema$GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData {
/**
* Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
*/
firebaseAppId?: string | null;
/**
* Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
*/
packageName?: string | null;
}
/**
* Data specific to iOS app streams.
*/
export interface Schema$GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData {
/**
* Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
*/
bundleId?: string | null;
/**
* Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
*/
firebaseAppId?: string | null;
}
/**
* Data specific to web streams.
*/
export interface Schema$GoogleAnalyticsAdminV1betaDataStreamWebStreamData {
/**
* Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
*/
defaultUri?: string | null;
/**
* Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
*/
firebaseAppId?: string | null;
/**
* Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
*/
measurementId?: string | null;
}
/**
* A link between a Google Analytics property and a Firebase project.
*/
export interface Schema$GoogleAnalyticsAdminV1betaFirebaseLink {
/**
* Output only. Time when this FirebaseLink was originally created.
*/
createTime?: string | null;
/**
* Output only. Example format: properties/1234/firebaseLinks/5678
*/
name?: string | null;
/**
* Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number\}' Example: 'projects/1234'
*/
project?: string | null;
}
/**
* A link between a Google Analytics property and a Google Ads account.
*/
export interface Schema$GoogleAnalyticsAdminV1betaGoogleAdsLink {
/**
* Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
*/
adsPersonalizationEnabled?: boolean | null;
/**
* Output only. If true, this link is for a Google Ads manager account.
*/
canManageClients?: boolean | null;
/**
* Output only. Time when this link was originally created.
*/
createTime?: string | null;
/**
* Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
*/
creatorEmailAddress?: string | null;
/**
* Immutable. Google Ads customer ID.
*/
customerId?: string | null;
/**
* Output only. Format: properties/{propertyId\}/googleAdsLinks/{googleAdsLinkId\} Note: googleAdsLinkId is not the Google Ads customer ID.
*/
name?: string | null;
/**
* Output only. Time when this link was last updated.
*/
updateTime?: string | null;
}
/**
* A key event in a Google Analytics property.
*/
export interface Schema$GoogleAnalyticsAdminV1betaKeyEvent {
/**
* Required. The method by which Key Events will be counted across multiple events within a session.
*/
countingMethod?: string | null;
/**
* Output only. Time when this key event was created in the property.
*/
createTime?: string | null;
/**
* Output only. If set to true, this key event refers to a custom event. If set to false, this key 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 key events that may be created per property.
*/
custom?: boolean | null;
/**
* Optional. Defines a default value/currency for a key event.
*/
defaultValue?: Schema$GoogleAnalyticsAdminV1betaKeyEventDefaultValue;
/**
* Output only. If set to true, this event can be deleted.
*/
deletable?: boolean | null;
/**
* Immutable. The event name for this key event. Examples: 'click', 'purchase'
*/
eventName?: string | null;
/**
* Output only. Resource name of this key event. Format: properties/{property\}/keyEvents/{key_event\}
*/
name?: string | null;
}
/**
* Defines a default value/currency for a key event.
*/
export interface Schema$GoogleAnalyticsAdminV1betaKeyEventDefaultValue {
/**
* Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
*/
currencyCode?: string | null;
/**
* Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
*/
numericValue?: number | null;
}
/**
* Request message for ListAccounts RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListAccountsResponse {
/**
* Results that were accessible to the caller.
*/
accounts?: Schema$GoogleAnalyticsAdminV1betaAccount[];
/**
* 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;
}
/**
* Response message for ListAccountSummaries RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListAccountSummariesResponse {
/**
* Account summaries of all accounts the caller has access to.
*/
accountSummaries?: Schema$GoogleAnalyticsAdminV1betaAccountSummary[];
/**
* 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;
}
/**
* Response message for ListConversionEvents RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListConversionEventsResponse {
/**
* The requested conversion events
*/
conversionEvents?: Schema$GoogleAnalyticsAdminV1betaConversionEvent[];
/**
* 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;
}
/**
* Response message for ListCustomDimensions RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListCustomDimensionsResponse {
/**
* List of CustomDimensions.
*/
customDimensions?: Schema$GoogleAnalyticsAdminV1betaCustomDimension[];
/**
* 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;
}
/**
* Response message for ListCustomMetrics RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListCustomMetricsResponse {
/**
* List of CustomMetrics.
*/
customMetrics?: Schema$GoogleAnalyticsAdminV1betaCustomMetric[];
/**
* 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;
}
/**
* Response message for ListDataStreams RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListDataStreamsResponse {
/**
* List of DataStreams.
*/
dataStreams?: Schema$GoogleAnalyticsAdminV1betaDataStream[];
/**
* 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;
}
/**
* Response message for ListFirebaseLinks RPC
*/
export interface Schema$GoogleAnalyticsAdminV1betaListFirebaseLinksResponse {
/**
* List of FirebaseLinks. This will have at most one value.
*/
firebaseLinks?: Schema$GoogleAnalyticsAdminV1betaFirebaseLink[];
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListGoogleAdsLinks RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse {
/**
* List of GoogleAdsLinks.
*/
googleAdsLinks?: Schema$GoogleAnalyticsAdminV1betaGoogleAdsLink[];
/**
* 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;
}
/**
* Response message for ListKeyEvents RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListKeyEventsResponse {
/**
* The requested Key Events
*/
keyEvents?: Schema$GoogleAnalyticsAdminV1betaKeyEvent[];
/**
* 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;
}
/**
* Response message for ListMeasurementProtocolSecret RPC
*/
export interface Schema$GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse {
/**
* A list of secrets for the parent stream specified in the request.
*/
measurementProtocolSecrets?: Schema$GoogleAnalyticsAdminV1betaMeasurementProtocolSecret[];
/**
* 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;
}
/**
* Response message for ListProperties RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaListPropertiesResponse {
/**
* 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;
/**
* Results that matched the filter criteria and were accessible to the caller.
*/
properties?: Schema$GoogleAnalyticsAdminV1betaProperty[];
}
/**
* A secret value used for sending hits to Measurement Protocol.
*/
export interface Schema$GoogleAnalyticsAdminV1betaMeasurementProtocolSecret {
/**
* Required. Human-readable display name for this secret.
*/
displayName?: string | null;
/**
* Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property\}/dataStreams/{dataStream\}/measurementProtocolSecrets/{measurementProtocolSecret\}
*/
name?: string | null;
/**
* Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
*/
secretValue?: string | null;
}
/**
* To represent a number.
*/
export interface Schema$GoogleAnalyticsAdminV1betaNumericValue {
/**
* Double value
*/
doubleValue?: number | null;
/**
* Integer value
*/
int64Value?: string | null;
}
/**
* A resource message representing a Google Analytics property.
*/
export interface Schema$GoogleAnalyticsAdminV1betaProperty {
/**
* Immutable. The resource name of the parent account Format: accounts/{account_id\} Example: "accounts/123"
*/
account?: string | null;
/**
* Output only. Time when the entity was originally created.
*/
createTime?: string | null;
/**
* The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
*/
currencyCode?: string | null;
/**
* Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
*/
deleteTime?: string | null;
/**
* Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
*/
displayName?: string | null;
/**
* Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
*/
expireTime?: string | null;
/**
* Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
*/
industryCategory?: string | null;
/**
* Output only. Resource name of this property. Format: properties/{property_id\} Example: "properties/1000"
*/
name?: string | null;
/**
* Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account\}, properties/{property\} Example: "accounts/100", "properties/101"
*/
parent?: string | null;
/**
* Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied.
*/
propertyType?: string | null;
/**
* Output only. The Google Analytics service level that applies to this property.
*/
serviceLevel?: string | null;
/**
* Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
*/
timeZone?: string | null;
/**
* Output only. Time when entity payload fields were last updated.
*/
updateTime?: string | null;
}
/**
* A virtual resource representing metadata for a Google Analytics property.
*/
export interface Schema$GoogleAnalyticsAdminV1betaPropertySummary {
/**
* Display name for the property referred to in this property summary.
*/
displayName?: string | null;
/**
* Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account\}, properties/{property\} Example: "accounts/100", "properties/200"
*/
parent?: string | null;
/**
* Resource name of property referred to by this property summary Format: properties/{property_id\} Example: "properties/1000"
*/
property?: string | null;
/**
* The property's property type.
*/
propertyType?: string | null;
}
/**
* Request message for ProvisionAccountTicket RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest {
/**
* The account to create.
*/
account?: Schema$GoogleAnalyticsAdminV1betaAccount;
/**
* Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI.
*/
redirectUri?: string | null;
}
/**
* Response message for ProvisionAccountTicket RPC.
*/
export interface Schema$GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse {
/**
* The param to be passed in the ToS link.
*/
accountTicketId?: string | null;
}
/**
* The request for a Data Access Record Report.
*/
export interface Schema$GoogleAnalyticsAdminV1betaRunAccessReportRequest {
/**
* Date ranges of access records 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 access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up t