Starting
September 8, 2025, every new line item will need to declare whether or not they will serve Eurpoean Union (EU) political ads. Display & Video 360 API and SDF uploads that don't provide declarations will fail. See our
deprecations page for more details on how to update your integration to make this declaration.
Method: users.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates an existing user. Returns the updated user if successful.
This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method.
The "Try this method" feature does not work for this method.
HTTP request
PATCH https://displayvideo.googleapis.com/v4/users/{user.userId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
user.userId |
string (int64 format)
Output only. The unique ID of the user. Assigned by the system.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Required. The mask to control which fields to update. 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 User.
Response body
If successful, the response body contains an instance of User.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/display-video-user-management
For more information, see the OAuth 2.0 Overview.
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 2025-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[],["The Display & Video 360 API v4, in beta, enables updating existing users via a PATCH request to `https://displayvideo.googleapis.com/v4/users/{user.userId}`. It uses gRPC Transcoding and requires specific authentication prerequisites. The `updateMask` query parameter is mandatory, specifying the fields for modification. The request body contains user data, and successful responses return the updated user. OAuth scope `https://www.googleapis.com/auth/display-video-user-management` is needed for authorization. The try method feature is unavailable.\n"],null,["# Method: users.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates an existing user. Returns the updated user if successful.\n\nThis method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method.\n\nThe \"Try this method\" feature does not work for this method.\n\n### HTTP request\n\n`PATCH https://displayvideo.googleapis.com/v4/users/{user.userId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `user.userId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. The unique ID of the user. Assigned by the system. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. The mask to control which fields to update. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [User](/display-video/api/reference/rest/v4/users#User).\n\n### Response body\n\nIf successful, the response body contains an instance of [User](/display-video/api/reference/rest/v4/users#User).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video-user-management`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
