import {z} from 'zod' export type DimensionValue = {dimensionName?: string | undefined, etag?: string | undefined, id?: string | undefined, kind?: string | undefined, matchType?: ('EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION') | undefined, value?: string | undefined}; export type Activities = {filters?: Array | undefined, kind?: string | undefined, metricNames?: Array | undefined}; export type CustomRichMediaEvents = {filteredEventIds?: Array | undefined, kind?: string | undefined}; export type DateRange = {endDate?: string | undefined, kind?: string | undefined, relativeDateRange?: ('TODAY' | 'YESTERDAY' | 'WEEK_TO_DATE' | 'MONTH_TO_DATE' | 'QUARTER_TO_DATE' | 'YEAR_TO_DATE' | 'PREVIOUS_WEEK' | 'PREVIOUS_MONTH' | 'PREVIOUS_QUARTER' | 'PREVIOUS_YEAR' | 'LAST_7_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'LAST_365_DAYS' | 'LAST_24_MONTHS' | 'LAST_14_DAYS' | 'LAST_60_DAYS') | undefined, startDate?: string | undefined}; export type SortedDimension = {kind?: string | undefined, name?: string | undefined, sortOrder?: ('ASCENDING' | 'DESCENDING') | undefined}; export type Recipient = {deliveryType?: ('LINK' | 'ATTACHMENT') | undefined, email?: string | undefined, kind?: string | undefined}; export type Report = {accountId?: unknown | undefined, criteria?: ({activities?: Activities | undefined, customRichMediaEvents?: CustomRichMediaEvents | undefined, dateRange?: DateRange | undefined, dimensionFilters?: Array | undefined, dimensions?: Array | undefined, metricNames?: Array | undefined}) | undefined, crossMediaReachCriteria?: ({dateRange?: DateRange | undefined, dimensionFilters?: Array | undefined, dimensions?: Array | undefined, metricNames?: Array | undefined}) | undefined, delivery?: ({emailOwner?: boolean | undefined, emailOwnerDeliveryType?: ('LINK' | 'ATTACHMENT') | undefined, message?: string | undefined, recipients?: Array | undefined}) | undefined, etag?: string | undefined, fileName?: string | undefined, floodlightCriteria?: ({customRichMediaEvents?: Array | undefined, dateRange?: DateRange | undefined, dimensionFilters?: Array | undefined, dimensions?: Array | undefined, floodlightConfigId?: DimensionValue | undefined, metricNames?: Array | undefined, reportProperties?: ({includeAttributedIPConversions?: boolean | undefined, includeUnattributedCookieConversions?: boolean | undefined, includeUnattributedIPConversions?: boolean | undefined}) | undefined}) | undefined, format?: ('CSV' | 'EXCEL') | undefined, id?: unknown | undefined, kind?: string | undefined, lastModifiedTime?: unknown | undefined, name?: string | undefined, ownerProfileId?: unknown | undefined, pathToConversionCriteria?: ({activityFilters?: Array | undefined, conversionDimensions?: Array | undefined, customFloodlightVariables?: Array | undefined, customRichMediaEvents?: Array | undefined, dateRange?: DateRange | undefined, floodlightConfigId?: DimensionValue | undefined, metricNames?: Array | undefined, perInteractionDimensions?: Array | undefined, reportProperties?: ({clicksLookbackWindow?: number | undefined, impressionsLookbackWindow?: number | undefined, includeAttributedIPConversions?: boolean | undefined, includeUnattributedCookieConversions?: boolean | undefined, includeUnattributedIPConversions?: boolean | undefined, maximumClickInteractions?: number | undefined, maximumImpressionInteractions?: number | undefined, maximumInteractionGap?: number | undefined, pivotOnInteractionPath?: boolean | undefined}) | undefined}) | undefined, reachCriteria?: ({activities?: Activities | undefined, customRichMediaEvents?: CustomRichMediaEvents | undefined, dateRange?: DateRange | undefined, dimensionFilters?: Array | undefined, dimensions?: Array | undefined, metricNames?: Array | undefined, reachByFrequencyMetricNames?: Array | undefined}) | undefined, schedule?: ({active?: boolean | undefined, every?: number | undefined, expirationDate?: string | undefined, repeats?: string | undefined, repeatsOnWeekDays?: (Array<'SUNDAY' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY'>) | undefined, runsOnDayOfMonth?: ('DAY_OF_MONTH' | 'WEEK_OF_MONTH') | undefined, startDate?: string | undefined, timezone?: string | undefined}) | undefined, subAccountId?: unknown | undefined, type?: ('STANDARD' | 'REACH' | 'PATH_TO_CONVERSION' | 'FLOODLIGHT' | 'CROSS_MEDIA_REACH') | undefined}; export type CreateApiUserprofilesProfileIdReportsCompatiblefieldsQueryArgs = {profileId: unknown, body: Report}; export type CreateApiUserprofilesProfileIdReportsCompatiblefieldsQueryOptions = {baseUrl?: string | undefined, Oauth2?: string | undefined, Oauth2c?: string | undefined, fetch?: typeof fetch | undefined}; export const dimension = z.object({kind: z.string().optional(), name: z.string().optional()}); export const metric = z.object({kind: z.string().optional(), name: z.string().optional()}); export const crossDimensionReachReportCompatibleFields = z.object({breakdown: z.array(dimension).optional(), dimensionFilters: z.array(dimension).optional(), kind: z.string().optional(), metrics: z.array(metric).optional(), overlapMetrics: z.array(metric).optional()}); export const crossMediaReachReportCompatibleFields = z.object({dimensionFilters: z.array(dimension).optional(), dimensions: z.array(dimension).optional(), kind: z.string().optional(), metrics: z.array(metric).optional()}); export const floodlightReportCompatibleFields = z.object({dimensionFilters: z.array(dimension).optional(), dimensions: z.array(dimension).optional(), kind: z.string().optional(), metrics: z.array(metric).optional()}); export const pathToConversionReportCompatibleFields = z.object({conversionDimensions: z.array(dimension).optional(), customFloodlightVariables: z.array(dimension).optional(), kind: z.string().optional(), metrics: z.array(metric).optional(), perInteractionDimensions: z.array(dimension).optional()}); export const reachReportCompatibleFields = z.object({dimensionFilters: z.array(dimension).optional(), dimensions: z.array(dimension).optional(), kind: z.string().optional(), metrics: z.array(metric).optional(), pivotedActivityMetrics: z.array(metric).optional(), reachByFrequencyMetrics: z.array(metric).optional()}); export const reportCompatibleFields = z.object({dimensionFilters: z.array(dimension).optional(), dimensions: z.array(dimension).optional(), kind: z.string().optional(), metrics: z.array(metric).optional(), pivotedActivityMetrics: z.array(metric).optional()}); export const compatibleFields = z.object({crossDimensionReachReportCompatibleFields: crossDimensionReachReportCompatibleFields.optional(), crossMediaReachReportCompatibleFields: crossMediaReachReportCompatibleFields.optional(), floodlightReportCompatibleFields: floodlightReportCompatibleFields.optional(), kind: z.string().optional(), pathToConversionReportCompatibleFields: pathToConversionReportCompatibleFields.optional(), reachReportCompatibleFields: reachReportCompatibleFields.optional(), reportCompatibleFields: reportCompatibleFields.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. * * POST /userprofiles/{profileId}/reports/compatiblefields/query */ export const createApiUserprofilesProfileIdReportsCompatiblefieldsQuery = async (args: CreateApiUserprofilesProfileIdReportsCompatiblefieldsQueryArgs, options?: CreateApiUserprofilesProfileIdReportsCompatiblefieldsQueryOptions) => { const {baseUrl = "https://dfareporting.googleapis.com/dfareporting/v5", fetch: fetchFn = fetch, Oauth2, Oauth2c} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (Oauth2 !== undefined) headers.set('authorization', `Bearer ${Oauth2}`) if (Oauth2c !== undefined) headers.set('authorization', `Bearer ${Oauth2c}`) const url = `${baseUrl.replace(/\/+$/, '')}/userprofiles/${encodeURIComponent(String(args.profileId))}/reports/compatiblefields/query${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(compatibleFields, await res.json()) };