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

Represents an EarningsProductBreakdown.

Package

@google-ads/admanager

Constructors

(constructor)(properties)

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

Constructs a new EarningsProductBreakdown.

Parameter
Name Description
properties IEarningsProductBreakdown

Properties to set

Properties

childPayment

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

EarningsProductBreakdown childPayment.

deductions

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

EarningsProductBreakdown deductions.

parentPayment

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

EarningsProductBreakdown parentPayment.

productType

public productType?: (google.ads.admanager.v1.McmEarningsProductTypeEnum.McmEarningsProductType|keyof typeof google.ads.admanager.v1.McmEarningsProductTypeEnum.McmEarningsProductType|null);

EarningsProductBreakdown productType.

totalEarnings

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

EarningsProductBreakdown totalEarnings.

Methods

create(properties)

public static create(properties?: google.ads.admanager.v1.IEarningsProductBreakdown): google.ads.admanager.v1.EarningsProductBreakdown;

Creates a new EarningsProductBreakdown instance using the specified properties.

Parameter
Name Description
properties IEarningsProductBreakdown

Properties to set

Returns
Type Description
EarningsProductBreakdown

EarningsProductBreakdown instance

decode(reader, length)

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

Decodes an EarningsProductBreakdown 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
EarningsProductBreakdown

EarningsProductBreakdown

decodeDelimited(reader)

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

Decodes an EarningsProductBreakdown message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
EarningsProductBreakdown

EarningsProductBreakdown

encode(message, writer)

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

Encodes the specified EarningsProductBreakdown message. Does not implicitly messages.

Parameters
Name Description
message IEarningsProductBreakdown

EarningsProductBreakdown 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.IEarningsProductBreakdown, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEarningsProductBreakdown

EarningsProductBreakdown 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.EarningsProductBreakdown;

Creates an EarningsProductBreakdown 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
EarningsProductBreakdown

EarningsProductBreakdown

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EarningsProductBreakdown

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 EarningsProductBreakdown to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message EarningsProductBreakdown

EarningsProductBreakdown

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 an EarningsProductBreakdown 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