Represents a Report.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.IReport);Constructs a new Report.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReport
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Report createTime.
displayName
public displayName: string;Report displayName.
locale
public locale: string;Report locale.
name
public name: string;Report name.
reportDefinition
public reportDefinition?: (google.ads.admanager.v1.IReportDefinition|null);Report reportDefinition.
reportId
public reportId: (number|Long|string);Report reportId.
scheduleOptions
public scheduleOptions?: (google.ads.admanager.v1.IScheduleOptions|null);Report scheduleOptions.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Report updateTime.
visibility
public visibility: (google.ads.admanager.v1.Report.Visibility|keyof typeof google.ads.admanager.v1.Report.Visibility);Report visibility.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.IReport): google.ads.admanager.v1.Report;Creates a new Report instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReport
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Report |
Report instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.Report;Decodes a Report 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 |
Report |
Report |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.Report;Decodes a Report message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Report |
Report |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.IReport, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Report message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReport
Report 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.IReport, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Report message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReport
Report 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.Report;Creates a Report 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 |
Report |
Report |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Report
| 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 Report to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.Report, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Report message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Report
Report |
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 Report message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|