Method: bidders.endpoints.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a bidder's endpoint.
HTTP request
PATCH https://realtimebidding.googleapis.com/v1/{endpoint.name=bidders/*/endpoints/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
endpoint.name |
string
Output only. Name of the endpoint resource that must follow the pattern bidders/{bidderAccountId}/endpoints/{endpointId}, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Field mask to use for partial in-place updates. 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 Endpoint.
Response body
If successful, the response body contains an instance of Endpoint.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/realtime-bidding
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-05-07 UTC.
[null,null,["Last updated 2025-05-07 UTC."],[[["\u003cp\u003eThis operation updates a bidder's endpoint using a \u003ccode\u003ePATCH\u003c/code\u003e request to the specified URL.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires path and query parameters to identify the endpoint and specify fields to update, respectively.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eEndpoint\u003c/code\u003e object is provided in the request body to define the updates, and the response also contains an \u003ccode\u003eEndpoint\u003c/code\u003e object upon successful completion.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using the \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This documentation details updating a bidder's endpoint via a `PATCH` request to a specific URL: `https://realtimebidding.googleapis.com/v1/{endpoint.name=bidders/*/endpoints/*}`. The endpoint's `name` is a required path parameter. The `updateMask` query parameter enables partial updates using a comma-separated list of field names. The request and response bodies both contain an `Endpoint` instance. Authorization requires the `https://www.googleapis.com/auth/realtime-bidding` OAuth scope. A functional \"Try It!\" link is also provided.\n"],null,["# Method: bidders.endpoints.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 a bidder's endpoint.\n\n### HTTP request\n\n`PATCH https://realtimebidding.googleapis.com/v1/{endpoint.name=bidders/*/endpoints/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `endpoint.name` | `string` Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId} is the account ID of the bidder who operates this endpoint, and {endpointId} is a unique ID assigned by the server. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Field mask to use for partial in-place updates. 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 [Endpoint](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#Endpoint).\n\n### Response body\n\nIf successful, the response body contains an instance of [Endpoint](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.endpoints#Endpoint).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]
