Method: customers.userLists.patch

  • This page details how to update an Ads Data Hub-managed user list using a PATCH HTTP request.

  • The request uses a specific URL structure including a path parameter for the user list name and a required query parameter updateMask to specify fields for partial updates.

  • The request and response bodies contain instances of a UserList object.

  • The operation requires the https://www.googleapis.com/auth/adsdatahub OAuth scope for authorization.

Updates the requested Ads Data Hub-managed user list.

HTTP request

PATCH https://adsdatahub.googleapis.com/v1/{userList.name=customers/*/userLists/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userList.name

string

Output only. Immutable. Name that uniquely identifies an Ads Data Hub user list. It has the form customers/[customerId]/userLists/[userListId]

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask to support partial updates. Only the following paths may be updated via the API: - title - description - recipientAdsDataLinks

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of UserList.

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