com.facebook.ads.sdk

Class APIRequest<T extends APINode>

java.lang.Object

com.facebook.ads.sdk.APIRequest<T>

Direct Known Subclasses:

Ad.APIRequestCreateAdLabel, Ad.APIRequestDelete, Ad.APIRequestDeleteAdLabels, Ad.APIRequestGet, Ad.APIRequestGetAdCreatives, Ad.APIRequestGetInsights, Ad.APIRequestGetInsightsAsync, Ad.APIRequestGetKeywordStats, Ad.APIRequestGetLeads, Ad.APIRequestGetPreviews, Ad.APIRequestGetTargetingSentenceLines, Ad.APIRequestUpdate, AdAccount.APIRequestCreateAd, AdAccount.APIRequestCreateAdCreative, AdAccount.APIRequestCreateAdImage, AdAccount.APIRequestCreateAdLabel, AdAccount.APIRequestCreateAdPlacePageSet, AdAccount.APIRequestCreateAdRulesLibrary, AdAccount.APIRequestCreateAdSet, AdAccount.APIRequestCreateAdsPixel, AdAccount.APIRequestCreateAdVideo, AdAccount.APIRequestCreateAsyncAdRequestSet, AdAccount.APIRequestCreateCampaign, AdAccount.APIRequestCreateCustomAudience, AdAccount.APIRequestCreateCustomConversion, AdAccount.APIRequestCreateOffsitePixel, AdAccount.APIRequestCreateProductAudience, AdAccount.APIRequestCreatePublisherBlockList, AdAccount.APIRequestCreateReachFrequencyPrediction, AdAccount.APIRequestCreateTracking, AdAccount.APIRequestDeleteAdImages, AdAccount.APIRequestDeleteCampaigns, AdAccount.APIRequestDeleteTracking, AdAccount.APIRequestGet, AdAccount.APIRequestGetActivities, AdAccount.APIRequestGetAdAssetFeeds, AdAccount.APIRequestGetAdCreatives, AdAccount.APIRequestGetAdCreativesByLabels, AdAccount.APIRequestGetAdImages, AdAccount.APIRequestGetAdLabels, AdAccount.APIRequestGetAdPlacePageSets, AdAccount.APIRequestGetAdReportRuns, AdAccount.APIRequestGetAdReportSchedules, AdAccount.APIRequestGetAdRulesHistory, AdAccount.APIRequestGetAds, AdAccount.APIRequestGetAdsByLabels, AdAccount.APIRequestGetAdSets, AdAccount.APIRequestGetAdSetsByLabels, AdAccount.APIRequestGetAdsPixels, AdAccount.APIRequestGetAdvertisableApplications, AdAccount.APIRequestGetAdVideos, AdAccount.APIRequestGetApplications, AdAccount.APIRequestGetAsyncAdRequestSets, AdAccount.APIRequestGetBroadTargetingCategories, AdAccount.APIRequestGetCampaigns, AdAccount.APIRequestGetCampaignsByLabels, AdAccount.APIRequestGetCustomAudiences, AdAccount.APIRequestGetCustomAudiencesTos, AdAccount.APIRequestGetDeliveryEstimate, AdAccount.APIRequestGetGeneratePreviews, AdAccount.APIRequestGetInsights, AdAccount.APIRequestGetInsightsAsync, AdAccount.APIRequestGetInstagramAccounts, AdAccount.APIRequestGetLeadGenForms, AdAccount.APIRequestGetMinimumBudgets, AdAccount.APIRequestGetOfflineConversionDataSets, AdAccount.APIRequestGetOffsitePixels, AdAccount.APIRequestGetPartnerCategories, AdAccount.APIRequestGetPartners, AdAccount.APIRequestGetPublisherBlockLists, AdAccount.APIRequestGetRateCard, AdAccount.APIRequestGetReachEstimate, AdAccount.APIRequestGetReachFrequencyPredictions, AdAccount.APIRequestGetRoas, AdAccount.APIRequestGetTargetingBrowse, AdAccount.APIRequestGetTargetingSearch, AdAccount.APIRequestGetTargetingSentenceLines, AdAccount.APIRequestGetTargetingSuggestions, AdAccount.APIRequestGetTargetingValidation, AdAccount.APIRequestGetTransactions, AdAccount.APIRequestGetUsers, AdAccount.APIRequestUpdate, AdAsyncRequest.APIRequestGet, AdAsyncRequestSet.APIRequestGet, AdAsyncRequestSet.APIRequestGetRequests, AdCreative.APIRequestCreateAdLabel, AdCreative.APIRequestDelete, AdCreative.APIRequestDeleteAdLabels, AdCreative.APIRequestGet, AdCreative.APIRequestGetPreviews, AdCreative.APIRequestUpdate, AdImage.APIRequestGet, AdLabel.APIRequestDelete, AdLabel.APIRequestGet, AdLabel.APIRequestGetAdCreatives, AdLabel.APIRequestGetAds, AdLabel.APIRequestGetAdSets, AdLabel.APIRequestGetCampaigns, AdLabel.APIRequestUpdate, AdPlacePageSet.APIRequestGet, AdPlacePageSet.APIRequestUpdate, AdReportRun.APIRequestGet, AdReportRun.APIRequestGetInsights, AdRule.APIRequestDelete, AdRule.APIRequestGet, AdRule.APIRequestGetHistory, AdRule.APIRequestUpdate, AdsDataPartner.APIRequestGet, AdSet.APIRequestCreateAdLabel, AdSet.APIRequestDelete, AdSet.APIRequestDeleteAdLabels, AdSet.APIRequestGet, AdSet.APIRequestGetActivities, AdSet.APIRequestGetAdCreatives, AdSet.APIRequestGetAds, AdSet.APIRequestGetAsyncAdRequests, AdSet.APIRequestGetCopies, AdSet.APIRequestGetDeliveryEstimate, AdSet.APIRequestGetInsights, AdSet.APIRequestGetInsightsAsync, AdSet.APIRequestGetTargetingSentenceLines, AdSet.APIRequestUpdate, AdsPixel.APIRequestGet, AdsPixel.APIRequestGetAudiences, AdsPixel.APIRequestGetSharedAccounts, AdsPixel.APIRequestGetSharedAgencies, AdsPixel.APIRequestGetStats, AdsPixel.APIRequestUpdate, AdStudy.APIRequestCreateObjective, AdStudy.APIRequestGet, AdStudyCell.APIRequestGet, AdStudyObjective.APIRequestGet, AppLinks.APIRequestGet, Business.APIRequestCreateAdAccount, Business.APIRequestCreateAdsPixel, Business.APIRequestCreateAdStudy, Business.APIRequestCreateEventSourceGroup, Business.APIRequestCreateMeasurementReport, Business.APIRequestCreateOfflineConversionDataSet, Business.APIRequestCreateUserPermission, Business.APIRequestDeleteApps, Business.APIRequestGet, Business.APIRequestGetAdsPixels, Business.APIRequestGetClientAdAccounts, Business.APIRequestGetClientPages, Business.APIRequestGetEventSourceGroups, Business.APIRequestGetGrpPlans, Business.APIRequestGetInstagramAccounts, Business.APIRequestGetMeasurementReports, Business.APIRequestGetOfflineConversionDataSets, Business.APIRequestGetOwnedAdAccounts, Business.APIRequestGetOwnedInstagramAccounts, Business.APIRequestGetOwnedPages, Business.APIRequestGetOwnedPixels, Business.APIRequestGetPendingClientAdAccounts, Business.APIRequestGetPendingOwnedAdAccounts, Business.APIRequestGetPicture, Business.APIRequestGetReceivedAudiencePermissions, Business.APIRequestGetSharedAudiencePermissions, Campaign.APIRequestCreateAdLabel, Campaign.APIRequestDelete, Campaign.APIRequestDeleteAdLabels, Campaign.APIRequestGet, Campaign.APIRequestGetAds, Campaign.APIRequestGetAdSets, Campaign.APIRequestGetCopies, Campaign.APIRequestGetInsights, Campaign.APIRequestGetInsightsAsync, Campaign.APIRequestUpdate, CustomAudience.APIRequestCreateAdAccount, CustomAudience.APIRequestCreateUser, CustomAudience.APIRequestDelete, CustomAudience.APIRequestDeleteAdAccounts, CustomAudience.APIRequestDeleteUsers, CustomAudience.APIRequestGet, CustomAudience.APIRequestGetAdAccounts, CustomAudience.APIRequestGetAds, CustomAudience.APIRequestGetPrefills, CustomAudience.APIRequestGetSessions, CustomAudience.APIRequestUpdate, CustomConversion.APIRequestCreateSharedAgency, CustomConversion.APIRequestDelete, CustomConversion.APIRequestDeleteSharedAgencies, CustomConversion.APIRequestGet, CustomConversion.APIRequestGetActivities, CustomConversion.APIRequestGetStats, CustomConversion.APIRequestUpdate, Domain.APIRequestGet, Event.APIRequestGet, Event.APIRequestGetPicture, EventSourceGroup.APIRequestCreateSharedAccount, EventSourceGroup.APIRequestGet, EventSourceGroup.APIRequestUpdate, ExternalEventSource.APIRequestGet, Hotel.APIRequestCreateHotelRoom, Hotel.APIRequestDelete, Hotel.APIRequestGet, Hotel.APIRequestUpdate, HotelRoom.APIRequestDelete, HotelRoom.APIRequestGet, HotelRoom.APIRequestUpdate, Lead.APIRequestDelete, Lead.APIRequestGet, LeadgenForm.APIRequestCreateTestLead, LeadgenForm.APIRequestDelete, LeadgenForm.APIRequestGet, LeadgenForm.APIRequestGetLeads, LeadGenQuestion.APIRequestGet, OfflineConversionDataSet.APIRequestCreateAdAccount, OfflineConversionDataSet.APIRequestCreateEvent, OfflineConversionDataSet.APIRequestGet, OfflineConversionDataSet.APIRequestGetActivities, OfflineConversionDataSet.APIRequestGetAdAccounts, OfflineConversionDataSet.APIRequestGetStats, OfflineConversionDataSet.APIRequestGetUploads, OffsitePixel.APIRequestCreateAdAccount, OffsitePixel.APIRequestDelete, OffsitePixel.APIRequestDeleteAdAccounts, OffsitePixel.APIRequestGet, OffsitePixel.APIRequestGetAdAccounts, OffsitePixel.APIRequestUpdate, ProductCatalog.APIRequestCreateExternalEventSource, ProductCatalog.APIRequestCreateHomeListing, ProductCatalog.APIRequestCreateHotel, ProductCatalog.APIRequestCreateHotelRoomsBatch, ProductCatalog.APIRequestCreatePricingVariablesBatch, ProductCatalog.APIRequestCreateProduct, ProductCatalog.APIRequestCreateProductFeed, ProductCatalog.APIRequestCreateProductGroup, ProductCatalog.APIRequestCreateProductSet, ProductCatalog.APIRequestCreateVideo, ProductCatalog.APIRequestDelete, ProductCatalog.APIRequestDeleteExternalEventSources, ProductCatalog.APIRequestGet, ProductCatalog.APIRequestGetAgencies, ProductCatalog.APIRequestGetCheckBatchRequestStatus, ProductCatalog.APIRequestGetDestinations, ProductCatalog.APIRequestGetExternalEventSources, ProductCatalog.APIRequestGetFlights, ProductCatalog.APIRequestGetHomeListings, ProductCatalog.APIRequestGetHotelRoomsBatch, ProductCatalog.APIRequestGetHotels, ProductCatalog.APIRequestGetPricingVariablesBatch, ProductCatalog.APIRequestGetProductFeeds, ProductCatalog.APIRequestGetProductGroups, ProductCatalog.APIRequestGetProducts, ProductCatalog.APIRequestGetProductSets, ProductCatalog.APIRequestGetProductSetsBatch, ProductCatalog.APIRequestUpdate, ProductFeed.APIRequestCreateUpload, ProductFeed.APIRequestDelete, ProductFeed.APIRequestGet, ProductFeed.APIRequestGetProducts, ProductFeed.APIRequestGetUploads, ProductFeed.APIRequestUpdate, ProductFeedUpload.APIRequestGet, ProductFeedUpload.APIRequestGetErrors, ProductFeedUploadError.APIRequestGet, ProductFeedUploadError.APIRequestGetSamples, ProductFeedUploadErrorSample.APIRequestGet, ProductGroup.APIRequestCreateProduct, ProductGroup.APIRequestDelete, ProductGroup.APIRequestGet, ProductGroup.APIRequestGetProducts, ProductGroup.APIRequestUpdate, ProductItem.APIRequestDelete, ProductItem.APIRequestGet, ProductItem.APIRequestGetProductSets, ProductItem.APIRequestUpdate, ProductSet.APIRequestDelete, ProductSet.APIRequestGet, ProductSet.APIRequestGetProducts, ProductSet.APIRequestUpdate, ReachFrequencyPrediction.APIRequestGet, User.APIRequestGet, User.APIRequestGetAccounts, User.APIRequestGetAdAccounts, User.APIRequestGetLeadGenForms, User.APIRequestGetPicture, User.APIRequestGetPromotableDomains, User.APIRequestGetPromotableEvents

public class APIRequest<T extends APINode>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIRequest.DefaultRequestExecutor
static interface	APIRequest.IRequestExecutor
static interface	APIRequest.ResponseParser<T extends APINode>

Field Summary

Fields

Modifier and Type	Field and Description
protected APIContext	context
protected String	endpoint
protected String	method
protected String	nodeId
protected List<String>	paramNames
protected Map<String,Object>	params
protected APIRequest.ResponseParser<T>	parser
protected List<String>	returnFields
static String	USER_AGENT
protected boolean	useVideoEndpoint

Constructor Summary

Constructors

Constructor and Description
APIRequest(APIContext context, String nodeId, String endpoint, String method)
APIRequest(APIContext context, String nodeId, String endpoint, String method, APIRequest.ResponseParser<T> parser)
APIRequest(APIContext context, String nodeId, String endpoint, String method, List<String> paramNames)
APIRequest(APIContext context, String nodeId, String endpoint, String method, List<String> paramNames, APIRequest.ResponseParser<T> parser)

Method Summary

Modifier and Type	Method and Description
APIRequest	addToBatch(BatchRequest batch)
APIRequest	addToBatch(BatchRequest batch, String name)
static void	changeRequestExecutor(APIRequest.IRequestExecutor newExecutor)
APIResponse	execute()
APIResponse	execute(Map<String,Object> extraParams)
protected String	executeInternal()
protected String	executeInternal(Map<String,Object> extraParams)
APIContext	getContext()
static APIRequest.IRequestExecutor	getExecutor()
APIResponse	getLastResponse()
static String	joinStringList(List<String> list)
APIResponse	parseResponse(String response)
APIRequest	requestField(String field)
APIRequest	requestField(String field, boolean value)
protected void	requestFieldInternal(String field, boolean value)
APIRequest	requestFields(List<String> fields)
APIRequest	requestFields(List<String> fields, boolean value)
void	setContext(APIContext context)
APIRequest<T>	setParam(String param, Object value)
protected void	setParamInternal(String param, Object value)
APIRequest	setParams(Map<String,Object> params)
protected void	setParamsInternal(Map<String,Object> params)
APIRequest	setUseVideoEndpoint(boolean useVideoEndpoint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_AGENT

public static final String USER_AGENT

See Also:

Constant Field Values

context

protected APIContext context

useVideoEndpoint

protected boolean useVideoEndpoint

nodeId

protected String nodeId

endpoint

protected String endpoint

method

protected String method

paramNames

protected List<String> paramNames

parser

protected APIRequest.ResponseParser<T extends APINode> parser

params

protected Map<String,Object> params

returnFields

protected List<String> returnFields

Constructor Detail

APIRequest

public APIRequest(APIContext context,
                  String nodeId,
                  String endpoint,
                  String method)

APIRequest

public APIRequest(APIContext context,
                  String nodeId,
                  String endpoint,
                  String method,
                  APIRequest.ResponseParser<T> parser)

APIRequest

public APIRequest(APIContext context,
                  String nodeId,
                  String endpoint,
                  String method,
                  List<String> paramNames)

APIRequest

public APIRequest(APIContext context,
                  String nodeId,
                  String endpoint,
                  String method,
                  List<String> paramNames,
                  APIRequest.ResponseParser<T> parser)

Method Detail

changeRequestExecutor

public static void changeRequestExecutor(APIRequest.IRequestExecutor newExecutor)

getExecutor

public static APIRequest.IRequestExecutor getExecutor()

getLastResponse

public APIResponse getLastResponse()

parseResponse

public APIResponse parseResponse(String response)
                          throws APIException

Throws:

APIException

execute

public APIResponse execute()
                    throws APIException

Throws:

APIException

execute

public APIResponse execute(Map<String,Object> extraParams)
                    throws APIException

Throws:

APIException

setParam

public APIRequest<T> setParam(String param,
                              Object value)

setParams

public APIRequest setParams(Map<String,Object> params)

requestFields

public APIRequest requestFields(List<String> fields)

requestFields

public APIRequest requestFields(List<String> fields,
                                boolean value)

requestField

public APIRequest requestField(String field)

requestField

public APIRequest requestField(String field,
                               boolean value)

setUseVideoEndpoint

public APIRequest setUseVideoEndpoint(boolean useVideoEndpoint)

executeInternal

protected String executeInternal()
                          throws APIException

Throws:

APIException

executeInternal

protected String executeInternal(Map<String,Object> extraParams)
                          throws APIException

Throws:

APIException

getContext

public APIContext getContext()

setContext

public void setContext(APIContext context)

setParamInternal

protected void setParamInternal(String param,
                                Object value)

setParamsInternal

protected void setParamsInternal(Map<String,Object> params)

requestFieldInternal

protected void requestFieldInternal(String field,
                                    boolean value)

joinStringList

public static String joinStringList(List<String> list)

addToBatch

public APIRequest addToBatch(BatchRequest batch)

addToBatch

public APIRequest addToBatch(BatchRequest batch,
                             String name)