Skip to main content
← back to extensions

@swamp/gcp/analyticsadmin

v2026.04.23.1

Google Cloud analyticsadmin infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudanalyticsadmincloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/analyticsadmin

@swamp/gcp/analyticsadmin/accountsv2026.04.23.1accounts.ts

Global Arguments

ArgumentTypeDescription
createTime?stringOutput only. Time when this account was originally created.
deleted?booleanOutput only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
displayName?stringRequired. Human-readable display name for this account.
gmpOrganization?stringOutput 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?stringIdentifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
regionCode?stringCountry of business. Must be a Unicode CLDR region code.
updateTime?stringOutput only. Time when account payload fields were last updated.
getGet a accounts
ArgumentTypeDescription
identifierstringThe name of the accounts
updateUpdate accounts attributes
deleteDelete the accounts
ArgumentTypeDescription
identifierstringThe name of the accounts
syncSync accounts state from GCP
get_data_sharing_settingsget data sharing settings
provision_account_ticketprovision account ticket
ArgumentTypeDescription
account?any
redirectUri?any
run_access_reportrun access report
ArgumentTypeDescription
dateRanges?any
dimensionFilter?any
dimensions?any
expandGroups?any
includeAllUsers?any
limit?any
metricFilter?any
metrics?any
offset?any
orderBys?any
returnEntityQuota?any
timeZone?any
search_change_history_eventssearch change history events
ArgumentTypeDescription
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.04.23.1accountsummaries.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a accountSummaries
ArgumentTypeDescription
identifierstringThe name of the accountSummaries
syncSync accountSummaries state from GCP

Resources

state(infinite)— A virtual resource representing an overview of an account and all its child G...
@swamp/gcp/analyticsadmin/propertiesv2026.04.23.1properties.ts

Global Arguments

ArgumentTypeDescription
account?stringImmutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
currencyCode?stringThe currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
displayName?stringRequired. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
industryCategory?enumIndustry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
name?stringIdentifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
parent?stringImmutable. Resource name of this property\
propertyType?enumImmutable. 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?stringRequired. 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"
createCreate a properties
getGet a properties
ArgumentTypeDescription
identifierstringThe name of the properties
updateUpdate properties attributes
deleteDelete the properties
ArgumentTypeDescription
identifierstringThe name of the properties
syncSync properties state from GCP
acknowledge_user_data_collectionacknowledge user data collection
ArgumentTypeDescription
acknowledgement?any
get_data_retention_settingsget data retention settings
run_access_reportrun access report
ArgumentTypeDescription
dateRanges?any
dimensionFilter?any
dimensions?any
expandGroups?any
includeAllUsers?any
limit?any
metricFilter?any
metrics?any
offset?any
orderBys?any
returnEntityQuota?any
timeZone?any
update_data_retention_settingsupdate data retention settings
ArgumentTypeDescription
eventDataRetention?any
name?any
resetUserDataOnNewActivity?any
userDataRetention?any

Resources

state(infinite)— A resource message representing a Google Analytics property.
@swamp/gcp/analyticsadmin/properties-conversioneventsv2026.04.23.1properties_conversionevents.ts

Global Arguments

ArgumentTypeDescription
countingMethod?enumOptional. 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?objectDefines a default value/currency for a conversion event. Both value and currency must be provided.
eventName?stringImmutable. The event name for this conversion event. Examples: 'click', 'purchase'
name?stringIdentifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a conversionEvents
getGet a conversionEvents
ArgumentTypeDescription
identifierstringThe name of the conversionEvents
updateUpdate conversionEvents attributes
deleteDelete the conversionEvents
ArgumentTypeDescription
identifierstringThe name of the conversionEvents
syncSync conversionEvents state from GCP

Resources

state(infinite)— A conversion event in a Google Analytics property.
@swamp/gcp/analyticsadmin/properties-customdimensionsv2026.04.23.1properties_customdimensions.ts

Global Arguments

ArgumentTypeDescription
description?stringOptional. Description for this custom dimension. Max length of 150 characters.
disallowAdsPersonalization?booleanOptional. 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?stringRequired. 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?stringIdentifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
parameterName?stringRequired. 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?enumRequired. Immutable. The scope of this dimension.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a customDimensions
getGet a customDimensions
ArgumentTypeDescription
identifierstringThe name of the customDimensions
updateUpdate customDimensions attributes
syncSync customDimensions state from GCP
archivearchive

Resources

state(infinite)— A definition for a CustomDimension.
@swamp/gcp/analyticsadmin/properties-custommetricsv2026.04.23.1properties_custommetrics.ts

Global Arguments

ArgumentTypeDescription
description?stringOptional. Description for this custom dimension. Max length of 150 characters.
displayName?stringRequired. 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?enumRequired. The type for the custom metric's value.
name?stringIdentifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
parameterName?stringRequired. 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?arrayOptional. 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?enumRequired. Immutable. The scope of this custom metric.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a customMetrics
getGet a customMetrics
ArgumentTypeDescription
identifierstringThe name of the customMetrics
updateUpdate customMetrics attributes
syncSync customMetrics state from GCP
archivearchive

Resources

state(infinite)— A definition for a custom metric.
@swamp/gcp/analyticsadmin/properties-datastreamsv2026.04.23.1properties_datastreams.ts

Global Arguments

ArgumentTypeDescription
androidAppStreamData?objectData specific to Android app streams.
displayName?stringHuman-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?objectData specific to iOS app streams.
name?stringIdentifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
type?enumRequired. Immutable. The type of this DataStream resource.
webStreamData?objectData specific to web streams.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a dataStreams
getGet a dataStreams
ArgumentTypeDescription
identifierstringThe name of the dataStreams
updateUpdate dataStreams attributes
deleteDelete the dataStreams
ArgumentTypeDescription
identifierstringThe name of the dataStreams
syncSync dataStreams state from GCP

Resources

state(infinite)— A resource message representing a data stream.
@swamp/gcp/analyticsadmin/properties-datastreams-measurementprotocolsecretsv2026.04.23.1properties_datastreams_measurementprotocolsecrets.ts

Global Arguments

ArgumentTypeDescription
displayName?stringRequired. Human-readable display name for this secret.
name?stringIdentifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a measurementProtocolSecrets
getGet a measurementProtocolSecrets
ArgumentTypeDescription
identifierstringThe name of the measurementProtocolSecrets
updateUpdate measurementProtocolSecrets attributes
deleteDelete the measurementProtocolSecrets
ArgumentTypeDescription
identifierstringThe name of the measurementProtocolSecrets
syncSync measurementProtocolSecrets state from GCP

Resources

state(infinite)— A secret value used for sending hits to Measurement Protocol.
@swamp/gcp/analyticsadmin/properties-firebaselinksv2026.04.23.1properties_firebaselinks.ts

Global Arguments

ArgumentTypeDescription
name?stringIdentifier. Example format: properties/1234/firebaseLinks/5678
project?stringImmutable. 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?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a firebaseLinks
getGet a firebaseLinks
ArgumentTypeDescription
identifierstringThe name of the firebaseLinks
deleteDelete the firebaseLinks
ArgumentTypeDescription
identifierstringThe name of the firebaseLinks
syncSync firebaseLinks state from GCP

Resources

state(infinite)— A link between a Google Analytics property and a Firebase project.
@swamp/gcp/analyticsadmin/properties-googleadslinksv2026.04.23.1properties_googleadslinks.ts

Global Arguments

ArgumentTypeDescription
adsPersonalizationEnabled?booleanEnable 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?stringImmutable. Google Ads customer ID.
name?stringIdentifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a googleAdsLinks
getGet a googleAdsLinks
ArgumentTypeDescription
identifierstringThe name of the googleAdsLinks
updateUpdate googleAdsLinks attributes
deleteDelete the googleAdsLinks
ArgumentTypeDescription
identifierstringThe name of the googleAdsLinks
syncSync googleAdsLinks state from GCP

Resources

state(infinite)— A link between a Google Analytics property and a Google Ads account.
@swamp/gcp/analyticsadmin/properties-keyeventsv2026.04.23.1properties_keyevents.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
countingMethod?enumRequired. The method by which Key Events will be counted across multiple events within a session.
defaultValue?objectDefines a default value/currency for a key event.
eventName?stringImmutable. The event name for this key event. Examples: 'click', 'purchase'
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a keyEvents
getGet a keyEvents
ArgumentTypeDescription
identifierstringThe name of the keyEvents
updateUpdate keyEvents attributes
deleteDelete the keyEvents
ArgumentTypeDescription
identifierstringThe name of the keyEvents
syncSync keyEvents state from GCP

Resources

state(infinite)— A key event in a Google Analytics property.