AdSet (com.facebook.ads.sdk:facebook-java-ads-sdk 2.11.1 API)

java.lang.Object
- com.facebook.ads.sdk.APINode
- - com.facebook.ads.sdk.AdSet

All Implemented Interfaces:

APIResponse
```
public class AdSet
extends APINode
```
This class is auto-generated. For any issues or feature requests related to this class, please let us know on github and we'll fix in our codegen framework. We'll not be able to accept pull request for this class.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AdSet.APIRequestCreateAdLabel`
`static class`	`AdSet.APIRequestDelete`
`static class`	`AdSet.APIRequestDeleteAdLabels`
`static class`	`AdSet.APIRequestGet`
`static class`	`AdSet.APIRequestGetActivities`
`static class`	`AdSet.APIRequestGetAdCreatives`
`static class`	`AdSet.APIRequestGetAds`
`static class`	`AdSet.APIRequestGetAsyncAdRequests`
`static class`	`AdSet.APIRequestGetCopies`
`static class`	`AdSet.APIRequestGetDeliveryEstimate`
`static class`	`AdSet.APIRequestGetInsights`
`static class`	`AdSet.APIRequestGetInsightsAsync`
`static class`	`AdSet.APIRequestGetTargetingSentenceLines`
`static class`	`AdSet.APIRequestUpdate`
`static class`	`AdSet.EnumBillingEvent`
`static class`	`AdSet.EnumConfiguredStatus`
`static class`	`AdSet.EnumDatePreset`
`static class`	`AdSet.EnumDestinationType`
`static class`	`AdSet.EnumEffectiveStatus`
`static class`	`AdSet.EnumExecutionOptions`
`static class`	`AdSet.EnumOperator`
`static class`	`AdSet.EnumOptimizationGoal`
`static class`	`AdSet.EnumStatus`

Field Summary

Fields
Modifier and Type Field and Description

protected static com.google.gson.Gson gson
- Fields inherited from class com.facebook.ads.sdk.APINode
  context, rawValue

Fields
Modifier and Type	Field and Description
`protected static com.google.gson.Gson`	`gson`

Constructor Summary

Constructors
Constructor and Description

AdSet()

AdSet(Long id, APIContext context)

AdSet(String id, APIContext context)

Constructors
Constructor and Description
`AdSet()`
`AdSet(Long id, APIContext context)`
`AdSet(String id, APIContext context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdSet`	`copyFrom(AdSet instance)`
`AdSet.APIRequestCreateAdLabel`	`createAdLabel()`
`AdSet.APIRequestDelete`	`delete()`
`AdSet.APIRequestDeleteAdLabels`	`deleteAdLabels()`
`AdSet`	`fetch()`
`static AdSet`	`fetchById(Long id, APIContext context)`
`static AdSet`	`fetchById(String id, APIContext context)`
`static APINodeList<AdSet>`	`fetchByIds(List<String> ids, List<String> fields, APIContext context)`
`AdSet.APIRequestGet`	`get()`
`AdSet.APIRequestGetActivities`	`getActivities()`
`AdSet.APIRequestGetAdCreatives`	`getAdCreatives()`
`AdSet.APIRequestGetAds`	`getAds()`
`AdSet.APIRequestGetAsyncAdRequests`	`getAsyncAdRequests()`
`APIContext`	`getContext()`
`AdSet.APIRequestGetCopies`	`getCopies()`
`AdSet.APIRequestGetDeliveryEstimate`	`getDeliveryEstimate()`
`String`	`getFieldAccountId()`
`List<AdLabel>`	`getFieldAdlabels()`
`List<DayPart>`	`getFieldAdsetSchedule()`
`List<Object>`	`getFieldAttributionSpec()`
`Long`	`getFieldBidAmount()`
`Map<String,Long>`	`getFieldBidInfo()`
`AdSet.EnumBillingEvent`	`getFieldBillingEvent()`
`String`	`getFieldBudgetRemaining()`
`Campaign`	`getFieldCampaign()`
`String`	`getFieldCampaignId()`
`AdSet.EnumConfiguredStatus`	`getFieldConfiguredStatus()`
`String`	`getFieldCreatedTime()`
`List<String>`	`getFieldCreativeSequence()`
`String`	`getFieldDailyBudget()`
`String`	`getFieldDestinationType()`
`AdSet.EnumEffectiveStatus`	`getFieldEffectiveStatus()`
`String`	`getFieldEndTime()`
`List<Object>`	`getFieldFrequencyControlSpecs()`
`String`	`getFieldId()`
`String`	`getFieldInstagramActorId()`
`Boolean`	`getFieldIsAutobid()`
`Boolean`	`getFieldIsAveragePricePacing()`
`String`	`getFieldLifetimeBudget()`
`Long`	`getFieldLifetimeImps()`
`String`	`getFieldName()`
`AdSet.EnumOptimizationGoal`	`getFieldOptimizationGoal()`
`List<String>`	`getFieldPacingType()`
`AdPromotedObject`	`getFieldPromotedObject()`
`List<AdRecommendation>`	`getFieldRecommendations()`
`Boolean`	`getFieldRecurringBudgetSemantics()`
`String`	`getFieldRfPredictionId()`
`Boolean`	`getFieldRtbFlag()`
`AdSet`	`getFieldSourceAdset()`
`String`	`getFieldSourceAdsetId()`
`String`	`getFieldStartTime()`
`AdSet.EnumStatus`	`getFieldStatus()`
`Targeting`	`getFieldTargeting()`
`List<List<Long>>`	`getFieldTimeBasedAdRotationIdBlocks()`
`List<Long>`	`getFieldTimeBasedAdRotationIntervals()`
`String`	`getFieldUpdatedTime()`
`Boolean`	`getFieldUseNewAppClick()`
`String`	`getId()`
`AdSet.APIRequestGetInsights`	`getInsights()`
`AdSet.APIRequestGetInsightsAsync`	`getInsightsAsync()`
`static APIRequest.ResponseParser<AdSet>`	`getParser()`
`AdSet.APIRequestGetTargetingSentenceLines`	`getTargetingSentenceLines()`
`static AdSet`	`loadJSON(String json, APIContext context)`
`static APINodeList<AdSet>`	`parseResponse(String json, APIContext context, APIRequest request)`
`void`	`setContext(APIContext context)`
`AdSet`	`setFieldAccountId(String value)`
`AdSet`	`setFieldAdlabels(List<AdLabel> value)`
`AdSet`	`setFieldAdlabels(String value)`
`AdSet`	`setFieldAdsetSchedule(List<DayPart> value)`
`AdSet`	`setFieldAdsetSchedule(String value)`
`AdSet`	`setFieldAttributionSpec(List<Object> value)`
`AdSet`	`setFieldBidAmount(Long value)`
`AdSet`	`setFieldBidInfo(Map<String,Long> value)`
`AdSet`	`setFieldBillingEvent(AdSet.EnumBillingEvent value)`
`AdSet`	`setFieldBudgetRemaining(String value)`
`AdSet`	`setFieldCampaign(Campaign value)`
`AdSet`	`setFieldCampaign(String value)`
`AdSet`	`setFieldCampaignId(String value)`
`AdSet`	`setFieldConfiguredStatus(AdSet.EnumConfiguredStatus value)`
`AdSet`	`setFieldCreatedTime(String value)`
`AdSet`	`setFieldCreativeSequence(List<String> value)`
`AdSet`	`setFieldDailyBudget(String value)`
`AdSet`	`setFieldDestinationType(String value)`
`AdSet`	`setFieldEffectiveStatus(AdSet.EnumEffectiveStatus value)`
`AdSet`	`setFieldEndTime(String value)`
`AdSet`	`setFieldFrequencyControlSpecs(List<Object> value)`
`AdSet`	`setFieldId(String value)`
`AdSet`	`setFieldInstagramActorId(String value)`
`AdSet`	`setFieldIsAutobid(Boolean value)`
`AdSet`	`setFieldIsAveragePricePacing(Boolean value)`
`AdSet`	`setFieldLifetimeBudget(String value)`
`AdSet`	`setFieldLifetimeImps(Long value)`
`AdSet`	`setFieldName(String value)`
`AdSet`	`setFieldOptimizationGoal(AdSet.EnumOptimizationGoal value)`
`AdSet`	`setFieldPacingType(List<String> value)`
`AdSet`	`setFieldPromotedObject(AdPromotedObject value)`
`AdSet`	`setFieldPromotedObject(String value)`
`AdSet`	`setFieldRecommendations(List<AdRecommendation> value)`
`AdSet`	`setFieldRecommendations(String value)`
`AdSet`	`setFieldRecurringBudgetSemantics(Boolean value)`
`AdSet`	`setFieldRfPredictionId(String value)`
`AdSet`	`setFieldRtbFlag(Boolean value)`
`AdSet`	`setFieldSourceAdset(AdSet value)`
`AdSet`	`setFieldSourceAdset(String value)`
`AdSet`	`setFieldSourceAdsetId(String value)`
`AdSet`	`setFieldStartTime(String value)`
`AdSet`	`setFieldStatus(AdSet.EnumStatus value)`
`AdSet`	`setFieldTargeting(String value)`
`AdSet`	`setFieldTargeting(Targeting value)`
`AdSet`	`setFieldTimeBasedAdRotationIdBlocks(List<List<Long>> value)`
`AdSet`	`setFieldTimeBasedAdRotationIntervals(List<Long> value)`
`AdSet`	`setFieldUpdatedTime(String value)`
`AdSet`	`setFieldUseNewAppClick(Boolean value)`
`String`	`toString()`
`AdSet.APIRequestUpdate`	`update()`

Methods inherited from class com.facebook.ads.sdk.APINode
getException, getRawResponse, getRawResponseAsJsonObject, getRawValue, head, parseResponse

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

gson

protected static com.google.gson.Gson gson

Constructor Detail

AdSet
```
public AdSet()
```

AdSet

public AdSet(Long id,
             APIContext context)

AdSet

public AdSet(String id,
             APIContext context)

Method Detail

fetch

public AdSet fetch()
            throws APIException

Throws:: APIException

fetchById

public static AdSet fetchById(Long id,
                              APIContext context)
                       throws APIException

Throws:: APIException

fetchById

public static AdSet fetchById(String id,
                              APIContext context)
                       throws APIException

Throws:: APIException

fetchByIds

public static APINodeList<AdSet> fetchByIds(List<String> ids,
                                            List<String> fields,
                                            APIContext context)
                                     throws APIException

Throws:: APIException

getId
```
public String getId()
```
Overrides:

getId in class APINode

loadJSON

public static AdSet loadJSON(String json,
                             APIContext context)

parseResponse

public static APINodeList<AdSet> parseResponse(String json,
                                               APIContext context,
                                               APIRequest request)
                                        throws APIException.MalformedResponseException

Throws:: APIException.MalformedResponseException

getContext
```
public APIContext getContext()
```
Overrides:

getContext in class APINode

setContext

public void setContext(APIContext context)

Overrides:: setContext in class APINode

toString
```
public String toString()
```
Overrides:

toString in class APINode

getActivities

public AdSet.APIRequestGetActivities getActivities()

getAdCreatives

public AdSet.APIRequestGetAdCreatives getAdCreatives()

deleteAdLabels

public AdSet.APIRequestDeleteAdLabels deleteAdLabels()

createAdLabel

public AdSet.APIRequestCreateAdLabel createAdLabel()

getAds

public AdSet.APIRequestGetAds getAds()

getAsyncAdRequests

public AdSet.APIRequestGetAsyncAdRequests getAsyncAdRequests()

getCopies

public AdSet.APIRequestGetCopies getCopies()

getDeliveryEstimate

public AdSet.APIRequestGetDeliveryEstimate getDeliveryEstimate()

getInsights

public AdSet.APIRequestGetInsights getInsights()

getInsightsAsync

public AdSet.APIRequestGetInsightsAsync getInsightsAsync()

getTargetingSentenceLines

public AdSet.APIRequestGetTargetingSentenceLines getTargetingSentenceLines()

delete

public AdSet.APIRequestDelete delete()

get
```
public AdSet.APIRequestGet get()
```

update

public AdSet.APIRequestUpdate update()

getFieldAccountId
```
public String getFieldAccountId()
```

setFieldAccountId

public AdSet setFieldAccountId(String value)

getFieldAdlabels

public List<AdLabel> getFieldAdlabels()

setFieldAdlabels

public AdSet setFieldAdlabels(List<AdLabel> value)

setFieldAdlabels

public AdSet setFieldAdlabels(String value)

getFieldAdsetSchedule

public List<DayPart> getFieldAdsetSchedule()

setFieldAdsetSchedule

public AdSet setFieldAdsetSchedule(List<DayPart> value)

setFieldAdsetSchedule

public AdSet setFieldAdsetSchedule(String value)

getFieldAttributionSpec

public List<Object> getFieldAttributionSpec()

setFieldAttributionSpec

public AdSet setFieldAttributionSpec(List<Object> value)

getFieldBidAmount
```
public Long getFieldBidAmount()
```

setFieldBidAmount

public AdSet setFieldBidAmount(Long value)

getFieldBidInfo

public Map<String,Long> getFieldBidInfo()

setFieldBidInfo

public AdSet setFieldBidInfo(Map<String,Long> value)

getFieldBillingEvent

public AdSet.EnumBillingEvent getFieldBillingEvent()

setFieldBillingEvent

public AdSet setFieldBillingEvent(AdSet.EnumBillingEvent value)

getFieldBudgetRemaining

public String getFieldBudgetRemaining()

setFieldBudgetRemaining

public AdSet setFieldBudgetRemaining(String value)

getFieldCampaign
```
public Campaign getFieldCampaign()
```

setFieldCampaign

public AdSet setFieldCampaign(Campaign value)

setFieldCampaign

public AdSet setFieldCampaign(String value)

getFieldCampaignId
```
public String getFieldCampaignId()
```

setFieldCampaignId

public AdSet setFieldCampaignId(String value)

getFieldConfiguredStatus

public AdSet.EnumConfiguredStatus getFieldConfiguredStatus()

setFieldConfiguredStatus

public AdSet setFieldConfiguredStatus(AdSet.EnumConfiguredStatus value)

getFieldCreatedTime
```
public String getFieldCreatedTime()
```

setFieldCreatedTime

public AdSet setFieldCreatedTime(String value)

getFieldCreativeSequence

public List<String> getFieldCreativeSequence()

setFieldCreativeSequence

public AdSet setFieldCreativeSequence(List<String> value)

getFieldDailyBudget
```
public String getFieldDailyBudget()
```

setFieldDailyBudget

public AdSet setFieldDailyBudget(String value)

getFieldDestinationType

public String getFieldDestinationType()

setFieldDestinationType

public AdSet setFieldDestinationType(String value)

getFieldEffectiveStatus

public AdSet.EnumEffectiveStatus getFieldEffectiveStatus()

setFieldEffectiveStatus

public AdSet setFieldEffectiveStatus(AdSet.EnumEffectiveStatus value)

getFieldEndTime
```
public String getFieldEndTime()
```

setFieldEndTime

public AdSet setFieldEndTime(String value)

getFieldFrequencyControlSpecs

public List<Object> getFieldFrequencyControlSpecs()

setFieldFrequencyControlSpecs

public AdSet setFieldFrequencyControlSpecs(List<Object> value)

getFieldId
```
public String getFieldId()
```

setFieldId

public AdSet setFieldId(String value)

getFieldInstagramActorId

public String getFieldInstagramActorId()

setFieldInstagramActorId

public AdSet setFieldInstagramActorId(String value)

getFieldIsAutobid
```
public Boolean getFieldIsAutobid()
```

setFieldIsAutobid

public AdSet setFieldIsAutobid(Boolean value)

getFieldIsAveragePricePacing

public Boolean getFieldIsAveragePricePacing()

setFieldIsAveragePricePacing

public AdSet setFieldIsAveragePricePacing(Boolean value)

getFieldLifetimeBudget

public String getFieldLifetimeBudget()

setFieldLifetimeBudget

public AdSet setFieldLifetimeBudget(String value)

getFieldLifetimeImps
```
public Long getFieldLifetimeImps()
```

setFieldLifetimeImps

public AdSet setFieldLifetimeImps(Long value)

getFieldName
```
public String getFieldName()
```

setFieldName

public AdSet setFieldName(String value)

getFieldOptimizationGoal

public AdSet.EnumOptimizationGoal getFieldOptimizationGoal()

setFieldOptimizationGoal

public AdSet setFieldOptimizationGoal(AdSet.EnumOptimizationGoal value)

getFieldPacingType

public List<String> getFieldPacingType()

setFieldPacingType

public AdSet setFieldPacingType(List<String> value)

getFieldPromotedObject

public AdPromotedObject getFieldPromotedObject()

setFieldPromotedObject

public AdSet setFieldPromotedObject(AdPromotedObject value)

setFieldPromotedObject

public AdSet setFieldPromotedObject(String value)

getFieldRecommendations

public List<AdRecommendation> getFieldRecommendations()

setFieldRecommendations

public AdSet setFieldRecommendations(List<AdRecommendation> value)

setFieldRecommendations

public AdSet setFieldRecommendations(String value)

getFieldRecurringBudgetSemantics

public Boolean getFieldRecurringBudgetSemantics()

setFieldRecurringBudgetSemantics

public AdSet setFieldRecurringBudgetSemantics(Boolean value)

getFieldRfPredictionId

public String getFieldRfPredictionId()

setFieldRfPredictionId

public AdSet setFieldRfPredictionId(String value)

getFieldRtbFlag
```
public Boolean getFieldRtbFlag()
```

setFieldRtbFlag

public AdSet setFieldRtbFlag(Boolean value)

getFieldSourceAdset
```
public AdSet getFieldSourceAdset()
```

setFieldSourceAdset

public AdSet setFieldSourceAdset(AdSet value)

setFieldSourceAdset

public AdSet setFieldSourceAdset(String value)

getFieldSourceAdsetId
```
public String getFieldSourceAdsetId()
```

setFieldSourceAdsetId

public AdSet setFieldSourceAdsetId(String value)

getFieldStartTime
```
public String getFieldStartTime()
```

setFieldStartTime

public AdSet setFieldStartTime(String value)

getFieldStatus

public AdSet.EnumStatus getFieldStatus()

setFieldStatus

public AdSet setFieldStatus(AdSet.EnumStatus value)

getFieldTargeting
```
public Targeting getFieldTargeting()
```

setFieldTargeting

public AdSet setFieldTargeting(Targeting value)

setFieldTargeting

public AdSet setFieldTargeting(String value)

getFieldTimeBasedAdRotationIdBlocks

public List<List<Long>> getFieldTimeBasedAdRotationIdBlocks()

setFieldTimeBasedAdRotationIdBlocks

public AdSet setFieldTimeBasedAdRotationIdBlocks(List<List<Long>> value)

getFieldTimeBasedAdRotationIntervals

public List<Long> getFieldTimeBasedAdRotationIntervals()

setFieldTimeBasedAdRotationIntervals

public AdSet setFieldTimeBasedAdRotationIntervals(List<Long> value)

getFieldUpdatedTime
```
public String getFieldUpdatedTime()
```

setFieldUpdatedTime

public AdSet setFieldUpdatedTime(String value)

getFieldUseNewAppClick

public Boolean getFieldUseNewAppClick()

setFieldUseNewAppClick

public AdSet setFieldUseNewAppClick(Boolean value)

copyFrom

public AdSet copyFrom(AdSet instance)

getParser

public static APIRequest.ResponseParser<AdSet> getParser()

Class AdSet

Nested Class Summary

Field Summary

Fields inherited from class com.facebook.ads.sdk.APINode

Constructor Summary

Method Summary

Methods inherited from class com.facebook.ads.sdk.APINode

Methods inherited from class java.lang.Object

Field Detail

gson

Constructor Detail

AdSet

AdSet

AdSet

Method Detail

fetch

fetchById

fetchById

fetchByIds

getId

loadJSON

parseResponse

getContext

setContext

toString

getActivities

getAdCreatives

deleteAdLabels

createAdLabel

getAds

getAsyncAdRequests

getCopies

getDeliveryEstimate

getInsights

getInsightsAsync

getTargetingSentenceLines

delete

get

update

getFieldAccountId

setFieldAccountId

getFieldAdlabels

setFieldAdlabels

setFieldAdlabels

getFieldAdsetSchedule

setFieldAdsetSchedule

setFieldAdsetSchedule

getFieldAttributionSpec

setFieldAttributionSpec

getFieldBidAmount

setFieldBidAmount

getFieldBidInfo

setFieldBidInfo

getFieldBillingEvent

setFieldBillingEvent

getFieldBudgetRemaining

setFieldBudgetRemaining

getFieldCampaign

setFieldCampaign

setFieldCampaign

getFieldCampaignId

setFieldCampaignId

getFieldConfiguredStatus

setFieldConfiguredStatus

getFieldCreatedTime

setFieldCreatedTime

getFieldCreativeSequence

setFieldCreativeSequence

getFieldDailyBudget

setFieldDailyBudget

getFieldDestinationType

setFieldDestinationType

getFieldEffectiveStatus

setFieldEffectiveStatus

getFieldEndTime

setFieldEndTime

getFieldFrequencyControlSpecs

setFieldFrequencyControlSpecs

getFieldId

setFieldId