REST Resource: curators.curatedPackages

Resource: CuratedPackage

Represents a curated package of inventory created and managed by a Curator.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "floorPriceCpm": {
    object (Money)
  },
  "state": enum (State),
  "accessSettings": {
    object (AccessControlSettings)
  },
  "targeting": {
    object (PackageTargeting)
  },

  // Union field fee can be only one of the following:
  "feeCpm": {
    object (Money)
  }
  // End of list of possible types for union field fee.
}
Fields
name

string

Identifier. The unique resource name for the curated package. Format: curators/{accountId}/curatedPackages/{curatedPackageId}
displayName

string

Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method.
description

string

Optional. A description of the curated package, provided by the curator.
createTime

string (Timestamp format)

Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
floorPriceCpm

object (Money)

Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method.
state

enum (State)

Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method.
accessSettings

object (AccessControlSettings)

Required. Settings for controlling access to the curated package.

Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource.
targeting

object (PackageTargeting)

Optional. Targeting criteria for the curated package.
Union field fee. Fee paid out to the curator for this package. fee can be only one of the following:
feeCpm

object (Money)

Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method.

State

The state of the curated package.

Enums
STATE_UNSPECIFIED Default value.
ACTIVE The curated package is active.
INACTIVE The curated package is inactive.

AccessControlSettings

Settings for controlling access to a curated package.

JSON representation 
{
  "allowlistedMediaPlanners": [
    string
  ]
}
Fields
allowlistedMediaPlanners[]

string

Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time.

Format: mediaPlanners/{mediaPlannerAccountId}

PackageTargeting

Targeting criteria for curated and auction packages.

JSON representation 
{
  "includedDeviceTypes": [
    enum (DeviceType)
  ],
  "includedEnvironment": enum (Environment),
  "includedCreativeFormat": enum (CreativeFormat),
  "includedAcceleratedMobilePageType": enum (AcceleratedMobilePageType),
  "includedAuthorizedSellerStatuses": [
    enum (AuthorizedSellerStatus)
  ],
  "includedNativeInventoryTypes": [
    enum (NativeInventoryType)
  ],
  "includedOpenMeasurementTypes": [
    enum (OpenMeasurementType)
  ],
  "includedRestrictedCategories": [
    enum (RestrictedCategory)
  ],
  "includedRewardedType": enum (RewardedType),
  "videoTargeting": {
    object (PackageVideoTargeting)
  },
  "minimumPredictedViewabilityPercentage": string,
  "languageTargeting": {
    object (StringTargetingDimension)
  },
  "includedAdSizes": [
    {
      object (AdSize)
    }
  ],
  "publisherTargeting": {
    object (StringTargetingDimension)
  },
  "minimumPredictedClickThroughRatePercentageMillis": string,
  "verticalTargeting": {
    object (CriteriaTargeting)
  },
  "geoTargeting": {
    object (CriteriaTargeting)
  },
  "includedDataSegments": [
    string
  ],
  "placementTargeting": {
    object (PackagePlacementTargeting)
  },
  "publisherProvidedSignalsTargeting": {
    object (PackagePublisherProvidedSignalsTargeting)
  }
}
Fields
includedDeviceTypes[]

enum (DeviceType)

Optional. The list of included device types to target. If empty, all device types are targeted.
includedEnvironment

enum (Environment)

Optional. The environment to target. If unspecified, all environments are targeted.
includedCreativeFormat

enum (CreativeFormat)

Optional. The creative format to target. If unset, all creative markup types are targeted.
includedAcceleratedMobilePageType

enum (AcceleratedMobilePageType)

Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status.
includedAuthorizedSellerStatuses[]

enum (AuthorizedSellerStatus)

Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status.
includedNativeInventoryTypes[]

enum (NativeInventoryType)

Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type.
includedOpenMeasurementTypes[]

enum (OpenMeasurementType)

Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support.
includedRestrictedCategories[]

enum (RestrictedCategory)

Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories.
includedRewardedType

enum (RewardedType)

Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type.
videoTargeting

object (PackageVideoTargeting)

Optional. Video specific targeting criteria.
minimumPredictedViewabilityPercentage

string (int64 format)

Optional. The targeted minimum predicted viewability percentage.

This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability.

An unset value indicates inventory will be targeted regardless of predicted viewability.
languageTargeting

object (StringTargetingDimension)

Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes.
includedAdSizes[]

object (AdSize)

Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size.

Curated packages supports PIXEL and INTERSTITIAL ad sizes.
publisherTargeting

object (StringTargetingDimension)

Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
minimumPredictedClickThroughRatePercentageMillis

string (int64 format)

Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate.

An unset value indicates inventory will be targeted regardless of predicted click through rate.
verticalTargeting

object (CriteriaTargeting)

Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical.
geoTargeting

object (CriteriaTargeting)

Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo.
includedDataSegments[]

string

Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: curators/{accountId}/dataSegments/{data_segment_id}
placementTargeting

object (PackagePlacementTargeting)

Optional. Placement targeting information, for example, URL, mobile applications.
publisherProvidedSignalsTargeting

object (PackagePublisherProvidedSignalsTargeting)

Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals.

DeviceType

The general type of device to target.

Enums
DEVICE_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
DEVICE_TYPE_PERSONAL_COMPUTER Targets desktop or laptop computers.
DEVICE_TYPE_CONNECTED_TV Targets connected TVs: devices that stream TV content, including smart TVs, gaming consoles, and streaming boxes/sticks.
DEVICE_TYPE_PHONE Targets high-end mobile devices.
DEVICE_TYPE_TABLET Targets tablet devices.

Environment

The environment to target.

Enums
ENVIRONMENT_UNSPECIFIED Default value. Should not be used in targeting specifications.
ENVIRONMENT_SITE Targets inventory rendered within an ad-supported website.
ENVIRONMENT_APP Targets inventory within a mobile application.

CreativeFormat

The creative format that can be targeted.

Enums
CREATIVE_FORMAT_UNSPECIFIED Default value. Should not be used in targeting specifications.
CREATIVE_FORMAT_DISPLAY Targets ad slots intended for HTML display creatives.
CREATIVE_FORMAT_VIDEO Targets ad slots intended for video creatives.
CREATIVE_FORMAT_AUDIO Targets ad slots intended for audio creatives.

AcceleratedMobilePageType

The type of Accelerated Mobile Page (AMP) implementation to target.

Enums
ACCELERATED_MOBILE_PAGE_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
ACCELERATED_MOBILE_PAGE_TYPE_NON_AMP Targets inventory on standard web pages not using any AMP framework.
ACCELERATED_MOBILE_PAGE_TYPE_AMP Targets inventory on pages built using the core AMP HTML framework.
ACCELERATED_MOBILE_PAGE_TYPE_AMP_STORY Targets inventory on pages using the AMP Story (STAMP) format, which is optimized for visual storytelling (e.g., tappable full-screen experiences).

AuthorizedSellerStatus

Represents the relationship between the publisher and the seller as declared in an ads.txt or app-ads.txt file.

Enums
AUTHORIZED_SELLER_STATUS_UNSPECIFIED Default value. Should not be used in targeting specifications.
AUTHORIZED_SELLER_STATUS_DIRECT Targets inventory where the seller is declared as 'DIRECT'. This indicates the publisher (content owner) directly controls the seller account and has a direct business contract with the advertising system for this account.
AUTHORIZED_SELLER_STATUS_RESELLER Targets inventory where the seller is declared as 'RESELLER'. This indicates the publisher has authorized another entity to operate the listed seller account and resell their ad space.

NativeInventoryType

Represents the type of creative rendering an ad slot supports, specifically in relation to native ads.

Enums
NATIVE_INVENTORY_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
NATIVE_INVENTORY_TYPE_NATIVE_ONLY Targets ad slots that only accept and render native ads.
NATIVE_INVENTORY_TYPE_NATIVE_OR_BANNER Targets ad slots that accept and render either native or banner ads.

OpenMeasurementType

The type of Open Measurement Interface Definition (OMID) to target.

Enums
OPEN_MEASUREMENT_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
OPEN_MEASUREMENT_TYPE_OMID_V1 Targets inventory that supports the v1 Open Measurement Interface Definition (OMID).

RestrictedCategory

Represents the specific categories of ads that are restricted by policy to target.

Enums
RESTRICTED_CATEGORY_UNSPECIFIED Default value. Should not be used in targeting specifications.
RESTRICTED_CATEGORY_ALCOHOL Targets inventory where alcohol ads are allowed by the publisher.
RESTRICTED_CATEGORY_GAMBLING Targets inventory where gambling ads are allowed by the publisher.

RewardedType

Defines targeting criteria based on whether the ad inventory offers a reward to the user for viewing an ad.

Enums
REWARDED_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
REWARDED_TYPE_NON_REWARDED Targets inventory that does NOT offer an explicit reward to the user for watching or interacting with the ad.
REWARDED_TYPE_REWARDED Targets inventory that offers a reward to the user in exchange for watching or engaging with the ad.

PackageVideoTargeting

Video specific targeting criteria.

JSON representation 
{
  "includedMimeTypes": [
    enum (VideoMimeType)
  ],
  "includedMaximumAdDurationTargeting": enum (MaximumVideoAdDuration),
  "includedPositionTypes": [
    enum (PositionType)
  ],
  "includedContentDeliveryMethod": enum (ContentDeliveryMethod),
  "plcmtTargeting": {
    object (VideoPlcmtTargeting)
  },
  "includedPlaybackMethods": [
    enum (PlaybackMethod)
  ],
  "minimumPredictedCompletionRatePercentage": string,
  "includedPlayerSizeTargeting": {
    object (VideoPlayerSizeTargeting)
  }
}
Fields
includedMimeTypes[]

enum (VideoMimeType)

Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type.
includedMaximumAdDurationTargeting

enum (MaximumVideoAdDuration)

Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration.
includedPositionTypes[]

enum (PositionType)

Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type.
includedContentDeliveryMethod

enum (ContentDeliveryMethod)

Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method.
plcmtTargeting

object (VideoPlcmtTargeting)

Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type.
includedPlaybackMethods[]

enum (PlaybackMethod)

Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method.
minimumPredictedCompletionRatePercentage

string (int64 format)

Optional. The targeted minimum predicted completion rate percentage.

This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate.

An unset value indicates inventory will be targeted regardless of predicted completion rate.
includedPlayerSizeTargeting

object (VideoPlayerSizeTargeting)

Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size.

VideoMimeType

The video mime types to target.

Enums
VIDEO_MIME_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
VIDEO_MIME_TYPE_THREEGPP 3GPP container format used on 3G phones.
VIDEO_MIME_TYPE_APPLICATION_MPEGURL HLS/M3U8
VIDEO_MIME_TYPE_MP4 MPEG-4 container typically with H.264 codec.
VIDEO_MIME_TYPE_APPLICATION_MPEGDASH DASH.
VIDEO_MIME_TYPE_APPLICATION_JAVASCRIPT JavaScript (used for VPAID ads).
VIDEO_MIME_TYPE_WEBM WebM container assuming VP9 codec.

MaximumVideoAdDuration

The upper limit on the duration of the video ad creative to target. The enum values define buckets, and selecting a value means that the creative's duration must be less than or equal to the specified time.

Enums
MAXIMUM_VIDEO_AD_DURATION_UNSPECIFIED Default value. Should not be used in targeting specifications.
MAXIMUM_VIDEO_AD_DURATION_FIFTEEN_SECONDS Applies to video ads with a duration up to 15 seconds (0 < duration <= 15s).
MAXIMUM_VIDEO_AD_DURATION_TWENTY_SECONDS Applies to video ads with a duration up to 20 seconds (0 < duration <= 20s).
MAXIMUM_VIDEO_AD_DURATION_THIRTY_SECONDS Applies to video ads with a duration up to 30 seconds (0 < duration <= 30s).
MAXIMUM_VIDEO_AD_DURATION_SIXTY_SECONDS Applies to video ads with a duration up to 60 seconds (0 < duration <= 60s).
MAXIMUM_VIDEO_AD_DURATION_NINETY_SECONDS Applies to video ads with a duration up to 90 seconds (0 < duration <= 90s).
MAXIMUM_VIDEO_AD_DURATION_ONE_HUNDRED_TWENTY_SECONDS Applies to video ads with a duration up to 120 seconds (0 < duration <= 120s).

PositionType

The targetable position of the ad within a video.

Enums
POSITION_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
POSITION_TYPE_MIDROLL The ad is played in the middle of the video content.
POSITION_TYPE_POSTROLL The ad is played after the video content.
POSITION_TYPE_PREROLL The ad is played before the video content.

ContentDeliveryMethod

Targeting criteria based on the video content's delivery method.

Enums
CONTENT_DELIVERY_METHOD_UNSPECIFIED Default value. Should not be used in targeting specifications.
CONTENT_DELIVERY_METHOD_STREAMING Targets video content that is being broadcast live.
CONTENT_DELIVERY_METHOD_PROGRESSIVE Targets video content that is transferred incrementally as client's playback requires.

VideoPlcmtTargeting

Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field.

JSON representation 
{
  "selectionType": enum (SelectionType),
  "videoPlcmtTypes": [
    enum (VideoPlcmtType)
  ]
}
Fields
selectionType

enum (SelectionType)

Required. The selection type for the list of video plcmts.
videoPlcmtTypes[]

enum (VideoPlcmtType)

Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type.

SelectionType

Enum for the possible selection types used by targeting dimensions.

Enums
SELECTION_TYPE_UNSPECIFIED Unspecified selection type. Should not be used.
SELECTION_TYPE_INCLUDE The values in the targeting dimension are included.
SELECTION_TYPE_EXCLUDE The values in the targeting dimension are excluded.

VideoPlcmtType

Represents the video placement type, in line with OpenRTB standards.

Enums
VIDEO_PLCMT_TYPE_UNSPECIFIED Default value. Should not be used in targeting specifications.
INSTREAM 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.
ACCOMPANYING_CONTENT 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.
INTERSTITIAL 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.
NO_CONTENT Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating.

PlaybackMethod

The playback method to target.

Enums
PLAYBACK_METHOD_UNSPECIFIED Unspecified video playback method. Should not be used.
PLAYBACK_METHOD_AUTO_PLAY_SOUND_ON Playback starts automatically when the page/content loads.
PLAYBACK_METHOD_AUTO_PLAY_SOUND_OFF Playback starts automatically when the page/content loads, but with sound off.
PLAYBACK_METHOD_CLICK_TO_PLAY Playback is initiated by a user action (e.g., clicking a play button).

VideoPlayerSizeTargeting

Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values.

JSON representation 
{
  "minimumWidth": string,
  "minimumHeight": string
}
Fields
minimumWidth

string (int64 format)

Required. The minimum width of the video player in pixels.
minimumHeight

string (int64 format)

Required. The minimum height of the video player in pixels.

StringTargetingDimension

Generic targeting with string values.

JSON representation 
{
  "selectionType": enum (SelectionType),
  "values": [
    string
  ]
}
Fields
selectionType

enum (SelectionType)

Required. How the items in this list should be targeted.
values[]

string

Required. The values specified.

PackagePlacementTargeting

Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.

JSON representation 
{
  "uriTargeting": {
    object (StringTargetingDimension)
  },
  "mobileAppTargeting": {
    object (StringTargetingDimension)
  },
  "includedMobileAppCategoryTargeting": [
    string
  ]
}
Fields
uriTargeting

object (StringTargetingDimension)

Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url.
mobileAppTargeting

object (StringTargetingDimension)

Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported.

Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.
includedMobileAppCategoryTargeting[]

string (int64 format)

Optional. The list of targeted mobile app categories.

PackagePublisherProvidedSignalsTargeting

Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed.

JSON representation 
{
  "audienceTargeting": {
    object (TaxonomyTargeting)
  },
  "contentTargeting": {
    object (TaxonomyTargeting)
  },
  "videoAndAudioSignalsTargeting": {
    object (StringTargetingDimension)
  }
}
Fields
audienceTargeting

object (TaxonomyTargeting)

Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv)
contentTargeting

object (TaxonomyTargeting)

Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv)
videoAndAudioSignalsTargeting

object (StringTargetingDimension)

Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals.

TaxonomyTargeting

Defines targeting criteria for handling the IAB audience and content Taxonomy ID space.

JSON representation 
{
  "targetedTaxonomyIds": [
    string
  ],
  "excludedTaxonomyIds": [
    string
  ]
}
Fields
targetedTaxonomyIds[]

string

Optional. The list of targeted content taxonomy IDs.
excludedTaxonomyIds[]

string

Optional. The list of excluded content taxonomy IDs.

Methods

activate

 Activates an existing curated package.

create

 Creates a new curated package.

deactivate

 Deactivates an existing curated package.

get

 Gets a curated package given its resource name.

list

 Lists curated packages owned by the specified curator.

patch

 Updates an existing curated package.