PretargetingConfig

import type { PretargetingConfig } from "https://googleapis.deno.dev/v1/realtimebidding:v1.ts";

Pretargeting config: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.

interface PretargetingConfig {

allowedUserTargetingModes?: "USER_TARGETING_MODE_UNSPECIFIED" | "REMARKETING_ADS" | "INTEREST_BASED_TARGETING"[];

appTargeting?: AppTargeting;

readonly billingId?: bigint;

displayName?: string;

excludedContentLabelIds?: bigint[];

geoTargeting?: NumericTargetingDimension;

includedCreativeDimensions?: CreativeDimensions[];

includedEnvironments?: "ENVIRONMENT_UNSPECIFIED" | "APP" | "WEB"[];

includedFormats?:

| "CREATIVE_FORMAT_UNSPECIFIED"

| "HTML"

| "VAST"

| "NATIVE"[];

includedLanguages?: string[];

includedMobileOperatingSystemIds?: bigint[];

includedPlatforms?:

| "PLATFORM_UNSPECIFIED"

| "PERSONAL_COMPUTER"

| "PHONE"

| "TABLET"

| "CONNECTED_TV"[];

includedUserIdTypes?:

| "USER_ID_TYPE_UNSPECIFIED"

| "HOSTED_MATCH_DATA"

| "GOOGLE_COOKIE"

| "DEVICE_ID"

| "PUBLISHER_PROVIDED_ID"

| "PUBLISHER_FIRST_PARTY_ID"[];

interstitialTargeting?: "INTERSTITIAL_TARGETING_UNSPECIFIED" | "ONLY_INTERSTITIAL_REQUESTS" | "ONLY_NON_INTERSTITIAL_REQUESTS";

readonly invalidGeoIds?: bigint[];

maximumQps?: bigint;

minimumViewabilityDecile?: number;

readonly name?: string;

publisherTargeting?: StringTargetingDimension;

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "SUSPENDED";

userListTargeting?: NumericTargetingDimension;

verticalTargeting?: NumericTargetingDimension;

webTargeting?: StringTargetingDimension;

}

§Properties

allowedUserTargetingModes?: "USER_TARGETING_MODE_UNSPECIFIED" | "REMARKETING_ADS" | "INTEREST_BASED_TARGETING"[]

[src]

Targeting modes included by this config. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.

appTargeting?: AppTargeting

[src]

Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).

readonly billingId?: bigint

[src]

Output only. The identifier that corresponds to this pretargeting config that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one config, the buyer chooses which billing_id to attribute each of their bids.

displayName?: string

[src]

The diplay name associated with this config. This name must be unique among all the pretargeting configs a bidder has.

excludedContentLabelIds?: bigint[]

[src]

The sensitive content category label IDs excluded in this config. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.

geoTargeting?: NumericTargetingDimension

[src]

The geos included or excluded in this config defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv

includedCreativeDimensions?: CreativeDimensions[]

[src]

Creative dimensions included by this config. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.

includedEnvironments?: "ENVIRONMENT_UNSPECIFIED" | "APP" | "WEB"[]

[src]

Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.

includedFormats?: "CREATIVE_FORMAT_UNSPECIFIED" | "HTML" | "VAST" | "NATIVE"[]

[src]

Creative formats included by this config. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.

includedLanguages?: string[]

[src]

The languages included in this config, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.

includedMobileOperatingSystemIds?: bigint[]

[src]

The mobile operating systems included in this config as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv

includedPlatforms?: "PLATFORM_UNSPECIFIED" | "PERSONAL_COMPUTER" | "PHONE" | "TABLET" | "CONNECTED_TV"[]

[src]

The platforms included by this config. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.

[src]

User identifier types included in this config. At least one of the user identifier types specified in this list must be available for the bid request to be sent.

interstitialTargeting?: "INTERSTITIAL_TARGETING_UNSPECIFIED" | "ONLY_INTERSTITIAL_REQUESTS" | "ONLY_NON_INTERSTITIAL_REQUESTS"

[src]

The interstitial targeting specified for this config. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.

readonly invalidGeoIds?: bigint[]

[src]

Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.

maximumQps?: bigint

[src]

The maximum QPS threshold for this config. The bidder should receive no more than this number of bid requests matching this config per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide

minimumViewabilityDecile?: number

[src]

The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the config will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.

readonly name?: string

[src]

Output only. Name of the pretargeting config that must follow the pattern bidders/{bidder_account_id}/pretargetingConfigs/{config_id}

publisherTargeting?: StringTargetingDimension

[src]

Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in ads.txt / app-ads.txt and in bid requests in the BidRequest.publisher_id field on the Google RTB protocol or the BidRequest.site.publisher.id / BidRequest.app.publisher.id field on the OpenRTB protocol. Publisher IDs will be returned in the order that they were entered.

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "SUSPENDED"

[src]

Output only. The state of this pretargeting config.

userListTargeting?: NumericTargetingDimension

[src]

The remarketing lists included or excluded in this config as defined in UserList.

verticalTargeting?: NumericTargetingDimension

[src]

The verticals included or excluded in this config as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals

webTargeting?: StringTargetingDimension

[src]

Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting config).