Class AuxiliaryAdSettings (0.54.0)

public final class AuxiliaryAdSettings extends GeneratedMessage implements AuxiliaryAdSettingsOrBuilder

Settings for auxiliary ads (e.g. pause ads) on a live stream.

Protobuf type google.ads.admanager.v1.AuxiliaryAdSettings

Static Fields

AD_TAG_URL_FIELD_NUMBER

public static final int AD_TAG_URL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AuxiliaryAdSettings getDefaultInstance()
Returns
Type Description
AuxiliaryAdSettings

getDescriptor()

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

newBuilder()

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

newBuilder(AuxiliaryAdSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAdTagUrl()

public String getAdTagUrl()

Required. The ad tag URL used to request auxiliary ads (such as pause ads). This can be a Google Ad Manager ad tag or a third-party ad tag. Publishers are responsible for ensuring the correctness of the URL.

optional string ad_tag_url = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The adTagUrl.

getAdTagUrlBytes()

public ByteString getAdTagUrlBytes()

Required. The ad tag URL used to request auxiliary ads (such as pause ads). This can be a Google Ad Manager ad tag or a third-party ad tag. Publishers are responsible for ensuring the correctness of the URL.

optional string ad_tag_url = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for adTagUrl.

getDefaultInstanceForType()

public AuxiliaryAdSettings getDefaultInstanceForType()
Returns
Type Description
AuxiliaryAdSettings

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAdTagUrl()

public boolean hasAdTagUrl()

Required. The ad tag URL used to request auxiliary ads (such as pause ads). This can be a Google Ad Manager ad tag or a third-party ad tag. Publishers are responsible for ensuring the correctness of the URL.

optional string ad_tag_url = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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