Method: customers.userLists.addEventMatchers

  • Frequency capping audiences are no longer supported in Ads Data Hub.

  • This method adds event matchers to a frequency-based user list but cannot delete or modify existing matchers or constraints.

  • The HTTP request uses a POST method to the specified API endpoint.

  • The request body contains an array of eventMatchers objects to be added to the user list.

  • A successful response will return an instance of UserList.

  • Authorization requires the https://www.googleapis.com/auth/adsdatahub OAuth scope.

Adds event matchers to a frequency-based user list. This call cannot delete existing event matchers or modify frequency-based constraint metadata such as window or when a user is added. The user list may already contain some event matchers. For example, this call could add: AddEventMatchersRequest { userList: "customers/1/userLists/12345" eventMatchers { matchType: GOOGLE_ADS_CAMPAIGN_ID value: "3456" } } For this call to succeed, user list 12345 should not already contain a campaign constraint of the type GOOGLE_ADS_CAMPAIGN_ID with campaign id "3456".

HTTP request

POST https://adsdatahub.googleapis.com/v1/{userList=customers/*/userLists/*}:addEventMatchers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userList

string

Required. Full resource name, has the form of ‘customers/[customerId]/userLists/[userlist_id]’. UserList must have UserListType FREQUENCY_BASED.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ]
}
Fields
eventMatchers[]

object (EventMatcher)

Contain only those constraints to add to the user list. The user list specified by userList should have none of the constraints specified here at the time of the call but can have other pre-existing constraints.

Response body

If successful, the response body contains an instance of UserList.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub