Class protos.google.ads.admanager.v1.McmEarnings (0.6.0)

Represents a McmEarnings.

Package

@google-ads/admanager

Constructors

(constructor)(properties)

constructor(properties?: google.ads.admanager.v1.IMcmEarnings);

Constructs a new McmEarnings.

Parameter
Name Description
properties IMcmEarnings

Properties to set

Properties

child

public child: string;

McmEarnings child.

childDisplayName

public childDisplayName?: (string|null);

McmEarnings childDisplayName.

childPayment

public childPayment?: (google.type.IMoney|null);

McmEarnings childPayment.

childPublisher

public childPublisher?: (string|null);

McmEarnings childPublisher.

deductions

public deductions?: (google.type.IMoney|null);

McmEarnings deductions.

delegationType

public delegationType?: (google.ads.admanager.v1.DelegationTypeEnum.DelegationType|keyof typeof google.ads.admanager.v1.DelegationTypeEnum.DelegationType|null);

McmEarnings delegationType.

earningsProductBreakdown

public earningsProductBreakdown: google.ads.admanager.v1.IEarningsProductBreakdown[];

McmEarnings earningsProductBreakdown.

month

public month?: (google.type.IDate|null);

McmEarnings month.

parent

public parent: string;

McmEarnings parent.

parentDisplayName

public parentDisplayName?: (string|null);

McmEarnings parentDisplayName.

parentPayment

public parentPayment?: (google.type.IMoney|null);

McmEarnings parentPayment.

totalEarnings

public totalEarnings?: (google.type.IMoney|null);

McmEarnings totalEarnings.

Methods

create(properties)

public static create(properties?: google.ads.admanager.v1.IMcmEarnings): google.ads.admanager.v1.McmEarnings;

Creates a new McmEarnings instance using the specified properties.

Parameter
Name Description
properties IMcmEarnings

Properties to set

Returns
Type Description
McmEarnings

McmEarnings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.McmEarnings;

Decodes a McmEarnings message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
McmEarnings

McmEarnings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.McmEarnings;

Decodes a McmEarnings message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
McmEarnings

McmEarnings

encode(message, writer)

public static encode(message: google.ads.admanager.v1.IMcmEarnings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified McmEarnings message. Does not implicitly messages.

Parameters
Name Description
message IMcmEarnings

McmEarnings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.ads.admanager.v1.IMcmEarnings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified McmEarnings message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IMcmEarnings

McmEarnings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.McmEarnings;

Creates a McmEarnings message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
McmEarnings

McmEarnings

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for McmEarnings

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this McmEarnings to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.ads.admanager.v1.McmEarnings, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a McmEarnings message. Also converts values to other types if specified.

Parameters
Name Description
message McmEarnings

McmEarnings

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a McmEarnings message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not