AdVideo (com.facebook.business.sdk:facebook-java-business-sdk 5.0.6 API)

java.lang.Object
- com.facebook.ads.sdk.APINode
- - com.facebook.ads.sdk.AdVideo

All Implemented Interfaces:

APIResponse
```
public class AdVideo
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`	`AdVideo.APIRequestCreateBlockedUser`
`static class`	`AdVideo.APIRequestCreateCaption`
`static class`	`AdVideo.APIRequestCreateComment`
`static class`	`AdVideo.APIRequestCreateLike`
`static class`	`AdVideo.APIRequestCreatePoll`
`static class`	`AdVideo.APIRequestCreatePollSetting`
`static class`	`AdVideo.APIRequestCreateTag`
`static class`	`AdVideo.APIRequestCreateThumbnail`
`static class`	`AdVideo.APIRequestDelete`
`static class`	`AdVideo.APIRequestDeleteCaptions`
`static class`	`AdVideo.APIRequestDeleteLikes`
`static class`	`AdVideo.APIRequestGet`
`static class`	`AdVideo.APIRequestGetAutoGeneratedCaptions`
`static class`	`AdVideo.APIRequestGetCaptions`
`static class`	`AdVideo.APIRequestGetComments`
`static class`	`AdVideo.APIRequestGetCrosspostSharedPages`
`static class`	`AdVideo.APIRequestGetLikes`
`static class`	`AdVideo.APIRequestGetPolls`
`static class`	`AdVideo.APIRequestGetPollSettings`
`static class`	`AdVideo.APIRequestGetReactions`
`static class`	`AdVideo.APIRequestGetSharedPosts`
`static class`	`AdVideo.APIRequestGetSponsorTags`
`static class`	`AdVideo.APIRequestGetTags`
`static class`	`AdVideo.APIRequestGetThumbnails`
`static class`	`AdVideo.APIRequestGetVideoInsights`
`static class`	`AdVideo.APIRequestUpdate`
`static class`	`AdVideo.EnumBackdatedTimeGranularity`
`static class`	`AdVideo.EnumContainerType`
`static class`	`AdVideo.EnumContentCategory`
`static class`	`AdVideo.EnumFormatting`
`static class`	`AdVideo.EnumOriginalProjectionType`
`static class`	`AdVideo.EnumSwapMode`
`static class`	`AdVideo.EnumType`
`static class`	`AdVideo.EnumUnpublishedContentType`
`static class`	`AdVideo.EnumUploadPhase`
`static class`	`AdVideo.EnumValidationAdPlacements`
`static class`	`AdVideo.EnumVideoPollWwwPlacement`

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

Fields
Modifier and Type	Field and Description
`protected static com.google.gson.Gson`	`gson`

Constructor Summary

Constructors
Constructor and Description

AdVideo(Long id, APIContext context)

AdVideo(String id, APIContext context)

Constructors
Constructor and Description
`AdVideo(Long id, APIContext context)`
`AdVideo(String id, APIContext context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdVideo`	`copyFrom(AdVideo instance)`
`AdVideo.APIRequestCreateBlockedUser`	`createBlockedUser()`
`AdVideo.APIRequestCreateCaption`	`createCaption()`
`AdVideo.APIRequestCreateComment`	`createComment()`
`AdVideo.APIRequestCreateLike`	`createLike()`
`AdVideo.APIRequestCreatePoll`	`createPoll()`
`AdVideo.APIRequestCreatePollSetting`	`createPollSetting()`
`AdVideo.APIRequestCreateTag`	`createTag()`
`AdVideo.APIRequestCreateThumbnail`	`createThumbnail()`
`AdVideo.APIRequestDelete`	`delete()`
`AdVideo.APIRequestDeleteCaptions`	`deleteCaptions()`
`AdVideo.APIRequestDeleteLikes`	`deleteLikes()`
`AdVideo`	`fetch()`
`static AdVideo`	`fetchById(Long id, APIContext context)`
`static AdVideo`	`fetchById(String id, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<AdVideo>`	`fetchByIdAsync(Long id, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<AdVideo>`	`fetchByIdAsync(String id, APIContext context)`
`static APINodeList<AdVideo>`	`fetchByIds(List<String> ids, List<String> fields, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<APINodeList<AdVideo>>`	`fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)`
`AdVideo.APIRequestGet`	`get()`
`AdVideo.APIRequestGetAutoGeneratedCaptions`	`getAutoGeneratedCaptions()`
`AdVideo.APIRequestGetCaptions`	`getCaptions()`
`AdVideo.APIRequestGetComments`	`getComments()`
`APIContext`	`getContext()`
`AdVideo.APIRequestGetCrosspostSharedPages`	`getCrosspostSharedPages()`
`List<Long>`	`getFieldAdBreaks()`
`String`	`getFieldBackdatedTime()`
`String`	`getFieldBackdatedTimeGranularity()`
`String`	`getFieldContentCategory()`
`List<String>`	`getFieldContentTags()`
`VideoCopyright`	`getFieldCopyright()`
`String`	`getFieldCopyrightMonitoringStatus()`
`String`	`getFieldCreatedTime()`
`List<String>`	`getFieldCustomLabels()`
`String`	`getFieldDescription()`
`Boolean`	`getFieldEmbeddable()`
`String`	`getFieldEmbedHtml()`
`Event`	`getFieldEvent()`
`Object`	`getFieldExpiration()`
`List<Object>`	`getFieldFormat()`
`Object`	`getFieldFrom()`
`String`	`getFieldIcon()`
`String`	`getFieldId()`
`Boolean`	`getFieldIsCrosspostingEligible()`
`Boolean`	`getFieldIsCrosspostVideo()`
`Boolean`	`getFieldIsEpisode()`
`Boolean`	`getFieldIsInstagramEligible()`
`Boolean`	`getFieldIsReferenceOnly()`
`Double`	`getFieldLength()`
`Long`	`getFieldLiveAudienceCount()`
`String`	`getFieldLiveStatus()`
`MusicVideoCopyright`	`getFieldMusicVideoCopyright()`
`String`	`getFieldPermalinkUrl()`
`String`	`getFieldPicture()`
`Place`	`getFieldPlace()`
`String`	`getFieldPremiereLivingRoomStatus()`
`Privacy`	`getFieldPrivacy()`
`Boolean`	`getFieldPublished()`
`String`	`getFieldScheduledPublishTime()`
`String`	`getFieldSource()`
`Boolean`	`getFieldSpherical()`
`Object`	`getFieldStatus()`
`String`	`getFieldTitle()`
`String`	`getFieldUniversalVideoId()`
`String`	`getFieldUpdatedTime()`
`String`	`getId()`
`AdVideo.APIRequestGetLikes`	`getLikes()`
`static APIRequest.ResponseParser<AdVideo>`	`getParser()`
`AdVideo.APIRequestGetPolls`	`getPolls()`
`AdVideo.APIRequestGetPollSettings`	`getPollSettings()`
`AdVideo.APIRequestGetReactions`	`getReactions()`
`AdVideo.APIRequestGetSharedPosts`	`getSharedPosts()`
`AdVideo.APIRequestGetSponsorTags`	`getSponsorTags()`
`AdVideo.APIRequestGetTags`	`getTags()`
`AdVideo.APIRequestGetThumbnails`	`getThumbnails()`
`AdVideo.APIRequestGetVideoInsights`	`getVideoInsights()`
`static AdVideo`	`loadJSON(String json, APIContext context, String header)`
`static APINodeList<AdVideo>`	`parseResponse(String json, APIContext context, APIRequest request, String header)`
`void`	`setContext(APIContext context)`
`String`	`toString()`
`AdVideo.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

AdVideo

public AdVideo(Long id,
               APIContext context)

AdVideo

public AdVideo(String id,
               APIContext context)

Method Detail

fetch

public AdVideo fetch()
              throws APIException

Throws:: APIException

fetchById

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

Throws:: APIException

fetchByIdAsync

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

Throws:: APIException

fetchById

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

Throws:: APIException

fetchByIdAsync

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

Throws:: APIException

fetchByIds

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

Throws:: APIException

fetchByIdsAsync

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

parseResponse

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

getAutoGeneratedCaptions

public AdVideo.APIRequestGetAutoGeneratedCaptions getAutoGeneratedCaptions()

createBlockedUser

public AdVideo.APIRequestCreateBlockedUser createBlockedUser()

deleteCaptions

public AdVideo.APIRequestDeleteCaptions deleteCaptions()

getCaptions

public AdVideo.APIRequestGetCaptions getCaptions()

createCaption

public AdVideo.APIRequestCreateCaption createCaption()

getComments

public AdVideo.APIRequestGetComments getComments()

createComment

public AdVideo.APIRequestCreateComment createComment()

getCrosspostSharedPages

public AdVideo.APIRequestGetCrosspostSharedPages getCrosspostSharedPages()

deleteLikes

public AdVideo.APIRequestDeleteLikes deleteLikes()

getLikes

public AdVideo.APIRequestGetLikes getLikes()

createLike

public AdVideo.APIRequestCreateLike createLike()

getPollSettings

public AdVideo.APIRequestGetPollSettings getPollSettings()

createPollSetting

public AdVideo.APIRequestCreatePollSetting createPollSetting()

getPolls

public AdVideo.APIRequestGetPolls getPolls()

createPoll

public AdVideo.APIRequestCreatePoll createPoll()

getReactions

public AdVideo.APIRequestGetReactions getReactions()

getSharedPosts

public AdVideo.APIRequestGetSharedPosts getSharedPosts()

getSponsorTags

public AdVideo.APIRequestGetSponsorTags getSponsorTags()

getTags

public AdVideo.APIRequestGetTags getTags()

createTag

public AdVideo.APIRequestCreateTag createTag()

getThumbnails

public AdVideo.APIRequestGetThumbnails getThumbnails()

createThumbnail

public AdVideo.APIRequestCreateThumbnail createThumbnail()

getVideoInsights

public AdVideo.APIRequestGetVideoInsights getVideoInsights()

delete

public AdVideo.APIRequestDelete delete()

get
```
public AdVideo.APIRequestGet get()
```

update

public AdVideo.APIRequestUpdate update()

getFieldAdBreaks
```
public List<Long> getFieldAdBreaks()
```

getFieldBackdatedTime
```
public String getFieldBackdatedTime()
```

getFieldBackdatedTimeGranularity

public String getFieldBackdatedTimeGranularity()

getFieldContentCategory

public String getFieldContentCategory()

getFieldContentTags

public List<String> getFieldContentTags()

getFieldCopyright

public VideoCopyright getFieldCopyright()

getFieldCopyrightMonitoringStatus

public String getFieldCopyrightMonitoringStatus()

getFieldCreatedTime
```
public String getFieldCreatedTime()
```

getFieldCustomLabels

public List<String> getFieldCustomLabels()

getFieldDescription
```
public String getFieldDescription()
```

getFieldEmbedHtml
```
public String getFieldEmbedHtml()
```

getFieldEmbeddable
```
public Boolean getFieldEmbeddable()
```

getFieldEvent
```
public Event getFieldEvent()
```

getFieldExpiration
```
public Object getFieldExpiration()
```

getFieldFormat
```
public List<Object> getFieldFormat()
```

getFieldFrom
```
public Object getFieldFrom()
```

getFieldIcon
```
public String getFieldIcon()
```

getFieldId
```
public String getFieldId()
```

getFieldIsCrosspostVideo

public Boolean getFieldIsCrosspostVideo()

getFieldIsCrosspostingEligible

public Boolean getFieldIsCrosspostingEligible()

getFieldIsEpisode
```
public Boolean getFieldIsEpisode()
```

getFieldIsInstagramEligible

public Boolean getFieldIsInstagramEligible()

getFieldIsReferenceOnly

public Boolean getFieldIsReferenceOnly()

getFieldLength
```
public Double getFieldLength()
```

getFieldLiveAudienceCount

public Long getFieldLiveAudienceCount()

getFieldLiveStatus
```
public String getFieldLiveStatus()
```

getFieldMusicVideoCopyright

public MusicVideoCopyright getFieldMusicVideoCopyright()

getFieldPermalinkUrl
```
public String getFieldPermalinkUrl()
```

getFieldPicture
```
public String getFieldPicture()
```

getFieldPlace
```
public Place getFieldPlace()
```

getFieldPremiereLivingRoomStatus

public String getFieldPremiereLivingRoomStatus()

getFieldPrivacy
```
public Privacy getFieldPrivacy()
```

getFieldPublished
```
public Boolean getFieldPublished()
```

getFieldScheduledPublishTime

public String getFieldScheduledPublishTime()

getFieldSource
```
public String getFieldSource()
```

getFieldSpherical
```
public Boolean getFieldSpherical()
```

getFieldStatus
```
public Object getFieldStatus()
```

getFieldTitle
```
public String getFieldTitle()
```

getFieldUniversalVideoId

public String getFieldUniversalVideoId()

getFieldUpdatedTime
```
public String getFieldUpdatedTime()
```

copyFrom

public AdVideo copyFrom(AdVideo instance)

getParser

public static APIRequest.ResponseParser<AdVideo> getParser()

Class AdVideo

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

gson

Constructor Detail

AdVideo

AdVideo

Method Detail

fetch

fetchById

fetchByIdAsync

fetchById

fetchByIdAsync

fetchByIds

fetchByIdsAsync

getId

loadJSON

parseResponse

getContext

setContext

toString

getAutoGeneratedCaptions

createBlockedUser

deleteCaptions

getCaptions

createCaption

getComments

createComment

getCrosspostSharedPages

deleteLikes

getLikes

createLike

getPollSettings

createPollSetting

getPolls

createPoll

getReactions

getSharedPosts

getSponsorTags

getTags

createTag

getThumbnails

createThumbnail

getVideoInsights

delete

get

update

getFieldAdBreaks

getFieldBackdatedTime

getFieldBackdatedTimeGranularity

getFieldContentCategory

getFieldContentTags

getFieldCopyright

getFieldCopyrightMonitoringStatus

getFieldCreatedTime

getFieldCustomLabels

getFieldDescription

getFieldEmbedHtml

getFieldEmbeddable

getFieldEvent

getFieldExpiration

getFieldFormat

getFieldFrom

getFieldIcon

getFieldId

getFieldIsCrosspostVideo

getFieldIsCrosspostingEligible

getFieldIsEpisode

getFieldIsInstagramEligible

getFieldIsReferenceOnly

getFieldLength

getFieldLiveAudienceCount

getFieldLiveStatus

getFieldMusicVideoCopyright