Gcp/analyticsadmin
@swamp/gcp/analyticsadminv2026.10.23.1
01README
Google Cloud analyticsadmin infrastructure models
02Release Notes
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
03Behaviors
@swamp/gcp/analyticsadmin/accountsv2026.10.23.1accounts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| createTime? | string | Output only. Time when this account was originally created. |
| deleted? | boolean | Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. |
| displayName? | string | Required. Human-readable display name for this account. |
| gmpOrganization? | string | 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} |
| name? | string | Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" |
| regionCode? | string | Country of business. Must be a Unicode CLDR region code. |
| updateTime? | string | Output only. Time when account payload fields were last updated. |
fn get(identifier: string)
Get a accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn update(identifier?: string)
Update accounts attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific accounts by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn sync(identifier?: string)
Sync accounts state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific accounts by name (e.g. one discovered by list) |
fn list(pageSize?: number, showDeleted?: boolean, maxPages?: number)
List accounts resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
| showDeleted? | boolean | Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_data_sharing_settings()
get data sharing settings
fn provision_account_ticket(account?: any, redirectUri?: any)
provision account ticket
| Argument | Type | Description |
|---|---|---|
| account? | any | |
| redirectUri? | any |
fn run_access_report(dateRanges?: any, dimensionFilter?: any, dimensions?: any, expandGroups?: any, includeAllUsers?: any, limit?: any, metricFilter?: any, metrics?: any, offset?: any, orderBys?: any, returnEntityQuota?: any, timeZone?: any)
run access report
| Argument | Type | Description |
|---|---|---|
| dateRanges? | any | |
| dimensionFilter? | any | |
| dimensions? | any | |
| expandGroups? | any | |
| includeAllUsers? | any | |
| limit? | any | |
| metricFilter? | any | |
| metrics? | any | |
| offset? | any | |
| orderBys? | any | |
| returnEntityQuota? | any | |
| timeZone? | any |
fn search_change_history_events(action?: any, actorEmail?: any, earliestChangeTime?: any, latestChangeTime?: any, pageSize?: any, pageToken?: any, property?: any, resourceType?: any)
search change history events
| Argument | Type | Description |
|---|---|---|
| action? | any | |
| actorEmail? | any | |
| earliestChangeTime? | any | |
| latestChangeTime? | any | |
| pageSize? | any | |
| pageToken? | any | |
| property? | any | |
| resourceType? | any |
Resources
state(infinite)— A resource message representing a Google Analytics account.
@swamp/gcp/analyticsadmin/accountsummariesv2026.10.23.1accountsummaries.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a accountSummaries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accountSummaries |
fn sync(identifier?: string)
Sync accountSummaries state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific accountSummaries by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List accountSummaries resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A virtual resource representing an overview of an account and all its child G...
@swamp/gcp/analyticsadmin/propertiesv2026.10.23.1properties.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| account? | string | Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123" |
| currencyCode? | string | The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY" |
| displayName? | string | Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. |
| industryCategory? | enum | Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK |
| name? | string | Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" |
| parent? | string | Immutable. Resource name of this property\ |
| propertyType? | enum | 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. |
| timeZone? | string | 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" |
fn create()
Create a properties
fn get(identifier: string)
Get a properties
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the properties |
fn update(identifier?: string)
Update properties attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific properties by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the properties
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the properties |
fn sync(identifier?: string)
Sync properties state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific properties by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, showDeleted?: boolean, maxPages?: number)
List properties resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties |
| pageSize? | number | Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
| showDeleted? | boolean | Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn acknowledge_user_data_collection(acknowledgement?: any)
acknowledge user data collection
| Argument | Type | Description |
|---|---|---|
| acknowledgement? | any |
fn get_data_retention_settings()
get data retention settings
fn run_access_report(dateRanges?: any, dimensionFilter?: any, dimensions?: any, expandGroups?: any, includeAllUsers?: any, limit?: any, metricFilter?: any, metrics?: any, offset?: any, orderBys?: any, returnEntityQuota?: any, timeZone?: any)
run access report
| Argument | Type | Description |
|---|---|---|
| dateRanges? | any | |
| dimensionFilter? | any | |
| dimensions? | any | |
| expandGroups? | any | |
| includeAllUsers? | any | |
| limit? | any | |
| metricFilter? | any | |
| metrics? | any | |
| offset? | any | |
| orderBys? | any | |
| returnEntityQuota? | any | |
| timeZone? | any |
fn update_data_retention_settings(eventDataRetention?: any, name?: any, resetUserDataOnNewActivity?: any, userDataRetention?: any, updateMask?: any)
update data retention settings
| Argument | Type | Description |
|---|---|---|
| eventDataRetention? | any | |
| name? | any | |
| resetUserDataOnNewActivity? | any | |
| userDataRetention? | any | |
| updateMask? | any |
Resources
state(infinite)— A resource message representing a Google Analytics property.
@swamp/gcp/analyticsadmin/properties-conversioneventsv2026.10.23.1properties_conversionevents.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| countingMethod? | enum | 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`. |
| defaultConversionValue? | object | Optional. Defines a default value/currency for a conversion event. |
| eventName? | string | Immutable. The event name for this conversion event. Examples: 'click', 'purchase' |
| name? | string | Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a conversionEvents
fn get(identifier: string)
Get a conversionEvents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversionEvents |
fn update(identifier?: string)
Update conversionEvents attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversionEvents by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the conversionEvents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversionEvents |
fn sync(identifier?: string)
Sync conversionEvents state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversionEvents by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List conversionEvents resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A conversion event in a Google Analytics property.
@swamp/gcp/analyticsadmin/properties-customdimensionsv2026.10.23.1properties_customdimensions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| description? | string | Optional. Description for this custom dimension. Max length of 150 characters. |
| disallowAdsPersonalization? | boolean | 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. |
| displayName? | string | 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. |
| name? | string | Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
| parameterName? | string | 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 dimens |
| scope? | enum | Required. Immutable. The scope of this dimension. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a customDimensions
fn get(identifier: string)
Get a customDimensions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customDimensions |
fn update(identifier?: string)
Update customDimensions attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customDimensions by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync customDimensions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customDimensions by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List customDimensions resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn archive()
archive
Resources
state(infinite)— A definition for a CustomDimension.
@swamp/gcp/analyticsadmin/properties-custommetricsv2026.10.23.1properties_custommetrics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| description? | string | Optional. Description for this custom dimension. Max length of 150 characters. |
| displayName? | string | 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. |
| measurementUnit? | enum | Required. The type for the custom metric's value. |
| name? | string | Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} |
| parameterName? | string | 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. |
| restrictedMetricType? | array | 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. |
| scope? | enum | Required. Immutable. The scope of this custom metric. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a customMetrics
fn get(identifier: string)
Get a customMetrics
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customMetrics |
fn update(identifier?: string)
Update customMetrics attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customMetrics by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync customMetrics state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customMetrics by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List customMetrics resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn archive()
archive
Resources
state(infinite)— A definition for a custom metric.
@swamp/gcp/analyticsadmin/properties-datastreamsv2026.10.23.1properties_datastreams.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| androidAppStreamData? | object | Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM. |
| displayName? | string | 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. |
| iosAppStreamData? | object | Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. |
| name? | string | Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" |
| type? | enum | Required. Immutable. The type of this DataStream resource. |
| webStreamData? | object | Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a dataStreams
fn get(identifier: string)
Get a dataStreams
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStreams |
fn update(identifier?: string)
Update dataStreams attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataStreams by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the dataStreams
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStreams |
fn sync(identifier?: string)
Sync dataStreams state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataStreams by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List dataStreams resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource message representing a data stream.
@swamp/gcp/analyticsadmin/properties-datastreams-measurementprotocolsecretsv2026.10.23.1properties_datastreams_measurementprotocolsecrets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| displayName? | string | Required. Human-readable display name for this secret. |
| name? | string | Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a measurementProtocolSecrets
fn get(identifier: string)
Get a measurementProtocolSecrets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the measurementProtocolSecrets |
fn update(identifier?: string)
Update measurementProtocolSecrets attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific measurementProtocolSecrets by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the measurementProtocolSecrets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the measurementProtocolSecrets |
fn sync(identifier?: string)
Sync measurementProtocolSecrets state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific measurementProtocolSecrets by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List measurementProtocolSecrets resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A secret value used for sending hits to Measurement Protocol.
@swamp/gcp/analyticsadmin/properties-firebaselinksv2026.10.23.1properties_firebaselinks.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name? | string | Identifier. Example format: properties/1234/firebaseLinks/5678 |
| project? | string | 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' |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a firebaseLinks
fn get(identifier: string)
Get a firebaseLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the firebaseLinks |
fn delete(identifier: string)
Delete the firebaseLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the firebaseLinks |
fn sync(identifier?: string)
Sync firebaseLinks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific firebaseLinks by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List firebaseLinks resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A link between a Google Analytics property and a Firebase project.
@swamp/gcp/analyticsadmin/properties-googleadslinksv2026.10.23.1properties_googleadslinks.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| adsPersonalizationEnabled? | boolean | 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. |
| customerId? | string | Immutable. Google Ads customer ID. |
| name? | string | Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a googleAdsLinks
fn get(identifier: string)
Get a googleAdsLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the googleAdsLinks |
fn update(identifier?: string)
Update googleAdsLinks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific googleAdsLinks by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the googleAdsLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the googleAdsLinks |
fn sync(identifier?: string)
Sync googleAdsLinks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific googleAdsLinks by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List googleAdsLinks resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A link between a Google Analytics property and a Google Ads account.
@swamp/gcp/analyticsadmin/properties-keyeventsv2026.10.23.1properties_keyevents.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| countingMethod? | enum | Required. The method by which Key Events will be counted across multiple events within a session. |
| defaultValue? | object | Optional. Defines a default value/currency for a key event. |
| eventName? | string | Immutable. The event name for this key event. Examples: 'click', 'purchase' |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a keyEvents
fn get(identifier: string)
Get a keyEvents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the keyEvents |
fn update(identifier?: string)
Update keyEvents attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific keyEvents by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the keyEvents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the keyEvents |
fn sync(identifier?: string)
Sync keyEvents state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific keyEvents by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List keyEvents resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A key event in a Google Analytics property.
04Previous Versions
2026.10.13.1
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.10.06.1
- Updated: accounts, properties, properties_googleadslinks
2026.09.07.1
- Updated: properties
2026.08.12.2
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.29.1
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.21.4
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.21.1
- Updated: properties_conversionevents, properties_datastreams, properties_keyevents
2026.07.20.2
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.20.1
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.19.1
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.18.1
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.17.2
- Updated: accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.07.17.1
- Updated: properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_keyevents
2026.07.13.1
- Updated: properties_firebaselinks
2026.06.09.1
- Updated: accountsummaries
2026.06.08.2
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.06.07.1
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.05.26.1
- Updated: accountsummaries, accounts, properties, properties_conversionevents, properties_customdimensions, properties_custommetrics, properties_datastreams, properties_datastreams_measurementprotocolsecrets, properties_firebaselinks, properties_googleadslinks, properties_keyevents
2026.05.25.2
- Updated: accountsummaries, accounts, properties
Modified 11 behaviors
05Stats
A
100 / 100
Downloads
35
Archive size
105.6 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels