com.facebook.ads.sdk

Class Ad

java.lang.Object

com.facebook.ads.sdk.APINode

com.facebook.ads.sdk.Ad

All Implemented Interfaces:

APIResponse

public class Ad
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	Ad.APIRequestCreateAdLabel
static class	Ad.APIRequestCreateCopy
static class	Ad.APIRequestCreateLead
static class	Ad.APIRequestCreateTrackingTag
static class	Ad.APIRequestDelete
static class	Ad.APIRequestDeleteAdLabels
static class	Ad.APIRequestDeleteTrackingTag
static class	Ad.APIRequestGet
static class	Ad.APIRequestGetAdCreatives
static class	Ad.APIRequestGetAdRulesGoverned
static class	Ad.APIRequestGetCopies
static class	Ad.APIRequestGetInsights
static class	Ad.APIRequestGetInsightsAsync
static class	Ad.APIRequestGetLeads
static class	Ad.APIRequestGetPreviews
static class	Ad.APIRequestGetTargetingSentenceLines
static class	Ad.APIRequestUpdate
static class	Ad.EnumBidType
static class	Ad.EnumConfiguredStatus
static class	Ad.EnumDatePreset
static class	Ad.EnumEffectiveStatus
static class	Ad.EnumExecutionOptions
static class	Ad.EnumOperator
static class	Ad.EnumStatus
static class	Ad.EnumStatusOption

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

Constructor Summary

Constructors

Constructor and Description
Ad(Long id, APIContext context)
Ad(String id, APIContext context)

Method Summary

Modifier and Type	Method and Description
Ad	copyFrom(Ad instance)
Ad.APIRequestCreateAdLabel	createAdLabel()
Ad.APIRequestCreateCopy	createCopy()
Ad.APIRequestCreateLead	createLead()
Ad.APIRequestCreateTrackingTag	createTrackingTag()
Ad.APIRequestDelete	delete()
Ad.APIRequestDeleteAdLabels	deleteAdLabels()
Ad.APIRequestDeleteTrackingTag	deleteTrackingTag()
Ad	fetch()
static Ad	fetchById(Long id, APIContext context)
static Ad	fetchById(String id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<Ad>	fetchByIdAsync(Long id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<Ad>	fetchByIdAsync(String id, APIContext context)
static APINodeList<Ad>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<APINodeList<Ad>>	fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)
Ad.APIRequestGet	get()
Ad.APIRequestGetAdCreatives	getAdCreatives()
Ad.APIRequestGetAdRulesGoverned	getAdRulesGoverned()
APIContext	getContext()
Ad.APIRequestGetCopies	getCopies()
String	getFieldAccountId()
List<AdLabel>	getFieldAdlabels()
AdgroupReviewFeedback	getFieldAdReviewFeedback()
AdSet	getFieldAdset()
String	getFieldAdsetId()
Long	getFieldBidAmount()
Map<String,Long>	getFieldBidInfo()
Ad.EnumBidType	getFieldBidType()
Campaign	getFieldCampaign()
String	getFieldCampaignId()
Ad.EnumConfiguredStatus	getFieldConfiguredStatus()
List<ConversionActionQuery>	getFieldConversionSpecs()
String	getFieldCreatedTime()
AdCreative	getFieldCreative()
String	getFieldDemolinkHash()
Long	getFieldDisplaySequence()
Ad.EnumEffectiveStatus	getFieldEffectiveStatus()
Boolean	getFieldEngagementAudience()
List<DeliveryCheck>	getFieldFailedDeliveryChecks()
String	getFieldId()
Boolean	getFieldIsAutobid()
List<AdgroupIssuesInfo>	getFieldIssuesInfo()
String	getFieldLastUpdatedByAppId()
String	getFieldName()
String	getFieldPreviewShareableLink()
Long	getFieldPriority()
List<AdRecommendation>	getFieldRecommendations()
Ad	getFieldSourceAd()
String	getFieldSourceAdId()
Ad.EnumStatus	getFieldStatus()
Targeting	getFieldTargeting()
TrackingAndConversionWithDefaults	getFieldTrackingAndConversionWithDefaults()
List<ConversionActionQuery>	getFieldTrackingSpecs()
String	getFieldUpdatedTime()
String	getId()
Ad.APIRequestGetInsights	getInsights()
Ad.APIRequestGetInsightsAsync	getInsightsAsync()
Ad.APIRequestGetLeads	getLeads()
static APIRequest.ResponseParser<Ad>	getParser()
Ad.APIRequestGetPreviews	getPreviews()
Ad.APIRequestGetTargetingSentenceLines	getTargetingSentenceLines()
static Ad	loadJSON(String json, APIContext context, String header)
static APINodeList<Ad>	parseResponse(String json, APIContext context, APIRequest request, String header)
void	setContext(APIContext context)
String	toString()
Ad.APIRequestUpdate	update()

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

Ad

public Ad(Long id,
          APIContext context)

Ad

public Ad(String id,
          APIContext context)

Method Detail

fetch

public Ad fetch()
         throws APIException

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchByIds

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

Throws:

APIException

fetchByIdsAsync

public static com.google.common.util.concurrent.ListenableFuture<APINodeList<Ad>> 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 Ad loadJSON(String json,
                          APIContext context,
                          String header)

parseResponse

public static APINodeList<Ad> 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

getAdCreatives

public Ad.APIRequestGetAdCreatives getAdCreatives()

deleteAdLabels

public Ad.APIRequestDeleteAdLabels deleteAdLabels()

createAdLabel

public Ad.APIRequestCreateAdLabel createAdLabel()

getAdRulesGoverned

public Ad.APIRequestGetAdRulesGoverned getAdRulesGoverned()

getCopies

public Ad.APIRequestGetCopies getCopies()

createCopy

public Ad.APIRequestCreateCopy createCopy()

getInsights

public Ad.APIRequestGetInsights getInsights()

getInsightsAsync

public Ad.APIRequestGetInsightsAsync getInsightsAsync()

getLeads

public Ad.APIRequestGetLeads getLeads()

createLead

public Ad.APIRequestCreateLead createLead()

getPreviews

public Ad.APIRequestGetPreviews getPreviews()

getTargetingSentenceLines

public Ad.APIRequestGetTargetingSentenceLines getTargetingSentenceLines()

deleteTrackingTag

public Ad.APIRequestDeleteTrackingTag deleteTrackingTag()

createTrackingTag

public Ad.APIRequestCreateTrackingTag createTrackingTag()

delete

public Ad.APIRequestDelete delete()

get

public Ad.APIRequestGet get()

update

public Ad.APIRequestUpdate update()

getFieldAccountId

public String getFieldAccountId()

getFieldAdReviewFeedback

public AdgroupReviewFeedback getFieldAdReviewFeedback()

getFieldAdlabels

public List<AdLabel> getFieldAdlabels()

getFieldAdset

public AdSet getFieldAdset()

getFieldAdsetId

public String getFieldAdsetId()

getFieldBidAmount

public Long getFieldBidAmount()

getFieldBidInfo

public Map<String,Long> getFieldBidInfo()

getFieldBidType

public Ad.EnumBidType getFieldBidType()

getFieldCampaign

public Campaign getFieldCampaign()

getFieldCampaignId

public String getFieldCampaignId()

getFieldConfiguredStatus

public Ad.EnumConfiguredStatus getFieldConfiguredStatus()

getFieldConversionSpecs

public List<ConversionActionQuery> getFieldConversionSpecs()

getFieldCreatedTime

public String getFieldCreatedTime()

getFieldCreative

public AdCreative getFieldCreative()

getFieldDemolinkHash

public String getFieldDemolinkHash()

getFieldDisplaySequence

public Long getFieldDisplaySequence()

getFieldEffectiveStatus

public Ad.EnumEffectiveStatus getFieldEffectiveStatus()

getFieldEngagementAudience

public Boolean getFieldEngagementAudience()

getFieldFailedDeliveryChecks

public List<DeliveryCheck> getFieldFailedDeliveryChecks()

getFieldId

public String getFieldId()

getFieldIsAutobid

public Boolean getFieldIsAutobid()

getFieldIssuesInfo

public List<AdgroupIssuesInfo> getFieldIssuesInfo()

getFieldLastUpdatedByAppId

public String getFieldLastUpdatedByAppId()

getFieldName

public String getFieldName()

getFieldPreviewShareableLink

public String getFieldPreviewShareableLink()

getFieldPriority

public Long getFieldPriority()

getFieldRecommendations

public List<AdRecommendation> getFieldRecommendations()

getFieldSourceAd

public Ad getFieldSourceAd()

getFieldSourceAdId

public String getFieldSourceAdId()

getFieldStatus

public Ad.EnumStatus getFieldStatus()

getFieldTargeting

public Targeting getFieldTargeting()

getFieldTrackingAndConversionWithDefaults

public TrackingAndConversionWithDefaults getFieldTrackingAndConversionWithDefaults()

getFieldTrackingSpecs

public List<ConversionActionQuery> getFieldTrackingSpecs()

getFieldUpdatedTime

public String getFieldUpdatedTime()

copyFrom

public Ad copyFrom(Ad instance)

getParser

public static APIRequest.ResponseParser<Ad> getParser()