Class McmEarnings (0.52.0)

public final class McmEarnings extends GeneratedMessage implements McmEarningsOrBuilder

The earnings for a given month between a parent and child publisher in MCM

Protobuf type google.ads.admanager.v1.McmEarnings

Static Fields

CHILD_DISPLAY_NAME_FIELD_NUMBER

public static final int CHILD_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

CHILD_FIELD_NUMBER

public static final int CHILD_FIELD_NUMBER
Field Value
Type Description
int

CHILD_PAYMENT_FIELD_NUMBER

public static final int CHILD_PAYMENT_FIELD_NUMBER
Field Value
Type Description
int

CHILD_PUBLISHER_FIELD_NUMBER

public static final int CHILD_PUBLISHER_FIELD_NUMBER
Field Value
Type Description
int

DEDUCTIONS_FIELD_NUMBER

public static final int DEDUCTIONS_FIELD_NUMBER
Field Value
Type Description
int

DELEGATION_TYPE_FIELD_NUMBER

public static final int DELEGATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

EARNINGS_PRODUCT_BREAKDOWN_FIELD_NUMBER

public static final int EARNINGS_PRODUCT_BREAKDOWN_FIELD_NUMBER
Field Value
Type Description
int

MONTH_FIELD_NUMBER

public static final int MONTH_FIELD_NUMBER
Field Value
Type Description
int

PARENT_DISPLAY_NAME_FIELD_NUMBER

public static final int PARENT_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PARENT_PAYMENT_FIELD_NUMBER

public static final int PARENT_PAYMENT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_EARNINGS_FIELD_NUMBER

public static final int TOTAL_EARNINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static McmEarnings getDefaultInstance()
Returns
Type Description
McmEarnings

getDescriptor()

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

newBuilder()

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

newBuilder(McmEarnings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getChild()

public String getChild()

Output only. The resource name of the ChildPublisher's Ad Manager network in the MCM relationship. Format: networks/{network_code}

string child = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The child.

getChildBytes()

public ByteString getChildBytes()

Output only. The resource name of the ChildPublisher's Ad Manager network in the MCM relationship. Format: networks/{network_code}

string child = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for child.

getChildDisplayName()

public String getChildDisplayName()

Output only. The name of the child publisher in the MCM relationship.

optional string child_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The childDisplayName.

getChildDisplayNameBytes()

public ByteString getChildDisplayNameBytes()

Output only. The name of the child publisher in the MCM relationship.

optional string child_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for childDisplayName.

getChildPayment()

public Money getChildPayment()

Output only. The portion of the total earnings paid to the child publisher.

optional .google.type.Money child_payment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Money

The childPayment.

getChildPaymentOrBuilder()

public MoneyOrBuilder getChildPaymentOrBuilder()

Output only. The portion of the total earnings paid to the child publisher.

optional .google.type.Money child_payment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.MoneyOrBuilder

getChildPublisher()

public String getChildPublisher()

Output only. The resource name of the child publisher in the MCM relationship. Format: "networks/{network_code}/childPublishers/{child_publisher_id}"

optional string child_publisher = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The childPublisher.

getChildPublisherBytes()

public ByteString getChildPublisherBytes()

Output only. The resource name of the child publisher in the MCM relationship. Format: "networks/{network_code}/childPublishers/{child_publisher_id}"

optional string child_publisher = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for childPublisher.

getDeductions()

public Money getDeductions()

Output only. The deductions for the month due to spam in micro units. Null for earnings prior to August 2020.

optional .google.type.Money deductions = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Money

The deductions.

getDeductionsOrBuilder()

public MoneyOrBuilder getDeductionsOrBuilder()

Output only. The deductions for the month due to spam in micro units. Null for earnings prior to August 2020.

optional .google.type.Money deductions = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.MoneyOrBuilder

getDefaultInstanceForType()

public McmEarnings getDefaultInstanceForType()
Returns
Type Description
McmEarnings

getDelegationType()

public DelegationTypeEnum.DelegationType getDelegationType()

Output only. The current type of MCM delegation between the parent and child publisher.

optional .google.ads.admanager.v1.DelegationTypeEnum.DelegationType delegation_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DelegationTypeEnum.DelegationType

The delegationType.

getDelegationTypeValue()

public int getDelegationTypeValue()

Output only. The current type of MCM delegation between the parent and child publisher.

optional .google.ads.admanager.v1.DelegationTypeEnum.DelegationType delegation_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for delegationType.

getEarningsProductBreakdown(int index)

public EarningsProductBreakdown getEarningsProductBreakdown(int index)

Output only. The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

repeated .google.ads.admanager.v1.EarningsProductBreakdown earnings_product_breakdown = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EarningsProductBreakdown

getEarningsProductBreakdownCount()

public int getEarningsProductBreakdownCount()

Output only. The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

repeated .google.ads.admanager.v1.EarningsProductBreakdown earnings_product_breakdown = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEarningsProductBreakdownList()

public List<EarningsProductBreakdown> getEarningsProductBreakdownList()

Output only. The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

repeated .google.ads.admanager.v1.EarningsProductBreakdown earnings_product_breakdown = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<EarningsProductBreakdown>

getEarningsProductBreakdownOrBuilder(int index)

public EarningsProductBreakdownOrBuilder getEarningsProductBreakdownOrBuilder(int index)

Output only. The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

repeated .google.ads.admanager.v1.EarningsProductBreakdown earnings_product_breakdown = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EarningsProductBreakdownOrBuilder

getEarningsProductBreakdownOrBuilderList()

public List<? extends EarningsProductBreakdownOrBuilder> getEarningsProductBreakdownOrBuilderList()

Output only. The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

repeated .google.ads.admanager.v1.EarningsProductBreakdown earnings_product_breakdown = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getMonth()

public Date getMonth()

Output only. The year and month that the MCM earnings data applies to. The date will be specified as the first of the month.

optional .google.type.Date month = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Date

The month.

getMonthOrBuilder()

public DateOrBuilder getMonthOrBuilder()

Output only. The year and month that the MCM earnings data applies to. The date will be specified as the first of the month.

optional .google.type.Date month = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.DateOrBuilder

getParent()

public String getParent()

Output only. The parent publisher in the MCM relationship. Format: networks/{network_code}

string parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Output only. The parent publisher in the MCM relationship. Format: networks/{network_code}

string parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParentDisplayName()

public String getParentDisplayName()

Output only. The name of the parent publisher.

optional string parent_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The parentDisplayName.

getParentDisplayNameBytes()

public ByteString getParentDisplayNameBytes()

Output only. The name of the parent publisher.

optional string parent_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for parentDisplayName.

getParentPayment()

public Money getParentPayment()

Output only. The portion of the total earnings paid to the parent publisher.

optional .google.type.Money parent_payment = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Money

The parentPayment.

getParentPaymentOrBuilder()

public MoneyOrBuilder getParentPaymentOrBuilder()

Output only. The portion of the total earnings paid to the parent publisher.

optional .google.type.Money parent_payment = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.MoneyOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalEarnings()

public Money getTotalEarnings()

Output only. The total earnings for the month.

optional .google.type.Money total_earnings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Money

The totalEarnings.

getTotalEarningsOrBuilder()

public MoneyOrBuilder getTotalEarningsOrBuilder()

Output only. The total earnings for the month.

optional .google.type.Money total_earnings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.MoneyOrBuilder

hasChildDisplayName()

public boolean hasChildDisplayName()

Output only. The name of the child publisher in the MCM relationship.

optional string child_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the childDisplayName field is set.

hasChildPayment()

public boolean hasChildPayment()

Output only. The portion of the total earnings paid to the child publisher.

optional .google.type.Money child_payment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the childPayment field is set.

hasChildPublisher()

public boolean hasChildPublisher()

Output only. The resource name of the child publisher in the MCM relationship. Format: "networks/{network_code}/childPublishers/{child_publisher_id}"

optional string child_publisher = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the childPublisher field is set.

hasDeductions()

public boolean hasDeductions()

Output only. The deductions for the month due to spam in micro units. Null for earnings prior to August 2020.

optional .google.type.Money deductions = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deductions field is set.

hasDelegationType()

public boolean hasDelegationType()

Output only. The current type of MCM delegation between the parent and child publisher.

optional .google.ads.admanager.v1.DelegationTypeEnum.DelegationType delegation_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the delegationType field is set.

hasMonth()

public boolean hasMonth()

Output only. The year and month that the MCM earnings data applies to. The date will be specified as the first of the month.

optional .google.type.Date month = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the month field is set.

hasParentDisplayName()

public boolean hasParentDisplayName()

Output only. The name of the parent publisher.

optional string parent_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the parentDisplayName field is set.

hasParentPayment()

public boolean hasParentPayment()

Output only. The portion of the total earnings paid to the parent publisher.

optional .google.type.Money parent_payment = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the parentPayment field is set.

hasTotalEarnings()

public boolean hasTotalEarnings()

Output only. The total earnings for the month.

optional .google.type.Money total_earnings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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