For a list of methods for this resource, see the end of this page.
Resource representations
{ "kind": "adexchangebuyer#pretargetingConfig", "configId": long, "billingId": long, "configName": string, "isActive": boolean, "creativeType": [ string ], "dimensions": [ { "width": long, "height": long } ], "languages": [ string ], "geoCriteriaIds": [ long ], "excludedGeoCriteriaIds": [ long ], "supportedCreativeAttributes": [ long ], "vendorTypes": [ long ], "placements": [ { "type": string, "token": string } ], "excludedPlacements": [ { "type": string, "token": string } ], "verticals": [ long ], "excludedVerticals": [ long ], "userLists": [ long ], "excludedUserLists": [ long ], "excludedContentLabels": [ long ], "platforms": [ string ], "mobileCarriers": [ long ], "mobileDevices": [ long ], "mobileOperatingSystemVersions": [ long ], "maximumQps": long }
Property name | Value | Description | Notes |
---|---|---|---|
billingId |
long |
The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically. | |
configId |
long |
The config id; generated automatically. Leave this field blank for insert requests. | |
configName |
string |
The name of the config. Must be unique. Required for all requests. | writable |
creativeType[] |
list |
List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. | |
dimensions[] |
list |
Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions. | |
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[] |
list |
Requests containing any of these placements will not match. | |
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 |
kind |
string |
The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig". | |
languages[] |
list |
Request containing any of these language codes will match. | writable |
maximumQps |
long |
The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed). | |
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[] |
list |
Requests containing any of these placements will match. | |
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 |
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 |
Methods
- delete
- Deletes an existing pretargeting config.
- get
- Gets a specific pretargeting configuration
- insert
- Inserts a new pretargeting configuration.
- list
- Retrieves a list of the authenticated user's pretargeting configurations.
- patch
- Updates an existing pretargeting config. This method supports patch semantics.
- update
- Updates an existing pretargeting config.