AtlasCampaign (com.facebook.business.sdk:facebook-java-business-sdk 5.0.6 API)

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

All Implemented Interfaces:

APIResponse
```
public class AtlasCampaign
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`	`AtlasCampaign.APIRequestGet`
`static class`	`AtlasCampaign.APIRequestGetAdSets`
`static class`	`AtlasCampaign.APIRequestGetBusinessUnit`
`static class`	`AtlasCampaign.APIRequestGetMetricsBreakdown`
`static class`	`AtlasCampaign.APIRequestGetSources`
`static class`	`AtlasCampaign.EnumDimensions`
`static class`	`AtlasCampaign.EnumGranularity`

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, header, rawValue

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

Constructor Summary

Constructors
Constructor and Description

AtlasCampaign(Long id, APIContext context)

AtlasCampaign(String id, APIContext context)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AtlasCampaign`	`copyFrom(AtlasCampaign instance)`
`AtlasCampaign`	`fetch()`
`static AtlasCampaign`	`fetchById(Long id, APIContext context)`
`static AtlasCampaign`	`fetchById(String id, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<AtlasCampaign>`	`fetchByIdAsync(Long id, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<AtlasCampaign>`	`fetchByIdAsync(String id, APIContext context)`
`static APINodeList<AtlasCampaign>`	`fetchByIds(List<String> ids, List<String> fields, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<APINodeList<AtlasCampaign>>`	`fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)`
`AtlasCampaign.APIRequestGet`	`get()`
`AtlasCampaign.APIRequestGetAdSets`	`getAdSets()`
`AtlasCampaign.APIRequestGetBusinessUnit`	`getBusinessUnit()`
`APIContext`	`getContext()`
`Object`	`getFieldAdPlatform()`
`String`	`getFieldAlias()`
`Double`	`getFieldCostPer1kImpressions()`
`Double`	`getFieldCostPerClick()`
`Double`	`getFieldCostPerVisit()`
`Object`	`getFieldCreatedBy()`
`String`	`getFieldCreatedDate()`
`Double`	`getFieldDataDrivenConvs()`
`Double`	`getFieldDataDrivenConvsPer1kImpress()`
`Double`	`getFieldDataDrivenConvsPerClick()`
`Double`	`getFieldDataDrivenConvsPerVisit()`
`Double`	`getFieldDataDrivenCpa()`
`Double`	`getFieldDataDrivenNullableConvs()`
`Double`	`getFieldDataDrivenRevenue()`
`Double`	`getFieldDataDrivenRoas()`
`Double`	`getFieldEvenCreditConvs()`
`Double`	`getFieldEvenCreditConvsPer1kImpress()`
`Double`	`getFieldEvenCreditConvsPerClick()`
`Double`	`getFieldEvenCreditConvsPerVisit()`
`Double`	`getFieldEvenCreditCpa()`
`Double`	`getFieldEvenCreditRevenue()`
`Double`	`getFieldEvenCreditRoas()`
`Double`	`getFieldFirstClickConvs()`
`Double`	`getFieldFirstClickConvsPer1kImpress()`
`Double`	`getFieldFirstClickConvsPerClick()`
`Double`	`getFieldFirstClickConvsPerVisit()`
`Double`	`getFieldFirstClickCpa()`
`Double`	`getFieldFirstClickRevenue()`
`Double`	`getFieldFirstClickRoas()`
`Double`	`getFieldFirstTouchConvs()`
`Double`	`getFieldFirstTouchConvsPer1kImpress()`
`Double`	`getFieldFirstTouchConvsPerClick()`
`Double`	`getFieldFirstTouchConvsPerVisit()`
`Double`	`getFieldFirstTouchCpa()`
`Double`	`getFieldFirstTouchRevenue()`
`Double`	`getFieldFirstTouchRoas()`
`String`	`getFieldId()`
`Boolean`	`getFieldIsArchived()`
`Double`	`getFieldLastClickConvs()`
`Double`	`getFieldLastClickConvsPer1kImpress()`
`Double`	`getFieldLastClickConvsPerClick()`
`Double`	`getFieldLastClickConvsPerVisit()`
`Double`	`getFieldLastClickCpa()`
`Double`	`getFieldLastClickRevenue()`
`Double`	`getFieldLastClickRoas()`
`Double`	`getFieldLastClickWithExtrapolationConvs()`
`Double`	`getFieldLastClickWithExtrapolationConvsPer100Clicks()`
`Double`	`getFieldLastClickWithExtrapolationConvsPer1kImpress()`
`Double`	`getFieldLastClickWithExtrapolationConvsPerClick()`
`Double`	`getFieldLastClickWithExtrapolationConvsPerVisit()`
`Double`	`getFieldLastClickWithExtrapolationCpa()`
`Double`	`getFieldLastClickWithExtrapolationRevenue()`
`Double`	`getFieldLastClickWithExtrapolationRoas()`
`Double`	`getFieldLastClickWithExtrapolationUnattributed()`
`Object`	`getFieldLastModifiedBy()`
`String`	`getFieldLastModifiedDate()`
`Double`	`getFieldLastTouchConvs()`
`Double`	`getFieldLastTouchConvsPer1kImpress()`
`Double`	`getFieldLastTouchConvsPerClick()`
`Double`	`getFieldLastTouchConvsPerVisit()`
`Double`	`getFieldLastTouchCpa()`
`Double`	`getFieldLastTouchRevenue()`
`Double`	`getFieldLastTouchRoas()`
`String`	`getFieldName()`
`Double`	`getFieldNetMediaCost()`
`Double`	`getFieldPositional30flConvs()`
`Double`	`getFieldPositional30flConvsPer1kImpress()`
`Double`	`getFieldPositional30flConvsPerClick()`
`Double`	`getFieldPositional30flConvsPerVisit()`
`Double`	`getFieldPositional30flCpa()`
`Double`	`getFieldPositional30flRevenue()`
`Double`	`getFieldPositional30flRoas()`
`Double`	`getFieldPositional40flConvs()`
`Double`	`getFieldPositional40flConvsPer1kImpress()`
`Double`	`getFieldPositional40flConvsPerClick()`
`Double`	`getFieldPositional40flConvsPerVisit()`
`Double`	`getFieldPositional40flCpa()`
`Double`	`getFieldPositional40flRevenue()`
`Double`	`getFieldPositional40flRoas()`
`Long`	`getFieldReportClicks()`
`Double`	`getFieldReportClickThroughRate()`
`Long`	`getFieldReportImpressions()`
`Long`	`getFieldReportVisits()`
`Double`	`getFieldTimeDecay1dayConvs()`
`Double`	`getFieldTimeDecay1dayConvsPer1kImpress()`
`Double`	`getFieldTimeDecay1dayConvsPerClick()`
`Double`	`getFieldTimeDecay1dayConvsPerVisit()`
`Double`	`getFieldTimeDecay1dayCpa()`
`Double`	`getFieldTimeDecay1dayRevenue()`
`Double`	`getFieldTimeDecay1dayRoas()`
`Double`	`getFieldTimeDecay7dayConvs()`
`Double`	`getFieldTimeDecay7dayConvsPer1kImpress()`
`Double`	`getFieldTimeDecay7dayConvsPerClick()`
`Double`	`getFieldTimeDecay7dayConvsPerVisit()`
`Double`	`getFieldTimeDecay7dayCpa()`
`Double`	`getFieldTimeDecay7dayRevenue()`
`Double`	`getFieldTimeDecay7dayRoas()`
`String`	`getFieldType()`
`String`	`getId()`
`AtlasCampaign.APIRequestGetMetricsBreakdown`	`getMetricsBreakdown()`
`static APIRequest.ResponseParser<AtlasCampaign>`	`getParser()`
`AtlasCampaign.APIRequestGetSources`	`getSources()`
`static AtlasCampaign`	`loadJSON(String json, APIContext context, String header)`
`static APINodeList<AtlasCampaign>`	`parseResponse(String json, APIContext context, APIRequest request, String header)`
`void`	`setContext(APIContext context)`
`String`	`toString()`

Methods inherited from class com.facebook.ads.sdk.APINode
getException, getHeader, 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

AtlasCampaign

public AtlasCampaign(Long id,
                     APIContext context)

AtlasCampaign

public AtlasCampaign(String id,
                     APIContext context)

Method Detail

fetch

public AtlasCampaign fetch()
                    throws APIException

Throws:: APIException

fetchById

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

Throws:: APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<AtlasCampaign> fetchByIdAsync(Long id,
                                                                                               APIContext context)
                                                                                        throws APIException

Throws:: APIException

fetchById

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

Throws:: APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<AtlasCampaign> fetchByIdAsync(String id,
                                                                                               APIContext context)
                                                                                        throws APIException

Throws:: APIException

fetchByIds

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

Throws:: APIException

fetchByIdsAsync

public static com.google.common.util.concurrent.ListenableFuture<APINodeList<AtlasCampaign>> fetchByIdsAsync(List<String> ids,
                                                                                                             List<String> fields,
                                                                                                             APIContext context)
                                                                                                      throws APIException

Throws:: APIException

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

getId in class APINode

loadJSON

public static AtlasCampaign loadJSON(String json,
                                     APIContext context,
                                     String header)

parseResponse

public static APINodeList<AtlasCampaign> parseResponse(String json,
                                                       APIContext context,
                                                       APIRequest request,
                                                       String header)
                                                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

getAdSets

public AtlasCampaign.APIRequestGetAdSets getAdSets()

getBusinessUnit

public AtlasCampaign.APIRequestGetBusinessUnit getBusinessUnit()

getMetricsBreakdown

public AtlasCampaign.APIRequestGetMetricsBreakdown getMetricsBreakdown()

getSources

public AtlasCampaign.APIRequestGetSources getSources()

get

public AtlasCampaign.APIRequestGet get()

getFieldAdPlatform
```
public Object getFieldAdPlatform()
```

getFieldAlias
```
public String getFieldAlias()
```

getFieldCostPer1kImpressions

public Double getFieldCostPer1kImpressions()

getFieldCostPerClick
```
public Double getFieldCostPerClick()
```

getFieldCostPerVisit
```
public Double getFieldCostPerVisit()
```

getFieldCreatedBy
```
public Object getFieldCreatedBy()
```

getFieldCreatedDate
```
public String getFieldCreatedDate()
```

getFieldDataDrivenConvs

public Double getFieldDataDrivenConvs()

getFieldDataDrivenConvsPer1kImpress

public Double getFieldDataDrivenConvsPer1kImpress()

getFieldDataDrivenConvsPerClick

public Double getFieldDataDrivenConvsPerClick()

getFieldDataDrivenConvsPerVisit

public Double getFieldDataDrivenConvsPerVisit()

getFieldDataDrivenCpa
```
public Double getFieldDataDrivenCpa()
```

getFieldDataDrivenNullableConvs

public Double getFieldDataDrivenNullableConvs()

getFieldDataDrivenRevenue

public Double getFieldDataDrivenRevenue()

getFieldDataDrivenRoas

public Double getFieldDataDrivenRoas()

getFieldEvenCreditConvs

public Double getFieldEvenCreditConvs()

getFieldEvenCreditConvsPer1kImpress

public Double getFieldEvenCreditConvsPer1kImpress()

getFieldEvenCreditConvsPerClick

public Double getFieldEvenCreditConvsPerClick()

getFieldEvenCreditConvsPerVisit

public Double getFieldEvenCreditConvsPerVisit()

getFieldEvenCreditCpa
```
public Double getFieldEvenCreditCpa()
```

getFieldEvenCreditRevenue

public Double getFieldEvenCreditRevenue()

getFieldEvenCreditRoas

public Double getFieldEvenCreditRoas()

getFieldFirstClickConvs

public Double getFieldFirstClickConvs()

getFieldFirstClickConvsPer1kImpress

public Double getFieldFirstClickConvsPer1kImpress()

getFieldFirstClickConvsPerClick

public Double getFieldFirstClickConvsPerClick()

getFieldFirstClickConvsPerVisit

public Double getFieldFirstClickConvsPerVisit()

getFieldFirstClickCpa
```
public Double getFieldFirstClickCpa()
```

getFieldFirstClickRevenue

public Double getFieldFirstClickRevenue()

getFieldFirstClickRoas

public Double getFieldFirstClickRoas()

getFieldFirstTouchConvs

public Double getFieldFirstTouchConvs()

getFieldFirstTouchConvsPer1kImpress

public Double getFieldFirstTouchConvsPer1kImpress()

getFieldFirstTouchConvsPerClick

public Double getFieldFirstTouchConvsPerClick()

getFieldFirstTouchConvsPerVisit

public Double getFieldFirstTouchConvsPerVisit()

getFieldFirstTouchCpa
```
public Double getFieldFirstTouchCpa()
```

getFieldFirstTouchRevenue

public Double getFieldFirstTouchRevenue()

getFieldFirstTouchRoas

public Double getFieldFirstTouchRoas()

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

getFieldIsArchived
```
public Boolean getFieldIsArchived()
```

getFieldLastClickConvs

public Double getFieldLastClickConvs()

getFieldLastClickConvsPer1kImpress

public Double getFieldLastClickConvsPer1kImpress()

getFieldLastClickConvsPerClick

public Double getFieldLastClickConvsPerClick()

getFieldLastClickConvsPerVisit

public Double getFieldLastClickConvsPerVisit()

getFieldLastClickCpa
```
public Double getFieldLastClickCpa()
```

getFieldLastClickRevenue

public Double getFieldLastClickRevenue()

getFieldLastClickRoas
```
public Double getFieldLastClickRoas()
```

getFieldLastClickWithExtrapolationConvs

public Double getFieldLastClickWithExtrapolationConvs()

getFieldLastClickWithExtrapolationConvsPer100Clicks

public Double getFieldLastClickWithExtrapolationConvsPer100Clicks()

getFieldLastClickWithExtrapolationConvsPer1kImpress

public Double getFieldLastClickWithExtrapolationConvsPer1kImpress()

getFieldLastClickWithExtrapolationConvsPerClick

public Double getFieldLastClickWithExtrapolationConvsPerClick()

getFieldLastClickWithExtrapolationConvsPerVisit

public Double getFieldLastClickWithExtrapolationConvsPerVisit()

getFieldLastClickWithExtrapolationCpa

public Double getFieldLastClickWithExtrapolationCpa()

getFieldLastClickWithExtrapolationRevenue

public Double getFieldLastClickWithExtrapolationRevenue()

getFieldLastClickWithExtrapolationRoas

public Double getFieldLastClickWithExtrapolationRoas()

getFieldLastClickWithExtrapolationUnattributed

public Double getFieldLastClickWithExtrapolationUnattributed()

getFieldLastModifiedBy

public Object getFieldLastModifiedBy()

getFieldLastModifiedDate

public String getFieldLastModifiedDate()

getFieldLastTouchConvs

public Double getFieldLastTouchConvs()

getFieldLastTouchConvsPer1kImpress

public Double getFieldLastTouchConvsPer1kImpress()

getFieldLastTouchConvsPerClick

public Double getFieldLastTouchConvsPerClick()

getFieldLastTouchConvsPerVisit

public Double getFieldLastTouchConvsPerVisit()

getFieldLastTouchCpa
```
public Double getFieldLastTouchCpa()
```

getFieldLastTouchRevenue

public Double getFieldLastTouchRevenue()

getFieldLastTouchRoas
```
public Double getFieldLastTouchRoas()
```

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

getFieldNetMediaCost
```
public Double getFieldNetMediaCost()
```

getFieldPositional30flConvs

public Double getFieldPositional30flConvs()

getFieldPositional30flConvsPer1kImpress

public Double getFieldPositional30flConvsPer1kImpress()

getFieldPositional30flConvsPerClick

public Double getFieldPositional30flConvsPerClick()

getFieldPositional30flConvsPerVisit

public Double getFieldPositional30flConvsPerVisit()

getFieldPositional30flCpa

public Double getFieldPositional30flCpa()

getFieldPositional30flRevenue

public Double getFieldPositional30flRevenue()

getFieldPositional30flRoas

public Double getFieldPositional30flRoas()

getFieldPositional40flConvs

public Double getFieldPositional40flConvs()

getFieldPositional40flConvsPer1kImpress

public Double getFieldPositional40flConvsPer1kImpress()

getFieldPositional40flConvsPerClick

public Double getFieldPositional40flConvsPerClick()

getFieldPositional40flConvsPerVisit

public Double getFieldPositional40flConvsPerVisit()

getFieldPositional40flCpa

public Double getFieldPositional40flCpa()

getFieldPositional40flRevenue

public Double getFieldPositional40flRevenue()

getFieldPositional40flRoas

public Double getFieldPositional40flRoas()

getFieldReportClickThroughRate

public Double getFieldReportClickThroughRate()

getFieldReportClicks
```
public Long getFieldReportClicks()
```

getFieldReportImpressions

public Long getFieldReportImpressions()

getFieldReportVisits
```
public Long getFieldReportVisits()
```

getFieldTimeDecay1dayConvs

public Double getFieldTimeDecay1dayConvs()

getFieldTimeDecay1dayConvsPer1kImpress

public Double getFieldTimeDecay1dayConvsPer1kImpress()

getFieldTimeDecay1dayConvsPerClick

public Double getFieldTimeDecay1dayConvsPerClick()

getFieldTimeDecay1dayConvsPerVisit

public Double getFieldTimeDecay1dayConvsPerVisit()

getFieldTimeDecay1dayCpa

public Double getFieldTimeDecay1dayCpa()

getFieldTimeDecay1dayRevenue

public Double getFieldTimeDecay1dayRevenue()

getFieldTimeDecay1dayRoas

public Double getFieldTimeDecay1dayRoas()

getFieldTimeDecay7dayConvs

public Double getFieldTimeDecay7dayConvs()

getFieldTimeDecay7dayConvsPer1kImpress

public Double getFieldTimeDecay7dayConvsPer1kImpress()

getFieldTimeDecay7dayConvsPerClick

public Double getFieldTimeDecay7dayConvsPerClick()

getFieldTimeDecay7dayConvsPerVisit

public Double getFieldTimeDecay7dayConvsPerVisit()

getFieldTimeDecay7dayCpa

public Double getFieldTimeDecay7dayCpa()

getFieldTimeDecay7dayRevenue

public Double getFieldTimeDecay7dayRevenue()

getFieldTimeDecay7dayRoas

public Double getFieldTimeDecay7dayRoas()

getFieldType
```
public String getFieldType()
```

copyFrom

public AtlasCampaign copyFrom(AtlasCampaign instance)

getParser

public static APIRequest.ResponseParser<AtlasCampaign> getParser()

Class AtlasCampaign

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

AtlasCampaign

AtlasCampaign

Method Detail

fetch

fetchById

fetchByIdAsync

fetchById

fetchByIdAsync

fetchByIds

fetchByIdsAsync

getId

loadJSON

parseResponse

getContext

setContext

toString

getAdSets

getBusinessUnit

getMetricsBreakdown

getSources

get

getFieldAdPlatform

getFieldAlias

getFieldCostPer1kImpressions

getFieldCostPerClick

getFieldCostPerVisit

getFieldCreatedBy

getFieldCreatedDate

getFieldDataDrivenConvs

getFieldDataDrivenConvsPer1kImpress

getFieldDataDrivenConvsPerClick

getFieldDataDrivenConvsPerVisit

getFieldDataDrivenCpa

getFieldDataDrivenNullableConvs

getFieldDataDrivenRevenue

getFieldDataDrivenRoas

getFieldEvenCreditConvs

getFieldEvenCreditConvsPer1kImpress

getFieldEvenCreditConvsPerClick

getFieldEvenCreditConvsPerVisit

getFieldEvenCreditCpa

getFieldEvenCreditRevenue

getFieldEvenCreditRoas

getFieldFirstClickConvs

getFieldFirstClickConvsPer1kImpress

getFieldFirstClickConvsPerClick

getFieldFirstClickConvsPerVisit

getFieldFirstClickCpa

getFieldFirstClickRevenue

getFieldFirstClickRoas

getFieldFirstTouchConvs

getFieldFirstTouchConvsPer1kImpress

getFieldFirstTouchConvsPerClick

getFieldFirstTouchConvsPerVisit

getFieldFirstTouchCpa

getFieldFirstTouchRevenue

getFieldFirstTouchRoas

getFieldId

getFieldIsArchived

getFieldLastClickConvs

getFieldLastClickConvsPer1kImpress

getFieldLastClickConvsPerClick

getFieldLastClickConvsPerVisit

getFieldLastClickCpa

getFieldLastClickRevenue

getFieldLastClickRoas

getFieldLastClickWithExtrapolationConvs

getFieldLastClickWithExtrapolationConvsPer100Clicks

getFieldLastClickWithExtrapolationConvsPer1kImpress