@maxim_mazurok/gapi.client.displayvideo-v3 0.0.20250410 → 0.0.20250424

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://displayvideo.googleapis.com/$discovery/rest?version=v3
-// Revision: 20250410
+// Revision: 20250424
 
 /// <reference types="gapi.client" />
 
@@ -109,9 +109,9 @@ declare namespace gapi.client {
       debatedSensitiveSocialIssueContent?: string;
       /** Optional. IAB viewability threshold for display ads. */
       displayIabViewability?: string;
-      /** Adloox categories to exclude. */
+      /** Scope3 categories to exclude. */
       excludedAdlooxCategories?: string[];
-      /** Optional. Adloox's fraud IVT MFA categories to exclude. */
+      /** Optional. Scope3's fraud IVT MFA categories to exclude. */
       excludedFraudIvtMfaCategories?: string[];
       /** Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude. */
       hateSpeechActsAggressionContent?: string;
@@ -217,8 +217,12 @@ declare namespace gapi.client {
       ageRange?: string;
     }
     interface AlgorithmRules {
+      /** Attribution model for the algorithm. */
+      attributionModelId?: string;
       /** Rules for the impression signals. */
       impressionSignalRuleset?: AlgorithmRulesRuleset;
+      /** Rules for the post-impression signals. */
+      postImpressionSignalRuleset?: AlgorithmRulesRuleset;
     }
     interface AlgorithmRulesComparisonValue {
       /** Boolean value. */
@@ -241,6 +245,16 @@ declare namespace gapi.client {
       onScreenPositionValue?: string;
       /** String value. */
       stringValue?: string;
+      /** Video player size value. */
+      videoPlayerSizeValue?: string;
+    }
+    interface AlgorithmRulesFloodlightActivityConversionSignal {
+      /** Required. The type of conversions to be used in impression value computation, for example, post-click conversions. */
+      conversionCounting?: string;
+      /** Required. The way to acquire value from the floodlight activity, for example, count of the conversion. */
+      countingMethod?: string;
+      /** Required. Id of the floodlight activity. */
+      floodlightActivityId?: string;
     }
     interface AlgorithmRulesRule {
       /** List of conditions in this rule. The criteria among conditions should be mutually exclusive. */
@@ -263,6 +277,10 @@ declare namespace gapi.client {
       rules?: AlgorithmRulesRule[];
     }
     interface AlgorithmRulesSignal {
+      /** Signal based on active views. */
+      activeViewSignal?: string;
+      /** Signal based on clicks. */
+      clickSignal?: string;
       /** Signal based on impressions. */
       impressionSignal?: string;
     }
@@ -275,6 +293,10 @@ declare namespace gapi.client {
       signal?: AlgorithmRulesSignal;
     }
     interface AlgorithmRulesSignalValue {
+      /** Signal based on active views. Only `TIME_ON_SCREEN` is supported. */
+      activeViewSignal?: string;
+      /** Signal based on floodlight conversion events. */
+      floodlightActivityConversionSignal?: AlgorithmRulesFloodlightActivityConversionSignal;
       /** Value to use as result. */
       number?: number;
     }
@@ -967,7 +989,7 @@ declare namespace gapi.client {
       contentTheme?: string;
     }
     interface ConversionCountingConfig {
-      /** The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. *Warning*: Starting **April 1, 2025**, this field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */
+      /** The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. */
       floodlightActivityConfigs?: TrackingFloodlightActivityConfig[];
       /** The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. */
       postViewCountPercentageMillis?: string;
@@ -1466,7 +1488,7 @@ declare namespace gapi.client {
       firstAndThirdPartyAudienceType?: string;
       /** Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. */
       gmailAudienceSize?: string;
-      /** The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` *Warning*: Starting on **April 7, 2025**, audiences will no longer be able to have infinite membership duration. This field will no longer accept the value 10000 and all audiences with membership durations greater than 540 days will be updated to a membership duration of 540 days. [Read more about this announced change](/display-video/api/deprecations#features.audience_duration). */
+      /** The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` */
       membershipDurationDays?: string;
       /** Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` */
       mobileDeviceIdList?: MobileDeviceIdList;
@@ -1940,7 +1962,7 @@ declare namespace gapi.client {
       budget?: LineItemBudget;
       /** Output only. The unique ID of the campaign that the line item belongs to. */
       campaignId?: string;
-      /** The conversion tracking setting of the line item. *Warning*: Starting **April 1, 2025**, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */
+      /** The conversion tracking setting of the line item. */
       conversionCounting?: ConversionCountingConfig;
       /** The IDs of the creatives associated with the line item. */
       creativeIds?: string[];
@@ -2260,7 +2282,7 @@ declare namespace gapi.client {
       videoAspectRatio?: string;
     }
     interface MaximizeSpendBidStrategy {
-      /** The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */
+      /** The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */
       customBiddingAlgorithmId?: string;
       /** The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. */
       maxAverageCpmBidAmountMicros?: string;
@@ -2492,7 +2514,7 @@ declare namespace gapi.client {
       performanceGoalType?: string;
     }
     interface PerformanceGoalBidStrategy {
-      /** The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. *Warning*: Starting **April 1, 2025**, assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */
+      /** The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. */
       customBiddingAlgorithmId?: string;
       /** The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. */
       maxAverageCpmBidAmountMicros?: string;
@@ -2826,7 +2848,7 @@ declare namespace gapi.client {
       vendor?: string;
     }
     interface ThirdPartyVerifierAssignedTargetingOptionDetails {
-      /** Third party brand verifier -- Adloox. */
+      /** Third party brand verifier -- Scope3 (previously known as Adloox). */
       adloox?: Adloox;
       /** Third party brand verifier -- DoubleVerify. */
       doubleVerify?: DoubleVerify;
@@ -6967,7 +6989,7 @@ declare namespace gapi.client {
       }): Request<ListCombinedAudiencesResponse>;
     }
     interface RulesResource {
-      /** Creates a new rules resource. Returns the newly created rules resource if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */
+      /** Creates a new rules resource. Returns the newly created rules resource if successful. Requests creating a custom bidding rules resource under an algorithm assigned to a line item will return an error. */
       create(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -7105,7 +7127,7 @@ declare namespace gapi.client {
       }): Request<ListCustomBiddingAlgorithmRulesResponse>;
     }
     interface ScriptsResource {
-      /** Creates a new custom bidding script. Returns the newly created script if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */
+      /** Creates a new custom bidding script. Returns the newly created script if successful. Requests creating a custom bidding script under an algorithm assigned to a line item will return an error. */
       create(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -7365,7 +7387,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<ListCustomBiddingAlgorithmsResponse>;
-      /** Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight). */
+      /** Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error. */
       patch(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -9870,7 +9892,7 @@ declare namespace gapi.client {
       }): Request<Operation>;
     }
     interface SdfdownloadtasksResource {
-      /** Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty. */
+      /** Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty. */
       create(request: {
         /** V1 error format. */
         '$.xgafv'?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.displayvideo-v3",
-  "version": "0.0.20250410",
+  "version": "0.0.20250424",
   "description": "TypeScript typings for Display & Video 360 API v3",
   "repository": {
     "type": "git",

package/readme.md

@@ -158,7 +158,7 @@ Lists custom bidding algorithms that are accessible to the current user and can
 await gapi.client.displayvideo.customBiddingAlgorithms.list({});
 
 /*
-Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. *Warning*: Starting **April 1, 2025**, requests updating custom bidding algorithms that are assigned to line items will return an error. [Read more about this announced change](/display-video/api/deprecations#features.custom_bidding_floodlight).
+Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.
 */
 await gapi.client.displayvideo.customBiddingAlgorithms.patch({
   customBiddingAlgorithmId: 'customBiddingAlgorithmId',
@@ -366,7 +366,7 @@ Lists partners that are accessible to the current user. The order is defined by
 await gapi.client.displayvideo.partners.list({});
 
 /*
-Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.
+Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with `sdfdownloadtasks.operations.get`. Any errors can be found in the error.message. Note that error.details is expected to be empty.
 */
 await gapi.client.displayvideo.sdfdownloadtasks.create({});