Method: customers.userLists.addRecipients
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
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userList |
string
Required. Full resource name of the user list to be updated. Has the form of customers/[customerId]/userLists/[userlist_id]
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"recipientAdsDataLinks": [
string
]
} |
| Fields |
recipientAdsDataLinks[] |
string
Add these linked entities to the specified userList’s recipients. eg. customers/[customerId]/adsDataLinks/[resource_id]
|
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["This operation allows you to add Google Ads Customer, DV360 Partner, or DV360 Advertiser entities as recipients to an Ads Data Hub-managed user list."],["The entities being added must already be linked to the Ads Data Hub customer associated with the user list."],["You will need to provide a list of Ads Data Links representing the recipients in the request body."],["A successful operation will return the updated UserList object in the response."],["Authorization requires the `https://www.googleapis.com/auth/adsdatahub` scope."]]],["This describes how to add entities 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's resource name. The request body, formatted as JSON, contains `recipientAdsDataLinks`, an array of strings representing linked entities. Supported entity types include Google Ads Customer, DV360 Partner, and DV360 Advertiser. A successful request returns an updated `UserList` instance. Authorization requires the `https://www.googleapis.com/auth/adsdatahub` OAuth scope.\n"]]
