import {z} from 'zod' export type SelectedInventories = {allowDiscover?: boolean | undefined, allowGmail?: boolean | undefined, allowGoogleDisplayNetwork?: boolean | undefined, allowYoutubeFeed?: boolean | undefined, allowYoutubeShorts?: boolean | undefined, allowYoutubeStream?: boolean | undefined}; export type AdGroupInventoryControl = {adGroupInventoryStrategy?: ('AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED' | 'AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY' | 'AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY') | undefined, selectedInventories?: SelectedInventories | undefined}; export type DemandGenBiddingStrategy = {effectiveBiddingValue?: unknown | undefined, effectiveBiddingValueSource?: ('BIDDING_SOURCE_UNSPECIFIED' | 'BIDDING_SOURCE_LINE_ITEM' | 'BIDDING_SOURCE_AD_GROUP') | undefined, type?: ('DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC') | undefined, value?: unknown | undefined}; export type FixedBidStrategy = {bidAmountMicros?: unknown | undefined}; export type MaximizeSpendBidStrategy = {customBiddingAlgorithmId?: unknown | undefined, maxAverageCpmBidAmountMicros?: unknown | undefined, performanceGoalType?: ('BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH') | undefined, raiseBidForDeals?: boolean | undefined}; export type PerformanceGoalBidStrategy = {customBiddingAlgorithmId?: unknown | undefined, maxAverageCpmBidAmountMicros?: unknown | undefined, performanceGoalAmountMicros?: unknown | undefined, performanceGoalType?: ('BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH') | undefined}; export type YoutubeAndPartnersBiddingStrategy = {adGroupEffectiveTargetCpaSource?: ('BIDDING_SOURCE_UNSPECIFIED' | 'BIDDING_SOURCE_LINE_ITEM' | 'BIDDING_SOURCE_AD_GROUP') | undefined, adGroupEffectiveTargetCpaValue?: unknown | undefined, type?: ('YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE') | undefined, value?: unknown | undefined}; export type BiddingStrategy = {demandGenBid?: DemandGenBiddingStrategy | undefined, fixedBid?: FixedBidStrategy | undefined, maximizeSpendAutoBid?: MaximizeSpendBidStrategy | undefined, performanceGoalAutoBid?: PerformanceGoalBidStrategy | undefined, youtubeAndPartnersBid?: YoutubeAndPartnersBiddingStrategy | undefined}; export type CustomLabel = {key?: ('CUSTOM_LABEL_KEY_UNSPECIFIED' | 'CUSTOM_LABEL_KEY_0' | 'CUSTOM_LABEL_KEY_1' | 'CUSTOM_LABEL_KEY_2' | 'CUSTOM_LABEL_KEY_3' | 'CUSTOM_LABEL_KEY_4') | undefined, value?: string | undefined}; export type ProductMatchDimension = {customLabel?: CustomLabel | undefined, productOfferId?: string | undefined}; export type ProductFeedData = {isFeedDisabled?: boolean | undefined, productMatchDimensions?: Array | undefined, productMatchType?: ('PRODUCT_MATCH_TYPE_UNSPECIFIED' | 'PRODUCT_MATCH_TYPE_ALL_PRODUCTS' | 'PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS' | 'PRODUCT_MATCH_TYPE_CUSTOM_LABEL') | undefined}; export type TargetingExpansionConfig = {audienceExpansionLevel?: ('UNKNOWN' | 'NO_REACH' | 'LEAST_REACH' | 'MID_REACH' | 'MOST_REACH') | undefined, audienceExpansionSeedListExcluded?: boolean | undefined, enableOptimizedTargeting?: boolean | undefined, excludeDemographicExpansion?: boolean | undefined}; export type AdGroup = {adGroupFormat?: ('AD_GROUP_FORMAT_UNSPECIFIED' | 'AD_GROUP_FORMAT_IN_STREAM' | 'AD_GROUP_FORMAT_VIDEO_DISCOVERY' | 'AD_GROUP_FORMAT_BUMPER' | 'AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM' | 'AD_GROUP_FORMAT_AUDIO' | 'AD_GROUP_FORMAT_RESPONSIVE' | 'AD_GROUP_FORMAT_REACH' | 'AD_GROUP_FORMAT_MASTHEAD' | 'AD_GROUP_FORMAT_DEMAND_GEN') | undefined, adGroupId?: unknown | undefined, adGroupInventoryControl?: AdGroupInventoryControl | undefined, advertiserId?: unknown | undefined, bidStrategy?: BiddingStrategy | undefined, displayName?: string | undefined, entityStatus?: ('ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION') | undefined, lineItemId?: unknown | undefined, name?: string | undefined, productFeedData?: ProductFeedData | undefined, targetingExpansion?: TargetingExpansionConfig | undefined}; export type PatchApiV4AdvertisersAdvertisersIdAdGroupsAdGroupsIdArgs = {advertisersId: string, adGroupsId: string, updateMask?: unknown | undefined, body: AdGroup}; export type PatchApiV4AdvertisersAdvertisersIdAdGroupsAdGroupsIdOptions = {baseUrl?: string | undefined, Oauth2?: string | undefined, Oauth2c?: string | undefined, fetch?: typeof fetch | undefined}; export const selectedInventories = z.object({allowDiscover: z.boolean().optional(), allowGmail: z.boolean().optional(), allowGoogleDisplayNetwork: z.boolean().optional(), allowYoutubeFeed: z.boolean().optional(), allowYoutubeShorts: z.boolean().optional(), allowYoutubeStream: z.boolean().optional()}); export const adGroupInventoryControl = z.object({adGroupInventoryStrategy: z.enum(["AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED", "AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY", "AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY"]).optional(), selectedInventories: selectedInventories.optional()}); export const demandGenBiddingStrategy = z.object({effectiveBiddingValue: z.string().optional(), effectiveBiddingValueSource: z.enum(["BIDDING_SOURCE_UNSPECIFIED", "BIDDING_SOURCE_LINE_ITEM", "BIDDING_SOURCE_AD_GROUP"]).optional(), type: z.enum(["DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC"]).optional(), value: z.string().optional()}); export const fixedBidStrategy = z.object({bidAmountMicros: z.string().optional()}); export const maximizeSpendBidStrategy = z.object({customBiddingAlgorithmId: z.string().optional(), maxAverageCpmBidAmountMicros: z.string().optional(), performanceGoalType: z.enum(["BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH"]).optional(), raiseBidForDeals: z.boolean().optional()}); export const performanceGoalBidStrategy = z.object({customBiddingAlgorithmId: z.string().optional(), maxAverageCpmBidAmountMicros: z.string().optional(), performanceGoalAmountMicros: z.string().optional(), performanceGoalType: z.enum(["BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED", "BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH"]).optional()}); export const youtubeAndPartnersBiddingStrategy = z.object({adGroupEffectiveTargetCpaSource: z.enum(["BIDDING_SOURCE_UNSPECIFIED", "BIDDING_SOURCE_LINE_ITEM", "BIDDING_SOURCE_AD_GROUP"]).optional(), adGroupEffectiveTargetCpaValue: z.string().optional(), type: z.enum(["YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS", "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE"]).optional(), value: z.string().optional()}); export const biddingStrategy = z.object({demandGenBid: demandGenBiddingStrategy.optional(), fixedBid: fixedBidStrategy.optional(), maximizeSpendAutoBid: maximizeSpendBidStrategy.optional(), performanceGoalAutoBid: performanceGoalBidStrategy.optional(), youtubeAndPartnersBid: youtubeAndPartnersBiddingStrategy.optional()}); export const customLabel = z.object({key: z.enum(["CUSTOM_LABEL_KEY_UNSPECIFIED", "CUSTOM_LABEL_KEY_0", "CUSTOM_LABEL_KEY_1", "CUSTOM_LABEL_KEY_2", "CUSTOM_LABEL_KEY_3", "CUSTOM_LABEL_KEY_4"]).optional(), value: z.string().optional()}); export const productMatchDimension = z.object({customLabel: customLabel.optional(), productOfferId: z.string().optional()}); export const productFeedData = z.object({isFeedDisabled: z.boolean().optional(), productMatchDimensions: z.array(productMatchDimension).optional(), productMatchType: z.enum(["PRODUCT_MATCH_TYPE_UNSPECIFIED", "PRODUCT_MATCH_TYPE_ALL_PRODUCTS", "PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS", "PRODUCT_MATCH_TYPE_CUSTOM_LABEL"]).optional()}); export const targetingExpansionConfig = z.object({audienceExpansionLevel: z.enum(["UNKNOWN", "NO_REACH", "LEAST_REACH", "MID_REACH", "MOST_REACH"]).optional(), audienceExpansionSeedListExcluded: z.boolean().optional(), enableOptimizedTargeting: z.boolean().optional(), excludeDemographicExpansion: z.boolean().optional()}); export const adGroup = z.object({adGroupFormat: z.enum(["AD_GROUP_FORMAT_UNSPECIFIED", "AD_GROUP_FORMAT_IN_STREAM", "AD_GROUP_FORMAT_VIDEO_DISCOVERY", "AD_GROUP_FORMAT_BUMPER", "AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM", "AD_GROUP_FORMAT_AUDIO", "AD_GROUP_FORMAT_RESPONSIVE", "AD_GROUP_FORMAT_REACH", "AD_GROUP_FORMAT_MASTHEAD", "AD_GROUP_FORMAT_DEMAND_GEN"]).optional(), adGroupId: z.string().optional(), adGroupInventoryControl: adGroupInventoryControl.optional(), advertiserId: z.string().optional(), bidStrategy: biddingStrategy.optional(), displayName: z.string().optional(), entityStatus: z.enum(["ENTITY_STATUS_UNSPECIFIED", "ENTITY_STATUS_ACTIVE", "ENTITY_STATUS_ARCHIVED", "ENTITY_STATUS_DRAFT", "ENTITY_STATUS_PAUSED", "ENTITY_STATUS_SCHEDULED_FOR_DELETION"]).optional(), lineItemId: z.string().optional(), name: z.string().optional(), productFeedData: productFeedData.optional(), targetingExpansion: targetingExpansionConfig.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 group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. * * PATCH /v4/advertisers/{advertisersId}/adGroups/{adGroupsId} */ export const patchApiV4AdvertisersAdvertisersIdAdGroupsAdGroupsId = async (args: PatchApiV4AdvertisersAdvertisersIdAdGroupsAdGroupsIdArgs, options?: PatchApiV4AdvertisersAdvertisersIdAdGroupsAdGroupsIdOptions) => { const {baseUrl = "https://displayvideo.googleapis.com", 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.updateMask != null) query.append("updateMask", String(args.updateMask)) if (Oauth2 !== undefined) headers.set('authorization', `Bearer ${Oauth2}`) if (Oauth2c !== undefined) headers.set('authorization', `Bearer ${Oauth2c}`) const url = `${baseUrl.replace(/\/+$/, '')}/v4/advertisers/${encodeURIComponent(String(args.advertisersId))}/adGroups/${encodeURIComponent(String(args.adGroupsId))}${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(adGroup, await res.json()) };