summaryrefslogtreecommitdiff
path: root/adservices/service-core/java/com/android/adservices/data/customaudience/CustomAudienceStats.java
blob: 8d4fd2ec8ef17693991907a5c868f36312a9724b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.adservices.data.customaudience;

import android.adservices.common.AdTechIdentifier;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import com.google.auto.value.AutoValue;

/** This class represents the query result for custom audience stats. */
@AutoValue
public abstract class CustomAudienceStats {
    public static final long UNSET_COUNT = -1;

    /** @return the queried owner app's package name, or {@code null} if not set */
    @Nullable
    public abstract String getOwner();

    /** @return the queried buyer ad tech's {@link AdTechIdentifier}, or {@code null} if not set */
    @Nullable
    public abstract AdTechIdentifier getBuyer();

    /**
     * @return the total number of custom audiences in the database, or {@link #UNSET_COUNT} if not
     *     set
     */
    public abstract long getTotalCustomAudienceCount();

    /**
     * @return the number of custom audiences in the database owned by the queried owner app, or
     *     {@link #UNSET_COUNT} if not set
     */
    public abstract long getPerOwnerCustomAudienceCount();

    /**
     * @return the total number of distinct owner apps in the database, or {@link #UNSET_COUNT} if
     *     not set
     */
    public abstract long getTotalOwnerCount();

    /**
     * @return the number of custom audiences in the database associated with the queried buyer ad
     *     tech, or {@link #UNSET_COUNT} if not set
     */
    public abstract long getPerBuyerCustomAudienceCount();

    /**
     * @return the total number of distinct buyer ad techs in the database, or {@link #UNSET_COUNT}
     *     if not set
     */
    public abstract long getTotalBuyerCount();

    /** @return a {@link Builder} for a {@link CustomAudienceStats} object */
    @NonNull
    public static Builder builder() {
        return new AutoValue_CustomAudienceStats.Builder()
                .setTotalCustomAudienceCount(UNSET_COUNT)
                .setPerOwnerCustomAudienceCount(UNSET_COUNT)
                .setTotalOwnerCount(UNSET_COUNT)
                .setPerBuyerCustomAudienceCount(UNSET_COUNT)
                .setTotalBuyerCount(UNSET_COUNT);
    }

    /** Builder class for a {@link CustomAudienceStats} object. */
    @AutoValue.Builder
    public abstract static class Builder {
        /**
         * Sets the owner app's package name which was queried on to create the {@link
         * CustomAudienceStats} object.
         */
        @NonNull
        public abstract Builder setOwner(@Nullable String value);

        /**
         * Sets the buyer ad tech's {@link AdTechIdentifier} which was queried to create the {@link
         * CustomAudienceStats} object.
         */
        @NonNull
        public abstract Builder setBuyer(@Nullable AdTechIdentifier value);

        /** Sets the total number of custom audiences in the database. */
        @NonNull
        public abstract Builder setTotalCustomAudienceCount(long value);

        /** Sets the number of custom audiences in the database owned by the queried owner. */
        @NonNull
        public abstract Builder setPerOwnerCustomAudienceCount(long value);

        /** Sets the total number of distinct owner apps in the database. */
        @NonNull
        public abstract Builder setTotalOwnerCount(long value);

        /**
         * Sets the number of custom audiences in the database associated with the queried buyer ad
         * tech.
         */
        @NonNull
        public abstract Builder setPerBuyerCustomAudienceCount(long value);

        /** Sets the total number of distinct buyer ad techs in the database. */
        @NonNull
        public abstract Builder setTotalBuyerCount(long value);

        /** Builds the {@link CustomAudienceStats} object and returns it. */
        @NonNull
        public abstract CustomAudienceStats build();
    }
}