This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to theMarketerssite. If you are a measurement partner, refer to theMeasurement Partnerssite.
Add entities to an Ads Data Hub-managed user list’s recipients. Supported entities are: - Google Ads Customer - DV360 Partner - DV360 Advertiser These entities must be linked to the ads data customer associated with the UserList.
HTTP request
POST https://adsdatahub.googleapis.com/v1/{userList=customers/*/userLists/*}:addRecipients
[[["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\u003eAdd Google Ads Customer, DV360 Partner, or DV360 Advertiser entities as recipients to an Ads Data Hub-managed user list.\u003c/p\u003e\n"],["\u003cp\u003eEntities must be linked to the Ads Data Hub customer associated with the UserList and added using their respective Ads Data Links.\u003c/p\u003e\n"],["\u003cp\u003eUse the \u003ccode\u003ePOST\u003c/code\u003e method and the provided URL with necessary path and request body parameters to add recipients.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful execution returns the updated UserList object in the response body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes how to add recipients to an Ads Data Hub-managed user list. A `POST` request is sent to `https://adsdatahub.googleapis.com/v1/{userList=customers/*/userLists/*}:addRecipients` using gRPC Transcoding syntax. The `userList` path parameter specifies the target list. The request body contains a JSON array, `recipientAdsDataLinks[]`, with strings representing linked entities (e.g., Google Ads Customer). Successful requests return a `UserList` instance in the response. This process requires the `https://www.googleapis.com/auth/adsdatahub` OAuth scope.\n"],null,["# Method: customers.userLists.addRecipients\n\n- [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\nAdd entities to an Ads Data Hub-managed user list's recipients. Supported entities are: - Google Ads Customer - DV360 Partner - DV360 Advertiser These entities must be linked to the ads data customer associated with the UserList.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{userList=customers/*/userLists/*}:addRecipients`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| `userList` | `string` Required. Full resource name of the user list to be updated. Has the form of customers/\\[customerId\\]/userLists/\\[userlist_id\\] |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------|\n| ``` { \"recipientAdsDataLinks\": [ string ] } ``` |\n\n| Fields ||\n|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `recipientAdsDataLinks[]` | `string` Add these linked entities to the specified userList's recipients. eg. customers/\\[customerId\\]/adsDataLinks/\\[resource_id\\] |\n\n### Response body\n\nIf successful, the response body contains an instance of [UserList](/ads-data-hub/reference/rest/v1/customers.userLists#UserList).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]
