Site

1
2
3
4
5
{
    "Name": "Mopedo.Database.Site",
    "Kind": "EntityResource",
    "Methods": ["GET", "POST", "PATCH", "PUT", "DELETE", "REPORT", "HEAD"]
}

Site entities are added when the DSP receives bid requests for impressions on web sites, for example a media site with banner ad slots.

Format

Properties marked in bold are required.

Property name Type Description    
Domain string The domain of the site (e.g., "nytimes.com")Id string Exchange-specific site ID
Name string The name of the site    
Categories string A comma-separated list of standard IAB codes for the site    
Page string The URL of the page where the impression will be shown    
Referrer string The referrer URL that caused navigation to the current page    
MobileOptimized boolean Does the site have a special layout for mobile devices?    
Extension SiteExtension Additional client-defined data associated with the Site    
Publisher Publisher The publisher of the site    
CreatedAt datetime See CreatedAt    
UsedAt datetime See UsedAt    
Matched bool See Matched    
MatchedAt datetime See MatchedAt    
UsedCount integer See UsedCount    
UsedRank integer See UsedRank    
AdWinCount integer See AdWinCount    
AdClickCount integer See AdClickCount    
CampaignWinCount integer See CampaignWinCount    
CampaignClickCount integer See CampaignClickCount    
WinCount integer Obsolete: Use AdWinCount instead    
ClickCount integer Obsolete: Use AdWinCount instead    

Site.Feed

1
2
3
4
5
{
    "Name": "Mopedo.Database.Site.Feed",
    "Kind": "TerminalResource",
    "Methods": ["GET"]
}

The Site.Feed resource is a terminal resource that posts representations of Site entities in real time as they are added to the DSP application.

Terminal properties

Property name Type Default value Description
IncludeExtension boolean false Should the Extension property be included in entities in the feed?
Status string "PAUSED" The current status of the console, can be "PAUSED" or "OPEN"
ShowWelcomeText boolean true Should the terminal print a welcome message on launch?

Entity format

The format of entities that are sent over the feed is different from the format of the entity resource.

Property name Type Description
Domain string The domain of the site (e.g., "nytimes.com")
CreatedAt datetime See CreatedAt
Matched bool See Matched
Extension AppExtension Additional client-defined data associated with the Site