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 ClickThroughUrl = {computedClickThroughUrl?: string | undefined, customClickThroughUrl?: string | undefined, defaultLandingPage?: boolean | undefined, landingPageId?: unknown | undefined}; export type ClickThroughUrlSuffixProperties = {clickThroughUrlSuffix?: string | undefined, overrideInheritedSuffix?: boolean | undefined}; export type ContextualKeyword = {keyword?: string | undefined}; export type ContextualKeywordTargeting = {keywords?: Array | undefined}; export type LastModifiedInfo = {time?: unknown | undefined}; export type CreativeGroupAssignment = {creativeGroupId?: unknown | undefined, creativeGroupNumber?: ('CREATIVE_GROUP_ONE' | 'CREATIVE_GROUP_TWO') | undefined}; export type CompanionClickThroughOverride = {clickThroughUrl?: ClickThroughUrl | undefined, creativeId?: unknown | undefined}; export type RichMediaExitOverride = {clickThroughUrl?: ClickThroughUrl | undefined, enabled?: boolean | undefined, exitId?: unknown | undefined}; export type CreativeAssignment = {active?: boolean | undefined, applyEventTags?: boolean | undefined, clickThroughUrl?: ClickThroughUrl | undefined, companionCreativeOverrides?: Array | undefined, creativeGroupAssignments?: Array | undefined, creativeId?: unknown | undefined, creativeIdDimensionValue?: DimensionValue | undefined, endTime?: string | undefined, richMediaExitOverrides?: Array | undefined, sequence?: number | undefined, sslCompliant?: boolean | undefined, startTime?: string | undefined, weight?: number | undefined}; export type CreativeRotation = {creativeAssignments?: Array | undefined, creativeOptimizationConfigurationId?: unknown | undefined, type?: ('CREATIVE_ROTATION_TYPE_SEQUENTIAL' | 'CREATIVE_ROTATION_TYPE_RANDOM') | undefined, weightCalculationStrategy?: ('WEIGHT_STRATEGY_EQUAL' | 'WEIGHT_STRATEGY_CUSTOM' | 'WEIGHT_STRATEGY_HIGHEST_CTR' | 'WEIGHT_STRATEGY_OPTIMIZED') | undefined}; export type DayPartTargeting = {daysOfWeek?: (Array<'SUNDAY' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY'>) | undefined, hoursOfDay?: Array | undefined, userLocalTime?: boolean | undefined}; export type DefaultClickThroughEventTagProperties = {defaultClickThroughEventTagId?: unknown | undefined, overrideInheritedEventTag?: boolean | undefined}; export type FrequencyCap = {duration?: unknown | undefined, impressions?: unknown | undefined}; export type DeliverySchedule = {frequencyCap?: FrequencyCap | undefined, hardCutoff?: boolean | undefined, impressionRatio?: unknown | undefined, priority?: ('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') | undefined}; export type EventTagOverride = {enabled?: boolean | undefined, id?: unknown | undefined}; export type City = {countryCode?: string | undefined, countryDartId?: unknown | undefined, dartId?: unknown | undefined, kind?: string | undefined, metroCode?: string | undefined, metroDmaId?: unknown | undefined, name?: string | undefined, regionCode?: string | undefined, regionDartId?: unknown | undefined}; export type Country = {countryCode?: string | undefined, dartId?: unknown | undefined, kind?: string | undefined, name?: string | undefined, sslEnabled?: boolean | undefined, tvDataProviders?: (Array<'INVALID_TV_DATA_PROVIDER' | 'INTAGE_JP' | 'IBOPE_AR' | 'IBOPE_BR' | 'IBOPE_CL' | 'IBOPE_CO' | 'TNS_VN' | 'COMSCORE_NATIONAL_US' | 'COMSCORE_CA' | 'SAMBA_AU'>) | undefined}; export type Metro = {countryCode?: string | undefined, countryDartId?: unknown | undefined, dartId?: unknown | undefined, dmaId?: unknown | undefined, kind?: string | undefined, metroCode?: string | undefined, name?: string | undefined}; export type PostalCode = {code?: string | undefined, countryCode?: string | undefined, countryDartId?: unknown | undefined, id?: string | undefined, kind?: string | undefined}; export type Region = {countryCode?: string | undefined, countryDartId?: unknown | undefined, dartId?: unknown | undefined, kind?: string | undefined, name?: string | undefined, regionCode?: string | undefined}; export type GeoTargeting = {cities?: Array | undefined, countries?: Array | undefined, excludeCountries?: boolean | undefined, metros?: Array | undefined, postalCodes?: Array | undefined, regions?: Array | undefined}; export type KeyValueTargetingExpression = {expression?: string | undefined}; export type Language = {id?: unknown | undefined, kind?: string | undefined, languageCode?: string | undefined, name?: string | undefined}; export type LanguageTargeting = {languages?: Array | undefined}; export type PlacementAssignment = {active?: boolean | undefined, placementId?: unknown | undefined, placementIdDimensionValue?: DimensionValue | undefined, sslRequired?: boolean | undefined}; export type ListTargetingExpression = {expression?: string | undefined}; export type Size = {height?: number | undefined, iab?: boolean | undefined, id?: unknown | undefined, kind?: string | undefined, width?: number | undefined}; export type Browser = {browserVersionId?: unknown | undefined, dartId?: unknown | undefined, kind?: string | undefined, majorVersion?: string | undefined, minorVersion?: string | undefined, name?: string | undefined}; export type ConnectionType = {id?: unknown | undefined, kind?: string | undefined, name?: string | undefined}; export type MobileCarrier = {countryCode?: string | undefined, countryDartId?: unknown | undefined, id?: unknown | undefined, kind?: string | undefined, name?: string | undefined}; export type OperatingSystem = {dartId?: unknown | undefined, desktop?: boolean | undefined, kind?: string | undefined, mobile?: boolean | undefined, name?: string | undefined}; export type OperatingSystemVersion = {id?: unknown | undefined, kind?: string | undefined, majorVersion?: string | undefined, minorVersion?: string | undefined, name?: string | undefined, operatingSystem?: OperatingSystem | undefined}; export type PlatformType = {id?: unknown | undefined, kind?: string | undefined, name?: string | undefined}; export type TechnologyTargeting = {browsers?: Array | undefined, connectionTypes?: Array | undefined, mobileCarriers?: Array | undefined, operatingSystemVersions?: Array | undefined, operatingSystems?: Array | undefined, platformTypes?: Array | undefined}; export type Ad = {accountId?: unknown | undefined, active?: boolean | undefined, advertiserId?: unknown | undefined, advertiserIdDimensionValue?: DimensionValue | undefined, archived?: boolean | undefined, audienceSegmentId?: unknown | undefined, campaignId?: unknown | undefined, campaignIdDimensionValue?: DimensionValue | undefined, clickThroughUrl?: ClickThroughUrl | undefined, clickThroughUrlSuffixProperties?: ClickThroughUrlSuffixProperties | undefined, comments?: string | undefined, compatibility?: ('DISPLAY' | 'DISPLAY_INTERSTITIAL' | 'APP' | 'APP_INTERSTITIAL' | 'IN_STREAM_VIDEO' | 'IN_STREAM_AUDIO') | undefined, contextualKeywordTargeting?: ContextualKeywordTargeting | undefined, createInfo?: LastModifiedInfo | undefined, creativeGroupAssignments?: Array | undefined, creativeRotation?: CreativeRotation | undefined, dayPartTargeting?: DayPartTargeting | undefined, defaultClickThroughEventTagProperties?: DefaultClickThroughEventTagProperties | undefined, deliverySchedule?: DeliverySchedule | undefined, dynamicClickTracker?: boolean | undefined, endTime?: string | undefined, eventTagOverrides?: Array | undefined, geoTargeting?: GeoTargeting | undefined, id?: unknown | undefined, idDimensionValue?: DimensionValue | undefined, keyValueTargetingExpression?: KeyValueTargetingExpression | undefined, kind?: string | undefined, languageTargeting?: LanguageTargeting | undefined, lastModifiedInfo?: LastModifiedInfo | undefined, name?: string | undefined, placementAssignments?: Array | undefined, remarketingListExpression?: ListTargetingExpression | undefined, size?: Size | undefined, sslCompliant?: boolean | undefined, sslRequired?: boolean | undefined, startTime?: string | undefined, subaccountId?: unknown | undefined, targetingTemplateId?: unknown | undefined, technologyTargeting?: TechnologyTargeting | undefined, type?: ('AD_SERVING_STANDARD_AD' | 'AD_SERVING_DEFAULT_AD' | 'AD_SERVING_CLICK_TRACKER' | 'AD_SERVING_TRACKING' | 'AD_SERVING_BRAND_SAFE_AD') | undefined}; export type PatchApiUserprofilesUserprofilesIdAdsArgs = {userprofilesId: string, id: unknown, body: Ad}; export type PatchApiUserprofilesUserprofilesIdAdsOptions = {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 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 }; /** * Updates an existing ad. This method supports patch semantics. * * PATCH /userprofiles/{userprofilesId}/ads */ export const patchApiUserprofilesUserprofilesIdAds = async (args: PatchApiUserprofilesUserprofilesIdAdsArgs, options?: PatchApiUserprofilesUserprofilesIdAdsOptions) => { 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 (args.id != null) query.append("id", String(args.id)) 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: "PATCH", 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(ad, await res.json()) };