0.16.0 (latest) 0.15.1 0.14.1 0.8.0 0.7.0 0.6.2 0.5.0 0.4.1 0.3.1 0.2.0 0.1.3 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` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Date.html` 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` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` Output only. The total earnings for the month. |
| `↳ parent_payment` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` Output only. The portion of the total earnings paid to the parent publisher. |
| `↳ child_payment` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` Output only. The portion of the total earnings paid to the child publisher. |
| `↳ deductions` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` Output only. The deductions for the month due to spam in micro units. Null for earnings prior to August 2020. |
| `↳ earnings_product_breakdown` | `array<https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.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** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Date.html|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` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Date.html` |

| **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** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html|null` |   |

### hasTotalEarnings

### clearTotalEarnings

### setTotalEarnings

Output only. The total earnings for the month.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getParentPayment

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html|null` |   |

### hasParentPayment

### clearParentPayment

### setParentPayment

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getChildPayment

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html|null` |   |

### hasChildPayment

### clearChildPayment

### setChildPayment

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDeductions

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html|null` |   |

### hasDeductions

### clearDeductions

### setDeductions

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Type.Money.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEarningsProductBreakdown

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\RepeatedField<https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.EarningsProductBreakdown>` |   |

### setEarningsProductBreakdown

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/ad-manager/latest/V1.EarningsProductBreakdown>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |