Skip to content
Scalekit Docs
Talk to an EngineerDashboard

Google Analytics connector

OAuth 2.0Analytics

Connect to Google Analytics (GA4) to run reports, realtime reports, and pivot reports, check dimension/metric compatibility, and manage audience exports...

Google Analytics connector

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “Set your credentials”

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>

  3. Authorize and make your first call

    Section titled “Authorize and make your first call”
    quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENV_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'googleanalytics'
    const identifier = 'user_123'
    

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Google Analytics:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'googleanalytics_list_account_summaries',
      toolInput: {},
    })
    console.log(result)

What you can do

Section titled “What you can do”

Connect this agent connector to let your agent:

  • Update property, measurement protocol secret, key event — Update an existing Google Analytics property’s editable fields (display name, industry category, time zone, currency code)
  • Search change history events — Search the configuration change history for a Google Analytics account or its child properties (e.g
  • Run report, realtime report, pivot report — Run a Google Analytics 4 (GA4) report: returns a customized table of event data for a property, broken down by the requested dimensions and metrics over a date range
  • Query audience export — Retrieve the rows (users and their dimension values) from a GA4 audience export that is in the ACTIVE state
  • Ticket provision account — Request a ticket for creating a new Google Analytics account
  • List properties, measurement protocol secrets, key events — List Google Analytics properties matching a filter, such as those belonging to a parent account/property or linked to a Firebase project

Tool list

Section titled “Tool list”

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

googleanalytics_accounts_run_access_report#Run a Data Access Record Report for a Google Analytics account: an audit log of who accessed report data and when, across every property in the account. Useful for compliance/security reviews. Returns rows broken down by the requested access-report dimensions and metrics (e.g. userEmail, accessCount) over a date range.10 params

Run a Data Access Record Report for a Google Analytics account: an audit log of who accessed report data and when, across every property in the account. Useful for compliance/security reviews. Returns rows broken down by the requested access-report dimensions and metrics (e.g. userEmail, accessCount) over a date range.

NameTypeRequiredDescription
end_datestringrequiredEnd of the report date range (YYYY-MM-DD, or relative: today/yesterday/NdaysAgo).
entitystringrequiredThe account to run the access report for, in the form accounts/{accountId}.
metricsarrayrequiredAccess-report metric names, e.g. ["accessCount"]. At least one metric is required. See the Data Access API schema docs for valid names.
start_datestringrequiredStart of the report date range (YYYY-MM-DD, or relative: today/yesterday/NdaysAgo).
dimension_filterobjectoptionalAdvanced: a raw FilterExpression object to filter rows by dimension values.
dimensionsarrayoptionalAccess-report dimension names, e.g. ["userEmail", "propertyId"]. See the Data Access API schema docs for valid names.
limitintegeroptionalMaximum rows to return. Defaults to 10000; the API returns at most 100000 rows regardless.
offsetintegeroptionalRow offset for pagination. Omit or set to 0 for the first page.
return_entity_quotabooleanoptionalIf true, the response includes this account's current Data Access API quota consumption.
time_zonestringoptionalIANA time zone (e.g. America/New_York) used to interpret start/end dates. Defaults to the property's time zone if omitted.
googleanalytics_acknowledge_user_data_collection#Acknowledge that the caller has the necessary privacy disclosures and rights from end users for the collection and processing of their data on this property. Required before certain data-collection features (such as user-ID reporting) can be used.2 params

Acknowledge that the caller has the necessary privacy disclosures and rights from end users for the collection and processing of their data on this property. Required before certain data-collection features (such as user-ID reporting) can be used.

NameTypeRequiredDescription
acknowledgementstringrequiredRequired. The exact acknowledgement text confirming the caller has the necessary privacy disclosures and rights from end users for the collection and processing of their data, including associating that data with the visitation information Google Analytics collects. Must match exactly: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."
propertystringrequiredProperty for which to acknowledge user data collection, in the form properties/{propertyId}.
googleanalytics_archive_custom_dimension#Archive a custom dimension on a property. Archived custom dimensions are permanently removed and cannot be restored, but historical data collected under them remains available in reports.1 param

Archive a custom dimension on a property. Archived custom dimensions are permanently removed and cannot be restored, but historical data collected under them remains available in reports.

NameTypeRequiredDescription
namestringrequiredResource name of the custom dimension to archive, in the form properties/{propertyId}/customDimensions/{customDimensionId}.
googleanalytics_archive_custom_metric#Archive a custom metric on a property. Archived custom metrics are permanently removed and cannot be restored, but historical data collected under them remains available in reports.1 param

Archive a custom metric on a property. Archived custom metrics are permanently removed and cannot be restored, but historical data collected under them remains available in reports.

NameTypeRequiredDescription
namestringrequiredResource name of the custom metric to archive, in the form properties/{propertyId}/customMetrics/{customMetricId}.
googleanalytics_batch_run_pivot_reports#Run multiple GA4 pivot reports against the same property in a single call. Provide an array of RunPivotReportRequest-shaped objects (each with dimensions, metrics, pivots, dateRanges, etc. using the GA4 Data API's own field names); each entry's property, if set, must match the top-level property.2 params

Run multiple GA4 pivot reports against the same property in a single call. Provide an array of RunPivotReportRequest-shaped objects (each with dimensions, metrics, pivots, dateRanges, etc. using the GA4 Data API's own field names); each entry's property, if set, must match the top-level property.

NameTypeRequiredDescription
propertystringrequiredThe GA4 property identifier all requests in the batch run against, in the form properties/{propertyId}.
requestsarrayrequiredArray of RunPivotReportRequest objects, one per pivot report, using the GA4 Data API's native field names (dimensions: [{name}], metrics: [{name}], pivots: [...], dateRanges: [{startDate,endDate}], etc). Example: [{"dimensions":[{"name":"country"}],"metrics":[{"name":"activeUsers"}],"pivots":[{"fieldNames":["country"],"limit":"5"}],"dateRanges":[{"startDate":"7daysAgo","endDate":"today"}]}]
googleanalytics_batch_run_reports#Run multiple GA4 reports against the same property in a single call. Provide an array of RunReportRequest-shaped objects (each with dimensions, metrics, dateRanges, etc. using the GA4 Data API's own field names); each entry's property, if set, must match the top-level property.2 params

Run multiple GA4 reports against the same property in a single call. Provide an array of RunReportRequest-shaped objects (each with dimensions, metrics, dateRanges, etc. using the GA4 Data API's own field names); each entry's property, if set, must match the top-level property.

NameTypeRequiredDescription
propertystringrequiredThe GA4 property identifier all requests in the batch run against, in the form properties/{propertyId}.
requestsarrayrequiredArray of RunReportRequest objects, one per report, using the GA4 Data API's native field names (dimensions: [{name}], metrics: [{name}], dateRanges: [{startDate,endDate}], etc). Example: [{"dimensions":[{"name":"country"}],"metrics":[{"name":"activeUsers"}],"dateRanges":[{"startDate":"7daysAgo","endDate":"today"}]}]
googleanalytics_check_compatibility#Check which dimensions and metrics are compatible with each other for a GA4 property before running a report. Pass the same dimensions/metrics/filters you intend to use in Run Report to preview which combinations are valid.6 params

Check which dimensions and metrics are compatible with each other for a GA4 property before running a report. Pass the same dimensions/metrics/filters you intend to use in Run Report to preview which combinations are valid.

NameTypeRequiredDescription
propertystringrequiredThe GA4 property identifier to check against, in the form properties/{propertyId}. Should match the property you intend to use in Run Report.
compatibility_filterstringoptionalRestrict results to only this compatibility level. Valid values: COMPATIBILITY_UNSPECIFIED, COMPATIBLE, INCOMPATIBLE. Commonly set to COMPATIBLE to only return usable dimensions/metrics.
dimension_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object matching what you intend to use in Run Report's dimension filter.
dimensionsarrayoptionalDimension names to check, e.g. ["country", "city"]. Should be the same value you intend to use in Run Report.
metric_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object matching what you intend to use in Run Report's metric filter.
metricsarrayoptionalMetric names to check, e.g. ["activeUsers", "sessions"]. Should be the same value you intend to use in Run Report.
googleanalytics_create_audience_export#Create an audience export for a GA4 audience, listing the users currently in that audience along with the requested dimension values. Creation is asynchronous — the export moves from CREATING to ACTIVE (typically within ~15 minutes); poll Get Audience Export or List Audience Exports until state is ACTIVE, then use Query Audience Export to read the rows.3 params

Create an audience export for a GA4 audience, listing the users currently in that audience along with the requested dimension values. Creation is asynchronous — the export moves from CREATING to ACTIVE (typically within ~15 minutes); poll Get Audience Export or List Audience Exports until state is ACTIVE, then use Query Audience Export to read the rows.

NameTypeRequiredDescription
audiencestringrequiredThe audience resource name to export, in the form properties/{propertyId}/audiences/{audienceId}. Find audience IDs via the Admin API's List Audiences.
dimensionsarrayrequiredDimension API names to include for each exported user, e.g. ["deviceCategory", "country"]. At least one dimension is required.
parentstringrequiredThe GA4 property under which to create the audience export, in the form properties/{propertyId}.
googleanalytics_create_conversion_event#Deprecated: prefer the equivalent Key Event tool. Create a conversion event for an existing GA4 event name.4 params

Deprecated: prefer the equivalent Key Event tool. Create a conversion event for an existing GA4 event name.

NameTypeRequiredDescription
event_namestringrequiredThe GA4 event name this conversion event tracks, e.g. "purchase" or "sign_up". The event must already be recorded on the property.
parentstringrequiredResource name of the parent property to create the conversion event under, in the form properties/{propertyId}.
counting_methodstringoptionalHow conversions are counted across multiple events within a session. One of CONVERSION_COUNTING_METHOD_UNSPECIFIED, ONCE_PER_EVENT, or ONCE_PER_SESSION. Defaults to ONCE_PER_EVENT if omitted.
default_conversion_valueobjectoptionalDefault conversion value as a raw DefaultConversionValue object: {"value": <number>, "currencyCode": "<ISO4217>"}. Both fields are required together if set.
googleanalytics_create_custom_dimension#Create a custom dimension on a property to track a custom event parameter, user property, or eCommerce item parameter as a report dimension.6 params

Create a custom dimension on a property to track a custom event parameter, user property, or eCommerce item parameter as a report dimension.

NameTypeRequiredDescription
display_namestringrequiredRequired. Display name shown for this custom dimension in the Analytics UI. Max 82 characters, alphanumeric plus spaces and underscores, starting with a letter.
parameter_namestringrequiredRequired. Immutable. The event parameter, user property, or item parameter name being tracked by this custom dimension. Must be alphanumeric plus underscores, starting with a letter. Max 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
parentstringrequiredResource name of the parent property to create the custom dimension on, in the form properties/{propertyId}.
scopestringrequiredRequired. Immutable. The scope of this custom dimension — which kind of entity the tracked parameter belongs to.
descriptionstringoptionalDescription of this custom dimension shown in the Analytics UI. Max 150 characters.
disallow_ads_personalizationbooleanoptionalIf true, sets this dimension as NPA (No Personalized Ads) and excludes it from ads personalization. Only supported for user-scoped dimensions.
googleanalytics_create_custom_metric#Create a custom metric on a property to track a custom event parameter as a report metric.7 params

Create a custom metric on a property to track a custom event parameter as a report metric.

NameTypeRequiredDescription
display_namestringrequiredRequired. Display name shown for this custom metric in the Analytics UI. Max 82 characters, alphanumeric plus spaces and underscores, starting with a letter.
measurement_unitstringrequiredRequired. The unit of measurement for this custom metric's value.
parameter_namestringrequiredRequired. Immutable. The event parameter name being tracked by this custom metric. Must be alphanumeric plus underscores, starting with a letter. Max 40 characters.
parentstringrequiredResource name of the parent property to create the custom metric on, in the form properties/{propertyId}.
scopestringrequiredRequired. Immutable. The scope of this custom metric. Currently only EVENT is supported.
descriptionstringoptionalDescription of this custom metric shown in the Analytics UI. Max 150 characters.
restricted_metric_typearrayoptionalTypes of restricted data this metric may contain, e.g. ["COST_DATA"] or ["REVENUE_DATA"]. Required and non-empty if measurement_unit is CURRENCY; must be empty otherwise.
googleanalytics_create_data_stream#Create a new WEB data stream for a Google Analytics 4 property. Note: Google's Admin API only supports creating WEB_DATA_STREAM directly here — creating ANDROID_APP_DATA_STREAM or IOS_APP_DATA_STREAM through this endpoint is rejected by Google with "To create app streams, use the Firebase API" (confirmed live); app streams must be created via Firebase, then they appear here read-only through Get/List Data Stream.6 params

Create a new WEB data stream for a Google Analytics 4 property. Note: Google's Admin API only supports creating WEB_DATA_STREAM directly here — creating ANDROID_APP_DATA_STREAM or IOS_APP_DATA_STREAM through this endpoint is rejected by Google with "To create app streams, use the Firebase API" (confirmed live); app streams must be created via Firebase, then they appear here read-only through Get/List Data Stream.

NameTypeRequiredDescription
parentstringrequiredThe resource name of the parent property to create the data stream under, in the form properties/{propertyId}.
typestringrequiredThe type of data stream to create. This is immutable once the stream is created. In practice only WEB_DATA_STREAM can be created through this API — Google rejects ANDROID_APP_DATA_STREAM/IOS_APP_DATA_STREAM here with "To create app streams, use the Firebase API".
android_app_stream_dataobjectoptionalRaw AndroidAppStreamData object, required when type is ANDROID_APP_DATA_STREAM. Example: {"packageName": "com.example.myapp"}.
display_namestringoptionalHuman-readable display name for the stream, up to 255 UTF-16 code units. Required for web streams.
ios_app_stream_dataobjectoptionalRaw IosAppStreamData object, required when type is IOS_APP_DATA_STREAM. Example: {"bundleId": "com.example.myapp"}.
web_stream_dataobjectoptionalRaw WebStreamData object, required when type is WEB_DATA_STREAM. Example: {"defaultUri": "https://www.example.com"}.
googleanalytics_create_key_event#Create a key event for an existing GA4 event name. Key Events (formerly Conversion Events) mark events that represent valuable user actions.4 params

Create a key event for an existing GA4 event name. Key Events (formerly Conversion Events) mark events that represent valuable user actions.

NameTypeRequiredDescription
counting_methodstringrequiredRequired. How this key event is counted across multiple events within a session. One of COUNTING_METHOD_UNSPECIFIED, ONCE_PER_EVENT, or ONCE_PER_SESSION.
event_namestringrequiredThe GA4 event name this key event tracks, e.g. "purchase" or "sign_up". The event must already be recorded on the property.
parentstringrequiredResource name of the parent property to create the key event under, in the form properties/{propertyId}.
default_valueobjectoptionalDefault value for this key event as a raw KeyEventDefaultValue object: {"numericValue": <number>, "currencyCode": "<ISO4217>"}. Both fields are required together if set.
googleanalytics_create_measurement_protocol_secret#Create a Measurement Protocol secret for a data stream. The generated secret value is used as the api_secret parameter when sending Measurement Protocol hits to this stream.2 params

Create a Measurement Protocol secret for a data stream. The generated secret value is used as the api_secret parameter when sending Measurement Protocol hits to this stream.

NameTypeRequiredDescription
display_namestringrequiredRequired human-readable display name for this Measurement Protocol secret.
parentstringrequiredThe resource name of the parent data stream to create the secret under, in the form properties/{propertyId}/dataStreams/{streamId}.
googleanalytics_create_property#Create a new Google Analytics 4 property under an existing account.6 params

Create a new Google Analytics 4 property under an existing account.

NameTypeRequiredDescription
display_namestringrequiredHuman-readable display name for the new property. Max 100 UTF-16 code units.
parentstringrequiredResource name of the parent account under which to create the property, in the form accounts/{accountId}.
time_zonestringrequiredIANA reporting time zone for the property, e.g. America/Los_Angeles. Used for the boundaries of every day in reports, regardless of where the data originated.
currency_codestringoptionalISO 4217 currency code used to display currency-denominated metrics in reports, e.g. USD.
industry_categorystringoptionalIndustry associated with this property.
property_typestringoptionalType of the property to create. Defaults to PROPERTY_TYPE_ORDINARY if unspecified.
googleanalytics_delete_account#Soft-delete a Google Analytics account. The account and all its properties are marked for deletion; Google permanently purges them after roughly 35 days unless the account is restored before then.1 param

Soft-delete a Google Analytics account. The account and all its properties are marked for deletion; Google permanently purges them after roughly 35 days unless the account is restored before then.

NameTypeRequiredDescription
namestringrequiredResource name of the account to delete, in the form accounts/{accountId}.
googleanalytics_delete_conversion_event#Deprecated: prefer the equivalent Key Event tool. Permanently delete a conversion event. Only events where 'deletable' is true can be deleted (custom events created by the property admin).1 param

Deprecated: prefer the equivalent Key Event tool. Permanently delete a conversion event. Only events where 'deletable' is true can be deleted (custom events created by the property admin).

NameTypeRequiredDescription
namestringrequiredResource name of the conversion event to delete, in the form properties/{propertyId}/conversionEvents/{conversionEventId}.
googleanalytics_delete_data_stream#Permanently delete a data stream (web, Android app, or iOS app) from a property. Data collection tied to this stream's measurement ID stops immediately and cannot be undone.1 param

Permanently delete a data stream (web, Android app, or iOS app) from a property. Data collection tied to this stream's measurement ID stops immediately and cannot be undone.

NameTypeRequiredDescription
namestringrequiredThe data stream resource name to delete, in the form properties/{propertyId}/dataStreams/{streamId}.
googleanalytics_delete_key_event#Permanently delete a key event. Only events where 'deletable' is true can be deleted (custom events created by the property admin).1 param

Permanently delete a key event. Only events where 'deletable' is true can be deleted (custom events created by the property admin).

NameTypeRequiredDescription
namestringrequiredResource name of the key event to delete, in the form properties/{propertyId}/keyEvents/{keyEventId}.
googleanalytics_delete_measurement_protocol_secret#Permanently delete a Measurement Protocol secret. Any Measurement Protocol hits sent with this secret's api_secret value are rejected once it is deleted, and this action cannot be undone.1 param

Permanently delete a Measurement Protocol secret. Any Measurement Protocol hits sent with this secret's api_secret value are rejected once it is deleted, and this action cannot be undone.

NameTypeRequiredDescription
namestringrequiredThe Measurement Protocol secret resource name to delete, in the form properties/{propertyId}/dataStreams/{streamId}/measurementProtocolSecrets/{secretId}.
googleanalytics_delete_property#Soft-delete a Google Analytics property. The property is marked for deletion and Google permanently purges it after approximately 35 days unless it is restored before then.1 param

Soft-delete a Google Analytics property. The property is marked for deletion and Google permanently purges it after approximately 35 days unless it is restored before then.

NameTypeRequiredDescription
namestringrequiredResource name of the property to delete, in the form properties/{propertyId}.
googleanalytics_get_account#Fetch a single Google Analytics account's details by resource name.1 param

Fetch a single Google Analytics account's details by resource name.

NameTypeRequiredDescription
namestringrequiredResource name of the account to fetch, in the form accounts/{accountId}.
googleanalytics_get_audience_export#Fetch the configuration and current state (CREATING, ACTIVE, or FAILED) of a GA4 audience export. Use this to poll a newly created export until it becomes ACTIVE before querying its rows.1 param

Fetch the configuration and current state (CREATING, ACTIVE, or FAILED) of a GA4 audience export. Use this to poll a newly created export until it becomes ACTIVE before querying its rows.

NameTypeRequiredDescription
namestringrequiredThe audience export resource name, in the form properties/{propertyId}/audienceExports/{audienceExportId}.
googleanalytics_get_conversion_event#Deprecated: prefer the equivalent Key Event tool. Fetch a single Google Analytics conversion event by its resource name.1 param

Deprecated: prefer the equivalent Key Event tool. Fetch a single Google Analytics conversion event by its resource name.

NameTypeRequiredDescription
namestringrequiredResource name of the conversion event to fetch, in the form properties/{propertyId}/conversionEvents/{conversionEventId}.
googleanalytics_get_custom_dimension#Fetch a single custom dimension by resource name.1 param

Fetch a single custom dimension by resource name.

NameTypeRequiredDescription
namestringrequiredResource name of the custom dimension to fetch, in the form properties/{propertyId}/customDimensions/{customDimensionId}.
googleanalytics_get_custom_metric#Fetch a single custom metric by resource name.1 param

Fetch a single custom metric by resource name.

NameTypeRequiredDescription
namestringrequiredResource name of the custom metric to fetch, in the form properties/{propertyId}/customMetrics/{customMetricId}.
googleanalytics_get_data_retention_settings#Get a property's event-level and user-level data retention settings.1 param

Get a property's event-level and user-level data retention settings.

NameTypeRequiredDescription
namestringrequiredResource name of the data retention settings, in the form properties/{propertyId}/dataRetentionSettings.
googleanalytics_get_data_sharing_settings#Get the data-sharing settings for a Google Analytics account. These settings control what account data Google may use for benchmarking, technical support, and other Google products.1 param

Get the data-sharing settings for a Google Analytics account. These settings control what account data Google may use for benchmarking, technical support, and other Google products.

NameTypeRequiredDescription
namestringrequiredResource name of the data sharing settings to fetch, in the form accounts/{accountId}/dataSharingSettings.
googleanalytics_get_data_stream#Fetch a single Google Analytics 4 data stream (web, Android app, or iOS app) by its resource name.1 param

Fetch a single Google Analytics 4 data stream (web, Android app, or iOS app) by its resource name.

NameTypeRequiredDescription
namestringrequiredThe data stream resource name to fetch, in the form properties/{propertyId}/dataStreams/{streamId}.
googleanalytics_get_key_event#Fetch a single key event by resource name, in the form properties/{propertyId}/keyEvents/{keyEventId}.1 param

Fetch a single key event by resource name, in the form properties/{propertyId}/keyEvents/{keyEventId}.

NameTypeRequiredDescription
namestringrequiredResource name of the key event to fetch, in the form properties/{propertyId}/keyEvents/{keyEventId}.
googleanalytics_get_measurement_protocol_secret#Fetch a single Measurement Protocol secret by resource name. The response includes the secret value itself, which is used as the api_secret parameter when sending Measurement Protocol hits.1 param

Fetch a single Measurement Protocol secret by resource name. The response includes the secret value itself, which is used as the api_secret parameter when sending Measurement Protocol hits.

NameTypeRequiredDescription
namestringrequiredThe Measurement Protocol secret resource name to fetch, in the form properties/{propertyId}/dataStreams/{streamId}/measurementProtocolSecrets/{secretId}.
googleanalytics_get_metadata#Fetch the dimensions and metrics available for a GA4 property, including custom dimensions/metrics defined on that property. Use this to discover valid dimension/metric API names before calling Run Report.1 param

Fetch the dimensions and metrics available for a GA4 property, including custom dimensions/metrics defined on that property. Use this to discover valid dimension/metric API names before calling Run Report.

NameTypeRequiredDescription
namestringrequiredThe metadata resource name, in the form properties/{propertyId}/metadata. Set the property ID to 0 (properties/0/metadata) to retrieve dimensions/metrics common to all properties, excluding custom ones.
googleanalytics_get_property#Fetch a single Google Analytics property's details by resource name.1 param

Fetch a single Google Analytics property's details by resource name.

NameTypeRequiredDescription
namestringrequiredResource name of the property to fetch, in the form properties/{propertyId}.
googleanalytics_list_account_summaries#List account summaries for all accounts the caller has access to — a convenient combined view of accounts and their properties without needing separate List Accounts / List Properties calls. This is the easiest way to discover which properties you can query.2 params

List account summaries for all accounts the caller has access to — a convenient combined view of accounts and their properties without needing separate List Accounts / List Properties calls. This is the easiest way to discover which properties you can query.

NameTypeRequiredDescription
page_sizeintegeroptionalMaximum number of account summaries to return in one page. Defaults to 50 if omitted; the maximum allowed value is 200.
page_tokenstringoptionalA page token received from a previous list_account_summaries call, used to fetch the next page of results.
googleanalytics_list_accounts#List all Google Analytics accounts accessible by the caller. Soft-deleted (trashed) accounts are excluded from the results unless show_deleted is set to true.3 params

List all Google Analytics accounts accessible by the caller. Soft-deleted (trashed) accounts are excluded from the results unless show_deleted is set to true.

NameTypeRequiredDescription
page_sizeintegeroptionalMaximum number of accounts to return per page. Defaults to 50 if omitted; the API caps this at 200.
page_tokenstringoptionalA page token from a previous List Accounts call, used to retrieve the next page of results.
show_deletedbooleanoptionalWhether to include soft-deleted (trashed) accounts in the results. Defaults to false — trashed accounts are hidden unless this is set to true.
googleanalytics_list_audience_exports#List all audience exports for a GA4 property, showing each export's state (CREATING, ACTIVE, FAILED) and row count.3 params

List all audience exports for a GA4 property, showing each export's state (CREATING, ACTIVE, FAILED) and row count.

NameTypeRequiredDescription
parentstringrequiredThe GA4 property whose audience exports to list, in the form properties/{propertyId}.
page_sizeintegeroptionalMaximum number of audience exports to return. Defaults to 200 if omitted; the API caps this at 1000.
page_tokenstringoptionalA page token from a previous List Audience Exports call, used to retrieve the next page of results.
googleanalytics_list_conversion_events#Deprecated: prefer the equivalent Key Event tool. List the conversion events defined on a Google Analytics property.3 params

Deprecated: prefer the equivalent Key Event tool. List the conversion events defined on a Google Analytics property.

NameTypeRequiredDescription
parentstringrequiredResource name of the parent property whose conversion events to list, in the form properties/{propertyId}.
page_sizeintegeroptionalMaximum number of conversion events to return. Defaults to 50 if omitted; the maximum value is 200.
page_tokenstringoptionalA page token received from a previous list_conversion_events call, used to fetch the next page of results.
googleanalytics_list_custom_dimensions#List custom dimensions defined on a property.3 params

List custom dimensions defined on a property.

NameTypeRequiredDescription
parentstringrequiredResource name of the parent property to list custom dimensions for, in the form properties/{propertyId}.
page_sizeintegeroptionalMaximum number of custom dimensions to return per page. Defaults to 50 if omitted; the API caps this at 200.
page_tokenstringoptionalA page token from a previous List Custom Dimensions call, used to retrieve the next page of results.
googleanalytics_list_custom_metrics#List custom metrics defined on a property.3 params

List custom metrics defined on a property.

NameTypeRequiredDescription
parentstringrequiredResource name of the parent property to list custom metrics for, in the form properties/{propertyId}.
page_sizeintegeroptionalMaximum number of custom metrics to return per page. Defaults to 50 if omitted; the API caps this at 200.
page_tokenstringoptionalA page token from a previous List Custom Metrics call, used to retrieve the next page of results.
googleanalytics_list_data_streams#List all data streams (web, Android app, iOS app) for a Google Analytics 4 property, with pagination support.3 params

List all data streams (web, Android app, iOS app) for a Google Analytics 4 property, with pagination support.

NameTypeRequiredDescription
parentstringrequiredThe resource name of the parent property whose data streams to list, in the form properties/{propertyId}.
page_sizeintegeroptionalMaximum number of data streams to return. Defaults to 50 if omitted; the API caps this at 200.
page_tokenstringoptionalA page token received from a previous list_data_streams call, used to fetch the next page of results.
googleanalytics_list_key_events#List the key events defined on a Google Analytics property.3 params

List the key events defined on a Google Analytics property.

NameTypeRequiredDescription
parentstringrequiredResource name of the parent property whose key events to list, in the form properties/{propertyId}.
page_sizeintegeroptionalMaximum number of key events to return. Defaults to 50 if omitted; the maximum value is 200.
page_tokenstringoptionalA page token received from a previous list_key_events call, used to fetch the next page of results.
googleanalytics_list_measurement_protocol_secrets#List all Measurement Protocol secrets registered for a data stream, with pagination support.3 params

List all Measurement Protocol secrets registered for a data stream, with pagination support.

NameTypeRequiredDescription
parentstringrequiredThe resource name of the parent data stream whose secrets to list, in the form properties/{propertyId}/dataStreams/{streamId}.
page_sizeintegeroptionalMaximum number of secrets to return. Defaults to 10 if omitted; the API caps this at 10 since this resource is small by design.
page_tokenstringoptionalA page token received from a previous list_measurement_protocol_secrets call, used to fetch the next page of results.
googleanalytics_list_properties#List Google Analytics properties matching a filter, such as those belonging to a parent account/property or linked to a Firebase project. For a simple list of everything you can access, Get Account Summaries is usually more convenient.4 params

List Google Analytics properties matching a filter, such as those belonging to a parent account/property or linked to a Firebase project. For a simple list of everything you can access, Get Account Summaries is usually more convenient.

NameTypeRequiredDescription
filterstringrequiredRequired filter expression restricting which properties are returned. Eligible fields: parent: (resource name of the parent account or property), ancestor: (resource name of the parent account), firebase_project: (linked Firebase project ID or number). Examples: "parent:accounts/123", "parent:properties/123", "ancestor:accounts/123", "firebase_project:my-project".
page_sizeintegeroptionalMaximum number of properties to return per page. Defaults to 50 if omitted; the API caps this at 200 (larger values are coerced down).
page_tokenstringoptionalPage token from a previous list call, used to fetch the next page of results. Omit for the first page.
show_deletedbooleanoptionalIf true, includes soft-deleted (trashed) properties in the results. Defaults to false if omitted.
googleanalytics_properties_run_access_report#Run a Data Access Record Report for a single Google Analytics property: an audit log of who accessed report data and when. Useful for compliance/security reviews. Returns rows broken down by the requested access-report dimensions and metrics (e.g. userEmail, accessCount) over a date range.10 params

Run a Data Access Record Report for a single Google Analytics property: an audit log of who accessed report data and when. Useful for compliance/security reviews. Returns rows broken down by the requested access-report dimensions and metrics (e.g. userEmail, accessCount) over a date range.

NameTypeRequiredDescription
end_datestringrequiredEnd of the report date range (YYYY-MM-DD, or relative: today/yesterday/NdaysAgo).
entitystringrequiredThe property to run the access report for, in the form properties/{propertyId}.
metricsarrayrequiredAccess-report metric names, e.g. ["accessCount"]. At least one metric is required. See the Data Access API schema docs for valid names.
start_datestringrequiredStart of the report date range (YYYY-MM-DD, or relative: today/yesterday/NdaysAgo).
dimension_filterobjectoptionalAdvanced: a raw FilterExpression object to filter rows by dimension values.
dimensionsarrayoptionalAccess-report dimension names, e.g. ["userEmail", "propertyId"]. See the Data Access API schema docs for valid names.
limitintegeroptionalMaximum rows to return. Defaults to 10000; the API returns at most 100000 rows regardless.
offsetintegeroptionalRow offset for pagination. Omit or set to 0 for the first page.
return_entity_quotabooleanoptionalIf true, the response includes this account's current Data Access API quota consumption.
time_zonestringoptionalIANA time zone (e.g. America/New_York) used to interpret start/end dates. Defaults to the property's time zone if omitted.
googleanalytics_provision_account_ticket#Request a ticket for creating a new Google Analytics account. Returns an account ticket ID; the user must complete account creation by visiting Google's Terms of Service acceptance flow at https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/{account_ticket_id} before the account actually exists.3 params

Request a ticket for creating a new Google Analytics account. Returns an account ticket ID; the user must complete account creation by visiting Google's Terms of Service acceptance flow at https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/{account_ticket_id} before the account actually exists.

NameTypeRequiredDescription
display_namestringrequiredHuman-readable display name for the account to be created.
redirect_uristringrequiredRedirect URI where the user is sent after accepting the Terms of Service. Must be configured in Google Cloud Console as an authorized redirect URI for this OAuth client.
region_codestringrequiredCountry of business for the new account, as a Unicode CLDR region code.
googleanalytics_query_audience_export#Retrieve the rows (users and their dimension values) from a GA4 audience export that is in the ACTIVE state. Supports pagination via limit/offset.3 params

Retrieve the rows (users and their dimension values) from a GA4 audience export that is in the ACTIVE state. Supports pagination via limit/offset.

NameTypeRequiredDescription
namestringrequiredThe audience export resource name to read rows from, in the form properties/{propertyId}/audienceExports/{audienceExportId}. The export must be in the ACTIVE state.
limitintegeroptionalNumber of rows to return. Defaults to 10000 if omitted; the API returns at most 250000 rows regardless of this value.
offsetintegeroptionalRow offset for pagination. The first request should omit this or set it to 0; subsequent pages set it to the previous request's limit.
googleanalytics_run_pivot_report#Run a GA4 pivot report: returns a report with pivot tables built from the requested dimensions and metrics. Unlike Run Report, results are organized into pivot dimension headers rather than flat rows — use this for cross-tabulated views (e.g. sessions by country x device category).8 params

Run a GA4 pivot report: returns a report with pivot tables built from the requested dimensions and metrics. Unlike Run Report, results are organized into pivot dimension headers rather than flat rows — use this for cross-tabulated views (e.g. sessions by country x device category).

NameTypeRequiredDescription
dimensionsarrayrequiredDimension names available to the pivots, e.g. ["country", "deviceCategory"]. Referenced by name in the pivots field.
end_datestringrequiredEnd of the reporting date range. Accepts an ISO date (YYYY-MM-DD) or a relative value like today, yesterday, or NdaysAgo.
metricsarrayrequiredMetric names to include in the report, e.g. ["activeUsers", "sessions"]. At least one metric is required.
pivotsarrayrequiredArray of raw GA4 Pivot objects describing how to cross-tabulate the dimensions, e.g. [{"fieldNames":["country"],"limit":"5"},{"fieldNames":["deviceCategory"],"limit":"3"}]. Each pivot's fieldNames must reference names from Dimensions above.
propertystringrequiredThe GA4 property identifier to query, in the form properties/{propertyId}.
start_datestringrequiredStart of the reporting date range. Accepts an ISO date (YYYY-MM-DD) or a relative value like today, yesterday, or NdaysAgo.
dimension_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object to filter rows by dimension values.
metric_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object to filter rows by metric values.
googleanalytics_run_realtime_report#Run a GA4 realtime report: returns event data from the last 30 minutes (or a custom minute range) for a property, broken down by the requested dimensions and metrics. Use this for live/active-user dashboards rather than historical reporting.8 params

Run a GA4 realtime report: returns event data from the last 30 minutes (or a custom minute range) for a property, broken down by the requested dimensions and metrics. Use this for live/active-user dashboards rather than historical reporting.

NameTypeRequiredDescription
metricsarrayrequiredRealtime metric names to include, e.g. ["activeUsers", "screenPageViews"]. At least one metric is required.
propertystringrequiredThe GA4 property identifier to query, in the form properties/{propertyId}.
dimension_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object to filter rows by dimension values.
dimensionsarrayoptionalRealtime dimension names to break the report down by, e.g. ["country", "unifiedScreenName"]. Optional — omit for a totals-only report.
limitintegeroptionalMaximum number of rows to return. Defaults to 10000 if omitted.
metric_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object to filter rows by metric values.
minute_rangesarrayoptionalAdvanced: a raw array of GA4 MinuteRange objects (each optionally with startMinutesAgo/endMinutesAgo). If omitted, the API defaults to the last 30 minutes.
return_property_quotabooleanoptionalIf true, the response includes the property's current Realtime API quota consumption.
googleanalytics_run_report#Run a Google Analytics 4 (GA4) report: returns a customized table of event data for a property, broken down by the requested dimensions and metrics over a date range. Use this for standard analytics queries like sessions by country, active users by day, or conversions by channel.13 params

Run a Google Analytics 4 (GA4) report: returns a customized table of event data for a property, broken down by the requested dimensions and metrics over a date range. Use this for standard analytics queries like sessions by country, active users by day, or conversions by channel.

NameTypeRequiredDescription
end_datestringrequiredEnd of the reporting date range. Accepts an ISO date (YYYY-MM-DD) or a relative value like today, yesterday, or NdaysAgo (e.g. 7daysAgo).
metricsarrayrequiredMetric names to include in the report, e.g. ["activeUsers", "sessions", "screenPageViews"]. At least one metric is required. See the Google Analytics Data API dimensions & metrics reference for valid names.
propertystringrequiredThe GA4 property identifier to query, in the form properties/{propertyId}. Find the numeric property ID in Google Analytics Admin settings.
start_datestringrequiredStart of the reporting date range. Accepts an ISO date (YYYY-MM-DD) or a relative value like today, yesterday, or NdaysAgo (e.g. 7daysAgo).
currency_codestringoptionalA currency code in ISO 4217 format (e.g. USD, EUR, JPY) used for currency-denominated metrics. Defaults to the property's own currency if omitted.
dimension_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object to filter rows by dimension values. Example: {"filter":{"fieldName":"country","stringFilter":{"value":"United States"}}}
dimensionsarrayoptionalDimension names to break the report down by, e.g. ["country", "date"]. Optional — omit for a totals-only report with no breakdown.
keep_empty_rowsbooleanoptionalIf true, rows where every metric is 0 are still returned (unless removed by a filter). If false or omitted, all-zero rows are dropped.
limitintegeroptionalMaximum number of rows to return. Defaults to 10000 if omitted. The API returns at most 250000 rows regardless of this value.
metric_filterobjectoptionalAdvanced: a raw GA4 FilterExpression object to filter rows by metric values. Example: {"filter":{"fieldName":"sessions","numericFilter":{"operation":"GREATER_THAN","value":{"int64Value":"10"}}}}
offsetintegeroptionalRow offset for pagination. The first request should omit this or set it to 0.
order_bysarrayoptionalAdvanced: a raw array of GA4 OrderBy objects controlling row ordering in the response. Example: [{"metric":{"metricName":"sessions"},"desc":true}]
return_property_quotabooleanoptionalIf true, the response includes the property's current Analytics Data API quota consumption.
googleanalytics_search_change_history_events#Search the configuration change history for a Google Analytics account or its child properties (e.g. property created, data stream updated). Does not include Data Access records — use Run Account Access Report for those.9 params

Search the configuration change history for a Google Analytics account or its child properties (e.g. property created, data stream updated). Does not include Data Access records — use Run Account Access Report for those.

NameTypeRequiredDescription
accountstringrequiredThe account to search change history for, in the form accounts/{accountId}.
actionarrayoptionalOptional list of action types to filter changes by. Only change events of these action types are returned, e.g. ["CREATED", "UPDATED"].
actor_emailarrayoptionalOptional list of actor email addresses to filter changes by. Only changes made by users with these emails are returned, e.g. ["user@example.com"].
earliest_change_timestringoptionalOptional. Only return changes made after this time, as an RFC 3339 UTC "Zulu" datetime (e.g. 2024-01-01T00:00:00Z).
latest_change_timestringoptionalOptional. Only return changes made before this time, as an RFC 3339 UTC "Zulu" datetime (e.g. 2024-12-31T23:59:59Z).
page_sizeintegeroptionalMaximum number of change history events to return per page. Defaults to 50 if omitted; the API caps this at 200.
page_tokenstringoptionalA page token from a previous Search Change History Events call, used to retrieve the next page of results.
propertystringoptionalOptional resource name of a property to filter changes for, in the form properties/{propertyId}. If omitted, returns changes for the whole account and all its properties.
resource_typearrayoptionalOptional list of resource types to filter changes by. Only change events touching these resource types are returned. Pass a raw array of strings, e.g. ["PROPERTY", "DATA_STREAM"].
googleanalytics_update_account#Update an existing Google Analytics account's editable fields (display name, region code). Requires the account resource name and an update mask listing which fields to change; only the fields named in the mask are applied.4 params

Update an existing Google Analytics account's editable fields (display name, region code). Requires the account resource name and an update mask listing which fields to change; only the fields named in the mask are applied.

NameTypeRequiredDescription
namestringrequiredThe account resource name to update, in the form accounts/{accountId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "display_name,region_code"). Only fields named here are changed; use "*" to replace the entire entity.
display_namestringoptionalNew human-readable display name for the account. Include this field's name in update_mask (display_name) for it to take effect.
region_codestringoptionalNew country of business as a Unicode CLDR region code (e.g. US, GB, IN). Include this field's name in update_mask (region_code) for it to take effect.
googleanalytics_update_conversion_event#Deprecated: prefer the equivalent Key Event tool. Update a conversion event's counting method or default conversion value. Requires the event resource name and an update mask listing which fields to change; only the fields named in the mask are applied.4 params

Deprecated: prefer the equivalent Key Event tool. Update a conversion event's counting method or default conversion value. Requires the event resource name and an update mask listing which fields to change; only the fields named in the mask are applied.

NameTypeRequiredDescription
namestringrequiredResource name of the conversion event to update, in the form properties/{propertyId}/conversionEvents/{conversionEventId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "counting_method"). Only fields named here are changed.
counting_methodstringoptionalHow conversions are counted across multiple events within a session. One of CONVERSION_COUNTING_METHOD_UNSPECIFIED, ONCE_PER_EVENT, or ONCE_PER_SESSION. Include this field's name in update_mask (counting_method) for it to take effect.
default_conversion_valueobjectoptionalNew default conversion value as a raw DefaultConversionValue object: {"value": <number>, "currencyCode": "<ISO4217>"}. Both fields are required together if set. Include this field's name in update_mask (default_conversion_value) for it to take effect.
googleanalytics_update_custom_dimension#Update a custom dimension's display name or description. Scope and parameter name are immutable and cannot be changed. Note: disallow_ads_personalization cannot be changed after creation either — confirmed live, Google rejects it in update_mask with "One or more values in the field 'update_mask.paths_list' was invalid" even though the field itself is not documented as immutable; set it at creation time via Create Custom Dimension instead.4 params

Update a custom dimension's display name or description. Scope and parameter name are immutable and cannot be changed. Note: disallow_ads_personalization cannot be changed after creation either — confirmed live, Google rejects it in update_mask with "One or more values in the field 'update_mask.paths_list' was invalid" even though the field itself is not documented as immutable; set it at creation time via Create Custom Dimension instead.

NameTypeRequiredDescription
namestringrequiredResource name of the custom dimension to update, in the form properties/{propertyId}/customDimensions/{customDimensionId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "display_name,description"). Only fields named here are changed.
descriptionstringoptionalNew description shown in the Analytics UI. Include description in update_mask for it to take effect.
display_namestringoptionalNew display name shown in the Analytics UI. Include display_name in update_mask for it to take effect.
googleanalytics_update_custom_metric#Update a custom metric's display name or description. Parameter name, scope, and measurement unit are immutable and cannot be changed.4 params

Update a custom metric's display name or description. Parameter name, scope, and measurement unit are immutable and cannot be changed.

NameTypeRequiredDescription
namestringrequiredResource name of the custom metric to update, in the form properties/{propertyId}/customMetrics/{customMetricId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "display_name,description"). Only fields named here are changed.
descriptionstringoptionalNew description shown in the Analytics UI. Include description in update_mask for it to take effect.
display_namestringoptionalNew display name shown in the Analytics UI. Include display_name in update_mask for it to take effect.
googleanalytics_update_data_retention_settings#Update a property's event-level and user-level data retention settings. Requires the settings resource name and an update mask listing which fields to change; only the fields named in the mask are applied.5 params

Update a property's event-level and user-level data retention settings. Requires the settings resource name and an update mask listing which fields to change; only the fields named in the mask are applied.

NameTypeRequiredDescription
namestringrequiredResource name of the data retention settings to update, in the form properties/{propertyId}/dataRetentionSettings.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "event_data_retention,user_data_retention"). Only fields named here are changed.
event_data_retentionstringoptionalNew retention duration for event-level data before it is automatically deleted. Include this field's name in update_mask (event_data_retention) for it to take effect. The 26/38/50-month values are available only to GA4 360 properties.
reset_user_data_on_new_activitybooleanoptionalIf true, the retention period for a given user's identifier resets to the full duration every time that user sends a new event to the property (a rolling window instead of a fixed one). Include this field's name in update_mask (reset_user_data_on_new_activity) for it to take effect.
user_data_retentionstringoptionalNew retention duration for user-level data (including user-ID and advertising-ID associated data) before it is automatically deleted. Include this field's name in update_mask (user_data_retention) for it to take effect.
googleanalytics_update_data_stream#Update a data stream's display name, or its type-specific web/Android/iOS stream data (e.g. the default URI for a web stream). Only fields named in the update mask are applied.6 params

Update a data stream's display name, or its type-specific web/Android/iOS stream data (e.g. the default URI for a web stream). Only fields named in the update mask are applied.

NameTypeRequiredDescription
namestringrequiredThe data stream resource name to update, in the form properties/{propertyId}/dataStreams/{streamId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "display_name,web_stream_data"). Only fields named here are changed.
android_app_stream_dataobjectoptionalRaw AndroidAppStreamData object carrying Android-app-stream-specific settings, e.g. {"packageName": "com.example.myapp"}. Only settable when this stream's type is ANDROID_APP_DATA_STREAM. Include this field's name in update_mask (android_app_stream_data) for it to take effect.
display_namestringoptionalNew display name for the stream, up to 255 UTF-16 code units. Include this field's name in update_mask (display_name) for it to take effect.
ios_app_stream_dataobjectoptionalRaw IosAppStreamData object carrying iOS-app-stream-specific settings, e.g. {"bundleId": "com.example.myapp"}. Only settable when this stream's type is IOS_APP_DATA_STREAM. Include this field's name in update_mask (ios_app_stream_data) for it to take effect.
web_stream_dataobjectoptionalRaw WebStreamData object carrying web-stream-specific settings, e.g. {"defaultUri": "https://www.example.com"}. Only settable when this stream's type is WEB_DATA_STREAM. Include this field's name in update_mask (web_stream_data) for it to take effect.
googleanalytics_update_key_event#Update a key event's counting method or default value. Requires the event resource name and an update mask listing which fields to change; only the fields named in the mask are applied.4 params

Update a key event's counting method or default value. Requires the event resource name and an update mask listing which fields to change; only the fields named in the mask are applied.

NameTypeRequiredDescription
namestringrequiredResource name of the key event to update, in the form properties/{propertyId}/keyEvents/{keyEventId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "counting_method"). Only fields named here are changed.
counting_methodstringoptionalHow this key event is counted across multiple events within a session. One of COUNTING_METHOD_UNSPECIFIED, ONCE_PER_EVENT, or ONCE_PER_SESSION. Include this field's name in update_mask (counting_method) for it to take effect.
default_valueobjectoptionalNew default value for this key event as a raw KeyEventDefaultValue object: {"numericValue": <number>, "currencyCode": "<ISO4217>"}. Include this field's name in update_mask (default_value) for it to take effect.
googleanalytics_update_measurement_protocol_secret#Update a Measurement Protocol secret's display name. Only fields named in the update mask are applied; the secret value itself cannot be changed.3 params

Update a Measurement Protocol secret's display name. Only fields named in the update mask are applied; the secret value itself cannot be changed.

NameTypeRequiredDescription
namestringrequiredThe Measurement Protocol secret resource name to update, in the form properties/{propertyId}/dataStreams/{streamId}/measurementProtocolSecrets/{secretId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "display_name"). Only fields named here are changed.
display_namestringoptionalNew human-readable display name for this secret. Include this field's name in update_mask (display_name) for it to take effect.
googleanalytics_update_property#Update an existing Google Analytics property's editable fields (display name, industry category, time zone, currency code). Requires the property resource name and an update mask listing which fields to change; only the fields named in the mask are applied.6 params

Update an existing Google Analytics property's editable fields (display name, industry category, time zone, currency code). Requires the property resource name and an update mask listing which fields to change; only the fields named in the mask are applied.

NameTypeRequiredDescription
namestringrequiredResource name of the property to update, in the form properties/{propertyId}.
update_maskstringrequiredComma-separated list of field names to update, in snake_case (e.g. "display_name,time_zone"). Only fields named here are changed.
currency_codestringoptionalNew ISO 4217 currency code for the property, e.g. USD. Include this field's name in update_mask (currency_code) for it to take effect.
display_namestringoptionalNew human-readable display name for the property (max 100 UTF-16 code units). Include this field's name in update_mask (display_name) for it to take effect.
industry_categorystringoptionalNew industry category for the property. Include this field's name in update_mask (industry_category) for it to take effect.
time_zonestringoptionalNew IANA reporting time zone for the property, e.g. America/Los_Angeles. Include this field's name in update_mask (time_zone) for it to take effect.