public interface

AdvertisingIdProvider

 androidx.ads.identifier.provider.AdvertisingIdProvider

Gradle dependencies

compile group: 'androidx.ads', name: 'ads-identifier-provider', version: '1.0.0-alpha04'

  • groupId: androidx.ads
  • artifactId: ads-identifier-provider
  • version: 1.0.0-alpha04

Artifact androidx.ads:ads-identifier-provider:1.0.0-alpha04 it located at Google repository (https://maven.google.com/)

Overview

The class for the AndroidX Advertising ID Provider that should provide the resettable ID and LAT preference should implement this interface. See AdvertisingIdProviderManager for more details.

Note: The implementation of this interface must be completely thread-safe.

Summary

Methods
public java.lang.StringgetId()

Retrieves the Advertising ID.

public booleanisLimitAdTrackingEnabled()

Retrieves whether the user has chosen to limit ad tracking (ads personalization).

Methods

public java.lang.String getId()

Retrieves the Advertising ID.

public boolean isLimitAdTrackingEnabled()

Retrieves whether the user has chosen to limit ad tracking (ads personalization).

Source

/*
 * Copyright 2019 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 androidx.ads.identifier.provider;

import androidx.annotation.NonNull;

/**
 * The class for the AndroidX Advertising ID Provider that should provide the resettable ID and
 * LAT preference should implement this interface.
 *
 * See {@link AdvertisingIdProviderManager} for more details.
 *
 * <p>Note: The implementation of this interface must be completely thread-safe.
 */
public interface AdvertisingIdProvider {
    /** Retrieves the Advertising ID. */
    @NonNull
    String getId();

    /** Retrieves whether the user has chosen to limit ad tracking (ads personalization). */
    boolean isLimitAdTrackingEnabled();
}