import {z} from 'zod' export type GetApiUserprofilesUserprofilesIdAdsArgs = {userprofilesId: string, active?: boolean | undefined, advertiserId?: unknown | undefined, archived?: boolean | undefined, audienceSegmentIds?: Array | undefined, campaignIds?: Array | undefined, compatibility?: ('DISPLAY' | 'DISPLAY_INTERSTITIAL' | 'APP' | 'APP_INTERSTITIAL' | 'IN_STREAM_VIDEO' | 'IN_STREAM_AUDIO') | undefined, creativeIds?: Array | undefined, creativeOptimizationConfigurationIds?: Array | undefined, dynamicClickTracker?: boolean | undefined, ids?: Array | undefined, landingPageIds?: Array | undefined, maxResults?: number | undefined, overriddenEventTagId?: unknown | undefined, pageToken?: string | undefined, placementIds?: Array | undefined, remarketingListIds?: Array | undefined, searchString?: string | undefined, sizeIds?: Array | undefined, sortField?: ('ID' | 'NAME') | undefined, sortOrder?: ('ASCENDING' | 'DESCENDING') | undefined, sslCompliant?: boolean | undefined, sslRequired?: boolean | undefined, type?: (Array<'AD_SERVING_STANDARD_AD' | 'AD_SERVING_DEFAULT_AD' | 'AD_SERVING_CLICK_TRACKER' | 'AD_SERVING_TRACKING' | 'AD_SERVING_BRAND_SAFE_AD'>) | undefined}; export type GetApiUserprofilesUserprofilesIdAdsOptions = {baseUrl?: string | undefined, Oauth2?: string | undefined, Oauth2c?: string | undefined, fetch?: typeof fetch | undefined}; export const dimensionValue = z.object({dimensionName: z.string().optional(), etag: z.string().optional(), id: z.string().optional(), kind: z.string().optional(), matchType: z.enum(["EXACT", "BEGINS_WITH", "CONTAINS", "WILDCARD_EXPRESSION"]).optional(), value: z.string().optional()}); export const clickThroughUrl = z.object({computedClickThroughUrl: z.string().optional(), customClickThroughUrl: z.string().optional(), defaultLandingPage: z.boolean().optional(), landingPageId: z.string().optional()}); export const clickThroughUrlSuffixProperties = z.object({clickThroughUrlSuffix: z.string().optional(), overrideInheritedSuffix: z.boolean().optional()}); export const contextualKeyword = z.object({keyword: z.string().optional()}); export const contextualKeywordTargeting = z.object({keywords: z.array(contextualKeyword).optional()}); export const lastModifiedInfo = z.object({time: z.string().optional()}); export const creativeGroupAssignment = z.object({creativeGroupId: z.string().optional(), creativeGroupNumber: z.enum(["CREATIVE_GROUP_ONE", "CREATIVE_GROUP_TWO"]).optional()}); export const companionClickThroughOverride = z.object({clickThroughUrl: clickThroughUrl.optional(), creativeId: z.string().optional()}); export const richMediaExitOverride = z.object({clickThroughUrl: clickThroughUrl.optional(), enabled: z.boolean().optional(), exitId: z.string().optional()}); export const creativeAssignment = z.object({active: z.boolean().optional(), applyEventTags: z.boolean().optional(), clickThroughUrl: clickThroughUrl.optional(), companionCreativeOverrides: z.array(companionClickThroughOverride).optional(), creativeGroupAssignments: z.array(creativeGroupAssignment).optional(), creativeId: z.string().optional(), creativeIdDimensionValue: dimensionValue.optional(), endTime: z.string().optional(), richMediaExitOverrides: z.array(richMediaExitOverride).optional(), sequence: z.number().int().optional(), sslCompliant: z.boolean().optional(), startTime: z.string().optional(), weight: z.number().int().optional()}); export const creativeRotation = z.object({creativeAssignments: z.array(creativeAssignment).optional(), creativeOptimizationConfigurationId: z.string().optional(), type: z.enum(["CREATIVE_ROTATION_TYPE_SEQUENTIAL", "CREATIVE_ROTATION_TYPE_RANDOM"]).optional(), weightCalculationStrategy: z.enum(["WEIGHT_STRATEGY_EQUAL", "WEIGHT_STRATEGY_CUSTOM", "WEIGHT_STRATEGY_HIGHEST_CTR", "WEIGHT_STRATEGY_OPTIMIZED"]).optional()}); export const dayPartTargeting = z.object({daysOfWeek: z.array(z.enum(["SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"])).optional(), hoursOfDay: z.array(z.number().int()).optional(), userLocalTime: z.boolean().optional()}); export const defaultClickThroughEventTagProperties = z.object({defaultClickThroughEventTagId: z.string().optional(), overrideInheritedEventTag: z.boolean().optional()}); export const frequencyCap = z.object({duration: z.string().optional(), impressions: z.string().optional()}); export const deliverySchedule = z.object({frequencyCap: frequencyCap.optional(), hardCutoff: z.boolean().optional(), impressionRatio: z.string().optional(), priority: z.enum(["AD_PRIORITY_01", "AD_PRIORITY_02", "AD_PRIORITY_03", "AD_PRIORITY_04", "AD_PRIORITY_05", "AD_PRIORITY_06", "AD_PRIORITY_07", "AD_PRIORITY_08", "AD_PRIORITY_09", "AD_PRIORITY_10", "AD_PRIORITY_11", "AD_PRIORITY_12", "AD_PRIORITY_13", "AD_PRIORITY_14", "AD_PRIORITY_15", "AD_PRIORITY_16"]).optional()}); export const eventTagOverride = z.object({enabled: z.boolean().optional(), id: z.string().optional()}); export const city = z.object({countryCode: z.string().optional(), countryDartId: z.string().optional(), dartId: z.string().optional(), kind: z.string().optional(), metroCode: z.string().optional(), metroDmaId: z.string().optional(), name: z.string().optional(), regionCode: z.string().optional(), regionDartId: z.string().optional()}); export const country = z.object({countryCode: z.string().optional(), dartId: z.string().optional(), kind: z.string().optional(), name: z.string().optional(), sslEnabled: z.boolean().optional(), tvDataProviders: z.array(z.enum(["INVALID_TV_DATA_PROVIDER", "INTAGE_JP", "IBOPE_AR", "IBOPE_BR", "IBOPE_CL", "IBOPE_CO", "TNS_VN", "COMSCORE_NATIONAL_US", "COMSCORE_CA", "SAMBA_AU"])).optional()}); export const metro = z.object({countryCode: z.string().optional(), countryDartId: z.string().optional(), dartId: z.string().optional(), dmaId: z.string().optional(), kind: z.string().optional(), metroCode: z.string().optional(), name: z.string().optional()}); export const postalCode = z.object({code: z.string().optional(), countryCode: z.string().optional(), countryDartId: z.string().optional(), id: z.string().optional(), kind: z.string().optional()}); export const region = z.object({countryCode: z.string().optional(), countryDartId: z.string().optional(), dartId: z.string().optional(), kind: z.string().optional(), name: z.string().optional(), regionCode: z.string().optional()}); export const geoTargeting = z.object({cities: z.array(city).optional(), countries: z.array(country).optional(), excludeCountries: z.boolean().optional(), metros: z.array(metro).optional(), postalCodes: z.array(postalCode).optional(), regions: z.array(region).optional()}); export const keyValueTargetingExpression = z.object({expression: z.string().optional()}); export const language = z.object({id: z.string().optional(), kind: z.string().optional(), languageCode: z.string().optional(), name: z.string().optional()}); export const languageTargeting = z.object({languages: z.array(language).optional()}); export const placementAssignment = z.object({active: z.boolean().optional(), placementId: z.string().optional(), placementIdDimensionValue: dimensionValue.optional(), sslRequired: z.boolean().optional()}); export const listTargetingExpression = z.object({expression: z.string().optional()}); export const size = z.object({height: z.number().int().optional(), iab: z.boolean().optional(), id: z.string().optional(), kind: z.string().optional(), width: z.number().int().optional()}); export const browser = z.object({browserVersionId: z.string().optional(), dartId: z.string().optional(), kind: z.string().optional(), majorVersion: z.string().optional(), minorVersion: z.string().optional(), name: z.string().optional()}); export const connectionType = z.object({id: z.string().optional(), kind: z.string().optional(), name: z.string().optional()}); export const mobileCarrier = z.object({countryCode: z.string().optional(), countryDartId: z.string().optional(), id: z.string().optional(), kind: z.string().optional(), name: z.string().optional()}); export const operatingSystem = z.object({dartId: z.string().optional(), desktop: z.boolean().optional(), kind: z.string().optional(), mobile: z.boolean().optional(), name: z.string().optional()}); export const operatingSystemVersion = z.object({id: z.string().optional(), kind: z.string().optional(), majorVersion: z.string().optional(), minorVersion: z.string().optional(), name: z.string().optional(), operatingSystem: operatingSystem.optional()}); export const platformType = z.object({id: z.string().optional(), kind: z.string().optional(), name: z.string().optional()}); export const technologyTargeting = z.object({browsers: z.array(browser).optional(), connectionTypes: z.array(connectionType).optional(), mobileCarriers: z.array(mobileCarrier).optional(), operatingSystemVersions: z.array(operatingSystemVersion).optional(), operatingSystems: z.array(operatingSystem).optional(), platformTypes: z.array(platformType).optional()}); export const ad = z.object({accountId: z.string().optional(), active: z.boolean().optional(), advertiserId: z.string().optional(), advertiserIdDimensionValue: dimensionValue.optional(), archived: z.boolean().optional(), audienceSegmentId: z.string().optional(), campaignId: z.string().optional(), campaignIdDimensionValue: dimensionValue.optional(), clickThroughUrl: clickThroughUrl.optional(), clickThroughUrlSuffixProperties: clickThroughUrlSuffixProperties.optional(), comments: z.string().optional(), compatibility: z.enum(["DISPLAY", "DISPLAY_INTERSTITIAL", "APP", "APP_INTERSTITIAL", "IN_STREAM_VIDEO", "IN_STREAM_AUDIO"]).optional(), contextualKeywordTargeting: contextualKeywordTargeting.optional(), createInfo: lastModifiedInfo.optional(), creativeGroupAssignments: z.array(creativeGroupAssignment).optional(), creativeRotation: creativeRotation.optional(), dayPartTargeting: dayPartTargeting.optional(), defaultClickThroughEventTagProperties: defaultClickThroughEventTagProperties.optional(), deliverySchedule: deliverySchedule.optional(), dynamicClickTracker: z.boolean().optional(), endTime: z.string().optional(), eventTagOverrides: z.array(eventTagOverride).optional(), geoTargeting: geoTargeting.optional(), id: z.string().optional(), idDimensionValue: dimensionValue.optional(), keyValueTargetingExpression: keyValueTargetingExpression.optional(), kind: z.string().optional(), languageTargeting: languageTargeting.optional(), lastModifiedInfo: lastModifiedInfo.optional(), name: z.string().optional(), placementAssignments: z.array(placementAssignment).optional(), remarketingListExpression: listTargetingExpression.optional(), size: size.optional(), sslCompliant: z.boolean().optional(), sslRequired: z.boolean().optional(), startTime: z.string().optional(), subaccountId: z.string().optional(), targetingTemplateId: z.string().optional(), technologyTargeting: technologyTargeting.optional(), type: z.enum(["AD_SERVING_STANDARD_AD", "AD_SERVING_DEFAULT_AD", "AD_SERVING_CLICK_TRACKER", "AD_SERVING_TRACKING", "AD_SERVING_BRAND_SAFE_AD"]).optional()}); export const adsListResponse = z.object({ads: z.array(ad).optional(), kind: z.string().optional(), nextPageToken: z.string().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 }; /** * Retrieves a list of ads, possibly filtered. This method supports paging. * * GET /userprofiles/{userprofilesId}/ads */ export const getApiUserprofilesUserprofilesIdAds = async (args: GetApiUserprofilesUserprofilesIdAdsArgs, options?: GetApiUserprofilesUserprofilesIdAdsOptions) => { const {baseUrl = "https://dfareporting.googleapis.com/dfareporting/v5", fetch: fetchFn = fetch, Oauth2, Oauth2c} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.active != null) query.append("active", String(args.active)) if (args.advertiserId != null) query.append("advertiserId", String(args.advertiserId)) if (args.archived != null) query.append("archived", String(args.archived)) for (const item of args.audienceSegmentIds ?? []) query.append("audienceSegmentIds", String(item)) for (const item of args.campaignIds ?? []) query.append("campaignIds", String(item)) if (args.compatibility != null) query.append("compatibility", String(args.compatibility)) for (const item of args.creativeIds ?? []) query.append("creativeIds", String(item)) for (const item of args.creativeOptimizationConfigurationIds ?? []) query.append("creativeOptimizationConfigurationIds", String(item)) if (args.dynamicClickTracker != null) query.append("dynamicClickTracker", String(args.dynamicClickTracker)) for (const item of args.ids ?? []) query.append("ids", String(item)) for (const item of args.landingPageIds ?? []) query.append("landingPageIds", String(item)) if (args.maxResults != null) query.append("maxResults", String(args.maxResults)) if (args.overriddenEventTagId != null) query.append("overriddenEventTagId", String(args.overriddenEventTagId)) if (args.pageToken != null) query.append("pageToken", String(args.pageToken)) for (const item of args.placementIds ?? []) query.append("placementIds", String(item)) for (const item of args.remarketingListIds ?? []) query.append("remarketingListIds", String(item)) if (args.searchString != null) query.append("searchString", String(args.searchString)) for (const item of args.sizeIds ?? []) query.append("sizeIds", String(item)) if (args.sortField != null) query.append("sortField", String(args.sortField)) if (args.sortOrder != null) query.append("sortOrder", String(args.sortOrder)) if (args.sslCompliant != null) query.append("sslCompliant", String(args.sslCompliant)) if (args.sslRequired != null) query.append("sslRequired", String(args.sslRequired)) for (const item of args.type ?? []) query.append("type", String(item)) if (Oauth2 !== undefined) headers.set('authorization', `Bearer ${Oauth2}`) if (Oauth2c !== undefined) headers.set('authorization', `Bearer ${Oauth2c}`) const url = `${baseUrl.replace(/\/+$/, '')}/userprofiles/${encodeURIComponent(String(args.userprofilesId))}/ads${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(adsListResponse, await res.json()) };