search

prebid / prebid-server

Open-source solution for running real-time advertising auctions in the cloud.
https://prebid.org/product-suite/prebid-server/
Apache License 2.0
423 stars 718 forks source link

Integration vs channel #2044

Closed bretg closed 10 months ago

bretg commented 2 years ago

It was pointed out that some variable names refer to "integration", but are actually referring to "channel" values.

Follow up to https://github.com/prebid/prebid-server/issues/1428

In config/accounts.go

// IntegrationType enumerates the values of integrations Prebid Server can configure for an account
type IntegrationType string

// Possible values of integration types Prebid Server can configure for an account
const (
    IntegrationTypeAMP   IntegrationType = "amp" // should be "ChannelAMP"
    IntegrationTypeApp   IntegrationType = "app"  // should be "ChannelApp"
    IntegrationTypeVideo IntegrationType = "video"   // should be "ChannelVideo"
    IntegrationTypeWeb   IntegrationType = "web"  // should be "ChannelWeb"
)

Similarly, in PBS-Java config, privacy.*.integration-enabled should be "channel-enabled"

          integration-enabled:     // "channel-enabled" please
            video: true
            web: true
            app: true
            amp: true

This change would be one that host companies would need to be aware of. Will discuss in the next PBS meeting.

bretg commented 2 years ago

Discussed in PBS committee. There was one suggestion to have a transition period where both integration-enabled and channel-enabled config is supported. This would make it easier on companies who are using the old config. e.g. Magnite. We would release the PBS transition code, then we could update our DB values without disruption. The next PBS release could get rid of the transition.

bretg commented 2 years ago

The first phase of this released with PBS-Java 1.79. PBS-Java users should consider checking their databases and migrating "integration-enabled" to "channel-enabled". At some point in the near future, this update will be required.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

bretg commented 2 years ago

The other shoe dropped here with PBS-Java 1.86: 

Important: this is the release where we finish a transition started with PBS-Java 1.79 related to https://github.com/prebid/prebid-server/issues/2044 . Up until now, account configuration entries could use either "channel-enabled" or "integration-enabled" attributes as synonyms. With this release, they must use "channel-enabled". If you've set up a database with JSON columns to hold account config, an SQL template is provided in the release notes.
bsardo commented 10 months ago

IntegrationType has been changed to ChannelType in PBS-Go and the corresponding values have been renamed:

// ChannelType enumerates the values of integrations Prebid Server can configure for an account
type ChannelType string

// Possible values of channel types Prebid Server can configure for an account
const (
    ChannelAMP   ChannelType = "amp"
    ChannelApp   ChannelType = "app"
    ChannelVideo ChannelType = "video"
    ChannelWeb   ChannelType = "web"
    ChannelDOOH  ChannelType = "dooh"
)

Both integration-enabled and channel-enabled have been supported for about a year at this point and we recently removed support for integration-enabled as part of the 2.0 release initiative.