AccountsReportsGenerateCsvOptions

import type { AccountsReportsGenerateCsvOptions } from "https://googleapis.deno.dev/v1/adsense:v2.ts";

Additional options for AdSense#accountsReportsGenerateCsv.

interface AccountsReportsGenerateCsvOptions {

currencyCode?: string;

dateRange?:

| "REPORTING_DATE_RANGE_UNSPECIFIED"

| "CUSTOM"

| "TODAY"

| "YESTERDAY"

| "MONTH_TO_DATE"

| "YEAR_TO_DATE"

| "LAST_7_DAYS"

| "LAST_30_DAYS";

dimensions?:

| "DIMENSION_UNSPECIFIED"

| "DATE"

| "WEEK"

| "MONTH"

| "ACCOUNT_NAME"

| "AD_CLIENT_ID"

| "HOSTED_AD_CLIENT_ID"

| "PRODUCT_NAME"

| "PRODUCT_CODE"

| "AD_UNIT_NAME"

| "AD_UNIT_ID"

| "AD_UNIT_SIZE_NAME"

| "AD_UNIT_SIZE_CODE"

| "CUSTOM_CHANNEL_NAME"

| "CUSTOM_CHANNEL_ID"

| "OWNED_SITE_DOMAIN_NAME"

| "OWNED_SITE_ID"

| "PAGE_URL"

| "URL_CHANNEL_NAME"

| "URL_CHANNEL_ID"

| "BUYER_NETWORK_NAME"

| "BUYER_NETWORK_ID"

| "BID_TYPE_NAME"

| "BID_TYPE_CODE"

| "CREATIVE_SIZE_NAME"

| "CREATIVE_SIZE_CODE"

| "DOMAIN_NAME"

| "DOMAIN_CODE"

| "COUNTRY_NAME"

| "COUNTRY_CODE"

| "PLATFORM_TYPE_NAME"

| "PLATFORM_TYPE_CODE"

| "TARGETING_TYPE_NAME"

| "TARGETING_TYPE_CODE"

| "CONTENT_PLATFORM_NAME"

| "CONTENT_PLATFORM_CODE"

| "AD_PLACEMENT_NAME"

| "AD_PLACEMENT_CODE"

| "REQUESTED_AD_TYPE_NAME"

| "REQUESTED_AD_TYPE_CODE"

| "SERVED_AD_TYPE_NAME"

| "SERVED_AD_TYPE_CODE"

| "AD_FORMAT_NAME"

| "AD_FORMAT_CODE"

| "CUSTOM_SEARCH_STYLE_NAME"

| "CUSTOM_SEARCH_STYLE_ID"

| "DOMAIN_REGISTRANT"

| "WEBSEARCH_QUERY_STRING";

[endDate.day]?: number;

[endDate.month]?: number;

[endDate.year]?: number;

filters?: string;

languageCode?: string;

limit?: number;

metrics?:

| "METRIC_UNSPECIFIED"

| "PAGE_VIEWS"

| "AD_REQUESTS"

| "MATCHED_AD_REQUESTS"

| "TOTAL_IMPRESSIONS"

| "IMPRESSIONS"

| "INDIVIDUAL_AD_IMPRESSIONS"

| "CLICKS"

| "PAGE_VIEWS_SPAM_RATIO"

| "AD_REQUESTS_SPAM_RATIO"

| "MATCHED_AD_REQUESTS_SPAM_RATIO"

| "IMPRESSIONS_SPAM_RATIO"

| "INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO"

| "CLICKS_SPAM_RATIO"

| "AD_REQUESTS_COVERAGE"

| "PAGE_VIEWS_CTR"

| "AD_REQUESTS_CTR"

| "MATCHED_AD_REQUESTS_CTR"

| "IMPRESSIONS_CTR"

| "INDIVIDUAL_AD_IMPRESSIONS_CTR"

| "ACTIVE_VIEW_MEASURABILITY"

| "ACTIVE_VIEW_VIEWABILITY"

| "ACTIVE_VIEW_TIME"

| "ESTIMATED_EARNINGS"

| "PAGE_VIEWS_RPM"

| "AD_REQUESTS_RPM"

| "MATCHED_AD_REQUESTS_RPM"

| "IMPRESSIONS_RPM"

| "INDIVIDUAL_AD_IMPRESSIONS_RPM"

| "COST_PER_CLICK"

| "ADS_PER_IMPRESSION"

| "TOTAL_EARNINGS"

| "WEBSEARCH_RESULT_PAGES"

| "FUNNEL_REQUESTS"

| "FUNNEL_IMPRESSIONS"

| "FUNNEL_CLICKS"

| "FUNNEL_RPM";

orderBy?: string;

reportingTimeZone?: "REPORTING_TIME_ZONE_UNSPECIFIED" | "ACCOUNT_TIME_ZONE" | "GOOGLE_TIME_ZONE";

[startDate.day]?: number;

[startDate.month]?: number;

[startDate.year]?: number;

}

§Properties

currencyCode?: string

[src]

The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.

[src]

Date range of the report, if unset the range will be considered CUSTOM.

[src]

Dimensions to base the report on.

[endDate.day]?: number

[src]

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

[endDate.month]?: number

[src]

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

[endDate.year]?: number

[src]

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

filters?: string

[src]

A list of filters to apply to the report. All provided filters must match in order for the data to be included in the report.

languageCode?: string

[src]

The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.

limit?: number

[src]

The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports.GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.

[src]

Required. Reporting metrics.

orderBy?: string

[src]

The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

reportingTimeZone?: "REPORTING_TIME_ZONE_UNSPECIFIED" | "ACCOUNT_TIME_ZONE" | "GOOGLE_TIME_ZONE"

[src]

Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.

[startDate.day]?: number

[src]

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

[startDate.month]?: number

[src]

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

[startDate.year]?: number

[src]

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.