Learn the Real-time Curation specification

  • Google sends a SegmentRequest based on ad requests matching your targeted inventory to your Real-time Curation integration.

  • The SegmentRequest object provides either contextual signals or secure signals that you can use to identify which of your segments apply to the given inventory in the SegmentResponse.

  • Real-time Curation supports SegmentRequest and SegmentResponse objects sent in JSON format.

  • This guide serves as a reference for the Real-time Curation protocol to assist in building your integration.

Google sends a SegmentRequest based on ad requests matching your targeted inventory to your Real-time Curation integration. The SegmentRequest object provides either contextual signals or secure signals that you can use to identify which of your segments apply to the given inventory in the SegmentResponse. Real-time Curation supports SegmentRequest and SegmentResponse objects sent in JSON format.

This guide is a reference for the Real-time Curation protocol that can help you build your integration.

SegmentRequest

Attribute Type Description
site Site

Only supported for contextual curation partners.

A descriptor of the website. The site field is populated if the ad supported content is a website rather than a non-browser application.
app App

Only supported for contextual curation partners.

A descriptor of the app. The app field is populated if the ad supported content is a non-browser application rather than a website.
pub Publisher

Only supported for contextual curation partners.

A descriptor of the publisher.
user User A descriptor of the user browsing publisher content that initiated the segment request.
device Device

Only supported for contextual curation partners.

A descriptor of the user's device.
segment_request_id string A unique identifier used to identify the segment request independently from all other segment requests.

Site

Attribute Type Description
page string

Only supported for contextual curation partners.

URL of the page showing the impression.

App

Attribute Type Description
bundle string

Only supported for contextual curation partners.

A platform-specific application identifier intended to be unique to the app. On Android, the bundle field is a bundle or package name. On iOS, it is a numeric ID.

Publisher

Attribute Type Description
id string

Only supported for contextual curation partners.

A publisher ID defined by the publisher code suffix of the web property code. For example, a publisher having a web property code of ca-pub-123 would have its ID set to pub-123.

User

Attribute Type Description
consent string

A web-safe based64-encoded IAB Transparency and Consent Framework (TCF) v2 consent string fetched from the publisher's IAB Consent Management Platform (CMP).

The consent field is populated if the publisher has integrated with a CMP for TCF v2 and that CMP indicates that GDPR applies to the ad request and provides a valid consent string.

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.
eids EID array

Only supported for secure signals curation partners.

Extended ID instances.

In Curation, the eids field is data made available by the publisher, such as secure signals.

EID

Attribute Type Description
source string

Only supported for secure signals curation partners.

Source or technology provider responsible for the set of included data. Expressed as a top-level domain.
uids UID array

Only supported for secure signals curation partners.

Array of UID objects from the given source.

UID

Attribute Type Description
id string

Only supported for secure signals curation partners.

The identifier.

In curation, the id field is a secure signal. To learn more about secure signals, see Ad Manager's Share secure signals with bidders and curation partners.

Device

Attribute Type Description
geo Geo

Only supported for contextual curation partners.

Location of the user's device.

Geo

Attribute Type Description
country string

Only supported for contextual curation partners.

Country using the ISO-3166-1 Alpha-3 standard.
region string

Only supported for contextual curation partners.

Region code using the ISO-3166-2 standard; 2-letter state code if USA.
metro string

Only supported for contextual curation partners.

Google metro code found in geo-table.csv file.

SegmentResponse

Attribute Type Description
segment Segment array A descriptor for a segment.

Segment

Attribute Type Description
segment_id string The ID for the segment. The ID should match the curatorDataSegmentId found in the name of the segment in Marketplace API's curators.dataSegments resource.