Authorized Buyers Real-time Bidding Proto

• google_user_id
• hosted_match_data
• mobile.encrypted_advertising_id
• mobile.encrypted_hashed_idfa
• session_id

TAG_FOR_CHILD_DIRECTED_TREATMENT = 0 - The current request should be treated as child-directed for purposes of the Children's Online Privacy Protection Act. See this article for more information.

QUALITY_UNKNOWN = 0
PROFESSIONAL = 1; Content that is usually created or produced by media and entertainment companies using professional-grade equipment, talent, and production crews that hold or maintain the rights for distribution and syndication.
PROSUMER = 2; Consumer or user-generated content that has professional or industrial qualities (e.g. shot with professional-grade equipment, using professional talent, etc.).
USER_GENERATED = 3; Publicly available video content that is created or produced by end users.

RATING_UNKNOWN = 0
GENERAL_AUDIENCES = 1; Content suitable for general audiences.
PARENTAL_GUIDANCE = 2; Content suitable for most audiences with parental guidance.
TEEN = 3; Content suitable for teen and older audiences.
MATURE_AUDIENCES = 4; Content suitable only for mature audiences.

UNKNOWN_AUCTION_TYPE = 0
FIRST_PRICE = 1
SECOND_PRICE = 2
FIXED_PRICE = 3

UNKNOWN_PUBLISHER_TYPE = 0
PUBLISHER_OWNED_AND_OPERATED = 1
PUBLISHER_REPRESENTED = 2


VISIBILITY_STATE_UNKNOWN = 0
VISIBILITY_STATE_VISIBLE = 1; The page is at least partially visible. For example, in the foreground tab of a non-minimized window.
VISIBILITY_STATE_HIDDEN = 2; The page is not visible at all to users. For example, when the page is on a background browser tab, or in a minimized window.

Contains labels indicating the experiment or control groups that are active for this request. Work with your account manager to opt in to an experiment. The exact set of experiments available, their meaning, and whether there is any action required from the bidder varies from experiment to experiment and will be communicated separately.

If empty, then this request is not part of any experiment or control group, or your bidder is not participating in any experiments.

Specifies the reasons that ads returned in response to this request should not be personalized. This signal does not reflect user decisions on surfaces including iOS App Tracking Transparency or Android advertising ID. See BidRequest.device.limit_ad_tracking and BidRequest.device.app_tracking_authorization_status fields for more information.

UNKNOWN = 0; Reason unknown.

PUBLISHER_DECLARED_NPA = 1; The publisher has declared that this request should serve non-personalized ads independent of other signals.

RESTRICT_DATA_PROCESSING= 2; The publisher has requested restricted data processing for this request.

USER_OPT_OUT = 3; The user has opted out of ads personalization.

Indicates the reason why access of local device storage during winning ad rendering and measurement is restricted. See Limited ads requests for additional details.

DEVICE_STORAGE_RESTRICTION_UNKNOWN = 0; Reason unknown.

INSUFFICIENT_USER_CONSENT = 1; This request is subject to user consent requirements to allow for device storage access for advertising use cases such as ads measurement, frequency capping, or profiling, but consent was insufficient or not provided.

Generalization for the BidRequest.ip field.

IP_TRUNCATED = 0; The BidRequest.ip field is truncated, /24 for IPv4 and /48 for IPv6. IPv4 addresses are truncated to 3-byte strings, representing the first three octets of an IP address. IPv6 addresses are truncated to 6-byte strings, representing the first 6 octets of an IP address.

IP_REDACTED = 2; The BidRequest.ip field is redacted.

Generalization that was applied to the BidRequest.user_agent and BidRequest.user_agent_data fields, if any.

USER_AGENT_FULL = 0; The BidRequest.user_agent and BidRequest.user_agent_data fields are both provided in full.

USER_AGENT_COARSE = 1; The BidRequest.user_agent and BidRequest.user_agent_data fields are generalized, which can include limiting browser and OS version information to major versions only and other changes to protect user privacy.

UNKNOWN_DEVICE = 0
HIGHEND_PHONE = 1
TABLET = 2
PERSONAL_COMPUTER = 3 - Desktop or laptop devices.
CONNECTED_TV = 4 - Both connected TVs (smart TVs) and connected devices (such as Roku and Apple TV).
GAME_CONSOLE = 5

Default = 0.

UNKNOWN_ORIENTATION = 0
PORTRAIT = 1
LANDSCAPE = 2

This signal reflects user decisions on surfaces including iOS App Tracking Transparency. See also lmt and App Tracking Transparency guidance and Android advertising ID.

NOT_DETERMINED = 0
RESTRICTED = 1
DENIED = 2
AUTHORIZED = 3

CONNECTION_UNKNOWN = 0
ETHERNET = 1
WIFI = 2
CELL_UNKNOWN = 3
CELL_2G = 4
CELL_3G = 5
CELL_4G = 6
CELL_5G = 7

1. iOS devices (This is called Identifier for Advertising, or IDFA, as described in this Help Center article.)
2. Android devices.
3. Roku devices.
4. Microsoft Xbox devices.
5. Amazon devices.

When the encrypted_advertising_id is an IDFA, the plaintext after decrypting the ciphertext is the IDFA (16-byte UUID) returned by iOS's [ASIdentifierManager advertisingIdentifier]. For encrypted_hashed_idfa, the plaintext is the 16-byte MD5 hash of the IDFA. Only one of the two fields will be available, depending on the version of the SDK making the request. Later SDKs provide unhashed values.

VIEW_THROUGH_ADS = 0; Attribution for app installs within 24 hours of viewing an ad for at least 3 seconds. Supported for SKAdnetwork version 2.2 and up. For more info, see this article.
STOREKIT_RENDERED_ADS = 1; Attribution for app installs initiated from the StoreKit-rendered App Store product page driven by ad clicks. Supported for all SKAdNetwork versions. For more info, see this article.

UNKNOWN_PLACEMENT = 0.
INSTREAM = 1 - Instream means the ad plays before, during, or after other video content. This is similar to a traditional TV commercial. The video content the user is watching does not play while the ad is playing.
INTERSTITIAL = 2 - Interstitial means the video ad plays in front of non-video content, (for example, a news article or video game). The ad covers all or nearly all of the space on the screen occupied by the content and the user is not able to proceed to the content until the ad has finished or been skipped.
IN_FEED = 3 - The in-feed video format is a video creative that shows within a feed of content, typically a social app feed, a list of editorial content items, etc, as the user is scrolling. It renders centered and not to the side.
AUDIO = 4 - Audio is a request for an ad that is an audio stream. It is distinct from INSTREAM above as that is exclusive to video requests.
IN_ARTICLE = 5 - The in-article video format is a video creative that loads and plays between paragraphs of editorial content as a standalone video player.

PLCMT_UNKNOWN = 0.
PLCMT_INSTREAM = 1 - Pre-roll, mid-roll, and post-roll ads that are played before, during or after the streaming video content that the consumer has requested. Instream video must be set to “sound on” by default at player start, or have explicitly clear user intent to watch the video content. While there may be other content surrounding the player, the video content must be the focus of the user’s visit. It should remain the primary content on the page and the only video player in-view capable of audio when playing. If the player converts to floating/sticky, subsequent ad calls should accurately convey the updated player size.
PLCMT_ACCOMPANYING_CONTENT = 2 - Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content. The video player loads and plays before, between, or after paragraphs of text or graphical content, and starts playing only when it enters the viewport. Accompanying content should only start playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.
PLCMT_INTERSTITIAL = 3 - Video ads that are played without video content. During playback, it must be the primary focus of the page and take up the majority of the viewport and cannot be scrolled out of view. This can be in placements like in-app video or slideshows.
PLCMT_NO_CONTENT_STANDALONE = 4 - Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating.

PLCMT_INSTREAM = 1 - Pre-roll, mid-roll, and post-roll ads that are played before, during or after the streaming video content that the consumer has requested. Instream video must be set to “sound on” by default at player start, or have explicitly clear user intent to watch the video content. While there may be other content surrounding the player, the video content must be the focus of the user’s visit. It should remain the primary content on the page and the only video player in-view capable of audio when playing. If the player converts to floating/sticky, subsequent ad calls should accurately convey the updated player size.
PLCMT_ACCOMPANYING_CONTENT = 2 - Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content. The video player loads and plays before, between, or after paragraphs of text or graphical content, and starts playing only when it enters the viewport. Accompanying content should only start playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.
PLCMT_INTERSTITIAL = 3 - Video ads that are played without video content. During playback, it must be the primary focus of the page and take up the majority of the viewport and cannot be scrolled out of view. This can be in placements like in-app video or slideshows.
PLCMT_NO_CONTENT_STANDALONE = 4 - Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating.

Alternatively, if an ad would normally play with the sound on but the device is muted then the value will be set to sound off. For devices where it is not possible to determine if the device is muted (for example, desktop), we assume that sound is on. Default = METHOD_UNKNOWN.

METHOD_UNKNOWN = 0
AUTO_PLAY_SOUND_ON = 1
AUTO_PLAY_SOUND_OFF = 2
CLICK_TO_PLAY = 3
MOUSE_OVER = 4
INITIATE_ON_ENTERING_VIEWPORT_SOUND_ON = 5
INITIATE_ON_ENTERING_VIEWPORT_SOUND_OFF = 6

ALLOW_SKIPPABLE = 0
REQUIRE_SKIPPABLE = 1
BLOCK_SKIPPABLE = 2

VAST_1_0 = 1
VAST_2_0 = 2
VAST_3_0 = 3
VAST_1_0_WRAPPER = 4
VAST_2_0_WRAPPER = 5
VAST_3_0_WRAPPER = 6
VAST_4_0 = 7
VAST_4_0_WRAPPER = 8
DAAST_1_0 = 9
DAAST_1_0_WRAPPER = 10

UNKNOWN_VIDEO_FORMAT = -1;
// Flash video files are accepted (FLV).
VIDEO_FLV = 0;
VIDEO_MP4 = 1;
// Valid VAST ads with at least one media file
// hosted on youtube.com.
YT_HOSTED = 2;
// Flash VPAID (SWF).
VPAID_FLASH = 3;
// JavaScript VPAID.
VPAID_JS = 4;
AUDIO_MP3 = 5;
AUDIO_OGG = 6;
// Requires both MP3 & OGG as Google does not know
// which codecs are installed on the player.
AUDIO_MP3_OGG = 7;
VIDEO_WEBM = 8;
VIDEO_MOV = 9;
VIDEO_3GPP = 10;
VIDEO_HLS = 11;
VIDEO_DASH = 12;
// Audio version of MP4.
AUDIO_MP4A = 13;

END_CAP_NOT_ENABLED = 0; - Companion ad won't be rendered as end cap.
END_CAP_OPTIONAL = 1; - End cap will be rendered if response contains eligible companion banner, but companion banner is not required.
END_CAP_FORBIDDEN = 2; - Response with companion ad is filtered.
END_CAP_REQUIRED = 3; - Response without companion ad is filtered.

MOBILE_APP_VIDEO is INSTREAM placement from apps only.

WEB_VIDEO = 0
GAMES = 1
MOBILE_INTERSTITIAL = 2
MOBILE_APP_VIDEO = 3

FEED_TYPE_UNKNOWN = 0
MUSIC_SERVICE = 1; Music streaming service.
FM_AM_BROADCAST = 2; Live content broadcast over the air but also available through online streaming.
PODCAST = 3; Original, pre-recorded content distributed as episodes in a series.

CONTENT_DELIVERY_METHOD_UNKNOWN = 0
STREAMING = 1; Content is transferred continuously by the network; clients receive real-time content for playback while connected. Example: broadcast TV.
PROGRESSIVE = 2; Content is transferred incrementally as client's playback requires. Example: on-demand movies, podcasts, or music.
DOWNLOAD = 3; Content should be transferred completely prior to use/playback. Example: content downloaded to the user's device for offline consumption.

IMAGE_CREATIVE = 0
FLASH_CREATIVE = 1
HTML_CREATIVE = 2

See this article for more information on LGPD.

NO_DETECTION = 0
ABOVE_THE_FOLD = 1
BELOW_THE_FOLD = 2

UNKNOWN_IFRAME_STATE = 0
NO_IFRAME = 1
SAME_DOMAIN_IFRAME = 2
CROSS_DOMAIN_IFRAME = 3

UNKNOWN_IFRAME_DEPTH = 0
NOT_IN_IFRAME = 1
ONE_IFRAME = 2
MULTIPLE_IFRAME = 3

PLACEMENT_UNKNOWN = 0
PLACEMENT_IN_FEED = 1 - In the feed of content, for example as an item inside the organic feed/grid/listing/carousel.
PLACEMENT_ATOMIC_UNIT = 2 - In the atomic unit of the content for example, in the article page or single image page.
PLACEMENT_OUTSIDE = 3 - Outside the core content, for example in the ads section on the right rail, as a banner-style placement near the content, etc.
PLACEMENT_RECOMMENDATION = 4 - Recommendation widget, most commonly presented below the article content.

UNKNOWN = 0
DIRECT_REQUEST = 1

UNDECLARED_SOURCE = 0
DESKTOP_APP = 1

UNKNOWN_RENDERER = 0
GOOGLE = 1
PUBLISHER = 2

UNKNOWN_AMP = 0 - AMP status unknown. Request may or may not be from an AMP page.
NON_AMP_PAGE = 1 - Not an AMP page. Could be regular HTML, VAST video, etc.
AMP_PAGE_LATE_REQUEST = 2 - Late-loading request from an AMP HTML page. Ad will render with a slight delay so it will not negatively impact page render performance.

UNKNOWN_AMP_PAGE = 0 - AMP page status unknown.
DIALECT_HTML = 1 - This is not an AMP page.
DIALECT_HTML_AMP = 2 - This is an Amp page.

UNKNOWN_AMP_AD_REQUIREMENT_TYPE = 0 - AMP ad requirements unknown.
AMP_AD_NOT_ALLOWED = 1 - AMP ads are not allowed.
AMP_AD_ALLOWED_AND_NOT_EARLY_RENDERED = 2 - Either AMP ads or non-AMP ads are allowed; AMP ads are not early rendered.
AMP_AD_ALLOWED_AND_EARLY_RENDERED = 3 - Either AMP ads or non-AMP ads are allowed; AMP ads are early rendered.
AMP_AD_REQUIRED = 4 - AMP ads are required. Ads that are non-AMP may be rejected by the publisher.

UNKNOWN_ALLOWED_AD_TYPE = -1
ALLOWED_AD_TYPE_BANNER = 0
ALLOWED_AD_TYPE_NATIVE = 1
ALLOWED_AD_TYPE_VIDEO = 2
ALLOWED_AD_TYPE_AUDIO = 3

UNKNOWN_FRAMEWORK = 0
MRAID_1 = 3 Mobile Rich Media Ad Interface Definitions Version 1.0.
MRAID_2 = 5 Mobile Rich Media Ad Interface Definitions Version 2.0.
MRAID_3 = 6 Mobile Rich Media Ad Interface Definitions Version 3.0.
OMID_1 = 7 Open Measurement Interface Definition Version 1.0.

Experimental feature; may be subject to change. See Set Google-hosted frequency caps for RTB bids for more information. Describes the scope of frequency cap enforcement available for this request. Frequency caps to be enforced for a bid can be specified in the BidResponse.ad.adslot.frequency_cap field.

FREQUENCY_CAPPING_SCOPE_UNKNOWN = 0; Default value which should not be used, or which can indicate that frequency cap scope could not be reliably determined.

FREQUENCY_CAPPING_SCOPE_NONE = 1; Frequency capping based on bid response specifications is not available for this request. A frequency-capped bid for a bid request with no frequency cap availability will be filtered prior to the auction.

FREQUENCY_CAPPING_SCOPE_BROWSER = 2; Frequency capping enforcement is available across multiple sites within the same browser.

FREQUENCY_CAPPING_SCOPE_DEVICE = 3; Frequency capping enforcement is available across multiple sites on the device, excluding browsers.

FREQUENCY_CAPPING_SCOPE_APP = 4; Frequency capping enforcement is available within a single app.

FREQUENCY_CAPPING_SCOPE_SITE = 5; Frequency capping enforcement is available within a single site.

Example strings:
GoogleMobileAds-iOS
GoogleMobileAds-Android
InteractiveMediaAds-iOS
InteractiveMediaAds-Android

If a publisher is using the IAB Transparency and Consent Framework (TCF) v2 to manage user consent, this is the set of ATPs consented through the Additional Consent string (see this article for details about Google's Additional Consent mode). ATPs consented through the TCF v2 consent string are represented in the ConsentedProvidersSettings.tcf_consent_string field.

A mapping of ATP ID to ATP name is posted at providers.csv.

See the IAB Global Vendor List at vendor-list.consensu.org/v2/vendor-list.json for details about the vendors listed in the consent string.

UNKNOWN_DEAL_TYPE = 0
PREFERRED_DEAL = 1
PRIVATE_AUCTION = 2
PROGRAMMATIC_GUARANTEED = 3 - Refer to the RTB differences for Programmatic Guaranteed Deals help center article for more information.
AUCTION_PACKAGE = 4 - Refer to the Auction Packages help center article for more information.
MARKETPLACE_PACKAGE = 5 - The deal ID for publisher curated inventory packages. Refer to the Marketplace Packages help center article for more information.

CREATIVE_SOURCE_UNKNOWN = 0
CREATIVE_SOURCE_ADVERTISER = 1 - The creative is hosted by the advertiser, which means the bidder is required to provide a creative in the bid response.
CREATIVE_SOURCE_PUBLISHER = 2 - The creative is hosted by the publisher, which means the bidder does not need to include a creative in the bid response. For more information on publisher-hosted creatives, see https://support.google.com/admanager/answer/9243220. This feature isn't currently supported for RTB bidders.

ALLOWED_AD_TYPE_BANNER = 0
ALLOWED_AD_TYPE_NATIVE = 1
ALLOWED_AD_TYPE_VIDEO = 2
ALLOWED_AD_TYPE_AUDIO = 3

ALLOW_SKIPPABLE = 0
REQUIRE_SKIPPABLE = 1
BLOCK_SKIPPABLE = 2


Possible values:

• FORMAT_UNKNOWN = 0;
• Display banner ads for web or mobile apps. For example, a 320x50 leaderboard slot. This includes out-stream video.

  FORMAT_BANNER = 1;

• A full-screen ad to be displayed inside a mobile app.

  FORMAT_INTERSTITIAL = 2;

• Custom display or video ads for web or mobile apps that match the user experience of the site or app in which they’re placed.

  FORMAT_NATIVE = 3;

• Video ads that appear before, during, or after video content streams.

  FORMAT_VIDEO_VAST = 4;

• Video ads for mobile apps that allow users to voluntarily watch an ad in exchange for an in-app reward.

  FORMAT_REWARDED = 5;

• Interstitial ads that allow users to watch an ad in exchange for an in-app reward. Does not require opt-in. https://support.google.com/admanager/answer/7386053

  FORMAT_REWARDED_INTERSTITIAL = 6;

• App open ads shows at app load screens. App open ads can be closed at any time, and are designed to be shown when the users bring the app to the foreground.

  FORMAT_APP_OPEN = 7;

enum Fields - Defines the bits used in required_fields and recommended_fields. There is one bit for each of the fields in BidResponse.Ad.NativeAd.

enum Fields - Defines the bits used in required_fields and recommended_fields. There is one bit for each of the fields in BidResponse.Ad.NativeAd.

PIXEL = 0
FLUID = 1

UNKNOWN_AUTO_REFRESH_TYPE = 0
USER_ACTION = 1 - Refresh triggered by user-initiated action such as scrolling.
EVENT = 2 - Event-driven content change. For example, ads refresh when the football game score changes on the page.
TIME = 3 - Time-based refresh. Ads refresh on a predefined time interval even without user activity.

UNKNOWN_STICKINESS = 0
IS_STICKY = 1

UNKNOWN_STICKINESS = 0
IS_STICKY = 1

UNKNOWN_STICKINESS = 0
IS_STICKY = 1

The type of ads to which the above bid adjustment applies to. Each type corresponds to different ways of how the ad's creative is specified, as described in https://developers.google.com/authorized-buyers/rtb/response-guide#specify-creative. If the ad is SDK-rendered, this will be set to SDK_RENDERED regardless of the actual creative type. Default = CREATIVE_TYPE_UNKNOWN.

CREATIVE_TYPE_UNKNOWN = 0
HTML_SNIPPET = 1 - Banner ads
VIDEO_VAST = 2 - VAST video or audio ads
NATIVE = 3 - Native ads
SDK_RENDERED = 4 - SDK rendered ad

Identifies the taxonomy that the segment IDs belong to. Google supports the following taxonomies:

TAXONOMY_TYPE_UNKNOWN = 0
IAB_AUDIENCE_1_1 = 4
IAB_CONTENT_2_2 = 6
IAB_CONTENT_3_0 = 7

DSA_SUPPORT_UNKNOWN = 0
NOT_REQUIRED = 1 - DSA declarations are not required in the bid response.
SUPPORTED = 2 - DSA declarations are supported, but not required in the bid response.
REQUIRED = 3 - DSA declarations are required in the bid response.
REQUIRED_BY_ONLINE_PLATFORM = 4 - DSA declarations are required in the bid response and the publisher is an OP or VLOP.

PUBLISHER_RENDERING_SUPPORT_UNKNOWN = 0
PUBLISHER_UNABLE_TO_RENDER = 1 - Publisher can't render.
PUBLISHER_CAN_RENDER = 2 - Publisher could render depending on the buyer's rendering capability as described in the BidResponse.ad.dsa_transparency.buyer_render field.
PUBLISHER_WILL_RENDER = 3 - Publisher will render regardless of the buyer's rendering capability as described in the BidResponse.ad.dsa_transparency.buyer_render field.

DATA_TO_PUBLISHER_UNKNOWN = 0
DO_NOT_SEND = 1 - Do not send transparency data.
OPTIONAL = 2 - Optional to send transparency data.
SEND = 3 - Send transparency data.

OPEN_AUCTION = 0
PRIVATE_AUCTION = 1
PREFERRED_DEAL = 2
EXCHANGE_AUCTION_PACKAGE = 3

To enable frequency capping for your account, contact your account manager.

Specifies frequency capping to be applied to the bid. Impressions for each user are capped at the level specified by frequency_cap_id. A bid will not participate in the auction if an additional impression for the user would violate any of the specified caps. Multiple frequency caps can be specified for the same frequency_cap_id.

A bid is filtered before the auction if the frequency cap is malformed. Instances where the cap is malformed include:

Indicates that the bid is only eligible for a specific position within the pod.

All bids with the same bid_group_id will be won or lost as a group. Bids must have a non-empty bid_group_id to allow an ad to be played as part of a pod.

This field is currently only supported for rewarded video pods requests. If an ad is submitted on multiple positional bids represented by AdSlot messages, each bid must have a different bid_group_id.

The currency used by max_cpm_micros and min_cpm_micros, using ISO-4217 alpha codes. If this field is populated, the specified currency will be used to interpret the bid. Otherwise, the default bidding currency will be used, which is determined in the following priority:

1. The bidder-level currency, if configured in RTB account settings.
2. The buyer-level currency. The buyer will be determined by the billing ID specified in the billing_id field of the bid response if it is populated, otherwise it will be based on the sole billing ID sent in the bid request.

The currency of a buyer account is set on account creation and can be checked by contacting a Technical Account Manager.

UNKNOWN_TIME_UNIT = 0
MINUTE = 1
DAY = 2
WEEK = 3
MONTH = 4
INDEFINITE = 5: When INDEFINITE is used, time_range will be ignored. INDEFINITE means the frequency cap will be applied for a long period of time, (longer than a month) but not necessarily forever.

UNKNOWN_CONTEXT = 0
OMID = 1

VIEW_THROUGH_ADS = 0; Attribution for app installs within 24 hours of viewing an ad for at least 3 seconds. Supported for SKAdnetwork version 2.2 and up. For more info, see this article.
STOREKIT_RENDERED_ADS = 1; Attribution for app installs initiated from the StoreKit-rendered App Store product page driven by ad clicks. Supported for all SKAdNetwork versions. For more info, see this article.