Package com.my.target.common

Class CustomParams

  • public final class CustomParams
extends FPDataProvider
    Allows you to refine your ad request by adding information about the app user

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  CustomParams.Gender
      Constants for gender

    • Constructor Summary

      Constructors 
      Constructor Description
      CustomParams()  

    • Constructor Detail

      • CustomParams

        public CustomParams()

    • Method Detail

      • getMrgsAppId

        @Nullable
public java.lang.String getMrgsAppId()

      • setMrgsAppId

        public void setMrgsAppId​(@Nullable
                         java.lang.String appId)

      • getMrgsUserId

        @Nullable
public java.lang.String getMrgsUserId()

      • setMrgsUserId

        public void setMrgsUserId​(@Nullable
                          java.lang.String userId)

      • getMrgsId

        @Nullable
public java.lang.String getMrgsId()

      • setMrgsId

        public void setMrgsId​(@Nullable
                      java.lang.String mrgsId)

      • getEmail

        @Nullable
public java.lang.String getEmail()
        Returns:
        user email address, if set

      • setEmail

        public void setEmail​(@Nullable
                     java.lang.String email)
        Parameters:
        email - user email address

      • getEmails

        @Nullable
public java.lang.String[] getEmails()
        Returns:
        an array if user emails, if set

      • setEmails

        public void setEmails​(@Nullable
                      java.lang.String[] emails)
        Parameters:
        emails - an array if user emails

      • getIcqId

        @Nullable
public java.lang.String getIcqId()
        Returns:
        user ICQ id, if set

      • setIcqId

        public void setIcqId​(@Nullable
                     java.lang.String id)
        Parameters:
        id - user ICQ id

      • getIcqIds

        @Nullable
public java.lang.String[] getIcqIds()
        Returns:
        an array of user ICQ ids

      • setIcqIds

        public void setIcqIds​(@Nullable
                      java.lang.String[] ids)
        Parameters:
        ids - an array of user ICQ ids

      • getOkId

        @Nullable
public java.lang.String getOkId()
        Returns:
        user ok.ru id, if set

      • setOkId

        public void setOkId​(@Nullable
                    java.lang.String id)
        Parameters:
        id - user ok.ru id

      • getOkIds

        @Nullable
public java.lang.String[] getOkIds()
        Returns:
        an array of user ok.ru ids, if set

      • setOkIds

        public void setOkIds​(@Nullable
                     java.lang.String[] ids)
        Parameters:
        ids - an array of user ok.ru ids

      • getVKId

        @Nullable
public java.lang.String getVKId()
        Returns:
        user vk.com id, if set

      • setVKId

        public void setVKId​(@Nullable
                    java.lang.String id)
        Parameters:
        id - user vk.com id

      • getVKIds

        @Nullable
public java.lang.String[] getVKIds()
        Returns:
        an array of user vk.com id, if set

      • setVKIds

        public void setVKIds​(@Nullable
                     java.lang.String[] ids)
        Parameters:
        ids - an array of user vk.com id

      • collectData

        public void collectData​(@NonNull
                        android.content.Context context)

      • setLang

        public void setLang​(@Nullable
                    java.lang.String lang)
        Sets if user has custom language
        Parameters:
        lang - custom language name

      • getLang

        @Nullable
public java.lang.String getLang()
        Returns:
        user custom language if set

      • setGender

        public void setGender​(int gender)
        Sets user gender info to SDK
        Parameters:
        gender - gender constant.
        See Also:
        CustomParams.Gender

      • getAge

        public int getAge()
        Returns:
        user age, if set

      • setAge

        public void setAge​(int age)
        sets information about user age
        Parameters:
        age - age in years

      • getCustomUserId

        @Nullable
public java.lang.String getCustomUserId()
        Returns:
        custom user ID, if set

      • setCustomUserId

        public void setCustomUserId​(@Nullable
                            java.lang.String id)
        Parameters:
        id - custom user ID

      • getCustomUserIds

        @Nullable
public java.lang.String[] getCustomUserIds()
        Returns:
        an array of custom user IDs if set

      • setCustomUserIds

        public void setCustomUserIds​(@Nullable
                             java.lang.String[] ids)
        Parameters:
        ids - an array of custom user IDs

      • setCustomParam

        public void setCustomParam​(@NonNull
                           java.lang.String key,
                           @Nullable
                           java.lang.String value)
        Custom key-value param will be added to the Ad request
        Parameters:
        key - param key
        value - param value

      • getCustomParam

        @Nullable
public java.lang.String getCustomParam​(@NonNull
                                       java.lang.String key)
        Custom param, set with CustomParams#addParam(String, String). If no such param returns null
        Parameters:
        key - param key
        Returns:
        param value

      • putCustomDataToMap

        public void putCustomDataToMap​(@NonNull
                               java.util.Map<java.lang.String,​java.lang.String> destination)
        Parameters:
        destination - is a map where custom parameters will be added