Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Report

import type { Report } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

Represents a Report resource.

interface Report {
accountId?: bigint;
criteria?: {
activities?: Activities;
customRichMediaEvents?: CustomRichMediaEvents;
dateRange?: DateRange;
dimensionFilters?: DimensionValue[];
dimensions?: SortedDimension[];
metricNames?: string[];
};
crossDimensionReachCriteria?: {
breakdown?: SortedDimension[];
dateRange?: DateRange;
dimension?:
| "ADVERTISER"
| "CAMPAIGN"
| "SITE_BY_ADVERTISER"
| "SITE_BY_CAMPAIGN";
dimensionFilters?: DimensionValue[];
metricNames?: string[];
overlapMetricNames?: string[];
pivoted?: boolean;
};
delivery?: {
emailOwner?: boolean;
emailOwnerDeliveryType?: "LINK" | "ATTACHMENT";
message?: string;
recipients?: Recipient[];
};
etag?: string;
fileName?: string;
floodlightCriteria?: {
customRichMediaEvents?: DimensionValue[];
dateRange?: DateRange;
dimensionFilters?: DimensionValue[];
dimensions?: SortedDimension[];
floodlightConfigId?: DimensionValue;
metricNames?: string[];
reportProperties?: {
includeAttributedIPConversions?: boolean;
includeUnattributedCookieConversions?: boolean;
includeUnattributedIPConversions?: boolean;
};
};
format?: "CSV" | "EXCEL";
id?: bigint;
kind?: string;
lastModifiedTime?: bigint;
name?: string;
ownerProfileId?: bigint;
pathAttributionCriteria?: {
activityFilters?: DimensionValue[];
customChannelGrouping?: ChannelGrouping;
dateRange?: DateRange;
dimensions?: SortedDimension[];
floodlightConfigId?: DimensionValue;
metricNames?: string[];
pathFilters?: PathFilter[];
};
pathCriteria?: {
activityFilters?: DimensionValue[];
customChannelGrouping?: ChannelGrouping;
dateRange?: DateRange;
dimensions?: SortedDimension[];
floodlightConfigId?: DimensionValue;
metricNames?: string[];
pathFilters?: PathFilter[];
};
pathToConversionCriteria?: {
activityFilters?: DimensionValue[];
conversionDimensions?: SortedDimension[];
customFloodlightVariables?: SortedDimension[];
customRichMediaEvents?: DimensionValue[];
dateRange?: DateRange;
floodlightConfigId?: DimensionValue;
metricNames?: string[];
perInteractionDimensions?: SortedDimension[];
reportProperties?: {
clicksLookbackWindow?: number;
impressionsLookbackWindow?: number;
includeAttributedIPConversions?: boolean;
includeUnattributedCookieConversions?: boolean;
includeUnattributedIPConversions?: boolean;
maximumClickInteractions?: number;
maximumImpressionInteractions?: number;
maximumInteractionGap?: number;
pivotOnInteractionPath?: boolean;
};
};
reachCriteria?: {
activities?: Activities;
customRichMediaEvents?: CustomRichMediaEvents;
dateRange?: DateRange;
dimensionFilters?: DimensionValue[];
dimensions?: SortedDimension[];
enableAllDimensionCombinations?: boolean;
metricNames?: string[];
reachByFrequencyMetricNames?: string[];
};
schedule?: {
active?: boolean;
every?: number;
expirationDate?: Date;
repeats?: string;
repeatsOnWeekDays?:
| "SUNDAY"
| "MONDAY"
| "TUESDAY"
| "WEDNESDAY"
| "THURSDAY"
| "FRIDAY"
| "SATURDAY"[];
runsOnDayOfMonth?: "DAY_OF_MONTH" | "WEEK_OF_MONTH";
startDate?: Date;
timezone?: string;
};
subAccountId?: bigint;
type?:
| "STANDARD"
| "REACH"
| "PATH_TO_CONVERSION"
| "CROSS_DIMENSION_REACH"
| "FLOODLIGHT"
| "PATH"
| "PATH_ATTRIBUTION";
}

§Properties

§
accountId?: bigint
[src]

The account ID to which this report belongs.

§
criteria?: {
activities?: Activities;
customRichMediaEvents?: CustomRichMediaEvents;
dateRange?: DateRange;
dimensionFilters?: DimensionValue[];
dimensions?: SortedDimension[];
metricNames?: string[];
}
[src]

The report criteria for a report of type "STANDARD".

§
crossDimensionReachCriteria?: {
breakdown?: SortedDimension[];
dateRange?: DateRange;
dimension?:
| "ADVERTISER"
| "CAMPAIGN"
| "SITE_BY_ADVERTISER"
| "SITE_BY_CAMPAIGN";
dimensionFilters?: DimensionValue[];
metricNames?: string[];
overlapMetricNames?: string[];
pivoted?: boolean;
}
[src]

The report criteria for a report of type "CROSS_DIMENSION_REACH".

§
delivery?: {
emailOwner?: boolean;
emailOwnerDeliveryType?: "LINK" | "ATTACHMENT";
message?: string;
recipients?: Recipient[];
}
[src]

The report's email delivery settings.

§
etag?: string
[src]

The eTag of this response for caching purposes.

§
fileName?: string
[src]

The filename used when generating report files for this report.

§
floodlightCriteria?: {
customRichMediaEvents?: DimensionValue[];
dateRange?: DateRange;
dimensionFilters?: DimensionValue[];
dimensions?: SortedDimension[];
floodlightConfigId?: DimensionValue;
metricNames?: string[];
reportProperties?: {
includeAttributedIPConversions?: boolean;
includeUnattributedCookieConversions?: boolean;
includeUnattributedIPConversions?: boolean;
};
}
[src]

The report criteria for a report of type "FLOODLIGHT".

§
format?: "CSV" | "EXCEL"
[src]

The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.

§
id?: bigint
[src]

The unique ID identifying this report resource.

§
kind?: string
[src]

The kind of resource this is, in this case dfareporting#report.

§
lastModifiedTime?: bigint
[src]

The timestamp (in milliseconds since epoch) of when this report was last modified.

§
name?: string
[src]

The name of the report.

§
ownerProfileId?: bigint
[src]

The user profile id of the owner of this report.

§
pathAttributionCriteria?: {
activityFilters?: DimensionValue[];
customChannelGrouping?: ChannelGrouping;
dateRange?: DateRange;
dimensions?: SortedDimension[];
floodlightConfigId?: DimensionValue;
metricNames?: string[];
pathFilters?: PathFilter[];
}
[src]

The report criteria for a report of type "PATH_ATTRIBUTION".

§
pathCriteria?: {
activityFilters?: DimensionValue[];
customChannelGrouping?: ChannelGrouping;
dateRange?: DateRange;
dimensions?: SortedDimension[];
floodlightConfigId?: DimensionValue;
metricNames?: string[];
pathFilters?: PathFilter[];
}
[src]

The report criteria for a report of type "PATH".

§
pathToConversionCriteria?: {
activityFilters?: DimensionValue[];
conversionDimensions?: SortedDimension[];
customFloodlightVariables?: SortedDimension[];
customRichMediaEvents?: DimensionValue[];
dateRange?: DateRange;
floodlightConfigId?: DimensionValue;
metricNames?: string[];
perInteractionDimensions?: SortedDimension[];
reportProperties?: {
clicksLookbackWindow?: number;
impressionsLookbackWindow?: number;
includeAttributedIPConversions?: boolean;
includeUnattributedCookieConversions?: boolean;
includeUnattributedIPConversions?: boolean;
maximumClickInteractions?: number;
maximumImpressionInteractions?: number;
maximumInteractionGap?: number;
pivotOnInteractionPath?: boolean;
};
}
[src]

The report criteria for a report of type "PATH_TO_CONVERSION".

§
reachCriteria?: {
activities?: Activities;
customRichMediaEvents?: CustomRichMediaEvents;
dateRange?: DateRange;
dimensionFilters?: DimensionValue[];
dimensions?: SortedDimension[];
enableAllDimensionCombinations?: boolean;
metricNames?: string[];
reachByFrequencyMetricNames?: string[];
}
[src]

The report criteria for a report of type "REACH".

§
schedule?: {
active?: boolean;
every?: number;
expirationDate?: Date;
repeats?: string;
repeatsOnWeekDays?:
| "SUNDAY"
| "MONDAY"
| "TUESDAY"
| "WEDNESDAY"
| "THURSDAY"
| "FRIDAY"
| "SATURDAY"[];
runsOnDayOfMonth?: "DAY_OF_MONTH" | "WEEK_OF_MONTH";
startDate?: Date;
timezone?: string;
}
[src]

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

§
subAccountId?: bigint
[src]

The subaccount ID to which this report belongs if applicable.

§
type?: "STANDARD" | "REACH" | "PATH_TO_CONVERSION" | "CROSS_DIMENSION_REACH" | "FLOODLIGHT" | "PATH" | "PATH_ATTRIBUTION"
[src]

The type of the report.