Class YieldAdSource (0.62.0)

public final class YieldAdSource extends GeneratedMessage implements YieldAdSourceOrBuilder

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

Protobuf type google.ads.admanager.v1.YieldAdSource

Static Fields

AD_SOURCE_ID_FIELD_NUMBER

public static final int AD_SOURCE_ID_FIELD_NUMBER
Field Value
Type Description
int

COMPANY_FIELD_NUMBER

public static final int COMPANY_FIELD_NUMBER
Field Value
Type Description
int

MANUAL_CPM_FIELD_NUMBER

public static final int MANUAL_CPM_FIELD_NUMBER
Field Value
Type Description
int

OPEN_BIDDING_SETTINGS_FIELD_NUMBER

public static final int OPEN_BIDDING_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

OVERRIDE_DYNAMIC_CPM_FIELD_NUMBER

public static final int OVERRIDE_DYNAMIC_CPM_FIELD_NUMBER
Field Value
Type Description
int

SDK_MEDIATION_SETTINGS_FIELD_NUMBER

public static final int SDK_MEDIATION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static YieldAdSource getDefaultInstance()
Returns
Type Description
YieldAdSource

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static YieldAdSource.Builder newBuilder()
Returns
Type Description
YieldAdSource.Builder

newBuilder(YieldAdSource prototype)

public static YieldAdSource.Builder newBuilder(YieldAdSource prototype)
Parameter
Name Description
prototype YieldAdSource
Returns
Type Description
YieldAdSource.Builder

parseDelimitedFrom(InputStream input)

public static YieldAdSource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
YieldAdSource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static YieldAdSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
YieldAdSource
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static YieldAdSource parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
YieldAdSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static YieldAdSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
YieldAdSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static YieldAdSource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
YieldAdSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static YieldAdSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
YieldAdSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static YieldAdSource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
YieldAdSource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static YieldAdSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
YieldAdSource
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static YieldAdSource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
YieldAdSource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static YieldAdSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
YieldAdSource
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static YieldAdSource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
YieldAdSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static YieldAdSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
YieldAdSource
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<YieldAdSource> parser()
Returns
Type Description
Parser<YieldAdSource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdSourceId()

public long getAdSourceId()

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.

optional int64 ad_source_id = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
long

The adSourceId.

getCompany()

public String getCompany()

Required. Immutable. The resource name of the Company. Format: networks/{network_code}/companies/{company_id}

optional string company = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The company.

getCompanyBytes()

public ByteString getCompanyBytes()

Required. Immutable. The resource name of the Company. Format: networks/{network_code}/companies/{company_id}

optional string company = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for company.

getDefaultInstanceForType()

public YieldAdSource getDefaultInstanceForType()
Returns
Type Description
YieldAdSource

getDisplaySettingsCase()

public YieldAdSource.DisplaySettingsCase getDisplaySettingsCase()
Returns
Type Description
YieldAdSource.DisplaySettingsCase

getManualCpm()

public Money getManualCpm()

Optional. CPM manually assigned to this source.

optional .google.type.Money manual_cpm = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Money

The manualCpm.

getManualCpmOrBuilder()

public MoneyOrBuilder getManualCpmOrBuilder()

Optional. CPM manually assigned to this source.

optional .google.type.Money manual_cpm = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.MoneyOrBuilder

getOpenBiddingSettings()

public YieldAdSource.OpenBiddingSettings getOpenBiddingSettings()

Settings for Open Bidding.

.google.ads.admanager.v1.YieldAdSource.OpenBiddingSettings open_bidding_settings = 6;

Returns
Type Description
YieldAdSource.OpenBiddingSettings

The openBiddingSettings.

getOpenBiddingSettingsOrBuilder()

public YieldAdSource.OpenBiddingSettingsOrBuilder getOpenBiddingSettingsOrBuilder()

Settings for Open Bidding.

.google.ads.admanager.v1.YieldAdSource.OpenBiddingSettings open_bidding_settings = 6;

Returns
Type Description
YieldAdSource.OpenBiddingSettingsOrBuilder

getOverrideDynamicCpm()

public boolean getOverrideDynamicCpm()

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

optional bool override_dynamic_cpm = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The overrideDynamicCpm.

getParserForType()

public Parser<YieldAdSource> getParserForType()
Returns
Type Description
Parser<YieldAdSource>
Overrides

getSdkMediationSettings()

public YieldAdSource.SdkMediationSettings getSdkMediationSettings()

Settings for mobile app display.

.google.ads.admanager.v1.YieldAdSource.SdkMediationSettings sdk_mediation_settings = 7;

Returns
Type Description
YieldAdSource.SdkMediationSettings

The sdkMediationSettings.

getSdkMediationSettingsOrBuilder()

public YieldAdSource.SdkMediationSettingsOrBuilder getSdkMediationSettingsOrBuilder()

Settings for mobile app display.

.google.ads.admanager.v1.YieldAdSource.SdkMediationSettings sdk_mediation_settings = 7;

Returns
Type Description
YieldAdSource.SdkMediationSettingsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public YieldEntityStatusEnum.YieldEntityStatus getStatus()

Optional. User-assigned status of the ad source.

optional .google.ads.admanager.v1.YieldEntityStatusEnum.YieldEntityStatus status = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
YieldEntityStatusEnum.YieldEntityStatus

The status.

getStatusValue()

public int getStatusValue()

Optional. User-assigned status of the ad source.

optional .google.ads.admanager.v1.YieldEntityStatusEnum.YieldEntityStatus status = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for status.

hasAdSourceId()

public boolean hasAdSourceId()

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.

optional int64 ad_source_id = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the adSourceId field is set.

hasCompany()

public boolean hasCompany()

Required. Immutable. The resource name of the Company. Format: networks/{network_code}/companies/{company_id}

optional string company = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the company field is set.

hasManualCpm()

public boolean hasManualCpm()

Optional. CPM manually assigned to this source.

optional .google.type.Money manual_cpm = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the manualCpm field is set.

hasOpenBiddingSettings()

public boolean hasOpenBiddingSettings()

Settings for Open Bidding.

.google.ads.admanager.v1.YieldAdSource.OpenBiddingSettings open_bidding_settings = 6;

Returns
Type Description
boolean

Whether the openBiddingSettings field is set.

hasOverrideDynamicCpm()

public boolean hasOverrideDynamicCpm()

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

optional bool override_dynamic_cpm = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the overrideDynamicCpm field is set.

hasSdkMediationSettings()

public boolean hasSdkMediationSettings()

Settings for mobile app display.

.google.ads.admanager.v1.YieldAdSource.SdkMediationSettings sdk_mediation_settings = 7;

Returns
Type Description
boolean

Whether the sdkMediationSettings field is set.

hasStatus()

public boolean hasStatus()

Optional. User-assigned status of the ad source.

optional .google.ads.admanager.v1.YieldEntityStatusEnum.YieldEntityStatus status = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public YieldAdSource.Builder newBuilderForType()
Returns
Type Description
YieldAdSource.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected YieldAdSource.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
YieldAdSource.Builder
Overrides

toBuilder()

public YieldAdSource.Builder toBuilder()
Returns
Type Description
YieldAdSource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException