Gcp/analytics
@swamp/gcp/analyticsv2026.07.21.2
01README
Google Cloud analytics infrastructure models
02Release Notes
- Updated: data_ga, data_mcf, data_realtime, management_accountsummaries, management_accountuserlinks, management_accounts, management_customdatasources, management_customdimensions, management_custommetrics, management_experiments, management_filters, management_goals, management_profilefilterlinks, management_profileuserlinks, management_profiles, management_remarketingaudience, management_segments, management_unsampledreports, management_uploads, management_webpropertyadwordslinks, management_webproperties, management_webpropertyuserlinks, metadata_columns
03Models
@swamp/gcp/analytics/data-gav2026.07.21.2data_ga.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. |
| ids | string | Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. |
| start_date | string | Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. |
| end_date | string | End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. |
fn get(identifier: string)
Get a ga
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the ga |
fn sync(identifier?: string)
Sync ga state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific ga by name (e.g. one discovered by list) |
Resources
state(infinite)— Analytics data for a given view (profile).
@swamp/gcp/analytics/data-mcfv2026.07.21.2data_mcf.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. |
| ids | string | Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. |
| start_date | string | Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. |
| end_date | string | End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. |
fn get(identifier: string)
Get a mcf
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the mcf |
fn sync(identifier?: string)
Sync mcf state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific mcf by name (e.g. one discovered by list) |
Resources
state(infinite)— Multi-Channel Funnels data for a given view (profile).
@swamp/gcp/analytics/data-realtimev2026.07.21.2data_realtime.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. |
| ids | string | Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. |
fn get(identifier: string)
Get a realtime
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the realtime |
fn sync(identifier?: string)
Sync realtime state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific realtime by name (e.g. one discovered by list) |
Resources
state(infinite)— Real time data for a given view (profile).
@swamp/gcp/analytics/management-accountsv2026.07.21.2management_accounts.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. |
fn get(identifier: string)
Get a 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(max_results?: number, start_index?: number, maxPages?: number)
List accounts resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of accounts to include in this response. |
| start_index? | number | An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for Analytics account entry.
@swamp/gcp/analytics/management-accountsummariesv2026.07.21.2management_accountsummaries.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. |
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(max_results?: number, start_index?: number, maxPages?: number)
List accountSummaries resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of account summaries to include in this response, where the largest acceptable value is 1000. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics AccountSummary. An AccountSummary is a lightwe...
@swamp/gcp/analytics/management-accountuserlinksv2026.07.21.2management_accountuserlinks.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. |
| entity? | object | Entity for this link. It can be an account, a web property, or a view (profile). |
| id? | string | Entity user link ID |
| permissions? | object | Permissions the user has for this entity. |
| userRef? | object | User reference. |
| accountId | string | Account ID to create the user link for. |
fn create()
Create a accountUserLinks
fn get(identifier: string)
Get a accountUserLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accountUserLinks |
fn update(identifier?: string)
Update accountUserLinks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific accountUserLinks by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the accountUserLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accountUserLinks |
fn sync(identifier?: string)
Sync accountUserLinks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific accountUserLinks by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List accountUserLinks resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of account-user links to include in this response. |
| start_index? | number | An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics Entity-User Link. Returns permissions that a u...
@swamp/gcp/analytics/management-customdatasourcesv2026.07.21.2management_customdatasources.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. |
| accountId | string | Account Id for the custom data sources to retrieve. |
| webPropertyId | string | Web property Id for the custom data sources to retrieve. |
fn get(identifier: string)
Get a customDataSources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customDataSources |
fn sync(identifier?: string)
Sync customDataSources state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customDataSources by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List customDataSources resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of custom data sources to include in this response. |
| start_index? | number | A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics custom data source.
@swamp/gcp/analytics/management-customdimensionsv2026.07.21.2management_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. |
| accountId? | string | Account ID. |
| active? | boolean | Boolean indicating whether the custom dimension is active. |
| created? | string | Time the custom dimension was created. |
| id? | string | Custom dimension ID. |
| index? | number | Index of the custom dimension. |
| name? | string | Name of the custom dimension. |
| parentLink? | object | Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| scope? | string | Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| updated? | string | Time the custom dimension was last modified. |
| webPropertyId? | string | Property ID. |
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(max_results?: number, start_index?: number, maxPages?: number)
List customDimensions resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of custom dimensions to include in this response. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for Analytics Custom Dimension.
@swamp/gcp/analytics/management-custommetricsv2026.07.21.2management_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. |
| accountId? | string | Account ID. |
| active? | boolean | Boolean indicating whether the custom metric is active. |
| created? | string | Time the custom metric was created. |
| id? | string | Custom metric ID. |
| index? | number | Index of the custom metric. |
| max_value? | string | Max value of custom metric. |
| min_value? | string | Min value of custom metric. |
| name? | string | Name of the custom metric. |
| parentLink? | object | Parent link for the custom metric. Points to the property to which the custom metric belongs. |
| scope? | string | Scope of the custom metric: HIT or PRODUCT. |
| type? | string | Data type of custom metric. |
| updated? | string | Time the custom metric was last modified. |
| webPropertyId? | string | Property ID. |
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(max_results?: number, start_index?: number, maxPages?: number)
List customMetrics resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of custom metrics to include in this response. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for Analytics Custom Metric.
@swamp/gcp/analytics/management-experimentsv2026.07.21.2management_experiments.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. |
| accountId? | string | Account ID to which this experiment belongs. This field is read-only. |
| created? | string | Time the experiment was created. This field is read-only. |
| description? | string | Notes about this experiment. |
| editableInGaUi? | boolean | If true, the end user will be able to edit the experiment via the Google Analytics user interface. |
| endTime? | string | The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only. |
| equalWeighting? | boolean | Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED. |
| id? | string | Experiment ID. Required for patch and update. Disallowed for create. |
| internalWebPropertyId? | string | Internal ID for the web property to which this experiment belongs. This field is read-only. |
| minimumExperimentLengthInDays? | number | An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED. |
| name | string | Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment. |
| objectiveMetric? | string | The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API". |
| optimizationType? | string | Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED". |
| parentLink? | object | Parent link for an experiment. Points to the view (profile) to which this experiment belongs. |
| profileId? | string | View (Profile) ID to which this experiment belongs. This field is read-only. |
| reasonExperimentEnded? | string | Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn\ |
| rewriteVariationUrlsAsOriginal? | boolean | Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED. |
| servingFramework? | string | The framework used to serve the experiment variations and evaluate the results. One of: - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is r |
| snippet? | string | The snippet of code to include on the control page(s). This field is read-only. |
| startTime? | string | The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only. |
| status | string | Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment. |
| trafficCoverage | number | |
| updated? | string | Time the experiment was last modified. This field is read-only. |
| variations? | array | Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING. |
| webPropertyId? | string | Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only. |
| winnerConfidenceLevel? | number | A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED. |
| winnerFound? | boolean | Boolean specifying whether a winner has been found for this experiment. This field is read-only. |
fn create()
Create a experiments
fn get(identifier: string)
Get a experiments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the experiments |
fn update(identifier?: string)
Update experiments attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific experiments by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the experiments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the experiments |
fn sync(identifier?: string)
Sync experiments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific experiments by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List experiments resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of experiments to include in this response. |
| start_index? | number | An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for Analytics experiment resource.
@swamp/gcp/analytics/management-filtersv2026.07.21.2management_filters.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. |
| accountId? | string | Account ID to which this filter belongs. |
| advancedDetails? | object | Details for the filter of the type ADVANCED. |
| created? | string | Time this filter was created. |
| excludeDetails? | object | Details for the filter of the type EXCLUDE. |
| id? | string | Filter ID. |
| includeDetails? | object | Details for the filter of the type INCLUDE. |
| lowercaseDetails? | object | Details for the filter of the type LOWER. |
| name | string | Name of this filter. |
| parentLink? | object | Parent link for this filter. Points to the account to which this filter belongs. |
| searchAndReplaceDetails? | object | Details for the filter of the type SEARCH_AND_REPLACE. |
| type | string | Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. |
| updated? | string | Time this filter was last modified. |
| uppercaseDetails? | object | Details for the filter of the type UPPER. |
fn create()
Create a filters
fn get(identifier: string)
Get a filters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filters |
fn update(identifier?: string)
Update filters attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific filters by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the filters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the filters |
fn sync(identifier?: string)
Sync filters state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific filters by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List filters resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of filters to include in this response. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics account filter.
@swamp/gcp/analytics/management-goalsv2026.07.21.2management_goals.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. |
| accountId? | string | Account ID to which this goal belongs. |
| active? | boolean | Determines whether this goal is active. |
| created? | string | Time this goal was created. |
| eventDetails? | object | Details for the goal of the type EVENT. |
| id? | string | Goal ID. |
| internalWebPropertyId? | string | Internal ID for the web property to which this goal belongs. |
| name? | string | Goal name. |
| parentLink? | object | Parent link for a goal. Points to the view (profile) to which this goal belongs. |
| profileId? | string | View (Profile) ID to which this goal belongs. |
| type? | string | Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT. |
| updated? | string | Time this goal was last modified. |
| urlDestinationDetails? | object | Details for the goal of the type URL_DESTINATION. |
| value? | number | Goal value. |
| visitNumPagesDetails? | object | Details for the goal of the type VISIT_NUM_PAGES. |
| visitTimeOnSiteDetails? | object | Details for the goal of the type VISIT_TIME_ON_SITE. |
| webPropertyId? | string | Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY. |
fn create()
Create a goals
fn get(identifier: string)
Get a goals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the goals |
fn update(identifier?: string)
Update goals attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific goals by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync goals state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific goals by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List goals resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of goals to include in this response. |
| start_index? | number | An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for Analytics goal resource.
@swamp/gcp/analytics/management-profilefilterlinksv2026.07.21.2management_profilefilterlinks.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. |
| filterRef? | object | Filter for this link. |
| id? | string | Profile filter link ID. |
| profileRef? | object | View (Profile) for this link. |
| rank? | number | The rank of this profile filter link relative to the other filters linked to the same profile. For readonly (i.e., list and get) operations, the rank always starts at 1. For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify |
| accountId | string | Account ID to create profile filter link for. |
| webPropertyId | string | Web property Id to create profile filter link for. |
| profileId | string | Profile ID to create filter link for. |
fn create()
Create a profileFilterLinks
fn get(identifier: string)
Get a profileFilterLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the profileFilterLinks |
fn update(identifier?: string)
Update profileFilterLinks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific profileFilterLinks by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the profileFilterLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the profileFilterLinks |
fn sync(identifier?: string)
Sync profileFilterLinks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific profileFilterLinks by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List profileFilterLinks resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of profile filter links to include in this response. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics profile filter link.
@swamp/gcp/analytics/management-profilesv2026.07.21.2management_profiles.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. |
| accountId? | string | Account ID to which this view (profile) belongs. |
| botFilteringEnabled? | boolean | Indicates whether bot filtering is enabled for this view (profile). |
| childLink? | object | Child link for this view (profile). Points to the list of goals for this view (profile). |
| created? | string | Time this view (profile) was created. |
| currency? | string | The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL |
| defaultPage? | string | Default page for this view (profile). |
| eCommerceTracking? | boolean | Indicates whether ecommerce tracking is enabled for this view (profile). |
| enhancedECommerceTracking? | boolean | Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. |
| excludeQueryParameters? | string | The query parameters that are excluded from this view (profile). |
| id? | string | View (Profile) ID. |
| internalWebPropertyId? | string | Internal ID for the web property to which this view (profile) belongs. |
| name? | string | Name of this view (profile). |
| parentLink? | object | Parent link for this view (profile). Points to the web property to which this view (profile) belongs. |
| permissions? | object | Permissions the user has for this view (profile). |
| siteSearchCategoryParameters? | string | Site search category parameters for this view (profile). |
| siteSearchQueryParameters? | string | The site search query parameters for this view (profile). |
| starred? | boolean | Indicates whether this view (profile) is starred or not. |
| stripSiteSearchCategoryParameters? | boolean | Whether or not Analytics will strip search category parameters from the URLs in your reports. |
| stripSiteSearchQueryParameters? | boolean | Whether or not Analytics will strip search query parameters from the URLs in your reports. |
| timezone? | string | Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. |
| type? | string | View (Profile) type. Supported types: WEB or APP. |
| updated? | string | Time this view (profile) was last modified. |
| webPropertyId? | string | Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. |
| websiteUrl? | string | Website URL for this view (profile). |
fn create()
Create a profiles
fn get(identifier: string)
Get a profiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the profiles |
fn update(identifier?: string)
Update profiles attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific profiles by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the profiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the profiles |
fn sync(identifier?: string)
Sync profiles state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific profiles by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List profiles resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of views (profiles) to include in this response. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics view (profile).
@swamp/gcp/analytics/management-profileuserlinksv2026.07.21.2management_profileuserlinks.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. |
| entity? | object | Entity for this link. It can be an account, a web property, or a view (profile). |
| id? | string | Entity user link ID |
| permissions? | object | Permissions the user has for this entity. |
| userRef? | object | User reference. |
| accountId | string | Account ID to create the user link for. |
| webPropertyId | string | Web Property ID to create the user link for. |
| profileId | string | View (Profile) ID to create the user link for. |
fn create()
Create a profileUserLinks
fn get(identifier: string)
Get a profileUserLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the profileUserLinks |
fn update(identifier?: string)
Update profileUserLinks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific profileUserLinks by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the profileUserLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the profileUserLinks |
fn sync(identifier?: string)
Sync profileUserLinks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific profileUserLinks by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List profileUserLinks resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of profile-user links to include in this response. |
| start_index? | number | An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics Entity-User Link. Returns permissions that a u...
@swamp/gcp/analytics/management-remarketingaudiencev2026.07.21.2management_remarketingaudience.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. |
| accountId? | string | Account ID to which this remarketing audience belongs. |
| audienceDefinition? | object | The simple audience definition that will cause a user to be added to an audience. |
| audienceType? | string | The type of audience, either SIMPLE or STATE_BASED. |
| created? | string | Time this remarketing audience was created. |
| description? | string | The description of this remarketing audience. |
| id? | string | Remarketing Audience ID. |
| internalWebPropertyId? | string | Internal ID for the web property to which this remarketing audience belongs. |
| linkedAdAccounts? | array | The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. |
| linkedViews? | array | The views (profiles) that this remarketing audience is linked to. |
| name? | string | The name of this remarketing audience. |
| stateBasedAudienceDefinition? | object | A state based audience definition that will cause a user to be added or removed from an audience. |
| updated? | string | Time this remarketing audience was last modified. |
| webPropertyId? | string | Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. |
fn create()
Create a remarketingAudience
fn get(identifier: string)
Get a remarketingAudience
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the remarketingAudience |
fn update(identifier?: string)
Update remarketingAudience attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific remarketingAudience by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the remarketingAudience
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the remarketingAudience |
fn sync(identifier?: string)
Sync remarketingAudience state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific remarketingAudience by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, type?: string, maxPages?: number)
List remarketingAudience resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of remarketing audiences to include in this response. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| type? | string | |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics remarketing audience.
@swamp/gcp/analytics/management-segmentsv2026.07.21.2management_segments.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. |
fn get(identifier: string)
Get a segments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the segments |
fn sync(identifier?: string)
Sync segments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific segments by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List segments resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of segments to include in this response. |
| start_index? | number | An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics segment.
@swamp/gcp/analytics/management-unsampledreportsv2026.07.21.2management_unsampledreports.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. |
| accountId? | string | Account ID to which this unsampled report belongs. |
| cloudStorageDownloadDetails? | object | Download details for a file stored in Google Cloud Storage. |
| created? | string | Time this unsampled report was created. |
| dimensions? | string | The dimensions for the unsampled report. |
| downloadType? | string | The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. |
| driveDownloadDetails? | object | Download details for a file stored in Google Drive. |
| end_date? | string | The end date for the unsampled report. |
| filters? | string | The filters for the unsampled report. |
| id? | string | Unsampled report ID. |
| metrics | string | The metrics for the unsampled report. |
| profileId? | string | View (Profile) ID to which this unsampled report belongs. |
| segment? | string | The segment for the unsampled report. |
| start_date? | string | The start date for the unsampled report. |
| status? | string | Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. |
| title | string | Title of the unsampled report. |
| updated? | string | Time this unsampled report was last modified. |
| webPropertyId? | string | Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. |
fn create()
Create a unsampledReports
fn get(identifier: string)
Get a unsampledReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the unsampledReports |
fn delete(identifier: string)
Delete the unsampledReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the unsampledReports |
fn sync(identifier?: string)
Sync unsampledReports state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific unsampledReports by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List unsampledReports resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of unsampled reports to include in this response. |
| start_index? | number | An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for Analytics unsampled report resource.
@swamp/gcp/analytics/management-uploadsv2026.07.21.2management_uploads.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. |
| accountId | string | Account Id for the upload to retrieve. |
| webPropertyId | string | Web property Id for the upload to retrieve. |
| customDataSourceId | string | Custom data source Id for upload to retrieve. |
fn get(identifier: string)
Get a uploads
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the uploads |
fn delete(identifier: string)
Delete the uploads
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the uploads |
fn sync(identifier?: string)
Sync uploads state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific uploads by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List uploads resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of uploads to include in this response. |
| start_index? | number | A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn upload_data()
upload data
Resources
state(infinite)— Metadata returned for an upload operation.
@swamp/gcp/analytics/management-webpropertiesv2026.07.21.2management_webproperties.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. |
| accountId? | string | Account ID to which this web property belongs. |
| childLink? | object | Child link for this web property. Points to the list of views (profiles) for this web property. |
| created? | string | Time this web property was created. |
| dataRetentionResetOnNewActivity? | boolean | Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifier automatically after the rentention period. This property cannot be set on insert. |
| dataRetentionTtl? | string | The length of time for which user and event data is retained. This property cannot be set on insert. |
| defaultProfileId? | string | Default view (profile) ID. |
| id? | string | Web property ID of the form UA-XXXXX-YY. |
| industryVertical? | string | The industry vertical/category selected for this web property. |
| internalWebPropertyId? | string | Internal ID for this web property. |
| level? | string | Level for this web property. Possible values are STANDARD or PREMIUM. |
| name? | string | Name of this web property. |
| parentLink? | object | Parent link for this web property. Points to the account to which this web property belongs. |
| permissions? | object | Permissions the user has for this web property. |
| profileCount? | number | View (Profile) count for this web property. |
| starred? | boolean | Indicates whether this web property is starred or not. |
| updated? | string | Time this web property was last modified. |
| websiteUrl? | string | Website url for this web property. |
fn create()
Create a webproperties
fn get(identifier: string)
Get a webproperties
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the webproperties |
fn update(identifier?: string)
Update webproperties attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific webproperties by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync webproperties state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific webproperties by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List webproperties resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of web properties to include in this response. |
| start_index? | number | An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics web property.
@swamp/gcp/analytics/management-webpropertyadwordslinksv2026.07.21.2management_webpropertyadwordslinks.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. |
| adWordsAccounts | array | A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. |
| entity? | object | Web property being linked. |
| id? | string | Entity Google Ads link ID |
| name | string | Name of the link. This field is required when creating a Google Ads link. |
| profileIds? | array | IDs of linked Views (Profiles) represented as strings. |
| accountId | string | ID of the Google Analytics account to create the link for. |
| webPropertyId | string | Web property ID to create the link for. |
fn create()
Create a webPropertyAdWordsLinks
fn get(identifier: string)
Get a webPropertyAdWordsLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the webPropertyAdWordsLinks |
fn update(identifier?: string)
Update webPropertyAdWordsLinks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific webPropertyAdWordsLinks by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the webPropertyAdWordsLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the webPropertyAdWordsLinks |
fn sync(identifier?: string)
Sync webPropertyAdWordsLinks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific webPropertyAdWordsLinks by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List webPropertyAdWordsLinks resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of webProperty-Google Ads links to include in this response. |
| start_index? | number | An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for Analytics Entity Google Ads Link.
@swamp/gcp/analytics/management-webpropertyuserlinksv2026.07.21.2management_webpropertyuserlinks.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. |
| entity? | object | Entity for this link. It can be an account, a web property, or a view (profile). |
| id? | string | Entity user link ID |
| permissions? | object | Permissions the user has for this entity. |
| userRef? | object | User reference. |
| accountId | string | Account ID to create the user link for. |
| webPropertyId | string | Web Property ID to create the user link for. |
fn create()
Create a webpropertyUserLinks
fn get(identifier: string)
Get a webpropertyUserLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the webpropertyUserLinks |
fn update(identifier?: string)
Update webpropertyUserLinks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific webpropertyUserLinks by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the webpropertyUserLinks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the webpropertyUserLinks |
fn sync(identifier?: string)
Sync webpropertyUserLinks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific webpropertyUserLinks by name (e.g. one discovered by list) |
fn list(max_results?: number, start_index?: number, maxPages?: number)
List webpropertyUserLinks resources
| Argument | Type | Description |
|---|---|---|
| max_results? | number | The maximum number of webProperty-user Links to include in this response. |
| start_index? | number | An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— JSON template for an Analytics Entity-User Link. Returns permissions that a u...
@swamp/gcp/analytics/metadata-columnsv2026.07.21.2metadata_columns.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. |
| reportType | string | Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API |
fn get(identifier: string)
Get a columns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the columns |
fn sync(identifier?: string)
Sync columns state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific columns by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List columns resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Lists all columns for a report type
04Previous Versions
2026.07.20.1
- Updated: data_ga, data_mcf, data_realtime, management_accountsummaries, management_accountuserlinks, management_accounts, management_customdatasources, management_customdimensions, management_custommetrics, management_experiments, management_filters, management_goals, management_profilefilterlinks, management_profileuserlinks, management_profiles, management_remarketingaudience, management_segments, management_unsampledreports, management_uploads, management_webpropertyadwordslinks, management_webproperties, management_webpropertyuserlinks, metadata_columns
Added 23, removed 1 models
2026.05.25.3
- Updated: metadata_columns
Modified 20 models
2026.05.19.1
2026.04.23.1
2026.04.04.1
- Updated: data_ga, data_mcf
2026.04.03.3
- Updated: data_ga, data_mcf, data_realtime, management_accountsummaries, management_accountuserlinks, management_accounts, management_customdatasources, management_customdimensions, management_custommetrics, management_experiments, management_filters, management_goals, management_profilefilterlinks, management_profileuserlinks, management_profiles, management_remarketingaudience, management_segments, management_unsampledreports, management_uploads, management_webpropertyadwordslinks, management_webproperties, management_webpropertyuserlinks, metadata_columns
2026.04.03.1
- Updated: data_ga, data_mcf, data_realtime, management_accountsummaries, management_accountuserlinks, management_accounts, management_customdatasources, management_customdimensions, management_custommetrics, management_experiments, management_filters, management_goals, management_profilefilterlinks, management_profileuserlinks, management_profiles, management_remarketingaudience, management_segments, management_unsampledreports, management_uploads, management_webpropertyadwordslinks, management_webproperties, management_webpropertyuserlinks, metadata_columns
2026.04.02.2
2026.03.27.1
- Added: data_ga, data_mcf, data_realtime, management_accountsummaries, management_accountuserlinks, management_accounts, management_customdatasources, management_customdimensions, management_custommetrics, management_experiments, management_filters, management_goals, management_profilefilterlinks, management_profileuserlinks, management_profiles, management_remarketingaudience, management_segments, management_unsampledreports, management_uploads, management_webpropertyadwordslinks, management_webproperties, management_webpropertyuserlinks, metadata_columns
05Stats
A
100 / 100
Downloads
0
Archive size
226.4 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels