@maxim_mazurok/gapi.client.displayvideo-v4 0.5.20260708 → 0.5.20260720
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +106 -13
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://displayvideo.googleapis.com/$discovery/rest?version=v4
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260720
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -90,6 +90,11 @@ declare namespace gapi.client {
|
|
|
90
90
|
| 'ENTITY_STATUS_SCHEDULED_FOR_DELETION';
|
|
91
91
|
/** Identifier. The resource name of the ad asset. */
|
|
92
92
|
name?: string;
|
|
93
|
+
/** Optional. Whether the asset contains synthetic content or was created using AI. */
|
|
94
|
+
syntheticContentAttestationStatus?:
|
|
95
|
+
| 'SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED'
|
|
96
|
+
| 'NOT_SYNTHETIC'
|
|
97
|
+
| 'IS_SYNTHETIC';
|
|
93
98
|
/** Youtube video asset data. */
|
|
94
99
|
youtubeVideoAsset?: YoutubeVideoAsset;
|
|
95
100
|
}
|
|
@@ -611,6 +616,10 @@ declare namespace gapi.client {
|
|
|
611
616
|
creativeConfig?: AdvertiserCreativeConfig;
|
|
612
617
|
/** Settings that control how advertiser data may be accessed. */
|
|
613
618
|
dataAccessConfig?: AdvertiserDataAccessConfig;
|
|
619
|
+
/** Optional. The default business name for the advertiser. This is the value used by YouTube and Demand Gen ads under this advertiser if a business name is not provided. */
|
|
620
|
+
defaultBusinessName?: string;
|
|
621
|
+
/** Optional. The asset ID of the default logo image for the advertiser. This is the asset ID that will be used by YouTube and Demand ads under this advertiser if a logo asset is not provided. You must use advertisers.adAssets.upload to upload this asset using the API. */
|
|
622
|
+
defaultLogoAssetId?: string;
|
|
614
623
|
/** Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. */
|
|
615
624
|
displayName?: string;
|
|
616
625
|
/** Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. */
|
|
@@ -2226,6 +2235,11 @@ declare namespace gapi.client {
|
|
|
2226
2235
|
skipOffset?: AudioVideoOffset;
|
|
2227
2236
|
/** Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` */
|
|
2228
2237
|
skippable?: boolean;
|
|
2238
|
+
/** Optional. Whether the creative contains synthetic content or was created using AI. */
|
|
2239
|
+
syntheticContentAttestationStatus?:
|
|
2240
|
+
| 'SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED'
|
|
2241
|
+
| 'NOT_SYNTHETIC'
|
|
2242
|
+
| 'IS_SYNTHETIC';
|
|
2229
2243
|
/** Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` */
|
|
2230
2244
|
thirdPartyTag?: string;
|
|
2231
2245
|
/** Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` */
|
|
@@ -2538,7 +2552,7 @@ declare namespace gapi.client {
|
|
|
2538
2552
|
value?: string;
|
|
2539
2553
|
}
|
|
2540
2554
|
interface DemandGenCarouselAd {
|
|
2541
|
-
/**
|
|
2555
|
+
/** Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2542
2556
|
businessName?: string;
|
|
2543
2557
|
/** Required. The list of cards shown on the ad. */
|
|
2544
2558
|
cards?: CarouselCard[];
|
|
@@ -2552,7 +2566,7 @@ declare namespace gapi.client {
|
|
|
2552
2566
|
finalUrlSuffix?: string;
|
|
2553
2567
|
/** Required. The headline of the ad. */
|
|
2554
2568
|
headline?: string;
|
|
2555
|
-
/**
|
|
2569
|
+
/** Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2556
2570
|
logo?: ImageAsset;
|
|
2557
2571
|
/** Output only. The URL address loaded in the background for tracking purposes. */
|
|
2558
2572
|
trackingUrl?: string;
|
|
@@ -2560,7 +2574,7 @@ declare namespace gapi.client {
|
|
|
2560
2574
|
userSpecifiedTrackingUrl?: string;
|
|
2561
2575
|
}
|
|
2562
2576
|
interface DemandGenImageAd {
|
|
2563
|
-
/**
|
|
2577
|
+
/** Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2564
2578
|
businessName?: string;
|
|
2565
2579
|
/** Required. The call-to-action button shown on the ad. */
|
|
2566
2580
|
callToAction?: string;
|
|
@@ -2576,7 +2590,7 @@ declare namespace gapi.client {
|
|
|
2576
2590
|
finalUrlSuffix?: string;
|
|
2577
2591
|
/** Required. The list of headlines shown on the ad. */
|
|
2578
2592
|
headlines?: string[];
|
|
2579
|
-
/** The list of logo images shown on the ad.
|
|
2593
|
+
/** The list of logo images shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2580
2594
|
logoImages?: ImageAsset[];
|
|
2581
2595
|
/** The list of marketing images shown on the ad. */
|
|
2582
2596
|
marketingImages?: ImageAsset[];
|
|
@@ -2590,7 +2604,7 @@ declare namespace gapi.client {
|
|
|
2590
2604
|
userSpecifiedTrackingUrl?: string;
|
|
2591
2605
|
}
|
|
2592
2606
|
interface DemandGenProductAd {
|
|
2593
|
-
/**
|
|
2607
|
+
/** Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2594
2608
|
businessName?: string;
|
|
2595
2609
|
/** Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` */
|
|
2596
2610
|
callToAction?:
|
|
@@ -2627,7 +2641,7 @@ declare namespace gapi.client {
|
|
|
2627
2641
|
finalUrlSuffix?: string;
|
|
2628
2642
|
/** Required. The headline of the ad. */
|
|
2629
2643
|
headline?: string;
|
|
2630
|
-
/**
|
|
2644
|
+
/** Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2631
2645
|
logo?: ImageAsset;
|
|
2632
2646
|
/** Output only. The URL address loaded in the background for tracking purposes. */
|
|
2633
2647
|
trackingUrl?: string;
|
|
@@ -2643,7 +2657,7 @@ declare namespace gapi.client {
|
|
|
2643
2657
|
thirdPartyMeasurementConfigs?: ThirdPartyMeasurementConfigs;
|
|
2644
2658
|
}
|
|
2645
2659
|
interface DemandGenVideoAd {
|
|
2646
|
-
/**
|
|
2660
|
+
/** Optional. The business name shown on the ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2647
2661
|
businessName?: string;
|
|
2648
2662
|
/** Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` */
|
|
2649
2663
|
callToAction?:
|
|
@@ -2684,7 +2698,7 @@ declare namespace gapi.client {
|
|
|
2684
2698
|
finalUrlSuffix?: string;
|
|
2685
2699
|
/** Required. The list of headlines shown on the ad. */
|
|
2686
2700
|
headlines?: string[];
|
|
2687
|
-
/**
|
|
2701
|
+
/** Optional. The logo image used by this ad. This setting is required unless a default value is set at the advertiser level. If left unset, the default value will be applied. */
|
|
2688
2702
|
logo?: ImageAsset;
|
|
2689
2703
|
/** Required. The list of long headlines shown on the ad. */
|
|
2690
2704
|
longHeadlines?: string[];
|
|
@@ -5276,12 +5290,12 @@ declare namespace gapi.client {
|
|
|
5276
5290
|
| 'GENDER_MALE'
|
|
5277
5291
|
| 'GENDER_FEMALE'
|
|
5278
5292
|
| 'GENDER_UNKNOWN'[];
|
|
5279
|
-
/** Output only. Targetable
|
|
5280
|
-
|
|
5293
|
+
/** Output only. Targetable networks for the ad product. */
|
|
5294
|
+
networks?:
|
|
5281
5295
|
| 'PLANNABLE_NETWORK_UNSPECIFIED'
|
|
5282
5296
|
| 'PLANNABLE_NETWORK_YOUTUBE'
|
|
5283
5297
|
| 'PLANNABLE_NETWORK_GOOGLE_VIDEO_PARTNERS'
|
|
5284
|
-
| 'PLANNABLE_NETWORK_YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS';
|
|
5298
|
+
| 'PLANNABLE_NETWORK_YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS'[];
|
|
5285
5299
|
/** Output only. Targetable surface combinations for the ad product. */
|
|
5286
5300
|
surfaceTargetingCombinations?: SurfaceTargetingCombinations;
|
|
5287
5301
|
/** Output only. Targetable YouTube Select Lineups for the ad product. */
|
|
@@ -5318,10 +5332,18 @@ declare namespace gapi.client {
|
|
|
5318
5332
|
plannableProductCode?: string;
|
|
5319
5333
|
}
|
|
5320
5334
|
interface PlannedProductForecast {
|
|
5335
|
+
/** Number of on-target impressions including co-viewers. */
|
|
5336
|
+
onTargetCoviewImpressions?: string;
|
|
5337
|
+
/** Number of unique people reached that match the on-target definition including co-viewers. */
|
|
5338
|
+
onTargetCoviewReach?: string;
|
|
5321
5339
|
/** Number of on-target impressions. */
|
|
5322
5340
|
onTargetImpressions?: string;
|
|
5323
5341
|
/** Number of unique people reached that match the on-target definition. */
|
|
5324
5342
|
onTargetReach?: string;
|
|
5343
|
+
/** Total number of impressions including co-viewers. */
|
|
5344
|
+
totalCoviewImpressions?: string;
|
|
5345
|
+
/** Total number of unique people reached including co-viewers. */
|
|
5346
|
+
totalCoviewReach?: string;
|
|
5325
5347
|
/** Total number of impressions. */
|
|
5326
5348
|
totalImpressions?: string;
|
|
5327
5349
|
/** Total number of unique people reached. */
|
|
@@ -5976,7 +5998,7 @@ declare namespace gapi.client {
|
|
|
5976
5998
|
viewabilityDetails?: ViewabilityTargetingOptionDetails;
|
|
5977
5999
|
}
|
|
5978
6000
|
interface ThirdPartyMeasurementConfigs {
|
|
5979
|
-
/** Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `
|
|
6001
|
+
/** Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_MACROMILL` */
|
|
5980
6002
|
brandLiftVendorConfigs?: ThirdPartyVendorConfig[];
|
|
5981
6003
|
/** Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` */
|
|
5982
6004
|
brandSafetyVendorConfigs?: ThirdPartyVendorConfig[];
|
|
@@ -6106,6 +6128,11 @@ declare namespace gapi.client {
|
|
|
6106
6128
|
| 'AD_ASSET_TYPE_YOUTUBE_VIDEO';
|
|
6107
6129
|
/** Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. */
|
|
6108
6130
|
filename?: string;
|
|
6131
|
+
/** Optional. Whether the asset contains synthetic content or was created using AI. */
|
|
6132
|
+
syntheticContentAttestationStatus?:
|
|
6133
|
+
| 'SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED'
|
|
6134
|
+
| 'NOT_SYNTHETIC'
|
|
6135
|
+
| 'IS_SYNTHETIC';
|
|
6109
6136
|
}
|
|
6110
6137
|
interface UploadAdAssetResponse {
|
|
6111
6138
|
/** The created ad asset. */
|
|
@@ -6629,6 +6656,72 @@ declare namespace gapi.client {
|
|
|
6629
6656
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6630
6657
|
uploadType?: string;
|
|
6631
6658
|
}): Request<ListAdAssetsResponse>;
|
|
6659
|
+
/** Updates an ad asset. Returns the updated ad asset if successful. Supports updating assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` and `AD_ASSET_TYPE_IMAGE`. Only the `synthetic_content_attestation_status` field is mutable. */
|
|
6660
|
+
patch(request: {
|
|
6661
|
+
/** V1 error format. */
|
|
6662
|
+
'$.xgafv'?: '1' | '2';
|
|
6663
|
+
/** OAuth access token. */
|
|
6664
|
+
access_token?: string;
|
|
6665
|
+
/** Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad. */
|
|
6666
|
+
adAssetId: string;
|
|
6667
|
+
/** Required. The ID of the advertiser this ad asset belongs to. */
|
|
6668
|
+
advertiserId: string;
|
|
6669
|
+
/** Data format for response. */
|
|
6670
|
+
alt?: 'json' | 'media' | 'proto';
|
|
6671
|
+
/** JSONP */
|
|
6672
|
+
callback?: string;
|
|
6673
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6674
|
+
fields?: string;
|
|
6675
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6676
|
+
key?: string;
|
|
6677
|
+
/** OAuth 2.0 token for the current user. */
|
|
6678
|
+
oauth_token?: string;
|
|
6679
|
+
/** Returns response with indentations and line breaks. */
|
|
6680
|
+
prettyPrint?: boolean;
|
|
6681
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6682
|
+
quotaUser?: string;
|
|
6683
|
+
/** Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable. */
|
|
6684
|
+
updateMask?: string;
|
|
6685
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6686
|
+
upload_protocol?: string;
|
|
6687
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6688
|
+
uploadType?: string;
|
|
6689
|
+
/** Request body */
|
|
6690
|
+
resource: AdAsset;
|
|
6691
|
+
}): Request<AdAsset>;
|
|
6692
|
+
patch(
|
|
6693
|
+
request: {
|
|
6694
|
+
/** V1 error format. */
|
|
6695
|
+
'$.xgafv'?: '1' | '2';
|
|
6696
|
+
/** OAuth access token. */
|
|
6697
|
+
access_token?: string;
|
|
6698
|
+
/** Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad. */
|
|
6699
|
+
adAssetId: string;
|
|
6700
|
+
/** Required. The ID of the advertiser this ad asset belongs to. */
|
|
6701
|
+
advertiserId: string;
|
|
6702
|
+
/** Data format for response. */
|
|
6703
|
+
alt?: 'json' | 'media' | 'proto';
|
|
6704
|
+
/** JSONP */
|
|
6705
|
+
callback?: string;
|
|
6706
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6707
|
+
fields?: string;
|
|
6708
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
6709
|
+
key?: string;
|
|
6710
|
+
/** OAuth 2.0 token for the current user. */
|
|
6711
|
+
oauth_token?: string;
|
|
6712
|
+
/** Returns response with indentations and line breaks. */
|
|
6713
|
+
prettyPrint?: boolean;
|
|
6714
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
6715
|
+
quotaUser?: string;
|
|
6716
|
+
/** Required. The list of fields to update. Only AdAsset.synthetic_content_attestation_status is mutable. */
|
|
6717
|
+
updateMask?: string;
|
|
6718
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6719
|
+
upload_protocol?: string;
|
|
6720
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6721
|
+
uploadType?: string;
|
|
6722
|
+
},
|
|
6723
|
+
body: AdAsset,
|
|
6724
|
+
): Request<AdAsset>;
|
|
6632
6725
|
/** Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`. */
|
|
6633
6726
|
upload(request: {
|
|
6634
6727
|
/** V1 error format. */
|