com.facebook.ads.sdk

Class Canvas

java.lang.Object

com.facebook.ads.sdk.APINode

com.facebook.ads.sdk.Canvas

All Implemented Interfaces:

APIResponse

public class Canvas
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	Canvas.APIRequestGet
static class	Canvas.APIRequestGetPreview
static class	Canvas.APIRequestGetPreviews
static class	Canvas.APIRequestUpdate

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
Canvas(Long id, APIContext context)
Canvas(String id, APIContext context)

Method Summary

Modifier and Type	Method and Description
Canvas	copyFrom(Canvas instance)
Canvas	fetch()
static Canvas	fetchById(Long id, APIContext context)
static Canvas	fetchById(String id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<Canvas>	fetchByIdAsync(Long id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<Canvas>	fetchByIdAsync(String id, APIContext context)
static APINodeList<Canvas>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<APINodeList<Canvas>>	fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)
Canvas.APIRequestGet	get()
APIContext	getContext()
String	getFieldBackgroundColor()
List<Object>	getFieldBodyElements()
String	getFieldBusinessId()
String	getFieldCanvasLink()
Photo	getFieldCollectionHeroImage()
AdVideo	getFieldCollectionHeroVideo()
List<CanvasCollectionThumbnail>	getFieldCollectionThumbnails()
CanvasDynamicSetting	getFieldDynamicSetting()
String	getFieldElementPayload()
List<RichMediaElement>	getFieldElements()
List<Object>	getFieldFbBodyElements()
String	getFieldId()
Boolean	getFieldIsHidden()
Boolean	getFieldIsPublished()
User	getFieldLastEditor()
List<Canvas>	getFieldLinkedDocuments()
String	getFieldName()
Page	getFieldOwner()
List<String>	getFieldPropertyList()
CanvasTemplate	getFieldSourceTemplate()
String	getFieldStoreUrl()
List<String>	getFieldStyleList()
List<String>	getFieldTags()
List<String>	getFieldUiPropertyList()
List<Object>	getFieldUnusedBodyElements()
Long	getFieldUpdateTime()
Boolean	getFieldUseRetailerItemIds()
String	getId()
static APIRequest.ResponseParser<Canvas>	getParser()
Canvas.APIRequestGetPreview	getPreview()
Canvas.APIRequestGetPreviews	getPreviews()
static Canvas	loadJSON(String json, APIContext context, String header)
static APINodeList<Canvas>	parseResponse(String json, APIContext context, APIRequest request, String header)
void	setContext(APIContext context)
String	toString()
Canvas.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

Canvas

public Canvas(Long id,
              APIContext context)

Canvas

public Canvas(String id,
              APIContext context)

Method Detail

fetch

public Canvas fetch()
             throws APIException

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchByIds

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

Throws:

APIException

fetchByIdsAsync

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

parseResponse

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

getPreview

public Canvas.APIRequestGetPreview getPreview()

getPreviews

public Canvas.APIRequestGetPreviews getPreviews()

get

public Canvas.APIRequestGet get()

update

public Canvas.APIRequestUpdate update()

getFieldBackgroundColor

public String getFieldBackgroundColor()

getFieldBodyElements

public List<Object> getFieldBodyElements()

getFieldBusinessId

public String getFieldBusinessId()

getFieldCanvasLink

public String getFieldCanvasLink()

getFieldCollectionHeroImage

public Photo getFieldCollectionHeroImage()

getFieldCollectionHeroVideo

public AdVideo getFieldCollectionHeroVideo()

getFieldCollectionThumbnails

public List<CanvasCollectionThumbnail> getFieldCollectionThumbnails()

getFieldDynamicSetting

public CanvasDynamicSetting getFieldDynamicSetting()

getFieldElementPayload

public String getFieldElementPayload()

getFieldElements

public List<RichMediaElement> getFieldElements()

getFieldFbBodyElements

public List<Object> getFieldFbBodyElements()

getFieldId

public String getFieldId()

getFieldIsHidden

public Boolean getFieldIsHidden()

getFieldIsPublished

public Boolean getFieldIsPublished()

getFieldLastEditor

public User getFieldLastEditor()

getFieldLinkedDocuments

public List<Canvas> getFieldLinkedDocuments()

getFieldName

public String getFieldName()

getFieldOwner

public Page getFieldOwner()

getFieldPropertyList

public List<String> getFieldPropertyList()

getFieldSourceTemplate

public CanvasTemplate getFieldSourceTemplate()

getFieldStoreUrl

public String getFieldStoreUrl()

getFieldStyleList

public List<String> getFieldStyleList()

getFieldTags

public List<String> getFieldTags()

getFieldUiPropertyList

public List<String> getFieldUiPropertyList()

getFieldUnusedBodyElements

public List<Object> getFieldUnusedBodyElements()

getFieldUpdateTime

public Long getFieldUpdateTime()

getFieldUseRetailerItemIds

public Boolean getFieldUseRetailerItemIds()

copyFrom

public Canvas copyFrom(Canvas instance)

getParser

public static APIRequest.ResponseParser<Canvas> getParser()