Represents a ReportDefinition.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.IReportDefinition);Constructs a new ReportDefinition.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReportDefinition
Properties to set |
Properties
_comparisonDateRange
public _comparisonDateRange?: "comparisonDateRange";ReportDefinition _comparisonDateRange.
comparisonDateRange
public comparisonDateRange?: (google.ads.admanager.v1.Report.IDateRange|null);ReportDefinition comparisonDateRange.
creativeCustomFieldIds
public creativeCustomFieldIds: (number|Long|string)[];ReportDefinition creativeCustomFieldIds.
currencyCode
public currencyCode: string;ReportDefinition currencyCode.
customDimensionKeyIds
public customDimensionKeyIds: (number|Long|string)[];ReportDefinition customDimensionKeyIds.
dateRange
public dateRange?: (google.ads.admanager.v1.Report.IDateRange|null);ReportDefinition dateRange.
dimensions
public dimensions: google.ads.admanager.v1.Report.Dimension[];ReportDefinition dimensions.
filters
public filters: google.ads.admanager.v1.Report.IFilter[];ReportDefinition filters.
flags
public flags: google.ads.admanager.v1.Report.IFlag[];ReportDefinition flags.
lineItemCustomFieldIds
public lineItemCustomFieldIds: (number|Long|string)[];ReportDefinition lineItemCustomFieldIds.
metrics
public metrics: google.ads.admanager.v1.Report.Metric[];ReportDefinition metrics.
orderCustomFieldIds
public orderCustomFieldIds: (number|Long|string)[];ReportDefinition orderCustomFieldIds.
reportType
public reportType: (google.ads.admanager.v1.Report.ReportType|keyof typeof google.ads.admanager.v1.Report.ReportType);ReportDefinition reportType.
sorts
public sorts: google.ads.admanager.v1.Report.ISort[];ReportDefinition sorts.
timePeriodColumn
public timePeriodColumn: (google.ads.admanager.v1.Report.TimePeriodColumn|keyof typeof google.ads.admanager.v1.Report.TimePeriodColumn);ReportDefinition timePeriodColumn.
timeZone
public timeZone: string;ReportDefinition timeZone.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.IReportDefinition): google.ads.admanager.v1.ReportDefinition;Creates a new ReportDefinition instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReportDefinition
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
ReportDefinition instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.ReportDefinition;Decodes a ReportDefinition 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 |
ReportDefinition |
ReportDefinition |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.ReportDefinition;Decodes a ReportDefinition message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ReportDefinition |
ReportDefinition |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.IReportDefinition, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ReportDefinition message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReportDefinition
ReportDefinition 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.IReportDefinition, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ReportDefinition message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReportDefinition
ReportDefinition 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.ReportDefinition;Creates a ReportDefinition 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 |
ReportDefinition |
ReportDefinition |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ReportDefinition
| 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 ReportDefinition to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.ReportDefinition, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ReportDefinition message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ReportDefinition
ReportDefinition |
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 ReportDefinition message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|