Class AdUnitSize (0.2.0)

  public 
  
 final 
  
 class 
 AdUnitSize 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 AdUnitSizeOrBuilder 
 

Represents the size, environment, and companions of an ad in an ad unit.

Protobuf type google.ads.admanager.v1.AdUnitSize

Implements

AdUnitSizeOrBuilder

Static Fields

COMPANIONS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 COMPANIONS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ENVIRONMENT_TYPE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ENVIRONMENT_TYPE_FIELD_NUMBER 
 
Field Value
Type
Description
int

SIZE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SIZE_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 AdUnitSize 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description

getDescriptor()

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

newBuilder()

  public 
  
 static 
  
 AdUnitSize 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(AdUnitSize prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCompanions(int index)

  public 
  
 Size 
  
 getCompanions 
 ( 
 int 
  
 index 
 ) 
 

The companions for this ad unit size. Companions are only valid if the environment is VIDEO_PLAYER .

repeated .google.ads.admanager.v1.Size companions = 3;

Parameter
Name
Description
index
int
Returns
Type
Description

getCompanionsCount()

  public 
  
 int 
  
 getCompanionsCount 
 () 
 

The companions for this ad unit size. Companions are only valid if the environment is VIDEO_PLAYER .

repeated .google.ads.admanager.v1.Size companions = 3;

Returns
Type
Description
int

getCompanionsList()

  public 
  
 List<Size> 
  
 getCompanionsList 
 () 
 

The companions for this ad unit size. Companions are only valid if the environment is VIDEO_PLAYER .

repeated .google.ads.admanager.v1.Size companions = 3;

Returns
Type
Description
List < Size >

getCompanionsOrBuilder(int index)

  public 
  
 SizeOrBuilder 
  
 getCompanionsOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

The companions for this ad unit size. Companions are only valid if the environment is VIDEO_PLAYER .

repeated .google.ads.admanager.v1.Size companions = 3;

Parameter
Name
Description
index
int
Returns
Type
Description

getCompanionsOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 SizeOrBuilder 
>  
 getCompanionsOrBuilderList 
 () 
 

The companions for this ad unit size. Companions are only valid if the environment is VIDEO_PLAYER .

repeated .google.ads.admanager.v1.Size companions = 3;

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

getDefaultInstanceForType()

  public 
  
 AdUnitSize 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

getEnvironmentType()

  public 
  
 EnvironmentTypeEnum 
 . 
 EnvironmentType 
  
 getEnvironmentType 
 () 
 

Required. The EnvironmentType of the AdUnit

.google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

getEnvironmentTypeValue()

  public 
  
 int 
  
 getEnvironmentTypeValue 
 () 
 

Required. The EnvironmentType of the AdUnit

.google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description
int

The enum numeric value on the wire for environmentType.

getParserForType()

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

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

getSize()

  public 
  
 Size 
  
 getSize 
 () 
 

Required. The Size of the AdUnit.

.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The size.

getSizeOrBuilder()

  public 
  
 SizeOrBuilder 
  
 getSizeOrBuilder 
 () 
 

Required. The Size of the AdUnit.

.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

hasSize()

  public 
  
 boolean 
  
 hasSize 
 () 
 

Required. The Size of the AdUnit.

.google.ads.admanager.v1.Size size = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

Whether the size field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 AdUnitSize 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

  protected 
  
 AdUnitSize 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 GeneratedMessageV3 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

  protected 
  
 Object 
  
 newInstance 
 ( 
 GeneratedMessageV3 
 . 
 UnusedPrivateParameter 
  
 unused 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 AdUnitSize 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: