REST Resource: networks.yieldGroups

Resource: YieldGroup

Represents a segment of inventory and a set of yield partners that can monetize that inventory.

JSON representation 
{
  "name": string,
  "adSources": [
    {
      object (YieldAdSource)
    }
  ],
  "displayName": string,
  "status": enum (YieldEntityStatus),
  "targeting": {
    object (Targeting)
  }
}
Fields
name

string

Identifier. The resource name of the YieldGroup. Format: networks/{networkCode}/yieldGroups/{yield_group_id}
adSources[]

object (YieldAdSource)

Optional. The ad sources that belong to the YieldGroup.
displayName

string

Required. The display name of the YieldGroup. This value has a maximum length of 255 characters.
status

enum (YieldEntityStatus)

Output only. Status of the YieldGroup.
targeting

object (Targeting)

Optional. The targeting of the YieldGroup.

YieldEntityStatus

Status of the yield group or ad source.

Enums
YIELD_ENTITY_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE Indicates that the associated object is currently eligible to serve.
EXPERIMENTING Indicates that the associated object is under experiment (only applicable to yield groups).
INACTIVE Indicates that the associated object is not currently eligible to serve.
ARCHIVED Indicates that the associated object is archived (deleted).

YieldAdSource

Represents an opportunity for a third party network to be mediated on a segment of inventory described in a YieldGroup.

JSON representation 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "openBiddingSettings": {
    object (OpenBiddingSettings)
  },
  "sdkMediationSettings": {
    object (SdkMediationSettings)
  }
  // End of mutually exclusive fields.
  "adSourceId": string,
  "company": string,
  "status": enum (YieldEntityStatus),
  "manualCpm": {
    object (Money)
  },
  "overrideDynamicCpm": boolean
}
Fields
The specific settings for the integration type. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
openBiddingSettings

object (OpenBiddingSettings)

Settings for Open Bidding.
sdkMediationSettings

object (SdkMediationSettings)

Settings for mobile app display.
End of mutually exclusive fields.
adSourceId

string (int64 format)

Optional. Non-empty default. The ID of the ad source. This field is assigned by Google when the ad source is created. Provide this ID when updating an existing ad source; omit it when adding a new ad source.
company

string

Required. Immutable. The resource name of the Company. Format: networks/{networkCode}/companies/{companyId}
status

enum (YieldEntityStatus)

Optional. User-assigned status of the ad source.
manualCpm

object (Money)

Optional. CPM manually assigned to this source.
overrideDynamicCpm

boolean

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

OpenBiddingSettings

Configuration for Open Bidding in a YieldAdSource.

JSON representation 
{
  "integrationType": enum (YieldIntegrationType)
}
Fields
integrationType

enum (YieldIntegrationType)

Required. The integration type of the yield partner.

SdkMediationSettings

Display settings for mobile SDK adapters.

JSON representation 
{
  "parameters": {
    string: string,
    ...
  },
  "integrationType": enum (YieldIntegrationType),
  "platform": enum (YieldPlatform)
}
Fields
parameters

map (key: string, value: string)

Optional. The parameters for the mobile SDK adapter.
integrationType

enum (YieldIntegrationType)

Required. The integration type of the yield partner.
platform

enum (YieldPlatform)

Required. The platform of the adapter.

Methods

batchActivate

 Activates a list of YieldGroup objects.

batchArchive

 Archives a list of YieldGroup objects.

batchCreate

 Batch creates YieldGroup objects.

batchDeactivate

 Deactivates a list of YieldGroup objects.

batchUpdate

 Batch updates YieldGroup objects.

create

 Creates a YieldGroup object.

get

 Retrieves a YieldGroup object.

list

 Lists YieldGroup objects.

patch

 Updates a YieldGroup object.