Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
floodlightActivities

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

patch/userprofiles/{+profileId}/floodlightActivities

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

idstring required

Required. EventTag ID.

Request body

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.

floodlightConfigurationIdstring 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.

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.

notesstring

General notes or implementation instructions for the tag.

floodlightTagType'IFRAME' | 'IMAGE' | 'GLOBAL_SITE_TAG'

The type of Floodlight tag this activity will generate. This is a required field.

tagStringstring

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.

floodlightActivityGroupType'COUNTER' | 'SALE'

Type of the associated floodlight activity group. This is a read-only field.

tagFormat'HTML' | 'XHTML'

Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.

attributionEnabledboolean

Whether the activity is enabled for attribution.

advertiserIdstring 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.

floodlightActivityGroupTagStringstring

Tag string of the associated floodlight activity group. This is a read-only field.

floodlightActivityGroupNamestring

Name of the associated floodlight activity group. This is a read-only field.

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.

userDefinedVariableTypesstring[]

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.

floodlightActivityGroupIdstring int64

Floodlight activity group ID of this floodlight activity. This is a required field.

sslCompliantboolean

Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.

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.

sslRequiredboolean

Whether this floodlight activity must be SSL-compliant.

namestring

Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.

secureboolean

Whether this tag should use SSL.

accountIdstring int64

Account ID of this floodlight activity. This is a read-only field that can be left blank.

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".

subaccountIdstring int64

Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.

expectedUrlstring

URL where this tag will be deployed. If specified, must be less than 256 characters long.

idstring int64

ID of this floodlight activity. This is a read-only, auto-generated field.

Response

Successful response