Updates an existing pretargeting config. Try it now.
Request
HTTP request
PUT https://www.googleapis.com/adexchangebuyer/v1.4/pretargetingconfigs/accountId/configId
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
accountId |
long |
The account id to update the pretargeting config for. |
configId |
long |
The specific id of the configuration to update. |
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/adexchange.buyer |
For more information, see the authentication and authorization page.
Request body
In the request body, supply a PretargetingConfig resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
Optional Properties | |||
configName |
string |
The name of the config. Must be unique. Required for all requests. | writable |
dimensions[].height |
long |
Height in pixels. | writable |
dimensions[].width |
long |
Width in pixels. | writable |
excludedContentLabels[] |
list |
Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section. | writable |
excludedGeoCriteriaIds[] |
list |
Requests containing any of these geo criteria ids will not match. | writable |
excludedPlacements[].token |
string |
The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement. | writable |
excludedPlacements[].type |
string |
The type of the placement.
Acceptable values are:
|
writable |
excludedUserLists[] |
list |
Requests containing any of these users list ids will not match. | writable |
excludedVerticals[] |
list |
Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. | writable |
geoCriteriaIds[] |
list |
Requests containing any of these geo criteria ids will match. | writable |
isActive |
boolean |
Whether this config is active. Required for all requests. | writable |
languages[] |
list |
Request containing any of these language codes will match. | writable |
minimumViewabilityDecile |
integer |
Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored. | writable |
mobileCarriers[] |
list |
Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section. | writable |
mobileDevices[] |
list |
Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section. | writable |
mobileOperatingSystemVersions[] |
list |
Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section. | writable |
placements[].token |
string |
The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement. | writable |
placements[].type |
string |
The type of the placement.
Acceptable values are:
|
writable |
platforms[] |
list |
Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. | writable |
supportedCreativeAttributes[] |
list |
Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section. | writable |
userIdentifierDataRequired[] |
list |
Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA. | writable |
userLists[] |
list |
Requests containing any of these user list ids will match. | writable |
vendorTypes[] |
list |
Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section. | writable |
verticals[] |
list |
Requests containing any of these vertical ids will match. | writable |
videoPlayerSizes[].aspectRatio |
string |
The type of aspect ratio. Leave this field blank to match all aspect ratios.
Acceptable values are:
|
writable |
videoPlayerSizes[].minWidth |
long |
The minimum player width in pixels. Leave this field blank to match any player width. | writable |
Response
If successful, this method returns a PretargetingConfig resource in the response body.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.