Google Ads Ad Manager V1 Client - Class McmEarnings (0.7.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class McmEarnings.

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

Generated from protobuf message google.ads.admanager.v1.McmEarnings

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ month`	`Google\Type\Date` Output only. The year and month that the MCM earnings data applies to. The date will be specified as the first of the month.
`↳ delegation_type`	`int` Output only. The current type of MCM delegation between the parent and child publisher.
`↳ parent`	`string` Output only. The parent publisher in the MCM relationship. Format: `networks/{network_code}`
`↳ parent_display_name`	`string` Output only. The name of the parent publisher.
`↳ child`	`string` Output only. The resource name of the `ChildPublisher`'s Ad Manager network in the MCM relationship. Format: `networks/{network_code}`
`↳ child_publisher`	`string` Output only. The resource name of the child publisher in the MCM relationship. Format: "networks/{network_code}/childPublishers/{child_publisher_id}"
`↳ child_display_name`	`string` Output only. The name of the child publisher in the MCM relationship.
`↳ total_earnings`	`Google\Type\Money` Output only. The total earnings for the month.
`↳ parent_payment`	`Google\Type\Money` Output only. The portion of the total earnings paid to the parent publisher.
`↳ child_payment`	`Google\Type\Money` Output only. The portion of the total earnings paid to the child publisher.
`↳ deductions`	`Google\Type\Money` Output only. The deductions for the month due to spam in micro units. Null for earnings prior to August 2020.
`↳ earnings_product_breakdown`	`array<EarningsProductBreakdown>` Output only. The product type breakdown of earnings for a given month between a parent and child publisher in MCM.

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.

Returns
Type	Description
`Google\Type\Date\|null`

hasMonth

clearMonth

setMonth

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

Parameter
Name	Description
`var`	`Google\Type\Date`

Returns
Type	Description
`$this`

getDelegationType

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

Returns
Type	Description
`int`

hasDelegationType

clearDelegationType

setDelegationType

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getParent

Output only. The parent publisher in the MCM relationship.

Format: networks/{network_code}

Returns
Type	Description
`string`

setParent

Output only. The parent publisher in the MCM relationship.

Format: networks/{network_code}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParentDisplayName

Output only. The name of the parent publisher.

Returns
Type	Description
`string`

hasParentDisplayName

clearParentDisplayName

setParentDisplayName

Output only. The name of the parent publisher.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getChild

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

Returns
Type	Description
`string`

setChild

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getChildPublisher

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

Returns
Type	Description
`string`

hasChildPublisher

clearChildPublisher

setChildPublisher

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getChildDisplayName

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

Returns
Type	Description
`string`

hasChildDisplayName

clearChildDisplayName

setChildDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTotalEarnings

Output only. The total earnings for the month.

Returns
Type	Description
`Google\Type\Money\|null`

hasTotalEarnings

clearTotalEarnings

setTotalEarnings