SellerProvidedInventoryAvailabilityEstimate

  • Encapsulates a week-long estimate of the available inventory for a discovery object, broken down by targeting dimensions.

  • It includes the expected weekly impressions and unique cookies.

  • Breakdowns provide inventory estimates by targeting dimensions like Age, Gender, and Device.

  • MobileAppSlice and MobileApp detail the breakdown and information for mobile app inventory.

Encapsulates a week-long estimate of the available inventory for a discovery object, broken down by targeting dimensions.

JSON representation 
{
  "weeklyImpressions": string,
  "weeklyUniques": string,
  "breakdowns": [
    {
      object (TargetingDimensionBreakdown)
    }
  ],
  "appsBreakdown": [
    {
      object (MobileAppSlice)
    }
  ]
}
Fields
weeklyImpressions

string (int64 format)

The number of impressions expected per week. NOTE: This is independent of the actual availability/sell-through of the seller.
weeklyUniques

string (int64 format)

The number of unique cookies expected per week.
breakdowns[]

object (TargetingDimensionBreakdown)

Each entry contains a breakdown of the forecast by a targeting dimension.
appsBreakdown[]

object (MobileAppSlice)

A breakdown for mobile app inventory.

TargetingDimensionBreakdown

Encapsulates the inventory breakdown of a single targeting dimension.

JSON representation 
{
  "type": enum (DimensionType),
  "value": [
    {
      object (DimensionValue)
    }
  ]
}
Fields
type

enum (DimensionType)

The targeting dimension this breakdown is for. Ex: AGE, GENDER, etc.
value[]

object (DimensionValue)

The list of breakdown slices for this dimension. Ex: (MALE, 20%), (FEMALE, 80%).

DimensionType

A predefined list of supported targeting dimensions.

Enums
DIMENSION_TYPE_UNSPECIFIED Dimension type not specified. Not a valid input value.
AGE Values defined by the Age enum.
COUNTRY Values defined by the 2-character ISO-3166 country code.
DEVICE Values defined by the Device enum.
GENDER Values defined by the Gender enum.
DOMAIN_NAME Values are the domain name strings.
REQUEST_FORMAT Request format.
CONTENT_VERTICAL Content vertical. Not supported.
DEVICE_MAKE Device make.
CONTENT_GENRE Content genre.
CONTENT_RATING Content rating.
CONTENT_DELIVERY_FORMAT Content delivery format.
VIDEO_AD_START_POSITION Ad start position. Applies to both video and audio ads.
CONTENT_DURATION Content duration.
VIDEO_DURATION Ad duration. Applies to both video and audio ads.
ENVIRONMENT Environment.
CONTENT_TYPE Content type for audio inventory.
FILE_TYPE File type. Also known as MIME type.
COMPANION_SIZE Companion ad size. Values are string represented dimensions of the form [width]x[height]. Ex: 200x300.
COMPANION_TYPE Companion ad type.
DIMENSION_TYPE_APP App. Not supported.

DimensionValue

A single slice in the breakdown. Ex: (MALE, 20%).

JSON representation 
{
  "id": string,
  "stringId": string,
  "percentage": string
}
Fields
id

string (int64 format)

ID of the dimension value. This should map to the enum value of the dimension value. For example, if this slice is for MALE, then id should be the enum value of Gender.GENDER_MALE = 1 (note: 0 is UNSPECIFIED and not a valid input value).
stringId

string

Alternate string ID for dimensions without an integer ID. Ex. DOMAIN_NAME. For companion size, string ID must be of the form "[width]x[height]". Ex: "200x300".
percentage

string (int64 format)

The percentage of impressions belonging to this dimension (0-100). This is required to sum to 100 across all dimension values in a single breakdown. For Auction Packages, percentage for DOMAIN_NAME is not supported. DOMAIN_NAME is required for Publisher.

MobileAppSlice

Represents a slice in the mobile app breakdown. Each app has a slice.

JSON representation 
{
  "app": {
    object (MobileApp)
  },
  "percentage": string
}
Fields
app

object (MobileApp)

The app this slice is for.
percentage

string (int64 format)

Not supported.

MobileApp

Contains information regarding mobile app.

JSON representation 
{
  "type": enum (MobileAppPlatformType),
  "appId": string
}
Fields
type

enum (MobileAppPlatformType)

Mobile app platform type.
appId

string

The app store ID of this app. Ex. com.google.android.googlequicksearchbox for an Android app, 284815942 for an iOS app.

MobileAppPlatformType

Mobile app platform type, such as Android.

Enums
MOBILE_APP_PLATFORM_TYPE_UNSPECIFIED Type unspecified. Not valid for input.
PLATFORM_TYPE_IOS_UNIVERSAL IOS universal.
PLATFORM_TYPE_IPHONE IPhone.
PLATFORM_TYPE_IPAD IPad.
PLATFORM_TYPE_ANDROID Android.