type YieldAdSource (v202508)

  • A YieldAdSource allows a third-party network to mediate on a segment of inventory within a YieldGroup.

  • Key fields include adSourceId, companyId, displaySettings, status, manualCpm, and overrideDynamicCpm.

  • The status of a YieldAdSource can be UNKNOWN, EXPERIMENTING, ACTIVE, INACTIVE, or DELETED.

  • manualCpm provides a default CPM that can override automatically collected data if overrideDynamicCpm is true.
Service
YieldGroupService
Dependencies
YieldGroup
▼
YieldAdSource

A yield ad source represents an opportunity for a third party network to be mediated on a segment of inventory described in a YieldGroupDto.

Namespace
https://www.google.com/apis/ads/publisher/v202508

Field

adSourceId

xsd:long

The unique ID of the ad source. This attribute is read-only and is assigned by Google when the ad source is created.

companyId

xsd:long

The id of the partner owning the ad source. This should be the ID of the Company representing the yield partner.

displaySettings

  1. AbstractDisplaySettings
    1. OpenBiddingSetting
    2. SdkMediationSettings

Data that describe how to call an ad network.

status

YieldEntityStatus

User-assigned status of the ad source. Note that this can be different than the status on the YieldGroup this ad source belongs to. Set this to DELETED to remove it from the YieldGroup.

Enumerations
UNKNOWN
EXPERIMENTING
ACTIVE
INACTIVE
DELETED

manualCpm

Money

CPM manually assigned to this source. This will be used as a default CPM until automatic data collection is available for the ad source, or always if overrideDynamicCpm is set to true.

overrideDynamicCpm

xsd:boolean

If true, then the automatically collected CPM, if available, is ignored in favor of manualCpm.