get(profileId, id, x__xgafv=None)

Gets one event tag by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Event tag ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of an event tag.
  "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
  "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
  "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
  "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
  "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
  "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
  "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
    "A String",
  ],
  "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
  "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
  "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
  "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
  "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
  "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
}

insert(profileId, body=None, x__xgafv=None)

Inserts a new event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of an event tag.
  "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
  "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
  "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
  "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
  "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
  "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
  "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
    "A String",
  ],
  "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
  "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
  "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
  "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
  "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
  "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of an event tag.
  "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
  "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
  "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
  "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
  "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
  "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
  "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
    "A String",
  ],
  "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
  "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
  "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
  "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
  "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
  "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
}

list(profileId, adId=None, advertiserId=None, campaignId=None, definitionsOnly=None, enabled=None, eventTagTypes=None, ids=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)

Retrieves a list of event tags, possibly filtered.

Args:
profileId: string, User profile ID associated with this request. (required)
adId: string, Select only event tags that belong to this ad.
advertiserId: string, Select only event tags that belong to this advertiser.
campaignId: string, Select only event tags that belong to this campaign.
definitionsOnly: boolean, Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
enabled: boolean, Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
Allowed values
IMPRESSION_IMAGE_EVENT_TAG -
IMPRESSION_JAVASCRIPT_EVENT_TAG -
CLICK_THROUGH_EVENT_TAG -
ids: string, Select only event tags with these IDs. (repeated)
searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Event Tag List Response
"eventTags": [ # Event tag collection.
{ # Contains properties of an event tag.
"accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
"advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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": "A String", # The value of the dimension.
},
"campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # 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": "A String", # The value of the dimension.
},
"enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
"excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
"id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
"name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
"siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
"siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
"A String",
],
"sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
"status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
"subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
"type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
"url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
"urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
}

patch(profileId, id, body=None, x__xgafv=None)

Updates an existing event tag. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, EventTag ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of an event tag.
  "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
  "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
  "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
  "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
  "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
  "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
  "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
    "A String",
  ],
  "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
  "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
  "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
  "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
  "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
  "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of an event tag.
  "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
  "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
  "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
  "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
  "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
  "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
  "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
    "A String",
  ],
  "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
  "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
  "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
  "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
  "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
  "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
}

update(profileId, body=None, x__xgafv=None)

Updates an existing event tag.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of an event tag.
  "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
  "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
  "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
  "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
  "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
  "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
  "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
    "A String",
  ],
  "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
  "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
  "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
  "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
  "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
  "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of an event tag.
  "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
  "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
  "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
  "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "matchType": "A String", # 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": "A String", # The value of the dimension.
  },
  "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
  "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
  "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
  "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
  "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
  "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
    "A String",
  ],
  "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
  "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
  "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
  "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
  "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
  "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
}

Campaign Manager 360 API . eventTags

Instance Methods

Method Details