Protocol Documentation

backend.advertiser.proto

Top

Advertiser

Typically representing a brand or company wishing to advertize their product.

Field	Type	Label	Description
id	int64		Unique id for an advertizer
organization_id	int64		Unique id for an org
name	string		Name of the advertiser
url	string		UKNOWN
logo	string		UKNOWN

AdvertiserID

Input type for Advertiser RCP calls - GetAdvertiser - GetListsForAdvertiser - Etc

Field	Type	Label	Description
id	int64		Unique id for an advertizer

AdvertiserListMessage

Input type for Advertiser list operations - AddListToAdvertiser - RemoveListFromAdvertiser

Field	Type	Label	Description
advertiser_id	int64		Unique id for an advertizer
list_id	int64		Unique id for an list

AdvertiserTagGroupMessage

DEAD CODE

Field	Type	Label	Description
advertiser_id	int64		Unique id for an advertizer
tag_group_id	int64		Unique id for an tagGroup

Advertisers

Output type for Advertiser rcp calls - GetAdvertisersForOrganization - SearchAdvertisers - Etc

Field	Type	Label	Description
advertisers	Advertiser	repeated	A list of advertiser

UploadAdvertiserLogoRequest

DEAD CODE

Field	Type	Label	Description
advertiser_id	int64
buffer	bytes

backend.audience.proto

Top

Audience

Input & Output type for Audience operations - CreateAudience (input and output) - ModifyAudience (input and output) - SearchAudience (input) Also used in the aggregate for lists of Audience

Field	Type	Label	Description
id	int64		Unique id for an Audience
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
name	string		UKNOWN
maintainer	string		UNKNOWN

AudienceID

Input type for Audience operations - GetAudience - DeleteAudience

Field	Type	Label	Description
id	int64		Unique id for an Audience

Audiences

Output type for Audience operations

Field	Type	Label	Description
audiences	Audience	repeated	A list of Audience

backend.campaign.proto

Top

Campaign

Output type for Campaign operations Mostly used in the aggregate as a list of Campaigns

Field	Type	Label	Description
id	int64		Unique id for an Campaign
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
name	string		UNKNOWN
budget	double		UNKNOWN
startDate	google.protobuf.Timestamp		UNKNOWN
endDate	google.protobuf.Timestamp		UNKNOWN
goal	string		UNKNOWN
event_id	int64		UNKNOWN
active	bool		UNKNOWN

CampaignID

Input type for Campaign operations - GetCampaign - GetCampaignState - ETC

Field	Type	Label	Description
id	int64		Unique id for an Campaign

Campaigns

Output type for Campaign Operations

Field	Type	Label	Description
campaigns	Campaign	repeated	A list of campaigns

backend.changelog.proto

Top

Change

Field	Type	Label	Description
original	string		UNKNOWN
updates	ChangeUpdate	repeated	UNKNOWN
field	string		UNKNOWN

ChangeUpdate

Field	Type	Label	Description
value	string		UNKNOWN
action	string		UNKNOWN

Changelog

Field	Type	Label	Description
id	int64		Unique id for an Changelog
user_id	string		Unique id for an User
organization_id	int64		Unique id for an Org
timestamp	google.protobuf.Timestamp		UNKNOWN
action	string		UNKNOWN
resource	string		UNKNOWN
resource_id	int64		UNKNOWN
changes	Change	repeated	A list of Change
name	string		UNKNOWN
linked_resource	string		UNKNOWN

ChangelogID

Field	Type	Label	Description
id	int64		Unique id for an Changelog

Changelogs

Field	Type	Label	Description
changelogs	Changelog	repeated	A list of changelog

backend.creative.proto

Top

Creative

Output type for Create operations - GetCreative - CreateCreative - ModifyCreative Also used in aggregate for lists of Creative

Field	Type	Label	Description
id	int64		Unique id for an Creative
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
name	string		UNKNOWN
media_type	string		UNKNOWN
click_url	google.protobuf.StringValue		UNKNOWN
width	google.protobuf.Int64Value		UNKNOWN
height	google.protobuf.Int64Value		UNKNOWN
mime	google.protobuf.StringValue		UNKNOWN
duration	google.protobuf.Int64Value		UNKNOWN
bitRate	google.protobuf.Int64Value		UNKNOWN
asset_url	google.protobuf.StringValue		UNKNOWN
macros	google.protobuf.StringValue		UNKNOWN
markup	google.protobuf.StringValue		UNKNOWN
companion_banner	google.protobuf.StringValue		UNKNOWN

CreativeID

Input type for Creative operations - GetCreative - DeleteCreative

Field	Type	Label	Description
id	int64		Unique id for an Creative

Creatives

Output type for Creative operations

Field	Type	Label	Description
creatives	Creative	repeated	A list of creative

backend.creativeTagGroup.proto

Top

CreativeTagGroupMessage

Input type for Creative/TagGroup operations - AddTagGroupToCreative - RemoveTagGroupFromCreative

Field	Type	Label	Description
creative_id	int64		Unique id for an Creative
tag_group_id	int64		Unique id for an TagGroup

backend.event.proto

Top

Event

Output type for Event operations - GetEvent - CreateEvent - ModifyEvent Also used in the aggregate of lists of Event

Field	Type	Label	Description
id	int64		Unique id for an Event
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
name	string		UNKNOWN
tag	google.protobuf.StringValue		UNKNOWN
type	string		UNKNOWN
matching_urls	string	repeated	UNKNOWN

EventID

Input type for Event operations - GetEvent - DeleteEvent

Field	Type	Label	Description
id	int64		Unique id for an Event

Events

Output type for Event operations

Field	Type	Label	Description
events	Event	repeated	A list of Event

backend.feed.proto

Top

AudienceFeed

Sub type AudienceReportWriteRequest

Field	Type	Label	Description
row	int64
timestamp	google.protobuf.Timestamp
audienceid	string		TODO: Fix CamelCasing
audiencesize	int64		TODO: Fix CamelCasing

AudienceReportWriteRequest

Input type for WriteAudienceReport operation

Field	Type	Label	Description
data	AudienceFeed	repeated	A list of AudienceFeed

CampaignFeed

Sub type for CampaignReportWriteRequest

Field	Type	Label	Description
row	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN
campaignId	int64		Unique id for an Campaign
mediaSpend	float		UNKNOWN
fees	float		UNKNOWN
totalSpend	float		UNKNOWN
viewableImps	float		UNKNOWN
totalImps	int64		UNKNOWN
views	int64		UNKNOWN
clicks	int64		UNKNOWN
conversions	int64		UNKNOWN
devices	int64		UNKNOWN
bids	int64		UNKNOWN
videocompletes	int64		TOOD: Fix CamelCasing

CampaignReportWriteRequest

Input type for WriteCampaignReport operation

Field	Type	Label	Description
data	CampaignFeed	repeated	A list of CampaignFeed

ConversionReportWriteRequest

Input type for WriteConversionReport operations

Field	Type	Label	Description
data	ConversionsFeed	repeated	A list of ConversionsFeed

ConversionsFeed

Sub type for CampaignReportWriteRequest

Field	Type	Label	Description
row	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN
eventId	int64		UNKNOWN
userId	string		UNKNOWN
bidId	string		UNKNOWN
placementId	int64		UNKNOWN
campaignId	int64		UNKNOWN
advertiserId	int64		UNKNOWN
domain	string		UNKNOWN

DmaFeed

Sub type for DmaReportWriteRequest

Field	Type	Label	Description
row	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN
advertiserId	int64		UNKNOWN
dma	string		UNKNOWN
bids	int64		UNKNOWN
views	int64		UNKNOWN
clicks	int64		UNKNOWN
totalImps	int64		UNKNOWN
mediaSpend	float		UNKNOWN

DmaReportWriteRequest

Input type for WriteDmaReport operations

Field	Type	Label	Description
data	DmaFeed	repeated	A list of DMAFeed

DomainFeed

Sub type for DomainReportWriteRequest

Field	Type	Label	Description
row	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN
advertiserId	int64		UNKNOWN
domain	string		UNKNOWN
bids	int64		UNKNOWN
views	int64		UNKNOWN
clicks	int64		UNKNOWN
totalImps	int64		UNKNOWN
mediaSpend	float		UNKNOWN
viewableimps	int64		TOOD: Fix CamelCasing
totalspend	int64		TOOD: Fix CamelCasing
videocompletes	int64		TOOD: Fix CamelCasing

DomainReportWriteRequest

Input type for WriteDomainReport operations

Field	Type	Label	Description
data	DomainFeed	repeated	A list of DomainFeed

EventFeed

Sub type for EventReportWriteRequest

Field	Type	Label	Description
row	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN
eventid	string		TOOD: Fix CamelCasing
events	int64		UNKNOWN

EventReportWriteRequest

Input type for WriteEventReport operations

Field	Type	Label	Description
data	EventFeed	repeated	A list of EventFeed

FeesFeed

Sub type for FeesReportWriteRequest

Field	Type	Label	Description
row	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN
placementId	int64		UNKNOWN
name	string		UNKNOWN
fee	double		UNKNOWN

FeesReportWriteRequest

Input type for WriteFeesReport operations

Field	Type	Label	Description
data	FeesFeed	repeated	A list of FeesFeed

FilterRejectionFeed

Sub type for FilterRejectionWriteRequest

Field	Type	Label	Description
reason	string		UNKNOWN
rejections	int64		UNKNOWN
placementId	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN

FilterRejectionWriteRequest

Input type for WriteFilterRejectionReport operation

Field	Type	Label	Description
data	FilterRejectionFeed	repeated	A list of FilterRejectionFeed

PlacementFeed

Sub type for PlacementReportWriteRequest

Field	Type	Label	Description
row	int64		UNKNOWN
timestamp	google.protobuf.Timestamp		UNKNOWN
placementId	int64		UNKNOWN
mediaSpend	float		UNKNOWN
fees	float		UNKNOWN
totalSpend	float		UNKNOWN
viewableImps	float		UNKNOWN
totalImps	int64		UNKNOWN
views	int64		UNKNOWN
clicks	int64		UNKNOWN
conversions	int64		UNKNOWN
devices	int64		UNKNOWN
bids	int64		UNKNOWN
videocompletes	int64		TOOD: Fix CamelCasing
advertiserId	int64		UNKNOWN
campaignId	int64		UNKNOWN

PlacementFeedSummary

DEAD CODE

Field	Type	Label	Description
placementId	int64
viewableImps	float
mediaSpend	float
totalSpend	float
fees	float

PlacementReportWriteRequest

Input type for WritePlacementReport operations

Field	Type	Label	Description
data	PlacementFeed	repeated	A list of PlacementFeed

ReportWriteResponse

Output type for Feed Operations

Field	Type	Label	Description
msg	string		TODO: Implementation is calling empty ctor

backend.frequency.proto

Top

Filter

Input & Output type for Filter operations - CreateFilter (input & output) - ModifyFilter (input & output) - ETC Also used in the aggregate for lists of Filter

Field	Type	Label	Description
id	int64		Unique id for an Filter
organization_id	int64		Unique id for an org
advertiser_id	int64		Unique id for an advertiser
placement_id	int64		Unique id for an placement
type	string		UNKNOWN
rule	string		UNKNOWN
list_id	int64		UNKNOWN

FilterID

Input type for Filter operations - GetFilter - DeleteFilter

Field	Type	Label	Description
id	int64		Unique id for an Filter

Filters

Output type for Filter operations

Field	Type	Label	Description
filters	Filter	repeated	A list of Filter

backend.frequencyCap.proto

Top

FrequencyCap

Input & Output type for operations - CreateFrequencyCap (input & output) - ModifyFrequencyCap (input & output) - ETC Also used in the aggregate for lists of FrequencyCap

Field	Type	Label	Description
id	int64		Unique id for an FrequencyCap
organization_id	int64		Unique id for an org
advertiser_id	int64		Unique id for an advertiser
placement_id	int64		Unique id for an placement
unit	string		UNKNOWN
value	double		UNKNOWN

FrequencyCapID

Input type for FrequencyCap operations - GetFrequencyCap - DeleteFrequencyCap

Field	Type	Label	Description
id	int64		Unique id for an FrequencyCap

FrequencyCaps

Output type for FrequencyCap operations

Field	Type	Label	Description
frequency_caps	FrequencyCap	repeated	A list of FrequencyCap

backend.list.proto

Top

List

Output type for List operations - GetList - CreateList - ModifyList - ETC Also used in the aggregate for lists of List

Field	Type	Label	Description
id	int64		Unique id for an List
organization_id	int64		Unique id for an org
scope	string		UNKNOWN
name	string		UNKNOWN
type	string		UNKNOWN
values	string	repeated	UNKNOWN

ListID

Input type for List operations - GetList - DeleteList

Field	Type	Label	Description
id	int64		Unique id for an List

Lists

Output type for List operations

Field	Type	Label	Description
lists	List	repeated	A list of List

ValidateListRequest

Input type for List operation - ValidateList

Field	Type	Label	Description
type	string		UNKNOWN
buffer	bytes		UNKNOWN

ValidateListResponse

Output type for List operation - ValidateList

Field	Type	Label	Description
type	string		UNKNOWN
values	string	repeated	UNKNOWN

backend.org.proto

Top

Organization

Output type for Organization operations

Field	Type	Label	Description
id	int64		Unique id for an Org
name	string		Name of the Org

OrganizationID

Input type for Organization RCP calls - GetOrganization - DeleteOrganization - GetAudiencesForOrganization - GetVendorsForOrganization - GetListsForOrganization - Etc

Field	Type	Label	Description
id	int64		Unique id for an Org

backend.placement.proto

Top

Placement

Output type for Placement operations Mostly used in aggregate as a list of Placements

Field	Type	Label	Description
id	int64		Unique id for a Placement
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
campaign_id	int64		Unique id for a Campaign
name	string		UNKNOWN
media_type	string		UNKNOWN
budget	double		UNKNOWN
base_bid	double		UNKNOWN
daily_budget_cap	double		UNKNOWN
pacing_type	string		UNKNOWN
bidding_strategy	string		UNKNOWN
active	bool		UNKNOWN
spend	string		UNKNOWN
video_type	google.protobuf.StringValue		UNKNOWN

PlacementCreativeMessage

Input type for Placement operations dealing with Creatives - AddCreativeFromPlacement - RemoveCreativeFromPlacement - ETC

Field	Type	Label	Description
placement_id	int64		Unique id for a Placement
creative_id	int64		Unique id for a Creative

PlacementID

Input type for Placement operations - GetPlacement - GetPlacementState - ETC

Field	Type	Label	Description
id	int64		Unique id for a Placement

PlacementListMessage

Input type for Placement operations dealing with Lists - AddListToPlacement - RemoveListFromPlacement

Field	Type	Label	Description
placement_id	int64		Unique id for a Placement
list_id	int64		Unique id for a List

Placements

Output type for Placement operations

Field	Type	Label	Description
placements	Placement	repeated	A list of Placement

backend.proto

Top

AdUpdate

Field	Type	Label	Description
advertisers	AdvertiserState	repeated
creatives	CreativeState	repeated
events	Event	repeated

AdUpdateRequest

DEAD CODE

BidderUpdate

Field	Type	Label	Description
advertisers	AdvertiserState	repeated

BidderUpdateRequest

CacheApp

Field	Type	Label	Description
bundle	string
brandSafety	string	repeated
viewability	string	repeated

CacheDomain

Field	Type	Label	Description
domain	string
adFraudShouldProcess	bool
publisherShouldProcess	bool
adFraud	string	repeated
publishers	string	repeated

CacheEntity

CacheEvent

Field	Type	Label	Description
eventid	int64
timestamp	int64

CacheImpression

Field	Type	Label	Description
placementid	int64
advertiserid	int64
campaignid	int64
userid	string
bidid	string
eventid	int64
domain	string
timestamp	int64

CachePage

Field	Type	Label	Description
url	string
brandSafetyShouldProcess	bool
viewabilityShouldProcess	bool
brandSafety	string	repeated
viewability	string	repeated

CacheUser

Field	Type	Label	Description
userid	string
num_impressions	int64
num_events	int64
impressions	CacheImpression	repeated
events	CacheEvent	repeated
audiences	string	repeated
controlGroups	int64	repeated
pages	string	repeated
keywords	string	repeated

CampaignTagGroupMessage

DEAD CODE

Field	Type	Label	Description
campaign_id	int64
tag_group_id	int64

Goal

DEAD CODE

Field	Type	Label	Description
id	int64
organization_id	int64
advertiser_id	int64
campaign_id	int64
event_id	int64
type	string

GoalID

DEAD CODE

Field	Type	Label	Description
id	int64

NotifUpdate

Field	Type	Label	Description
advertisers	AdvertiserState	repeated
creatives	CreativeState	repeated
events	Event	repeated

NotifUpdateRequest

ResourceCacheUpdate

Field	Type	Label	Description
placements	PlacementState	repeated
creatives	CreativeState	repeated
events	Event	repeated

ResourceCacheUpdateRequest

UploadCreativeRequest

DEAD CODE

Field	Type	Label	Description
creative_id	int64
buffer	bytes

backend

Method Name	Request Type	Response Type	Description
GetOrganization	OrganizationID	Organization
CreateOrganization	Organization	Organization
ModifyOrganization	Organization	Organization
DeleteOrganization	OrganizationID	Organization
GetAdvertisersForOrganization	OrganizationID	Advertisers
GetAdvertiser	AdvertiserID	AdvertiserState
GetAdvertiserState	AdvertiserID	AdvertiserState
CreateAdvertiser	Advertiser	AdvertiserState
ModifyAdvertiser	Advertiser	AdvertiserState
DeleteAdvertiser	AdvertiserID	Advertiser
SearchAdvertisers	Advertiser	Advertisers
GetAudiencesForOrganization	OrganizationID	Audiences
GetAudiencesForAdvertiser	AdvertiserID	Audiences
GetAudience	AudienceID	Audience
CreateAudience	Audience	Audience
ModifyAudience	Audience	Audience
DeleteAudience	AudienceID	Audience
SearchAudiences	Audience	Audiences
GetCampaignsForAdvertiser	AdvertiserID	Campaigns
GetCampaignState	CampaignID	CampaignState
GetCampaign	CampaignID	CampaignState
CreateCampaign	Campaign	CampaignState
ModifyCampaign	Campaign	CampaignState
DeleteCampaign	CampaignID	Campaign
SearchCampaigns	Campaign	Campaigns
GetPlacementsForCampaign	CampaignID	Placements
SearchPlacements	Placement	Placements
GetPlacementState	PlacementID	PlacementState
DeactivatePlacement	PlacementID	PlacementState
ActivatePlacement	PlacementID	PlacementState
GetPlacement	PlacementID	PlacementState
CreatePlacement	Placement	PlacementState
ModifyPlacement	Placement	PlacementState
DeletePlacement	PlacementID	Placement
GetFiltersForPlacement	PlacementID	Filters
GetFilter	FilterID	Filter
CreateFilter	Filter	Filter
ModifyFilter	Filter	Filter
DeleteFilter	FilterID	Filter
GetFrequencyCapsForPlacement	PlacementID	FrequencyCaps
GetFrequencyCap	FrequencyCapID	FrequencyCap
CreateFrequencyCap	FrequencyCap	FrequencyCap
ModifyFrequencyCap	FrequencyCap	FrequencyCap
DeleteFrequencyCap	FrequencyCapID	FrequencyCap
GetEventsForAdvertiser	AdvertiserID	Events
GetEvent	EventID	Event
CreateEvent	Event	Event
ModifyEvent	Event	Event
DeleteEvent	EventID	Event
SearchEvents	Event	Events
GetTag	TagID	Tag
CreateTag	Tag	Tag
ModifyTag	Tag	Tag
DeleteTag	TagID	Tag
SearchTags	Tag	Tags
GetTagsForOrganization	OrganizationID	Tags
GetTagsForCampaign	CampaignID	Tags
AddTagToCampaign	CampaignTagMessage	Tags
RemoveTagFromCampaign	CampaignTagMessage	Tags
GetTagsForAdvertiser	AdvertiserID	Tags
AddTagToAdvertiser	AdvertiserTagMessage	Tags
RemoveTagFromAdvertiser	AdvertiserTagMessage	Tags
GetTagsForPlacement	PlacementID	Tags
AddTagToPlacement	PlacementTagMessage	Tags
RemoveTagFromPlacement	PlacementTagMessage	Tags
GetTagGroupsForOrganization	OrganizationID	TagGroups
GetTagGroupsForCreative	CreativeID	TagGroups
AddTagGroupToCreative	CreativeTagGroupMessage	TagGroups
RemoveTagGroupFromCreative	CreativeTagGroupMessage	TagGroups
GetTagGroup	TagGroupID	TagGroup
CreateTagGroup	TagGroup	TagGroup
ModifyTagGroup	TagGroup	TagGroup
DeleteTagGroup	TagGroupID	TagGroup
SearchTagGroups	TagGroup	TagGroups
GetTagalongsForTagGroup	TagGroupID	Tagalongs
GetTagalong	TagalongID	Tagalong
CreateTagalong	Tagalong	Tagalong
ModifyTagalong	Tagalong	Tagalong
DeleteTagalong	TagalongID	Tagalong
SearchTagalongs	Tagalong	Tagalongs
GetListsForOrganization	OrganizationID	Lists
GetListsForAdvertiser	AdvertiserID	Lists
AddListToAdvertiser	AdvertiserListMessage	Lists
RemoveListFromAdvertiser	AdvertiserListMessage	Lists
GetListsForPlacement	PlacementID	Lists
AddListToPlacement	PlacementListMessage	Lists
RemoveListFromPlacement	PlacementListMessage	Lists
GetList	ListID	List
CreateList	List	List
ModifyList	List	List
DeleteList	ListID	List
SearchLists	List	Lists
ValidateList	ValidateListRequest stream	ValidateListResponse
GetVendorsForOrganization	OrganizationID	Vendors
CreateVendorForOrganization	OrganizationVendorMessage	Vendor
GetVendorsForAdvertiser	AdvertiserID	Vendors
CreateVendorForAdvertiser	AdvertiserVendorMessage	Vendor
GetVendorsForCampaign	CampaignID	Vendors
CreateVendorForCampaign	CampaignVendorMessage	Vendor
GetVendorsForPlacement	PlacementID	Vendors
CreateVendorForPlacement	PlacementVendorMessage	Vendor
GetVendor	VendorID	Vendor
ModifyVendor	Vendor	Vendor
DeleteVendor	VendorID	Vendor
GetCreativesForAdvertiser	AdvertiserID	Creatives
GetCreativesForPlacement	PlacementID	Creatives
AddCreativeToPlacement	PlacementCreativeMessage	Creatives
RemoveCreativeFromPlacement	PlacementCreativeMessage	Creatives
GetCreative	CreativeID	Creative
CreateCreative	Creative	Creative
ModifyCreative	Creative	Creative
DeleteCreative	CreativeID	Creative
SearchCreatives	Creative	Creatives
GetChangelog	ChangelogID	Changelog
SearchChangelogs	Changelog	Changelogs
GetChangelogsForCampaign	CampaignID	Changelogs
GetChangelogsForAdvertiser	AdvertiserID	Changelogs
GetChangelogsForPlacement	PlacementID	Changelogs
GetChangelogsForCreative	CreativeID	Changelogs
GetAdvertiserPlacementTrendsReport	AdvertiserPlacementTrendsReportRequest	AdvertiserPlacementTrendsReport
GetAudienceSizeReport	AudienceSizeReportRequest	AudienceSizeReport
GetCampaignReport	ReportRequest	CampaignReport
GetDmaReport	ReportRequest	DmaReport
GetDomainReport	ReportRequest	DomainReport
GetFeesReport	FeesReportRequest	FeesReport
GetFilterRejectionReport	FilterRejectionReportRequest	FilterRejectionReport
GetPlacementReport	ReportRequest	PlacementReport
GetPlacementTrendsReport	PlacementTrendsReportRequest	PlacementTrendsReport
GetOrganizationSpendReport	OrganizationSpendReportRequest	OrganizationSpendReport
GetAdvertiserInventoryReport	AdvertiserInventoryReportRequest	InventoryReport
GetCampaignInventoryReport	CampaignInventoryReportRequest	InventoryReport
GetAdvertiserVendorReport	AdvertiserVendorReportRequest	VendorReport
GetCampaignVendorReport	CampaignVendorReportRequest	VendorReport
GetPlacementVendorReport	PlacementVendorReportRequest	VendorReport
GetNotifUpdate	NotifUpdateRequest	NotifUpdate	Bidder Operations
GetAdUpdate	AdUpdateRequest	AdUpdate
GetBidderUpdate	BidderUpdateRequest	BidderUpdate
WriteAudienceReport	AudienceReportWriteRequest	ReportWriteResponse
WriteCampaignReport	CampaignReportWriteRequest	ReportWriteResponse
WriteConversionReport	ConversionReportWriteRequest	ReportWriteResponse
WriteDmaReport	DmaReportWriteRequest	ReportWriteResponse
WriteDomainReport	DomainReportWriteRequest	ReportWriteResponse
WriteEventReport	EventReportWriteRequest	ReportWriteResponse
WriteFeesReport	FeesReportWriteRequest	ReportWriteResponse
WriteFilterRejectionReport	FilterRejectionWriteRequest	ReportWriteResponse
WritePlacementReport	PlacementReportWriteRequest	ReportWriteResponse
GetUpdate	ResourceCacheUpdateRequest	ResourceCacheUpdate

backend.report.proto

Top

AdvertiserInventoryReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp		Report start time
end_time	google.protobuf.Timestamp		Report end time
advertiser_id	int64		Unique id

AdvertiserPlacementTrendsReport

Output type for Report operations

Field	Type	Label	Description
placements	PlacementsReport	repeated	Rows of the report

AdvertiserPlacementTrendsReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp		Report start time
end_time	google.protobuf.Timestamp		Report end time
advertiser_id	int64		Unique id for an Advertiser
agg	string

AdvertiserSpendReportRow

Field	Type	Label	Description
advertiser_id	int64
campaigns	CampaignSpendReportRow	repeated

AdvertiserVendorReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp
end_time	google.protobuf.Timestamp
advertiser_id	int64		Unique id for a Advertiser

AudienceSizeReport

Output type for Report operations

Field	Type	Label	Description
items	AudienceSizeReport.AudienceSizeReportRow	repeated	Rows of the report

AudienceSizeReport.AudienceSizeReportRow

Field	Type	Label	Description
id	string		UNKNOWN
audienceSize	int64		UNKNOWN

AudienceSizeReportRequest

Input type for Report operations

CampaignInventoryReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp		Report start time
end_time	google.protobuf.Timestamp		Report end time
campaign_id	int64		Unique id

CampaignReport

Output type for Report operations

Field	Type	Label	Description
items	CampaignReport.CampaignReportRow	repeated	Rows of the report

CampaignReport.CampaignReportRow

Field	Type	Label	Description
campaignId	int64		UNKNOWN
viewableImps	int64		UNKNOWN
totalImps	int64		UNKNOWN
mediaSpend	float		UNKNOWN
totalSpend	float		UNKNOWN
fees	float		UNKNOWN
clicks	int64		UNKNOWN
conversions	int64		UNKNOWN
cpm	float		UNKNOWN
vcpm	float		UNKNOWN
ctr	float		UNKNOWN
bids	int64		UNKNOWN
videoCompletes	int64		UNKNOWN
videoCompletionRate	float		UNKNOWN
viewability	float		UNKNOWN
spendPerConversion	float		UNKNOWN
conversionRate	float		UNKNOWN

CampaignSpendReportRow

Field	Type	Label	Description
campaign_id	int64
total_spend	float
placements	PlacementSpendReportRow	repeated

CampaignVendorReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp
end_time	google.protobuf.Timestamp
campaign_id	int64		Unique id for a Campaign

DmaReport

Output type for Report operations

Field	Type	Label	Description
items	DmaReport.DmaReportRow	repeated	Rows of the report
total	float		Aggregate of the report

DmaReport.DmaReportRow

Field	Type	Label	Description
dma	string		UNKNOWN
totalImps	int64		UNKNOWN
mediaSpend	float		UNKNOWN
clicks	int64		UNKNOWN
views	int64		UNKNOWN
bids	int64		UNKNOWN
ctr	float		UNKNOWN

DomainReport

Output type for Report operations

Field	Type	Label	Description
items	DomainReport.DomainReportRow	repeated	Rows of the report
total	float		Aggregate of the report

DomainReport.DomainReportRow

Field	Type	Label	Description
domain	string		UNKNOWN
viewableImps	int64		UNKNOWN
totalImps	int64		UNKNOWN
mediaSpend	float		UNKNOWN
totalSpend	float		UNKNOWN
fees	float		UNKNOWN
clicks	int64		UNKNOWN
views	int64		UNKNOWN
cpm	float		UNKNOWN
vcpm	float		UNKNOWN
ctr	float		UNKNOWN
bids	int64		UNKNOWN
videoCompletes	int64		UNKNOWN
videoCompletionRate	float		UNKNOWN
viewability	float		UNKNOWN

FeesReport

Output type for Report operations

Field	Type	Label	Description
items	FeesReport.FeesReportRow	repeated	Rows of the report

FeesReport.FeesReportRow

Field	Type	Label	Description
name	string		UNKNOWN
fee	float		UNKNOWN

FeesReportRequest

Input type for Report operations

Field	Type	Label	Description
placement_id	int64		Unique id for a Placement

FilterRejectionReport

Output type for Report operations

Field	Type	Label	Description
items	FilterRejectionReport.FilterRejectionReportRow	repeated	Rows of the report

FilterRejectionReport.FilterRejectionReportRow

Field	Type	Label	Description
reason	string		UNKNOWN
rejections	int64		UNKNOWN

FilterRejectionReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp		Report start time
end_time	google.protobuf.Timestamp		Report end time
placement_id	int64		Unique id for a Placement

InventoryReport

Output type for Report operations

Field	Type	Label	Description
items	InventoryReport.InventoryReportRow	repeated

InventoryReport.InventoryReportRow

Field	Type	Label	Description
name	string
mediaSpend	float

OrganizationSpendReport

Field	Type	Label	Description
advertisers	AdvertiserSpendReportRow	repeated

OrganizationSpendReportRequest

Field	Type	Label	Description
organization_id	int64

PlacementReport

Output type for Report operations

Field	Type	Label	Description
items	PlacementReport.PlacementReportRow	repeated	Rows of the report

PlacementReport.PlacementReportRow

Field	Type	Label	Description
placementId	int64		UNKNOWN
viewableImps	int64		UNKNOWN
totalImps	int64		UNKNOWN
mediaSpend	float		UNKNOWN
totalSpend	float		UNKNOWN
fees	float		UNKNOWN
clicks	int64		UNKNOWN
conversions	int64		UNKNOWN
cpm	float		UNKNOWN
vcpm	float		UNKNOWN
ctr	float		UNKNOWN
bids	int64		UNKNOWN
videoCompletes	int64		UNKNOWN
videoCompletionRate	float		UNKNOWN
viewability	float		UNKNOWN
spendPerConversion	float		UNKNOWN
conversionRate	float		UNKNOWN

PlacementSpendReportRow

Field	Type	Label	Description
advertiser_id	int64
campaign_id	int64
placement_id	int64
total_spend	float
impressions	float
cpm	float

PlacementTrendsReport

Output type for Report operations

Field	Type	Label	Description
items	PlacementTrendsRow	repeated	Rows of the report

PlacementTrendsReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp		Report start time
end_time	google.protobuf.Timestamp		Report end time
placement_id	int64		Unique id for a Placement
agg	string

PlacementTrendsRow

Output type for Report operations

Field	Type	Label	Description
placementId	int64		Unique id for a Placement
timestamp	google.protobuf.Timestamp		UNKNOWN
mediaSpend	float		UNKNOWN
fees	float		UNKNOWN
totalImps	int64		UNKNOWN
viewableImps	int64		UNKNOWN
views	int64		UNKNOWN
clicks	int64		UNKNOWN
conversions	int64		UNKNOWN
totalSpend	float		UNKNOWN
cpm	float		UNKNOWN
vcpm	float		UNKNOWN
ctr	float		UNKNOWN
viewability	float		UNKNOWN
conversionRate	float		UNKNOWN
bids	int64		UNKNOWN
videoCompletionRate	float		UNKNOWN
spendPerConversion	float		UNKNOWN

PlacementVendorReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp
end_time	google.protobuf.Timestamp
placement_id	int64		Unique id for a Placement

PlacementsReport

Output type for Report operations

Field	Type	Label	Description
placement_id	int64		Unique id for a Placement
advertiser_id	int64		Unique id for an Advertiser
campaign_id	int64		Unique id for a Campaign
reports	PlacementTrendsRow	repeated

ReportRequest

Input type for Report operations

Field	Type	Label	Description
start_time	google.protobuf.Timestamp
end_time	google.protobuf.Timestamp
advertiser_id	int64		Unique id for an Advertiser

VendorReport

Output type for Report operations

Field	Type	Label	Description
items	VendorReport.VendorReportRow	repeated

VendorReport.VendorReportRow

Field	Type	Label	Description
name	string
fees	float

backend.state.proto

Top

AdvertiserState

Output type for Advertiser operations

Field	Type	Label	Description
id	int64		Unique id for an Advertiser
organization_id	int64		Unique id for an Org
name	string		UNKNOWN
url	string		UNKNOWN
logo	string		UNKNOWN
campaigns	CampaignState	repeated	UNKNOWN

CampaignState

Output type for CampaignState operations

Field	Type	Label	Description
id	int64		Unique id for a Campaign
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
name	string		UNKNOWN
budget	double		UNKNOWN
startDate	google.protobuf.Timestamp		UNKNOWN
endDate	google.protobuf.Timestamp		UNKNOWN
goal	string		UNKNOWN
event_id	int64		UNKNOWN
event	Event		UNKNOWN
active	bool		UNKNOWN
placements	PlacementState	repeated	UNKNOWN
tags	Tag	repeated	UNKNOWN
spend	double		UNKNOWN

CreativeState

Output type for Creative operations

Field	Type	Label	Description
id	int64		Unique id for a Creative
organization_id	int64		Unique id for an Organization
advertiser_id	int64		Unique id for an Advertiser
name	string		UNKNOWN
media_type	string		UNKNOWN
click_url	string		UNKNOWN
width	google.protobuf.Int64Value		UNKNOWN
height	google.protobuf.Int64Value		UNKNOWN
mime	google.protobuf.StringValue		UNKNOWN
duration	google.protobuf.Int64Value
bitRate	google.protobuf.Int64Value
asset_url	google.protobuf.StringValue
macros	google.protobuf.StringValue
markup	google.protobuf.StringValue
tag_groups	TagGroupState	repeated
companion_banner	google.protobuf.StringValue

FilterState

Output type for Filter operations

Field	Type	Label	Description
id	int64		Unique id for a Filter
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
placement_id	int64		Unique id for a Placement
type	string		UNKNOWN
rule	string		UNKNOWN
list_id	int64		Unique id for a List
list	List		UNKNOWN

PlacementState

Output type for Placement operations

Field	Type	Label	Description
id	int64		Unique id for a Placement
organization_id	int64		Unique id for an Org
advertiser_id	int64		Unique id for an Advertiser
campaign_id	int64		Unique id for a Campaign
name	string		UNKNOWN
media_type	string		UNKNOWN
budget	double		UNKNOWN
base_bid	double		UNKNOWN
daily_budget_cap	double		UNKNOWN
pacing_type	string		UNKNOWN
bidding_strategy	string		UNKNOWN
active	bool		UNKNOWN
frequency_caps	FrequencyCap	repeated	UNKNOWN
vendors	Vendor	repeated	UNKNOWN
filters	FilterState	repeated	UNKNOWN
creatives	CreativeState	repeated	UNKNOWN
advertiser	Advertiser		UNKNOWN
campaign	Campaign		UNKNOWN
spend	double		UNKNOWN
bids	int64		UNKNOWN
impressions	int64		UNKNOWN
video_type	google.protobuf.StringValue		UNKNOWN

TagGroupState

Output type for TagGroup operations

Field	Type	Label	Description
id	int64		Unique id for a TagGroup
organization_id	int64		Unique id for an Org
scope	string		UNKNOWN
name	string		UNKNOWN
tagalongs	TagalongState	repeated	UNKNOWN

TagalongState

Output type for Tagalong operations

Field	Type	Label	Description
id	int64		Unique id for a Tagalong
organization_id	int64		Unique id for an Org
vendor_id	google.protobuf.Int64Value		Unique id for a Vendor
tag_group_id	int64		Unique id for a TagGroup
name	string		UNKNOWN
type	string		UNKNOWN
tag	string		UNKNOWN
vendor	Vendor		UNKNOWN

backend.tag.proto

Top

AdvertiserTagMessage

Input type for Tag/Advertiser operations - AddTagToAdvertiser - RemoveTagFromAdvertiser

Field	Type	Label	Description
advertiser_id	int64		Unique id for an Advertiser
tag_id	int64		Unique id for a Tag

CampaignTagMessage

Input type for Tag/Campaign operations - AddTagToCampaign - RemoveTagFromCampaign

Field	Type	Label	Description
campaign_id	int64		Unique id for a Campaign
tag_id	int64		Unique id for a Tag

OrganizationTagMessage

DEAD CODE

Field	Type	Label	Description
organization_id	int64		Unique id for an Org
tag_id	int64		Unique id for a Tag

PlacementTagMessage

Input type for Tag/Placement operations - AddTagToPlacement - RemoveTagFromPlacement

Field	Type	Label	Description
placement_id	int64		Unique id for a Placement
tag_id	int64		Unique id for a Tag

Tag

Output type for Tag operations - GetTag - CreateTag - ModifyTag - ETC

Field	Type	Label	Description
id	int64		Unique id for a Tag
organization_id	int64		Unique id for an Org
name	string		UNKNOWN
type	string		UNKNOWN
scope	string		UNKNOWN

TagID

Input type for Tag operations - GetTag - ModifyTag - ETC

Field	Type	Label	Description
id	int64		Unique id for a Tag

TagGroupID

Input type for TagGroup operations - CreateTagGroup - DeleteTagGroup

Field	Type	Label	Description
id	int64		Unique id for a TagGroup

TagGroups

Output type for TagGroup operations - GetTagGroupsForCreative - SearchTagGroups - ETC This is a list of type

Field	Type	Label	Description
tag_groups	TagGroup	repeated	A list of TagGroup

backend.tagalong.proto

Top

Tagalong

Output type for Tagalong operations - GetTagalong - ModifyTagalong Also used in the aggregate of lists of Tagalong

Field	Type	Label	Description
id	int64		Unique id for a Tagalong
organization_id	int64		Unique id for an Org
vendor_id	google.protobuf.Int64Value		Unique id for a Vendor
tag_group_id	int64		Unique id for a TagGroup
name	string		UNKNOWN
type	string		UNKNOWN
tag	string		UNKNOWN

TagalongID

Input type for Tagalong operations - GetTagalong - DeleteTagalong

Field	Type	Label	Description
id	int64		Unique id for a Tagalong

Tagalongs

Output type for Tagalong operations

Field	Type	Label	Description
tagalongs	Tagalong	repeated	A list of Tagalong

backend.vendor.proto

Top

AdvertiserVendorMessage

Input type for a single Vendor operation - CreateVendorForAdvertiser

Field	Type	Label	Description
advertiser_id	int64		Unique id for an Advertiser
vendor	Vendor		UNKNOWN

CampaignVendorMessage

Input type for a single Vendor operation - CreateVendorForCampaign

Field	Type	Label	Description
campaign_id	int64		Unique id for a Campaign
vendor	Vendor		UNKNOWN

OrganizationVendorMessage

Input type for a single Vendor operation - CreateVendorForOrganization

Field	Type	Label	Description
organization_id	int64		Unique id for an Org
vendor	Vendor		UNKNOWN

PlacementVendorMessage

Input type for a single Vendor operation - CreateVendorForPlacement

Field	Type	Label	Description
placement_id	int64		Unique id for a Placement
vendor	Vendor		UNKNOWN

Vendor

Output type for Vendor operations - GetVendor - ModifyVendor Also used in the aggregate for vendor lists

Field	Type	Label	Description
id	int64		Unique id for a Vendor
name	string		UNKNOWN
tier	int64		UNKNOWN
fee	double		UNKNOWN
fee_type	string		UNKNOWN

VendorID

Input type for Vendor operations - GetVendor - DeleteVendor

Field	Type	Label	Description
id	int64		Unique id for a Vendor

Vendors

Output type for Vendor operations

Field	Type	Label	Description
vendors	Vendor	repeated	A list of Vendor

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)