Method: bidders.pretargetingConfigs.suspend
Stay organized with collections
Save and categorize content based on your preferences.
Suspends a pretargeting configuration.
HTTP request
POST https://realtimebidding.googleapis.com/v1/{name=bidders/*/pretargetingConfigs/*}:suspend
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of PretargetingConfig.
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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eSuspends a specified pretargeting configuration using an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003ePOST\u003c/code\u003e method with a specific URL structure including bidder and configuration IDs.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"],["\u003cp\u003eReturns the \u003ccode\u003ePretargetingConfig\u003c/code\u003e object upon successful suspension.\u003c/p\u003e\n"]]],["This document outlines the process to suspend a pretargeting configuration using an HTTP POST request. The request targets a specific configuration via a URL path parameter, `name`, which includes the bidder's account ID and configuration ID. The request body must be empty. A successful request returns a `PretargetingConfig` instance in the response body. Authorization requires the `https://www.googleapis.com/auth/realtime-bidding` OAuth scope. The provided information include a URL and path parameter format.\n"],null,["# Method: bidders.pretargetingConfigs.suspend\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nSuspends a pretargeting configuration.\n\n### HTTP request\n\n`POST https://realtimebidding.googleapis.com/v1/{name=bidders/*/pretargetingConfigs/*}:suspend`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [PretargetingConfig](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders.pretargetingConfigs#PretargetingConfig).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]
