Skip to content

Deprecate legacy frequency capping schema #3633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
justinchou-google wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Deprecate legacy frequency capping schema #3633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c53826
deprecate legacy frequency capping schema
justinchou-google Apr 1, 2025
fd36059
restore anypromptfrequencycapconfig
justinchou-google Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 1 addition & 44 deletions src/model/auto-prompt-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,6 @@ interface AutoPromptConfigParams {
impressionBackOffSeconds?: number;
maxImpressions?: number;
maxImpressionsResultingHideSeconds?: number;
globalFrequencyCapDurationSeconds?: number;
globalFrequencyCapDurationNano?: number;
promptFrequencyCaps?: {
audienceActionType?: string;
frequencyCapDuration?: {
seconds?: number;
nano?: number;
};
}[];
anyPromptFrequencyCapDurationSeconds?: number;
anyPromptFrequencyCapDurationNano?: number;
}
Expand All @@ -57,9 +48,6 @@ export class AutoPromptConfig {
impressionBackOffSeconds,
maxImpressions,
maxImpressionsResultingHideSeconds,
globalFrequencyCapDurationSeconds,
globalFrequencyCapDurationNano,
promptFrequencyCaps,
anyPromptFrequencyCapDurationSeconds,
anyPromptFrequencyCapDurationNano,
}: AutoPromptConfigParams) {
Expand All @@ -78,22 +66,6 @@ export class AutoPromptConfig {
maxImpressionsResultingHideSeconds
);
this.frequencyCapConfig = new FrequencyCapConfig(
new GlobalFrequencyCap(
new Duration(
globalFrequencyCapDurationSeconds,
globalFrequencyCapDurationNano
)
),
promptFrequencyCaps?.map(
(promptFrequencyCap) =>
new PromptFrequencyCap(
promptFrequencyCap.audienceActionType,
new Duration(
promptFrequencyCap.frequencyCapDuration?.seconds,
promptFrequencyCap.frequencyCapDuration?.nano
)
)
),
new AnyPromptFrequencyCap(
new Duration(
anyPromptFrequencyCapDurationSeconds,
Expand Down Expand Up @@ -140,22 +112,7 @@ export class ImpressionConfig {
* Configuration of Prompt Frequency Capping.
*/
export class FrequencyCapConfig {
constructor(
public readonly globalFrequencyCap?: GlobalFrequencyCap,
public readonly promptFrequencyCaps?: PromptFrequencyCap[],
public readonly anyPromptFrequencyCap?: AnyPromptFrequencyCap
) {}
}

export class GlobalFrequencyCap {
constructor(public readonly frequencyCapDuration?: Duration) {}
}

export class PromptFrequencyCap {
constructor(
public readonly audienceActionType?: string,
public readonly frequencyCapDuration?: Duration
) {}
constructor(public readonly anyPromptFrequencyCap?: AnyPromptFrequencyCap) {}
}

export class AnyPromptFrequencyCap {
Expand Down
1 change: 0 additions & 1 deletion src/runtime/auto-prompt-manager-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1389,7 +1389,6 @@ describes.realWin('AutoPromptManager', (env) => {

beforeEach(() => {
autoPromptConfig = new AutoPromptConfig({
globalFrequencyCapDurationSeconds,
anyPromptFrequencyCapDurationSeconds,
});
const uiPredicates = new UiPredicates(/* canDisplayAutoPrompt */ true);
Expand Down
8 changes: 0 additions & 8 deletions src/runtime/client-config-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,6 @@ export class ClientConfigManager {
maxImpressionsResultingHideSeconds:
autoPromptConfigJson.impressionConfig
?.maxImpressionsResultingHideSeconds,
globalFrequencyCapDurationSeconds:
autoPromptConfigJson.frequencyCapConfig?.globalFrequencyCap
?.frequencyCapDuration?.seconds,
globalFrequencyCapDurationNano:
autoPromptConfigJson.frequencyCapConfig?.globalFrequencyCap
?.frequencyCapDuration?.nano,
promptFrequencyCaps:
autoPromptConfigJson.frequencyCapConfig?.promptFrequencyCaps,
anyPromptFrequencyCapDurationSeconds:
autoPromptConfigJson.frequencyCapConfig?.anyPromptFrequencyCap
?.frequencyCapDuration?.seconds,
Expand Down
Loading