---
title: "PATCH /userprofiles/{userprofilesId}/floodlightActivities"
method: PATCH
path: "/userprofiles/{userprofilesId}/floodlightActivities"
tags: ["floodlightActivities"]
---

# PATCH /userprofiles/{userprofilesId}/floodlightActivities

`PATCH /userprofiles/{userprofilesId}/floodlightActivities`

## Request

- Base URL: `https://dfareporting.googleapis.com/dfareporting/v5`
- URL: `https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{userprofilesId}/floodlightActivities`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/dfatrafficking`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/dfatrafficking`
- TypeScript: <https://skmtc.dev/google/apis/dfareporting/docs/userprofiles/:userprofilesId/floodlightActivities/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates an existing floodlight activity. This method supports patch semantics.

## Path parameters

- `userprofilesId` string, required

## Query parameters

- `id` string, int64, required

## Request body

- FloodlightActivity: Contains properties of a Floodlight activity.
  - `accountId` string, int64: Account ID of this floodlight activity. This is a read-only field that can be left blank.
  - `advertiserId` string, int64: Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
  - `advertiserIdDimensionValue` DimensionValue: Represents a DimensionValue resource.
    - `dimensionName` string: The name of the dimension.
    - `etag` string: The eTag of this response for caching purposes.
    - `id` string: The ID associated with the value if available.
    - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
    - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
    - `value` string: The value of the dimension.
  - `attributionEnabled` boolean: Whether the activity is enabled for attribution.
  - `cacheBustingType` 'JAVASCRIPT' | 'ACTIVE_SERVER_PAGE' | 'JSP' | 'PHP' | 'COLD_FUSION': Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
  - `conversionCategory` 'CONVERSION_CATEGORY_DEFAULT' | 'CONVERSION_CATEGORY_PURCHASE' | 'CONVERSION_CATEGORY_SIGNUP' | 'CONVERSION_CATEGORY_PAGE_VIEW' | 'CONVERSION_CATEGORY_DOWNLOAD' | 'CONVERSION_CATEGORY_ADD_TO_CART' | 'CONVERSION_CATEGORY_BEGIN_CHECKOUT' | 'CONVERSION_CATEGORY_SUBSCRIBE_PAID' | 'CONVERSION_CATEGORY_SUBMIT_LEAD_FORM' | 'CONVERSION_CATEGORY_BOOK_APPOINTMENT' | 'CONVERSION_CATEGORY_REQUEST_QUOTE' | 'CONVERSION_CATEGORY_GET_DIRECTIONS' | 'CONVERSION_CATEGORY_OUTBOUND_CLICK' | 'CONVERSION_CATEGORY_CONTACT' | 'CONVERSION_CATEGORY_QUALIFIED_LEAD' | 'CONVERSION_CATEGORY_CONVERTED_LEAD' | 'CONVERSION_CATEGORY_IN_APP_AD_REVENUE': Required. The conversion category of the activity.
  - `countingMethod` 'STANDARD_COUNTING' | 'UNIQUE_COUNTING' | 'SESSION_COUNTING' | 'TRANSACTIONS_COUNTING' | 'ITEMS_SOLD_COUNTING': Counting method for conversions for this floodlight activity. This is a required field.
  - `defaultTags` FloodlightActivityDynamicTag[]: Dynamic floodlight tags.
    - `id` string, int64: ID of this dynamic tag. This is a read-only, auto-generated field.
    - `name` string: Name of this tag.
    - `tag` string: Tag code.
  - `expectedUrl` string: URL where this tag will be deployed. If specified, must be less than 256 characters long.
  - `floodlightActivityGroupId` string, int64: Floodlight activity group ID of this floodlight activity. This is a required field.
  - `floodlightActivityGroupName` string: Name of the associated floodlight activity group. This is a read-only field.
  - `floodlightActivityGroupTagString` string: Tag string of the associated floodlight activity group. This is a read-only field.
  - `floodlightActivityGroupType` 'COUNTER' | 'SALE': Type of the associated floodlight activity group. This is a read-only field.
  - `floodlightConfigurationId` string, int64: Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
  - `floodlightConfigurationIdDimensionValue` DimensionValue: Represents a DimensionValue resource.
    - `dimensionName` string: The name of the dimension.
    - `etag` string: The eTag of this response for caching purposes.
    - `id` string: The ID associated with the value if available.
    - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
    - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
    - `value` string: The value of the dimension.
  - `floodlightTagType` 'IFRAME' | 'IMAGE' | 'GLOBAL_SITE_TAG': The type of Floodlight tag this activity will generate. This is a required field.
  - `id` string, int64: ID of this floodlight activity. This is a read-only, auto-generated field.
  - `idDimensionValue` DimensionValue: Represents a DimensionValue resource.
    - `dimensionName` string: The name of the dimension.
    - `etag` string: The eTag of this response for caching purposes.
    - `id` string: The ID associated with the value if available.
    - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
    - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
    - `value` string: The value of the dimension.
  - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
  - `name` string: Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
  - `notes` string: General notes or implementation instructions for the tag.
  - `publisherTags` FloodlightActivityPublisherDynamicTag[]: Publisher dynamic floodlight tags.
    - `clickThrough` boolean: Whether this tag is applicable only for click-throughs.
    - `directorySiteId` string, int64: Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
    - `dynamicTag` FloodlightActivityDynamicTag: Dynamic Tag
      - `id` string, int64: ID of this dynamic tag. This is a read-only, auto-generated field.
      - `name` string: Name of this tag.
      - `tag` string: Tag code.
    - `siteId` string, int64: Site ID of this dynamic tag.
    - `siteIdDimensionValue` DimensionValue: Represents a DimensionValue resource.
      - `dimensionName` string: The name of the dimension.
      - `etag` string: The eTag of this response for caching purposes.
      - `id` string: The ID associated with the value if available.
      - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
      - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
      - `value` string: The value of the dimension.
    - `viewThrough` boolean: Whether this tag is applicable only for view-throughs.
  - `secure` boolean: Whether this tag should use SSL.
  - `sslCompliant` boolean: Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
  - `sslRequired` boolean: Whether this floodlight activity must be SSL-compliant.
  - `status` 'ACTIVE' | 'ARCHIVED_AND_DISABLED' | 'ARCHIVED' | 'DISABLED_POLICY': The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
  - `subaccountId` string, int64: Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
  - `tagFormat` 'HTML' | 'XHTML': Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
  - `tagString` string: Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
  - `userDefinedVariableTypes` string[]: List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.

## Response `200`

Successful response

- FloodlightActivity: Contains properties of a Floodlight activity.
  - `accountId` string, int64: Account ID of this floodlight activity. This is a read-only field that can be left blank.
  - `advertiserId` string, int64: Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
  - `advertiserIdDimensionValue` DimensionValue: Represents a DimensionValue resource.
    - `dimensionName` string: The name of the dimension.
    - `etag` string: The eTag of this response for caching purposes.
    - `id` string: The ID associated with the value if available.
    - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
    - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
    - `value` string: The value of the dimension.
  - `attributionEnabled` boolean: Whether the activity is enabled for attribution.
  - `cacheBustingType` 'JAVASCRIPT' | 'ACTIVE_SERVER_PAGE' | 'JSP' | 'PHP' | 'COLD_FUSION': Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
  - `conversionCategory` 'CONVERSION_CATEGORY_DEFAULT' | 'CONVERSION_CATEGORY_PURCHASE' | 'CONVERSION_CATEGORY_SIGNUP' | 'CONVERSION_CATEGORY_PAGE_VIEW' | 'CONVERSION_CATEGORY_DOWNLOAD' | 'CONVERSION_CATEGORY_ADD_TO_CART' | 'CONVERSION_CATEGORY_BEGIN_CHECKOUT' | 'CONVERSION_CATEGORY_SUBSCRIBE_PAID' | 'CONVERSION_CATEGORY_SUBMIT_LEAD_FORM' | 'CONVERSION_CATEGORY_BOOK_APPOINTMENT' | 'CONVERSION_CATEGORY_REQUEST_QUOTE' | 'CONVERSION_CATEGORY_GET_DIRECTIONS' | 'CONVERSION_CATEGORY_OUTBOUND_CLICK' | 'CONVERSION_CATEGORY_CONTACT' | 'CONVERSION_CATEGORY_QUALIFIED_LEAD' | 'CONVERSION_CATEGORY_CONVERTED_LEAD' | 'CONVERSION_CATEGORY_IN_APP_AD_REVENUE': Required. The conversion category of the activity.
  - `countingMethod` 'STANDARD_COUNTING' | 'UNIQUE_COUNTING' | 'SESSION_COUNTING' | 'TRANSACTIONS_COUNTING' | 'ITEMS_SOLD_COUNTING': Counting method for conversions for this floodlight activity. This is a required field.
  - `defaultTags` FloodlightActivityDynamicTag[]: Dynamic floodlight tags.
    - `id` string, int64: ID of this dynamic tag. This is a read-only, auto-generated field.
    - `name` string: Name of this tag.
    - `tag` string: Tag code.
  - `expectedUrl` string: URL where this tag will be deployed. If specified, must be less than 256 characters long.
  - `floodlightActivityGroupId` string, int64: Floodlight activity group ID of this floodlight activity. This is a required field.
  - `floodlightActivityGroupName` string: Name of the associated floodlight activity group. This is a read-only field.
  - `floodlightActivityGroupTagString` string: Tag string of the associated floodlight activity group. This is a read-only field.
  - `floodlightActivityGroupType` 'COUNTER' | 'SALE': Type of the associated floodlight activity group. This is a read-only field.
  - `floodlightConfigurationId` string, int64: Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
  - `floodlightConfigurationIdDimensionValue` DimensionValue: Represents a DimensionValue resource.
    - `dimensionName` string: The name of the dimension.
    - `etag` string: The eTag of this response for caching purposes.
    - `id` string: The ID associated with the value if available.
    - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
    - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
    - `value` string: The value of the dimension.
  - `floodlightTagType` 'IFRAME' | 'IMAGE' | 'GLOBAL_SITE_TAG': The type of Floodlight tag this activity will generate. This is a required field.
  - `id` string, int64: ID of this floodlight activity. This is a read-only, auto-generated field.
  - `idDimensionValue` DimensionValue: Represents a DimensionValue resource.
    - `dimensionName` string: The name of the dimension.
    - `etag` string: The eTag of this response for caching purposes.
    - `id` string: The ID associated with the value if available.
    - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
    - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
    - `value` string: The value of the dimension.
  - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
  - `name` string: Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
  - `notes` string: General notes or implementation instructions for the tag.
  - `publisherTags` FloodlightActivityPublisherDynamicTag[]: Publisher dynamic floodlight tags.
    - `clickThrough` boolean: Whether this tag is applicable only for click-throughs.
    - `directorySiteId` string, int64: Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
    - `dynamicTag` FloodlightActivityDynamicTag: Dynamic Tag
      - `id` string, int64: ID of this dynamic tag. This is a read-only, auto-generated field.
      - `name` string: Name of this tag.
      - `tag` string: Tag code.
    - `siteId` string, int64: Site ID of this dynamic tag.
    - `siteIdDimensionValue` DimensionValue: Represents a DimensionValue resource.
      - `dimensionName` string: The name of the dimension.
      - `etag` string: The eTag of this response for caching purposes.
      - `id` string: The ID associated with the value if available.
      - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue.
      - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
      - `value` string: The value of the dimension.
    - `viewThrough` boolean: Whether this tag is applicable only for view-throughs.
  - `secure` boolean: Whether this tag should use SSL.
  - `sslCompliant` boolean: Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
  - `sslRequired` boolean: Whether this floodlight activity must be SSL-compliant.
  - `status` 'ACTIVE' | 'ARCHIVED_AND_DISABLED' | 'ARCHIVED' | 'DISABLED_POLICY': The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
  - `subaccountId` string, int64: Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
  - `tagFormat` 'HTML' | 'XHTML': Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
  - `tagString` string: Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
  - `userDefinedVariableTypes` string[]: List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.

---

[API](https://skmtc.dev/google/apis/dfareporting.md) - [All operations](https://skmtc.dev/google/apis/dfareporting/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/dfareporting/revisions/be73a9a450de?raw)