Class YieldAdSource.Builder (0.62.0)

public static final class YieldAdSource.Builder extends GeneratedMessage.Builder<YieldAdSource.Builder> 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 Methods

getDescriptor()

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

Methods

build()

public YieldAdSource build()
Returns
Type Description
YieldAdSource

buildPartial()

public YieldAdSource buildPartial()
Returns
Type Description
YieldAdSource

clear()

public YieldAdSource.Builder clear()
Returns
Type Description
YieldAdSource.Builder
Overrides

clearAdSourceId()

public YieldAdSource.Builder clearAdSourceId()

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
YieldAdSource.Builder

This builder for chaining.

clearCompany()

public YieldAdSource.Builder clearCompany()

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
YieldAdSource.Builder

This builder for chaining.

clearDisplaySettings()

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

clearManualCpm()

public YieldAdSource.Builder clearManualCpm()

Optional. CPM manually assigned to this source.

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

Returns
Type Description
YieldAdSource.Builder

clearOpenBiddingSettings()

public YieldAdSource.Builder clearOpenBiddingSettings()

Settings for Open Bidding.

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

Returns
Type Description
YieldAdSource.Builder

clearOverrideDynamicCpm()

public YieldAdSource.Builder clearOverrideDynamicCpm()

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
YieldAdSource.Builder

This builder for chaining.

clearSdkMediationSettings()

public YieldAdSource.Builder clearSdkMediationSettings()

Settings for mobile app display.

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

Returns
Type Description
YieldAdSource.Builder

clearStatus()

public YieldAdSource.Builder clearStatus()

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
YieldAdSource.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getManualCpmBuilder()

public Money.Builder getManualCpmBuilder()

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.Builder

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.

getOpenBiddingSettingsBuilder()

public YieldAdSource.OpenBiddingSettings.Builder getOpenBiddingSettingsBuilder()

Settings for Open Bidding.

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

Returns
Type Description
YieldAdSource.OpenBiddingSettings.Builder

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.

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.

getSdkMediationSettingsBuilder()

public YieldAdSource.SdkMediationSettings.Builder getSdkMediationSettingsBuilder()

Settings for mobile app display.

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

Returns
Type Description
YieldAdSource.SdkMediationSettings.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(YieldAdSource other)

public YieldAdSource.Builder mergeFrom(YieldAdSource other)
Parameter
Name Description
other YieldAdSource
Returns
Type Description
YieldAdSource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public YieldAdSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
YieldAdSource.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public YieldAdSource.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
YieldAdSource.Builder
Overrides

mergeManualCpm(Money value)

public YieldAdSource.Builder mergeManualCpm(Money value)

Optional. CPM manually assigned to this source.

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

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
YieldAdSource.Builder

mergeOpenBiddingSettings(YieldAdSource.OpenBiddingSettings value)

public YieldAdSource.Builder mergeOpenBiddingSettings(YieldAdSource.OpenBiddingSettings value)

Settings for Open Bidding.

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

Parameter
Name Description
value YieldAdSource.OpenBiddingSettings
Returns
Type Description
YieldAdSource.Builder

mergeSdkMediationSettings(YieldAdSource.SdkMediationSettings value)

public YieldAdSource.Builder mergeSdkMediationSettings(YieldAdSource.SdkMediationSettings value)

Settings for mobile app display.

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

Parameter
Name Description
value YieldAdSource.SdkMediationSettings
Returns
Type Description
YieldAdSource.Builder

setAdSourceId(long value)

public YieldAdSource.Builder setAdSourceId(long value)

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];

Parameter
Name Description
value long

The adSourceId to set.

Returns
Type Description
YieldAdSource.Builder

This builder for chaining.

setCompany(String value)

public YieldAdSource.Builder setCompany(String value)

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) = { ... }

Parameter
Name Description
value String

The company to set.

Returns
Type Description
YieldAdSource.Builder

This builder for chaining.

setCompanyBytes(ByteString value)

public YieldAdSource.Builder setCompanyBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for company to set.

Returns
Type Description
YieldAdSource.Builder

This builder for chaining.

setManualCpm(Money value)

public YieldAdSource.Builder setManualCpm(Money value)

Optional. CPM manually assigned to this source.

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

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
YieldAdSource.Builder

setManualCpm(Money.Builder builderForValue)

public YieldAdSource.Builder setManualCpm(Money.Builder builderForValue)

Optional. CPM manually assigned to this source.

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

Parameter
Name Description
builderForValue com.google.type.Money.Builder
Returns
Type Description
YieldAdSource.Builder

setOpenBiddingSettings(YieldAdSource.OpenBiddingSettings value)

public YieldAdSource.Builder setOpenBiddingSettings(YieldAdSource.OpenBiddingSettings value)

Settings for Open Bidding.

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

Parameter
Name Description
value YieldAdSource.OpenBiddingSettings
Returns
Type Description
YieldAdSource.Builder

setOpenBiddingSettings(YieldAdSource.OpenBiddingSettings.Builder builderForValue)

public YieldAdSource.Builder setOpenBiddingSettings(YieldAdSource.OpenBiddingSettings.Builder builderForValue)

Settings for Open Bidding.

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

Parameter
Name Description
builderForValue YieldAdSource.OpenBiddingSettings.Builder
Returns
Type Description
YieldAdSource.Builder

setOverrideDynamicCpm(boolean value)

public YieldAdSource.Builder setOverrideDynamicCpm(boolean value)

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];

Parameter
Name Description
value boolean

The overrideDynamicCpm to set.

Returns
Type Description
YieldAdSource.Builder

This builder for chaining.

setSdkMediationSettings(YieldAdSource.SdkMediationSettings value)

public YieldAdSource.Builder setSdkMediationSettings(YieldAdSource.SdkMediationSettings value)

Settings for mobile app display.

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

Parameter
Name Description
value YieldAdSource.SdkMediationSettings
Returns
Type Description
YieldAdSource.Builder

setSdkMediationSettings(YieldAdSource.SdkMediationSettings.Builder builderForValue)

public YieldAdSource.Builder setSdkMediationSettings(YieldAdSource.SdkMediationSettings.Builder builderForValue)

Settings for mobile app display.

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

Parameter
Name Description
builderForValue YieldAdSource.SdkMediationSettings.Builder
Returns
Type Description
YieldAdSource.Builder

setStatus(YieldEntityStatusEnum.YieldEntityStatus value)

public YieldAdSource.Builder setStatus(YieldEntityStatusEnum.YieldEntityStatus value)

Optional. User-assigned status of the ad source.

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

Parameter
Name Description
value YieldEntityStatusEnum.YieldEntityStatus

The status to set.

Returns
Type Description
YieldAdSource.Builder

This builder for chaining.

setStatusValue(int value)

public YieldAdSource.Builder setStatusValue(int value)

Optional. User-assigned status of the ad source.

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

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
YieldAdSource.Builder

This builder for chaining.