import {z} from 'zod' export type GetApiUserprofilesUserprofilesIdPlacementsArgs = {userprofilesId: string, activeStatus?: (Array<'PLACEMENT_STATUS_UNKNOWN' | 'PLACEMENT_STATUS_ACTIVE' | 'PLACEMENT_STATUS_INACTIVE' | 'PLACEMENT_STATUS_ARCHIVED' | 'PLACEMENT_STATUS_PERMANENTLY_ARCHIVED'>) | undefined, advertiserIds?: Array | undefined, campaignIds?: Array | undefined, compatibilities?: (Array<'DISPLAY' | 'DISPLAY_INTERSTITIAL' | 'APP' | 'APP_INTERSTITIAL' | 'IN_STREAM_VIDEO' | 'IN_STREAM_AUDIO'>) | undefined, contentCategoryIds?: Array | undefined, directorySiteIds?: Array | undefined, groupIds?: Array | undefined, ids?: Array | undefined, maxEndDate?: string | undefined, maxResults?: number | undefined, maxStartDate?: string | undefined, minEndDate?: string | undefined, minStartDate?: string | undefined, pageToken?: string | undefined, paymentSource?: ('PLACEMENT_AGENCY_PAID' | 'PLACEMENT_PUBLISHER_PAID') | undefined, placementStrategyIds?: Array | undefined, pricingTypes?: (Array<'PRICING_TYPE_CPM' | 'PRICING_TYPE_CPC' | 'PRICING_TYPE_CPA' | 'PRICING_TYPE_FLAT_RATE_IMPRESSIONS' | 'PRICING_TYPE_FLAT_RATE_CLICKS' | 'PRICING_TYPE_CPM_ACTIVEVIEW'>) | undefined, searchString?: string | undefined, siteIds?: Array | undefined, sizeIds?: Array | undefined, sortField?: ('ID' | 'NAME') | undefined, sortOrder?: ('ASCENDING' | 'DESCENDING') | undefined}; export type GetApiUserprofilesUserprofilesIdPlacementsOptions = {baseUrl?: string | undefined, Oauth2?: string | undefined, Oauth2c?: string | undefined, fetch?: typeof fetch | undefined}; 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 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 placementSingleConversionDomain = z.object({conversionDomainId: z.string().optional(), conversionDomainValue: z.string().optional()}); export const placementConversionDomainOverride = z.object({conversionDomains: z.array(placementSingleConversionDomain).optional()}); export const lastModifiedInfo = z.object({time: z.string().optional()}); export const lookbackConfiguration = z.object({clickDuration: z.number().int().optional(), postImpressionActivitiesDuration: z.number().int().optional()}); export const measurementPartnerWrappingData = z.object({linkStatus: z.enum(["MEASUREMENT_PARTNER_UNLINKED", "MEASUREMENT_PARTNER_LINKED", "MEASUREMENT_PARTNER_LINK_PENDING", "MEASUREMENT_PARTNER_LINK_FAILURE", "MEASUREMENT_PARTNER_LINK_OPT_OUT", "MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING", "MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING", "MEASUREMENT_PARTNER_MODE_CHANGE_PENDING", "MEASUREMENT_PARTNER_UNLINK_PENDING"]).optional(), measurementPartner: z.enum(["NONE", "INTEGRAL_AD_SCIENCE", "DOUBLE_VERIFY"]).optional(), tagWrappingMode: z.enum(["NONE", "BLOCKING", "MONITORING", "MONITORING_READ_ONLY", "VIDEO_PIXEL_MONITORING", "TRACKING", "VPAID_MONITORING", "VPAID_BLOCKING", "NON_VPAID_MONITORING", "VPAID_ONLY_MONITORING", "VPAID_ONLY_BLOCKING", "VPAID_ONLY_FILTERING", "VPAID_FILTERING", "NON_VPAID_FILTERING", "BLOCKING_FILTERING_VPAID", "BLOCKING_FILTERING_VPAID_ONLY"]).optional(), wrappedTag: z.string().optional()}); export const pricingSchedulePricingPeriod = z.object({endDate: z.string().optional(), pricingComment: z.string().optional(), rateOrCostNanos: z.string().optional(), startDate: z.string().optional(), units: z.string().optional()}); export const pricingSchedule = z.object({capCostOption: z.enum(["CAP_COST_NONE", "CAP_COST_MONTHLY", "CAP_COST_CUMULATIVE"]).optional(), endDate: z.string().optional(), flighted: z.boolean().optional(), floodlightActivityId: z.string().optional(), pricingPeriods: z.array(pricingSchedulePricingPeriod).optional(), pricingType: z.enum(["PRICING_TYPE_CPM", "PRICING_TYPE_CPC", "PRICING_TYPE_CPA", "PRICING_TYPE_FLAT_RATE_IMPRESSIONS", "PRICING_TYPE_FLAT_RATE_CLICKS", "PRICING_TYPE_CPM_ACTIVEVIEW"]).optional(), startDate: z.string().optional(), testingStartDate: z.string().optional()}); export const tagSetting = z.object({additionalKeyValues: z.string().optional(), includeClickThroughUrls: z.boolean().optional(), includeClickTracking: z.boolean().optional(), includeUnescapedlpurlMacro: z.boolean().optional(), keywordOption: z.enum(["PLACEHOLDER_WITH_LIST_OF_KEYWORDS", "IGNORE", "GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD"]).optional()}); export const companionSetting = z.object({companionsDisabled: z.boolean().optional(), enabledSizes: z.array(size).optional(), imageOnly: z.boolean().optional(), kind: z.string().optional()}); export const obaIcon = z.object({iconClickThroughUrl: z.string().optional(), iconClickTrackingUrl: z.string().optional(), iconViewTrackingUrl: z.string().optional(), program: z.string().optional(), resourceUrl: z.string().optional(), size: size.optional(), xPosition: z.string().optional(), yPosition: z.string().optional()}); export const videoOffset = z.object({offsetPercentage: z.number().int().optional(), offsetSeconds: z.number().int().optional()}); export const skippableSetting = z.object({kind: z.string().optional(), progressOffset: videoOffset.optional(), skipOffset: videoOffset.optional(), skippable: z.boolean().optional()}); export const transcodeSetting = z.object({enabledVideoFormats: z.array(z.number().int()).optional(), kind: z.string().optional()}); export const videoSettings = z.object({companionSettings: companionSetting.optional(), durationSeconds: z.number().int().optional(), kind: z.string().optional(), obaEnabled: z.boolean().optional(), obaSettings: obaIcon.optional(), orientation: z.enum(["ANY", "LANDSCAPE", "PORTRAIT"]).optional(), publisherSpecificationId: z.string().optional(), skippableSettings: skippableSetting.optional(), transcodeSettings: transcodeSetting.optional()}); export const youtubeSettings = z.object({businessLogoCreativeIds: z.array(z.string()).optional(), businessName: z.string().optional(), callToActions: z.array(z.enum(["CALL_TO_ACTION_UNKNOWN", "CALL_TO_ACTION_LEARN_MORE", "CALL_TO_ACTION_GET_QUOTE", "CALL_TO_ACTION_APPLY_NOW", "CALL_TO_ACTION_SIGN_UP", "CALL_TO_ACTION_CONTACT_US", "CALL_TO_ACTION_SUBSCRIBE", "CALL_TO_ACTION_DOWNLOAD", "CALL_TO_ACTION_BOOK_NOW", "CALL_TO_ACTION_GET_OFFER", "CALL_TO_ACTION_SHOP_NOW", "CALL_TO_ACTION_VISIT_STORE", "CALL_TO_ACTION_CALL_NOW", "CALL_TO_ACTION_VIEW_MENU", "CALL_TO_ACTION_TEST_DRIVE", "CALL_TO_ACTION_SCHEDULE_NOW", "CALL_TO_ACTION_BUY_NOW", "CALL_TO_ACTION_DONATE_NOW", "CALL_TO_ACTION_ORDER_NOW", "CALL_TO_ACTION_PLAY_NOW", "CALL_TO_ACTION_SEE_MORE", "CALL_TO_ACTION_START_NOW", "CALL_TO_ACTION_VISIT_SITE", "CALL_TO_ACTION_WATCH_NOW"])).optional(), descriptions: z.array(z.string()).optional(), headlines: z.array(z.string()).optional(), longHeadlines: z.array(z.string()).optional()}); export const placement = z.object({accountId: z.string().optional(), activeStatus: z.enum(["PLACEMENT_STATUS_UNKNOWN", "PLACEMENT_STATUS_ACTIVE", "PLACEMENT_STATUS_INACTIVE", "PLACEMENT_STATUS_ARCHIVED", "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED"]).optional(), adBlockingOptOut: z.boolean().optional(), adServingPlatformId: z.string().optional(), additionalSizes: z.array(size).optional(), advertiserId: z.string().optional(), advertiserIdDimensionValue: dimensionValue.optional(), allowOnYoutube: z.boolean().optional(), campaignId: z.string().optional(), campaignIdDimensionValue: dimensionValue.optional(), comment: z.string().optional(), compatibility: z.enum(["DISPLAY", "DISPLAY_INTERSTITIAL", "APP", "APP_INTERSTITIAL", "IN_STREAM_VIDEO", "IN_STREAM_AUDIO"]).optional(), contentCategoryId: z.string().optional(), conversionDomainOverride: placementConversionDomainOverride.optional(), createInfo: lastModifiedInfo.optional(), directorySiteId: z.string().optional(), directorySiteIdDimensionValue: dimensionValue.optional(), externalId: z.string().optional(), id: z.string().optional(), idDimensionValue: dimensionValue.optional(), keyName: z.string().optional(), kind: z.string().optional(), lastModifiedInfo: lastModifiedInfo.optional(), lookbackConfiguration: lookbackConfiguration.optional(), name: z.string().optional(), partnerWrappingData: measurementPartnerWrappingData.optional(), paymentApproved: z.boolean().optional(), paymentSource: z.enum(["PLACEMENT_AGENCY_PAID", "PLACEMENT_PUBLISHER_PAID"]).optional(), placementGroupId: z.string().optional(), placementGroupIdDimensionValue: dimensionValue.optional(), placementStrategyId: z.string().optional(), pricingSchedule: pricingSchedule.optional(), primary: z.boolean().optional(), publisherUpdateInfo: lastModifiedInfo.optional(), siteId: z.string().optional(), siteIdDimensionValue: dimensionValue.optional(), siteServed: z.boolean().optional(), size: size.optional(), sslRequired: z.boolean().optional(), status: z.enum(["PENDING_REVIEW", "PAYMENT_ACCEPTED", "PAYMENT_REJECTED", "ACKNOWLEDGE_REJECTION", "ACKNOWLEDGE_ACCEPTANCE", "DRAFT"]).optional(), subaccountId: z.string().optional(), tagFormats: z.array(z.enum(["PLACEMENT_TAG_STANDARD", "PLACEMENT_TAG_IFRAME_JAVASCRIPT", "PLACEMENT_TAG_IFRAME_ILAYER", "PLACEMENT_TAG_INTERNAL_REDIRECT", "PLACEMENT_TAG_JAVASCRIPT", "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", "PLACEMENT_TAG_CLICK_COMMANDS", "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", "PLACEMENT_TAG_TRACKING", "PLACEMENT_TAG_TRACKING_IFRAME", "PLACEMENT_TAG_TRACKING_JAVASCRIPT", "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", "PLACEMENT_TAG_JAVASCRIPT_LEGACY", "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4", "PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT"])).optional(), tagSetting: tagSetting.optional(), videoActiveViewOptOut: z.boolean().optional(), videoSettings: videoSettings.optional(), vpaidAdapterChoice: z.enum(["DEFAULT", "FLASH", "HTML5", "BOTH"]).optional(), wrappingOptOut: z.boolean().optional(), youtubeSettings: youtubeSettings.optional()}); export const placementsListResponse = z.object({kind: z.string().optional(), nextPageToken: z.string().optional(), placements: z.array(placement).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 placements, possibly filtered. This method supports paging. * * GET /userprofiles/{userprofilesId}/placements */ export const getApiUserprofilesUserprofilesIdPlacements = async (args: GetApiUserprofilesUserprofilesIdPlacementsArgs, options?: GetApiUserprofilesUserprofilesIdPlacementsOptions) => { 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") for (const item of args.activeStatus ?? []) query.append("activeStatus", String(item)) for (const item of args.advertiserIds ?? []) query.append("advertiserIds", String(item)) for (const item of args.campaignIds ?? []) query.append("campaignIds", String(item)) for (const item of args.compatibilities ?? []) query.append("compatibilities", String(item)) for (const item of args.contentCategoryIds ?? []) query.append("contentCategoryIds", String(item)) for (const item of args.directorySiteIds ?? []) query.append("directorySiteIds", String(item)) for (const item of args.groupIds ?? []) query.append("groupIds", String(item)) for (const item of args.ids ?? []) query.append("ids", String(item)) if (args.maxEndDate != null) query.append("maxEndDate", String(args.maxEndDate)) if (args.maxResults != null) query.append("maxResults", String(args.maxResults)) if (args.maxStartDate != null) query.append("maxStartDate", String(args.maxStartDate)) if (args.minEndDate != null) query.append("minEndDate", String(args.minEndDate)) if (args.minStartDate != null) query.append("minStartDate", String(args.minStartDate)) if (args.pageToken != null) query.append("pageToken", String(args.pageToken)) if (args.paymentSource != null) query.append("paymentSource", String(args.paymentSource)) for (const item of args.placementStrategyIds ?? []) query.append("placementStrategyIds", String(item)) for (const item of args.pricingTypes ?? []) query.append("pricingTypes", String(item)) if (args.searchString != null) query.append("searchString", String(args.searchString)) for (const item of args.siteIds ?? []) query.append("siteIds", String(item)) 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 (Oauth2 !== undefined) headers.set('authorization', `Bearer ${Oauth2}`) if (Oauth2c !== undefined) headers.set('authorization', `Bearer ${Oauth2c}`) const url = `${baseUrl.replace(/\/+$/, '')}/userprofiles/${encodeURIComponent(String(args.userprofilesId))}/placements${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(placementsListResponse, await res.json()) };