This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to the Marketers site. If you are a measurement partner, refer to the Measurement Partners site.
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
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eAdds event matchers to a frequency-based user list without deleting existing ones or modifying frequency-based constraint metadata.\u003c/p\u003e\n"],["\u003cp\u003eThe request must specify the user list using its full resource name and include an array of event matchers to be added.\u003c/p\u003e\n"],["\u003cp\u003eThe user list should not already contain the same constraints being added but can have other pre-existing constraints.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the updated UserList object.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This document details the process of adding event matchers to a frequency-based user list in Ads Data Hub. The core action is adding event matchers via a `POST` request to the specified URL, using the `userList` path parameter to identify the target list. The request body, formatted in JSON, contains an array of `eventMatchers`. The `userList` must be a frequency based type and cannot already include the same constraint values. A successful response returns an updated `UserList`. Authentication requires the `adsdatahub` OAuth scope. Frequency capping is no longer supported.\n"],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\n| Frequency capping audiences are no longer supported in Ads Data Hub due to the upstream [deprecation of frequency-based audiences in Display \\& Video 360](https://support.google.com/displayvideo/answer/13439592).\nAdds 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\".\n\nHTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{userList=customers/*/userLists/*}:addEventMatchers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userList` | `string` Required. Full resource name, has the form of 'customers/\\[customerId\\]/userLists/\\[userlist_id\\]'. UserList must have UserListType FREQUENCY_BASED. |\n\nRequest body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------|\n| ``` { \"eventMatchers\": [ { object (/ads-data-hub/reference/rest/v1/customers.userLists#EventMatcher) } ] } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `eventMatchers[]` | `object (`[EventMatcher](/ads-data-hub/reference/rest/v1/customers.userLists#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. |\n\nResponse body\n\nIf successful, the response body contains an instance of [UserList](/ads-data-hub/reference/rest/v1/customers.userLists#UserList).\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]
