REST Resource: networks.yieldPartners

Resource: YieldPartner

Represents a third-party ad network or exchange, configured within the context of a Company, that publishers partner with to monetize their ad inventory.

JSON representation 
{
  "name": string,
  "settings": [
    {
      object (YieldPartnerSettings)
    }
  ],
  "displayName": string,
  "company": string
}
Fields
name

string

Identifier. The resource name of the YieldPartner. Format: networks/{networkCode}/yieldPartners/{yieldPartnerId}
settings[]

object (YieldPartnerSettings)

Optional. The settings of the partner, representing its capabilities.
displayName

string

Optional. The name of the yield partner. This refers to the name of the company associated with the partner, if there is one.
company

string

Output only. The company associated with this yield partner.

YieldPartnerSettings

Settings for a yield partner.

JSON representation 
{
  "parameters": [
    {
      object (YieldParameter)
    }
  ],
  "status": enum (YieldPartnerSettingStatus),
  "environment": enum (YieldEnvironmentType),
  "format": enum (YieldFormat),
  "integrationType": enum (YieldIntegrationType),
  "platform": enum (YieldPlatform)
}
Fields
parameters[]

object (YieldParameter)

Output only. The parameters of this yield partner setting.
status

enum (YieldPartnerSettingStatus)

Output only. The status of this yield partner setting.
environment

enum (YieldEnvironmentType)

Output only. The environment of this yield partner setting.
format

enum (YieldFormat)

Output only. The format of this yield partner setting.
integrationType

enum (YieldIntegrationType)

Output only. The integration type of this yield partner setting.
platform

enum (YieldPlatform)

Output only. The platform of this yield partner setting.

YieldPartnerSettingStatus

Status of a partner setting, representing a partner capability.

Enums
YIELD_PARTNER_SETTING_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE Active setting
DEPRECATED Deprecated setting

YieldEnvironmentType

Available environment types for mediation. Describes the environment/technology rendering the TYM response.

Enums
YIELD_ENVIRONMENT_TYPE_UNSPECIFIED Default value. This value is unused.
MOBILE Mobile environment type.
VIDEO_VAST Video in-stream environment type.
WEB Web environment type.

YieldFormat

Represents possible formats for a yield group.

Enums
YIELD_FORMAT_UNSPECIFIED Default value. This value is unused.
APP_OPEN App open format when users open their app.
BANNER Banner format, some fixed wxh size.
INTERSTITIAL Interstitial ad format.
NATIVE Native ad format.
REWARDED Rewarded format.
REWARDED_INTERSTITIAL Rewarded interstitial format.
VIDEO_VAST Vast video ad format.

YieldIntegrationType

Represents the possible types of adapters a buyer can have.

Enums
YIELD_INTEGRATION_TYPE_UNSPECIFIED Default value. This value is unused.
CUSTOM_EVENT_MEDIATION Custom event mediation integration type
OPEN_BIDDING Open bidding integration type
SDK_MEDIATION SDK mediation integration type
THIRD_PARTY_SDK_BIDDING Third party SDK bidding integration type

YieldParameter

Describes a field used by a mobile adapter to call an ad network. For example, pubid.

JSON representation 
{
  "key": string,
  "optional": boolean
}
Fields
key

string

Output only. Identifier of the parameter.
optional

boolean

Output only. Whether or not this parameter is optional.

YieldPlatform

Represents possible platforms for a mediation ad source.

Enums
YIELD_PLATFORM_UNSPECIFIED Default value. This value is unused.
ANDROID Android platform.
IOS iOS platform.

Methods

get

 Gets a YieldPartner object.

list

 Gets a list of all yield partners.