inventory.go

package openrtb

import "encoding/json"

// Inventory contains inventory specific attributes
type Inventory struct {
	ID                string            `json:"id,omitempty"` // ID on the exchange
	Name              string            `json:"name,omitempty"`
	Domain            string            `json:"domain,omitempty"`
	Categories        []ContentCategory `json:"cat,omitempty"`           // Array of IAB content categories
	SectionCategories []ContentCategory `json:"sectioncat,omitempty"`    // Array of IAB content categories for subsection
	PageCategories    []ContentCategory `json:"pagecat,omitempty"`       // Array of IAB content categories for page
	PrivacyPolicy     *int              `json:"privacypolicy,omitempty"` // Default: 1 ("1": has a privacy policy)
	Publisher         *Publisher        `json:"publisher,omitempty"`     // Details about the Publisher
	Content           *Content          `json:"content,omitempty"`       // Details about the Content
	Keywords          string            `json:"keywords,omitempty"`      // Comma separated list of keywords about the site.
	Ext               json.RawMessage   `json:"ext,omitempty"`
}

// GetPrivacyPolicy returns the privacy policy value
func (a *Inventory) GetPrivacyPolicy() int {
	if a.PrivacyPolicy != nil {
		return *a.PrivacyPolicy
	}
	return 1
}

// App object should be included if the ad supported content is part of a mobile application
// (as opposed to a mobile website).  A bid request must not contain both an "app" object and a
// "site" object.
type App struct {
	Inventory
	Bundle   string `json:"bundle,omitempty"`   // App bundle or package name
	StoreURL string `json:"storeurl,omitempty"` // App store URL for an installed app
	Version  string `json:"ver,omitempty"`      // App version
	Paid     int    `json:"paid,omitempty"`     // "1": Paid, "2": Free
}

// Site object should be included if the ad supported content is part of a website (as opposed to
// an application).  A bid request must not contain both a site object and an app object.
type Site struct {
	Inventory
	Page     string `json:"page,omitempty"`   // URL of the page
	Referrer string `json:"ref,omitempty"`    // Referrer URL
	Search   string `json:"search,omitempty"` // Search string that caused naviation
	Mobile   int    `json:"mobile,omitempty"` // Mobile ("1": site is mobile optimised)
}