Class Goal (0.3.0)

public final class Goal extends GeneratedMessageV3 implements GoalOrBuilder

Defines the criteria a LineItem needs to satisfy to meet its delivery goal.

Protobuf type google.ads.admanager.v1.Goal

Implements

GoalOrBuilder

Static Fields

GOAL_TYPE_FIELD_NUMBER

public static final int GOAL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

UNITS_FIELD_NUMBER

public static final int UNITS_FIELD_NUMBER
Field Value
Type Description
int

UNIT_TYPE_FIELD_NUMBER

public static final int UNIT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Goal getDefaultInstance()
Returns
Type Description
Goal

getDescriptor()

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

newBuilder()

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

newBuilder(Goal prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Goal getDefaultInstanceForType()
Returns
Type Description
Goal

getGoalType()

public GoalTypeEnum.GoalType getGoalType()

The type of the goal for the LineItem. It defines the period over which the goal should be reached.

.google.ads.admanager.v1.GoalTypeEnum.GoalType goal_type = 1;

Returns
Type Description
GoalTypeEnum.GoalType

The goalType.

getGoalTypeValue()

public int getGoalTypeValue()

The type of the goal for the LineItem. It defines the period over which the goal should be reached.

.google.ads.admanager.v1.GoalTypeEnum.GoalType goal_type = 1;

Returns
Type Description
int

The enum numeric value on the wire for goalType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnitType()

public UnitTypeEnum.UnitType getUnitType()

The type of the goal unit for the LineItem.

.google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 2;

Returns
Type Description
UnitTypeEnum.UnitType

The unitType.

getUnitTypeValue()

public int getUnitTypeValue()

The type of the goal unit for the LineItem.

.google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 2;

Returns
Type Description
int

The enum numeric value on the wire for unitType.

getUnits()

public long getUnits()

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved. If the line item is of type LineItemTypeEnum.LineItemType.SPONSORSHIP, it represents the percentage of available impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.BULK or LineItemTypeEnum.LineItemType.PRICE_PRIORITY, it represents the number of remaining impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.NETWORK or LineItemTypeEnum.LineItemType.HOUSE, it represents the percentage of remaining impressions reserved. <p>If this is an impression cap goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see [LineItem.impressions_cap][].

int64 units = 3;

Returns
Type Description
long

The units.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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