script-astra/Android/Sdk/sources/android-35/android/adservices/adselection/PersistAdSelectionResultRequest.java

/*
 * Copyright (C) 2023 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 android.adservices.adselection;

import static android.adservices.adselection.AdSelectionOutcome.UNSET_AD_SELECTION_ID;
import static android.adservices.adselection.AdSelectionOutcome.UNSET_AD_SELECTION_ID_MESSAGE;

import android.adservices.common.AdTechIdentifier;
import android.annotation.FlaggedApi;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.OutcomeReceiver;

import com.android.internal.util.Preconditions;

import java.util.Arrays;
import java.util.Objects;
import java.util.concurrent.Executor;

/**
 * Represents a request containing the seller, the ad selection data id and data.
 *
 * <p>Instances of this class are created by SDKs to be provided as arguments to the {@link
 * AdSelectionManager#persistAdSelectionResult} methods in {@link AdSelectionManager}.
 */
public final class PersistAdSelectionResultRequest {
    private final long mAdSelectionId;
    @Nullable private final AdTechIdentifier mSeller;
    @Nullable private final byte[] mAdSelectionResult;

    private PersistAdSelectionResultRequest(
            long adSelectionId,
            @Nullable AdTechIdentifier seller,
            @Nullable byte[] adSelectionResult) {
        this.mAdSelectionId = adSelectionId;
        this.mSeller = seller;
        this.mAdSelectionResult = adSelectionResult;
    }

    /**
     * @return an ad selection id.
     * @deprecated Use the {@link #getAdSelectionDataId()} instead, the underlying value is enforced
     *     to be the same.
     */
    public long getAdSelectionId() {
        return mAdSelectionId;
    }

    /**
     * Returns the id that identifies the {@link
     * AdSelectionManager#getAdSelectionData(GetAdSelectionDataRequest, Executor, OutcomeReceiver)}
     * payload that generated this result.
     */
    @FlaggedApi(
            "com.android.adservices.flags.fledge_auction_server_get_ad_selection_data_id_enabled")
    public long getAdSelectionDataId() {
        return mAdSelectionId;
    }

    /**
     * @return a seller.
     */
    @Nullable
    public AdTechIdentifier getSeller() {
        return mSeller;
    }

    /**
     * @return an ad selection result.
     */
    @Nullable
    public byte[] getAdSelectionResult() {
        if (Objects.isNull(mAdSelectionResult)) {
            return null;
        } else {
            return Arrays.copyOf(mAdSelectionResult, mAdSelectionResult.length);
        }
    }

    /** Builder for {@link PersistAdSelectionResultRequest} objects. */
    public static final class Builder {
        private long mAdSelectionId;
        @Nullable private AdTechIdentifier mSeller;
        @Nullable private byte[] mAdSelectionResult;

        public Builder() {}

        /**
         * Sets the ad selection id {@link Long}.
         *
         * @deprecated Use the {@link #setAdSelectionDataId(long)} instead.
         */
        @NonNull
        public PersistAdSelectionResultRequest.Builder setAdSelectionId(long adSelectionId) {
            this.mAdSelectionId = adSelectionId;
            return this;
        }

        /** Sets the ad selection data id {@link Long}. */
        @NonNull
        @FlaggedApi(
                "com.android.adservices.flags.fledge_auction_server_get_ad_selection_data_id_enabled")
        public PersistAdSelectionResultRequest.Builder setAdSelectionDataId(
                long adSelectionDataId) {
            this.mAdSelectionId = adSelectionDataId;
            return this;
        }

        /** Sets the seller {@link AdTechIdentifier}. */
        @NonNull
        public PersistAdSelectionResultRequest.Builder setSeller(
                @Nullable AdTechIdentifier seller) {
            this.mSeller = seller;
            return this;
        }

        /** Sets the ad selection result {@link String}. */
        @NonNull
        public PersistAdSelectionResultRequest.Builder setAdSelectionResult(
                @Nullable byte[] adSelectionResult) {
            if (!Objects.isNull(adSelectionResult)) {
                this.mAdSelectionResult =
                        Arrays.copyOf(adSelectionResult, adSelectionResult.length);
            } else {
                this.mAdSelectionResult = null;
            }
            return this;
        }

        /**
         * Builds a {@link PersistAdSelectionResultRequest} instance.
         *
         * @throws IllegalArgumentException if the adSelectionIid is not set
         */
        @NonNull
        public PersistAdSelectionResultRequest build() {
            Preconditions.checkArgument(
                    mAdSelectionId != UNSET_AD_SELECTION_ID, UNSET_AD_SELECTION_ID_MESSAGE);

            return new PersistAdSelectionResultRequest(mAdSelectionId, mSeller, mAdSelectionResult);
        }
    }
}