Interface McmEarningsOrBuilder (0.52.0)

0.52.0 (latest) 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface McmEarningsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChild()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDelegationType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getTotalEarnings()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.