Class YieldGroup (0.62.0)

public final class YieldGroup extends GeneratedMessage implements YieldGroupOrBuilder

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

Protobuf type google.ads.admanager.v1.YieldGroup

Implements

YieldGroupOrBuilder

Static Fields

AD_SOURCES_FIELD_NUMBER

public static final int AD_SOURCES_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGETING_FIELD_NUMBER

public static final int TARGETING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static YieldGroup getDefaultInstance()
Returns
Type Description
YieldGroup

getDescriptor()

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

newBuilder()

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

newBuilder(YieldGroup prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAdSources(int index)

public YieldAdSource getAdSources(int index)

Optional. The ad sources that belong to the YieldGroup.

repeated .google.ads.admanager.v1.YieldAdSource ad_sources = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
YieldAdSource

getAdSourcesCount()

public int getAdSourcesCount()

Optional. The ad sources that belong to the YieldGroup.

repeated .google.ads.admanager.v1.YieldAdSource ad_sources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAdSourcesList()

public List<YieldAdSource> getAdSourcesList()

Optional. The ad sources that belong to the YieldGroup.

repeated .google.ads.admanager.v1.YieldAdSource ad_sources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<YieldAdSource>

getAdSourcesOrBuilder(int index)

public YieldAdSourceOrBuilder getAdSourcesOrBuilder(int index)

Optional. The ad sources that belong to the YieldGroup.

repeated .google.ads.admanager.v1.YieldAdSource ad_sources = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
YieldAdSourceOrBuilder

getAdSourcesOrBuilderList()

public List<? extends YieldAdSourceOrBuilder> getAdSourcesOrBuilderList()

Optional. The ad sources that belong to the YieldGroup.

repeated .google.ads.admanager.v1.YieldAdSource ad_sources = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.YieldAdSourceOrBuilder>

getDefaultInstanceForType()

public YieldGroup getDefaultInstanceForType()
Returns
Type Description
YieldGroup

getDisplayName()

public String getDisplayName()

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

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the YieldGroup. Format: networks/{network_code}/yieldGroups/{yield_group_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public YieldEntityStatusEnum.YieldEntityStatus getStatus()

Output only. Status of the YieldGroup.

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

Returns
Type Description
YieldEntityStatusEnum.YieldEntityStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. Status of the YieldGroup.

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

Returns
Type Description
int

The enum numeric value on the wire for status.

getTargeting()

public Targeting getTargeting()

Optional. The targeting of the YieldGroup.

optional .google.ads.admanager.v1.Targeting targeting = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Targeting

The targeting.

getTargetingOrBuilder()

public TargetingOrBuilder getTargetingOrBuilder()

Optional. The targeting of the YieldGroup.

optional .google.ads.admanager.v1.Targeting targeting = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TargetingOrBuilder

hasDisplayName()

public boolean hasDisplayName()

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

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasStatus()

public boolean hasStatus()

Output only. Status of the YieldGroup.

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

Returns
Type Description
boolean

Whether the status field is set.

hasTargeting()

public boolean hasTargeting()

Optional. The targeting of the YieldGroup.

optional .google.ads.admanager.v1.Targeting targeting = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the targeting 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 YieldGroup.Builder newBuilderForType()
Returns
Type Description
YieldGroup.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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