agma

README

agma Analytics

In order to use the Agma Analytics Adapter, please adjust the accounts / endpoint with the data provided by agma (https://www.agma-mmc.de).

Configuration

analytics:
    agma:
        # Required: enable the module
        enabled: true
        # Required: set the accounts you want to track
        accounts:
        - code: "my-code" # Required: provied by agma
          publisher_id: "123" # Required: Exchange specific publisher_id, can be an empty string accounts are not used
          site_app_id: "openrtb2-site.id-or-app.id-or-app.bundle" # optional: scope to the publisher with an openrtb2 Site object id or App object id/bundle
        # Optional properties (advanced configuration)
        endpoint: 
            url: "https://go.pbs.agma-analytics.de/v1/prebid-server" # Check with agma if your site needs an extra url
            timeout: "2s"
            gzip: true
        buffers: # Flush events when (first condition reached)
            # Size of the buffer in bytes
            size: "2MB" # greater than 2MB (size using SI standard eg. "44kB", "17MB")
            count : 100 # greater than 100 events
            timeout: "15m" # greater than 15 minutes (parsed as golang duration)

Documentation

Index

• func NewModule(httpClient *http.Client, cfg config.AgmaAnalytics, clock clock.Clock) (analytics.Module, error)
• type AgmaLogger
  • func (l *AgmaLogger) LogAmpObject(event *analytics.AmpObject)
  • func (l *AgmaLogger) LogAuctionObject(event *analytics.AuctionObject)
  • func (l *AgmaLogger) LogCookieSyncObject(event *analytics.CookieSyncObject)
  • func (l *AgmaLogger) LogNotificationEventObject(event *analytics.NotificationEvent)
  • func (l *AgmaLogger) LogSetUIDObject(event *analytics.SetUIDObject)
  • func (l *AgmaLogger) LogVideoObject(event *analytics.VideoObject)
  • func (l *AgmaLogger) Shutdown()
• type EventType

Functions

func NewModule

func NewModule(httpClient *http.Client, cfg config.AgmaAnalytics, clock clock.Clock) (analytics.Module, error)

Types

type AgmaLogger

type AgmaLogger struct {
	// contains filtered or unexported fields
}

func (*AgmaLogger) LogAmpObject

func (l *AgmaLogger) LogAmpObject(event *analytics.AmpObject)

func (*AgmaLogger) LogAuctionObject

func (l *AgmaLogger) LogAuctionObject(event *analytics.AuctionObject)

func (*AgmaLogger) LogCookieSyncObject

func (l *AgmaLogger) LogCookieSyncObject(event *analytics.CookieSyncObject)

func (*AgmaLogger) LogNotificationEventObject

func (l *AgmaLogger) LogNotificationEventObject(event *analytics.NotificationEvent)

func (*AgmaLogger) LogSetUIDObject

func (l *AgmaLogger) LogSetUIDObject(event *analytics.SetUIDObject)

func (*AgmaLogger) LogVideoObject

func (l *AgmaLogger) LogVideoObject(event *analytics.VideoObject)

func (*AgmaLogger) Shutdown

func (l *AgmaLogger) Shutdown()

type EventType

type EventType string

const (
	EventTypeAuction EventType = "auction"
	EventTypeAmp     EventType = "amp"
	EventTypeVideo   EventType = "video"
)