com.facebook.ads.sdk

Class Canvas.APIRequestGet

java.lang.Object

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

com.facebook.ads.sdk.Canvas.APIRequestGet

Enclosing class:

Canvas

public static class Canvas.APIRequestGet
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
APIRequestGet(String nodeId, APIContext context)

Method Summary

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

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

APIRequestGet

public APIRequestGet(String nodeId,
                     APIContext context)

Method Detail

getLastResponse

public Canvas getLastResponse()

Overrides:

getLastResponse in class APIRequest<Canvas>

parseResponse

public Canvas parseResponse(String response,
                            String header)
                     throws APIException

Overrides:

parseResponse in class APIRequest<Canvas>

Throws:

APIException

execute

public Canvas execute()
               throws APIException

Overrides:

execute in class APIRequest<Canvas>

Throws:

APIException

execute

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

Overrides:

execute in class APIRequest<Canvas>

Throws:

APIException

executeAsync

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

Throws:

APIException

executeAsync

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

Throws:

APIException

setParam

public Canvas.APIRequestGet setParam(String param,
                                     Object value)

Overrides:

setParam in class APIRequest<Canvas>

setParams

public Canvas.APIRequestGet setParams(Map<String,Object> params)

Overrides:

setParams in class APIRequest<Canvas>

requestAllFields

public Canvas.APIRequestGet requestAllFields()

requestAllFields

public Canvas.APIRequestGet requestAllFields(boolean value)

requestFields

public Canvas.APIRequestGet requestFields(List<String> fields)

Overrides:

requestFields in class APIRequest<Canvas>

requestFields

public Canvas.APIRequestGet requestFields(List<String> fields,
                                          boolean value)

Overrides:

requestFields in class APIRequest<Canvas>

requestField

public Canvas.APIRequestGet requestField(String field)

Overrides:

requestField in class APIRequest<Canvas>

requestField

public Canvas.APIRequestGet requestField(String field,
                                         boolean value)

Overrides:

requestField in class APIRequest<Canvas>

requestBackgroundColorField

public Canvas.APIRequestGet requestBackgroundColorField()

requestBackgroundColorField

public Canvas.APIRequestGet requestBackgroundColorField(boolean value)

requestBodyElementsField

public Canvas.APIRequestGet requestBodyElementsField()

requestBodyElementsField

public Canvas.APIRequestGet requestBodyElementsField(boolean value)

requestBusinessIdField

public Canvas.APIRequestGet requestBusinessIdField()

requestBusinessIdField

public Canvas.APIRequestGet requestBusinessIdField(boolean value)

requestCanvasLinkField

public Canvas.APIRequestGet requestCanvasLinkField()

requestCanvasLinkField

public Canvas.APIRequestGet requestCanvasLinkField(boolean value)

requestCollectionHeroImageField

public Canvas.APIRequestGet requestCollectionHeroImageField()

requestCollectionHeroImageField

public Canvas.APIRequestGet requestCollectionHeroImageField(boolean value)

requestCollectionHeroVideoField

public Canvas.APIRequestGet requestCollectionHeroVideoField()

requestCollectionHeroVideoField

public Canvas.APIRequestGet requestCollectionHeroVideoField(boolean value)

requestCollectionThumbnailsField

public Canvas.APIRequestGet requestCollectionThumbnailsField()

requestCollectionThumbnailsField

public Canvas.APIRequestGet requestCollectionThumbnailsField(boolean value)

requestDynamicSettingField

public Canvas.APIRequestGet requestDynamicSettingField()

requestDynamicSettingField

public Canvas.APIRequestGet requestDynamicSettingField(boolean value)

requestElementPayloadField

public Canvas.APIRequestGet requestElementPayloadField()

requestElementPayloadField

public Canvas.APIRequestGet requestElementPayloadField(boolean value)

requestElementsField

public Canvas.APIRequestGet requestElementsField()

requestElementsField

public Canvas.APIRequestGet requestElementsField(boolean value)

requestFbBodyElementsField

public Canvas.APIRequestGet requestFbBodyElementsField()

requestFbBodyElementsField

public Canvas.APIRequestGet requestFbBodyElementsField(boolean value)

requestIdField

public Canvas.APIRequestGet requestIdField()

requestIdField

public Canvas.APIRequestGet requestIdField(boolean value)

requestIsHiddenField

public Canvas.APIRequestGet requestIsHiddenField()

requestIsHiddenField

public Canvas.APIRequestGet requestIsHiddenField(boolean value)

requestIsPublishedField

public Canvas.APIRequestGet requestIsPublishedField()

requestIsPublishedField

public Canvas.APIRequestGet requestIsPublishedField(boolean value)

requestLastEditorField

public Canvas.APIRequestGet requestLastEditorField()

requestLastEditorField

public Canvas.APIRequestGet requestLastEditorField(boolean value)

requestLinkedDocumentsField

public Canvas.APIRequestGet requestLinkedDocumentsField()

requestLinkedDocumentsField

public Canvas.APIRequestGet requestLinkedDocumentsField(boolean value)

requestNameField

public Canvas.APIRequestGet requestNameField()

requestNameField

public Canvas.APIRequestGet requestNameField(boolean value)

requestOwnerField

public Canvas.APIRequestGet requestOwnerField()

requestOwnerField

public Canvas.APIRequestGet requestOwnerField(boolean value)

requestPropertyListField

public Canvas.APIRequestGet requestPropertyListField()

requestPropertyListField

public Canvas.APIRequestGet requestPropertyListField(boolean value)

requestSourceTemplateField

public Canvas.APIRequestGet requestSourceTemplateField()

requestSourceTemplateField

public Canvas.APIRequestGet requestSourceTemplateField(boolean value)

requestStoreUrlField

public Canvas.APIRequestGet requestStoreUrlField()

requestStoreUrlField

public Canvas.APIRequestGet requestStoreUrlField(boolean value)

requestStyleListField

public Canvas.APIRequestGet requestStyleListField()

requestStyleListField

public Canvas.APIRequestGet requestStyleListField(boolean value)

requestTagsField

public Canvas.APIRequestGet requestTagsField()

requestTagsField

public Canvas.APIRequestGet requestTagsField(boolean value)

requestUiPropertyListField

public Canvas.APIRequestGet requestUiPropertyListField()

requestUiPropertyListField

public Canvas.APIRequestGet requestUiPropertyListField(boolean value)

requestUnusedBodyElementsField

public Canvas.APIRequestGet requestUnusedBodyElementsField()

requestUnusedBodyElementsField

public Canvas.APIRequestGet requestUnusedBodyElementsField(boolean value)

requestUpdateTimeField

public Canvas.APIRequestGet requestUpdateTimeField()

requestUpdateTimeField

public Canvas.APIRequestGet requestUpdateTimeField(boolean value)

requestUseRetailerItemIdsField

public Canvas.APIRequestGet requestUseRetailerItemIdsField()

requestUseRetailerItemIdsField

public Canvas.APIRequestGet requestUseRetailerItemIdsField(boolean value)