com.facebook.ads.sdk

Class User.APIRequestGetRichMediaDocuments

java.lang.Object

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

com.facebook.ads.sdk.User.APIRequestGetRichMediaDocuments

Enclosing class:

User

public static class User.APIRequestGetRichMediaDocuments
extends APIRequest<Canvas>

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.ads.sdk.APIRequest

APIRequest.DefaultAsyncRequestExecutor, APIRequest.DefaultRequestExecutor, APIRequest.IAsyncRequestExecutor, APIRequest.IRequestExecutor, APIRequest.RequestHelper, APIRequest.ResponseParser<T extends APINode>, APIRequest.ResponseWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	FIELDS
static String[]	PARAMS

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

context, endpoint, method, nodeId, paramNames, params, parser, returnFields, USER_AGENT, useVideoEndpoint

Constructor Summary

Constructors

Constructor and Description
APIRequestGetRichMediaDocuments(String nodeId, APIContext context)

Method Summary

Modifier and Type	Method and Description
APINodeList<Canvas>	execute()
APINodeList<Canvas>	execute(Map<String,Object> extraParams)
com.google.common.util.concurrent.ListenableFuture<APINodeList<Canvas>>	executeAsync()
com.google.common.util.concurrent.ListenableFuture<APINodeList<Canvas>>	executeAsync(Map<String,Object> extraParams)
APINodeList<Canvas>	getLastResponse()
APINodeList<Canvas>	parseResponse(String response, String header)
User.APIRequestGetRichMediaDocuments	requestAllFields()
User.APIRequestGetRichMediaDocuments	requestAllFields(boolean value)
User.APIRequestGetRichMediaDocuments	requestBackgroundColorField()
User.APIRequestGetRichMediaDocuments	requestBackgroundColorField(boolean value)
User.APIRequestGetRichMediaDocuments	requestBodyElementsField()
User.APIRequestGetRichMediaDocuments	requestBodyElementsField(boolean value)
User.APIRequestGetRichMediaDocuments	requestBusinessIdField()
User.APIRequestGetRichMediaDocuments	requestBusinessIdField(boolean value)
User.APIRequestGetRichMediaDocuments	requestCanvasLinkField()
User.APIRequestGetRichMediaDocuments	requestCanvasLinkField(boolean value)
User.APIRequestGetRichMediaDocuments	requestCollectionHeroImageField()
User.APIRequestGetRichMediaDocuments	requestCollectionHeroImageField(boolean value)
User.APIRequestGetRichMediaDocuments	requestCollectionHeroVideoField()
User.APIRequestGetRichMediaDocuments	requestCollectionHeroVideoField(boolean value)
User.APIRequestGetRichMediaDocuments	requestCollectionThumbnailsField()
User.APIRequestGetRichMediaDocuments	requestCollectionThumbnailsField(boolean value)
User.APIRequestGetRichMediaDocuments	requestDynamicSettingField()
User.APIRequestGetRichMediaDocuments	requestDynamicSettingField(boolean value)
User.APIRequestGetRichMediaDocuments	requestElementPayloadField()
User.APIRequestGetRichMediaDocuments	requestElementPayloadField(boolean value)
User.APIRequestGetRichMediaDocuments	requestElementsField()
User.APIRequestGetRichMediaDocuments	requestElementsField(boolean value)
User.APIRequestGetRichMediaDocuments	requestFbBodyElementsField()
User.APIRequestGetRichMediaDocuments	requestFbBodyElementsField(boolean value)
User.APIRequestGetRichMediaDocuments	requestField(String field)
User.APIRequestGetRichMediaDocuments	requestField(String field, boolean value)
User.APIRequestGetRichMediaDocuments	requestFields(List<String> fields)
User.APIRequestGetRichMediaDocuments	requestFields(List<String> fields, boolean value)
User.APIRequestGetRichMediaDocuments	requestIdField()
User.APIRequestGetRichMediaDocuments	requestIdField(boolean value)
User.APIRequestGetRichMediaDocuments	requestIsHiddenField()
User.APIRequestGetRichMediaDocuments	requestIsHiddenField(boolean value)
User.APIRequestGetRichMediaDocuments	requestIsPublishedField()
User.APIRequestGetRichMediaDocuments	requestIsPublishedField(boolean value)
User.APIRequestGetRichMediaDocuments	requestLastEditorField()
User.APIRequestGetRichMediaDocuments	requestLastEditorField(boolean value)
User.APIRequestGetRichMediaDocuments	requestLinkedDocumentsField()
User.APIRequestGetRichMediaDocuments	requestLinkedDocumentsField(boolean value)
User.APIRequestGetRichMediaDocuments	requestNameField()
User.APIRequestGetRichMediaDocuments	requestNameField(boolean value)
User.APIRequestGetRichMediaDocuments	requestOwnerField()
User.APIRequestGetRichMediaDocuments	requestOwnerField(boolean value)
User.APIRequestGetRichMediaDocuments	requestPropertyListField()
User.APIRequestGetRichMediaDocuments	requestPropertyListField(boolean value)
User.APIRequestGetRichMediaDocuments	requestSourceTemplateField()
User.APIRequestGetRichMediaDocuments	requestSourceTemplateField(boolean value)
User.APIRequestGetRichMediaDocuments	requestStoreUrlField()
User.APIRequestGetRichMediaDocuments	requestStoreUrlField(boolean value)
User.APIRequestGetRichMediaDocuments	requestStyleListField()
User.APIRequestGetRichMediaDocuments	requestStyleListField(boolean value)
User.APIRequestGetRichMediaDocuments	requestTagsField()
User.APIRequestGetRichMediaDocuments	requestTagsField(boolean value)
User.APIRequestGetRichMediaDocuments	requestUiPropertyListField()
User.APIRequestGetRichMediaDocuments	requestUiPropertyListField(boolean value)
User.APIRequestGetRichMediaDocuments	requestUnusedBodyElementsField()
User.APIRequestGetRichMediaDocuments	requestUnusedBodyElementsField(boolean value)
User.APIRequestGetRichMediaDocuments	requestUpdateTimeField()
User.APIRequestGetRichMediaDocuments	requestUpdateTimeField(boolean value)
User.APIRequestGetRichMediaDocuments	requestUseRetailerItemIdsField()
User.APIRequestGetRichMediaDocuments	requestUseRetailerItemIdsField(boolean value)
User.APIRequestGetRichMediaDocuments	setParam(String param, Object value)
User.APIRequestGetRichMediaDocuments	setParams(Map<String,Object> params)
User.APIRequestGetRichMediaDocuments	setQuery(String query)

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

addToBatch, addToBatch, addToBatch, changeAsyncRequestExecutor, changeRequestExecutor, executeAsyncBase, executeAsyncBase, executeAsyncInternal, executeAsyncInternal, executeInternal, executeInternal, getAsyncExecutor, getContext, getExecutor, joinStringList, requestFieldInternal, setContext, setOverrideUrl, setParamInternal, setParamsInternal, setUseVideoEndpoint

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS

public static final String[] PARAMS

FIELDS

public static final String[] FIELDS

Constructor Detail

APIRequestGetRichMediaDocuments

public APIRequestGetRichMediaDocuments(String nodeId,
                                       APIContext context)

Method Detail

getLastResponse

public APINodeList<Canvas> getLastResponse()

Overrides:

getLastResponse in class APIRequest<Canvas>

parseResponse

public APINodeList<Canvas> parseResponse(String response,
                                         String header)
                                  throws APIException

Overrides:

parseResponse in class APIRequest<Canvas>

Throws:

APIException

execute

public APINodeList<Canvas> execute()
                            throws APIException

Overrides:

execute in class APIRequest<Canvas>

Throws:

APIException

execute

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

Overrides:

execute in class APIRequest<Canvas>

Throws:

APIException

executeAsync

public com.google.common.util.concurrent.ListenableFuture<APINodeList<Canvas>> executeAsync()
                                                                                     throws APIException

Throws:

APIException

executeAsync

public com.google.common.util.concurrent.ListenableFuture<APINodeList<Canvas>> executeAsync(Map<String,Object> extraParams)
                                                                                     throws APIException

Throws:

APIException

setParam

public User.APIRequestGetRichMediaDocuments setParam(String param,
                                                     Object value)

Overrides:

setParam in class APIRequest<Canvas>

setParams

public User.APIRequestGetRichMediaDocuments setParams(Map<String,Object> params)

Overrides:

setParams in class APIRequest<Canvas>

setQuery

public User.APIRequestGetRichMediaDocuments setQuery(String query)

requestAllFields

public User.APIRequestGetRichMediaDocuments requestAllFields()

requestAllFields

public User.APIRequestGetRichMediaDocuments requestAllFields(boolean value)

requestFields

public User.APIRequestGetRichMediaDocuments requestFields(List<String> fields)

Overrides:

requestFields in class APIRequest<Canvas>

requestFields

public User.APIRequestGetRichMediaDocuments requestFields(List<String> fields,
                                                          boolean value)

Overrides:

requestFields in class APIRequest<Canvas>

requestField

public User.APIRequestGetRichMediaDocuments requestField(String field)

Overrides:

requestField in class APIRequest<Canvas>

requestField

public User.APIRequestGetRichMediaDocuments requestField(String field,
                                                         boolean value)

Overrides:

requestField in class APIRequest<Canvas>

requestBackgroundColorField

public User.APIRequestGetRichMediaDocuments requestBackgroundColorField()

requestBackgroundColorField

public User.APIRequestGetRichMediaDocuments requestBackgroundColorField(boolean value)

requestBodyElementsField

public User.APIRequestGetRichMediaDocuments requestBodyElementsField()

requestBodyElementsField

public User.APIRequestGetRichMediaDocuments requestBodyElementsField(boolean value)

requestBusinessIdField

public User.APIRequestGetRichMediaDocuments requestBusinessIdField()

requestBusinessIdField

public User.APIRequestGetRichMediaDocuments requestBusinessIdField(boolean value)

requestCanvasLinkField

public User.APIRequestGetRichMediaDocuments requestCanvasLinkField()

requestCanvasLinkField

public User.APIRequestGetRichMediaDocuments requestCanvasLinkField(boolean value)

requestCollectionHeroImageField

public User.APIRequestGetRichMediaDocuments requestCollectionHeroImageField()

requestCollectionHeroImageField

public User.APIRequestGetRichMediaDocuments requestCollectionHeroImageField(boolean value)

requestCollectionHeroVideoField

public User.APIRequestGetRichMediaDocuments requestCollectionHeroVideoField()

requestCollectionHeroVideoField

public User.APIRequestGetRichMediaDocuments requestCollectionHeroVideoField(boolean value)

requestCollectionThumbnailsField

public User.APIRequestGetRichMediaDocuments requestCollectionThumbnailsField()

requestCollectionThumbnailsField

public User.APIRequestGetRichMediaDocuments requestCollectionThumbnailsField(boolean value)

requestDynamicSettingField

public User.APIRequestGetRichMediaDocuments requestDynamicSettingField()

requestDynamicSettingField

public User.APIRequestGetRichMediaDocuments requestDynamicSettingField(boolean value)

requestElementPayloadField

public User.APIRequestGetRichMediaDocuments requestElementPayloadField()

requestElementPayloadField

public User.APIRequestGetRichMediaDocuments requestElementPayloadField(boolean value)

requestElementsField

public User.APIRequestGetRichMediaDocuments requestElementsField()

requestElementsField

public User.APIRequestGetRichMediaDocuments requestElementsField(boolean value)

requestFbBodyElementsField

public User.APIRequestGetRichMediaDocuments requestFbBodyElementsField()

requestFbBodyElementsField

public User.APIRequestGetRichMediaDocuments requestFbBodyElementsField(boolean value)

requestIdField

public User.APIRequestGetRichMediaDocuments requestIdField()

requestIdField

public User.APIRequestGetRichMediaDocuments requestIdField(boolean value)

requestIsHiddenField

public User.APIRequestGetRichMediaDocuments requestIsHiddenField()

requestIsHiddenField

public User.APIRequestGetRichMediaDocuments requestIsHiddenField(boolean value)

requestIsPublishedField

public User.APIRequestGetRichMediaDocuments requestIsPublishedField()

requestIsPublishedField

public User.APIRequestGetRichMediaDocuments requestIsPublishedField(boolean value)

requestLastEditorField

public User.APIRequestGetRichMediaDocuments requestLastEditorField()

requestLastEditorField

public User.APIRequestGetRichMediaDocuments requestLastEditorField(boolean value)

requestLinkedDocumentsField

public User.APIRequestGetRichMediaDocuments requestLinkedDocumentsField()

requestLinkedDocumentsField

public User.APIRequestGetRichMediaDocuments requestLinkedDocumentsField(boolean value)

requestNameField

public User.APIRequestGetRichMediaDocuments requestNameField()

requestNameField

public User.APIRequestGetRichMediaDocuments requestNameField(boolean value)

requestOwnerField

public User.APIRequestGetRichMediaDocuments requestOwnerField()

requestOwnerField

public User.APIRequestGetRichMediaDocuments requestOwnerField(boolean value)

requestPropertyListField

public User.APIRequestGetRichMediaDocuments requestPropertyListField()

requestPropertyListField

public User.APIRequestGetRichMediaDocuments requestPropertyListField(boolean value)

requestSourceTemplateField

public User.APIRequestGetRichMediaDocuments requestSourceTemplateField()

requestSourceTemplateField

public User.APIRequestGetRichMediaDocuments requestSourceTemplateField(boolean value)

requestStoreUrlField

public User.APIRequestGetRichMediaDocuments requestStoreUrlField()

requestStoreUrlField

public User.APIRequestGetRichMediaDocuments requestStoreUrlField(boolean value)

requestStyleListField

public User.APIRequestGetRichMediaDocuments requestStyleListField()

requestStyleListField

public User.APIRequestGetRichMediaDocuments requestStyleListField(boolean value)

requestTagsField

public User.APIRequestGetRichMediaDocuments requestTagsField()

requestTagsField

public User.APIRequestGetRichMediaDocuments requestTagsField(boolean value)

requestUiPropertyListField

public User.APIRequestGetRichMediaDocuments requestUiPropertyListField()

requestUiPropertyListField

public User.APIRequestGetRichMediaDocuments requestUiPropertyListField(boolean value)

requestUnusedBodyElementsField

public User.APIRequestGetRichMediaDocuments requestUnusedBodyElementsField()

requestUnusedBodyElementsField

public User.APIRequestGetRichMediaDocuments requestUnusedBodyElementsField(boolean value)

requestUpdateTimeField

public User.APIRequestGetRichMediaDocuments requestUpdateTimeField()

requestUpdateTimeField

public User.APIRequestGetRichMediaDocuments requestUpdateTimeField(boolean value)

requestUseRetailerItemIdsField

public User.APIRequestGetRichMediaDocuments requestUseRetailerItemIdsField()

requestUseRetailerItemIdsField

public User.APIRequestGetRichMediaDocuments requestUseRetailerItemIdsField(boolean value)