Serialized Form

Package com.restfb

Class com.restfb.DebugHeaderInfo

class DebugHeaderInfo extends Object implements Serializable

Serialized Fields

adAccountUsage

DebugHeaderInfo.HeaderUsage adAccountUsage

x-ad-account-usage

appUsage

DebugHeaderInfo.HeaderUsage appUsage

x-app-usage

businessUseCaseUsage

DebugHeaderInfo.BusinessUseCaseUsage businessUseCaseUsage

debug

String debug

x-fb-debug

pageUsage

DebugHeaderInfo.HeaderUsage pageUsage

x-page-usage

rev

String rev

x-fb-rev

traceId

String traceId

x-fb-trace-id

usedVersion

Version usedVersion

the use version

Class com.restfb.DebugHeaderInfo.BusinessUseCaseUsage

class BusinessUseCaseUsage extends Object implements Serializable

Serialized Fields

usageMap

Map<String,List<DebugHeaderInfo.InnerBusinessUseCaseUsage>> usageMap

Class com.restfb.DebugHeaderInfo.DebugHeaderInfoFactory

class DebugHeaderInfoFactory extends Object implements Serializable

Serialized Fields

adAccountUsage

String adAccountUsage

appUsage

String appUsage

businessUseCaseUsage

String businessUseCaseUsage

debug

String debug

pageUsage

String pageUsage

rev

String rev

traceId

String traceId

version

Version version

Class com.restfb.DebugHeaderInfo.HeaderUsage

class HeaderUsage extends Object implements Serializable

Serialized Fields

accIdUtilPct

Double accIdUtilPct

adAccountHeader

boolean adAccountHeader

callCount

Integer callCount

percentage

String percentage

percentageOnly

boolean percentageOnly

totalCputime

Integer totalCputime

totalTime

Integer totalTime

Class com.restfb.DebugHeaderInfo.InnerBusinessUseCaseUsage

class InnerBusinessUseCaseUsage extends Object implements Serializable

Serialized Fields

callCount

Integer callCount

Percentage of calls made for this business id/business ad account

estimatedTimeToRegainAccess

Integer estimatedTimeToRegainAccess

Time in minutes to resume calls

totalCputime

Integer totalCputime

Percentage of the total CPU time that has been used

totalTime

Integer totalTime

Percentage of the total time that has been used

type

String type

Type of rate limit logic being applied

Package com.restfb.exception

Exception com.restfb.exception.FacebookCheckedException

class FacebookCheckedException extends Exception implements Serializable

Exception com.restfb.exception.FacebookErrorMessageException

class FacebookErrorMessageException extends FacebookException implements Serializable

serialVersionUID:

1L

Serialized Fields

debugHeaderInfo

DebugHeaderInfo debugHeaderInfo

rawErrorJson

JsonObject rawErrorJson

Exception com.restfb.exception.FacebookException

class FacebookException extends RuntimeException implements Serializable

serialVersionUID:

1L

Exception com.restfb.exception.FacebookGraphException

class FacebookGraphException extends FacebookErrorMessageException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

Integer errorCode

The Facebook API error code.

errorMessage

String errorMessage

The Facebook API error message.

errorSubcode

Integer errorSubcode

The Facebook API error subcode.

errorType

String errorType

The Facebook Graph API error type.

errorUserMessage

String errorUserMessage

The Facebook API error user message.

errorUserTitle

String errorUserTitle

The Facebook API error user title.

httpStatusCode

Integer httpStatusCode

The HTTP status code returned by the server.

isTransient

Boolean isTransient

Exception com.restfb.exception.FacebookJsonMappingException

class FacebookJsonMappingException extends FacebookException implements Serializable

serialVersionUID:

1L

Exception com.restfb.exception.FacebookLoggerException

class FacebookLoggerException extends FacebookException implements Serializable

Exception com.restfb.exception.FacebookNetworkException

class FacebookNetworkException extends FacebookException implements Serializable

serialVersionUID:

1L

Serialized Fields

httpStatusCode

Integer httpStatusCode

The HTTP response status code.

Exception com.restfb.exception.FacebookOAuthException

class FacebookOAuthException extends FacebookGraphException implements Serializable

serialVersionUID:

2L

Exception com.restfb.exception.FacebookPreconditionException

class FacebookPreconditionException extends FacebookException implements Serializable

Exception com.restfb.exception.FacebookQueryParseException

class FacebookQueryParseException extends FacebookGraphException implements Serializable

serialVersionUID:

1L

Exception com.restfb.exception.FacebookResponseContentException

class FacebookResponseContentException extends FacebookException implements Serializable

serialVersionUID:

1L

Exception com.restfb.exception.FacebookResponseStatusException

class FacebookResponseStatusException extends FacebookErrorMessageException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

Integer errorCode

The Facebook API error code.

errorMessage

String errorMessage

The Facebook API error message.

Exception com.restfb.exception.FacebookSignedRequestParsingException

class FacebookSignedRequestParsingException extends FacebookException implements Serializable

Exception com.restfb.exception.FacebookSignedRequestVerificationException

class FacebookSignedRequestVerificationException extends FacebookException implements Serializable

Exception com.restfb.exception.ResponseErrorJsonParsingException

class ResponseErrorJsonParsingException extends Exception implements Serializable

Exception com.restfb.exception.ThreadsApiException

class ThreadsApiException extends FacebookGraphException implements Serializable

Package com.restfb.exception.devicetoken

Exception com.restfb.exception.devicetoken.FacebookDeviceTokenCodeExpiredException

class FacebookDeviceTokenCodeExpiredException extends FacebookDeviceTokenException implements Serializable

Exception com.restfb.exception.devicetoken.FacebookDeviceTokenDeclinedException

class FacebookDeviceTokenDeclinedException extends FacebookDeviceTokenException implements Serializable

Exception com.restfb.exception.devicetoken.FacebookDeviceTokenException

class FacebookDeviceTokenException extends FacebookCheckedException implements Serializable

Exception com.restfb.exception.devicetoken.FacebookDeviceTokenPendingException

class FacebookDeviceTokenPendingException extends FacebookDeviceTokenException implements Serializable

Exception com.restfb.exception.devicetoken.FacebookDeviceTokenSlowdownException

class FacebookDeviceTokenSlowdownException extends FacebookDeviceTokenException implements Serializable

Package com.restfb.json

Class com.restfb.json.JsonArray

class JsonArray extends JsonValue implements Serializable

Serialized Fields

values

List<JsonValue> values

Class com.restfb.json.JsonObject

class JsonObject extends JsonValue implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream inputStream)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

Serialized Fields

names

List<String> names

values

List<JsonValue> values

Class com.restfb.json.JsonValue

class JsonValue extends Object implements Serializable

Class com.restfb.json.Location

class Location extends Object implements Serializable

serialVersionUID:

-1249816104753838044L

Serialized Fields

column

int column

The column number, starting at 1.

line

int line

The line number, starting at 1.

offset

int offset

The absolute character index, starting at 0.

Exception com.restfb.json.ParseException

class ParseException extends RuntimeException implements Serializable

Serialized Fields

location

Location location

Package com.restfb.types

Class com.restfb.types.AbstractFacebookType

class AbstractFacebookType extends Object implements Serializable

serialVersionUID:

1L

Class com.restfb.types.Account

class Account extends Page implements Serializable

serialVersionUID:

1L

Serialized Fields

tasks

List<String> tasks

Class com.restfb.types.Album

class Album extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

canUpload

Boolean canUpload

Whether or not the user has permission to upload to this album.

comments

Comments comments

The comments for this album.

count

Long count

The number of photos in this album.

coverPhoto

Photo coverPhoto

The album cover photo ID.

coverPhotoAsString

String coverPhotoAsString

createdTime

Date createdTime

The time the photo album was initially created.

description

String description

The description of the album.

event

Event event

The event associated with this album.

from

From from

An object containing the ID and name of the profile who posted this album.

likes

Likes likes

People who like this.

link

String link

A link to this album on Facebook.

location

String location

The location of the album.

picture

ProfilePictureSource picture

The album's picture, if provided. To force Facebook to fill the picture field you have to fetch the album with the fields=picture parameter, otherwise the picture is null.

place

Place place

The place associated with this album.

privacy

String privacy

The privacy settings for the album.

updatedTime

Date updatedTime

The last time the photo album was updated.

Class com.restfb.types.Application

class Application extends CategorizedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

androidKeyHash

String androidKeyHash

The app key hash for this app's Android native implementation.

androidSdkErrorCategories

List<Application.MobileSdkErrorCategory> androidSdkErrorCategories

appAdDebugInfo

Application.ApplicationAppAdDebugInfo appAdDebugInfo

App ad related information to help debugging.

appDomains

List<String> appDomains

appEventsFeatureBitmask

Long appEventsFeatureBitmask

Bitmask of on/off settings for various App Events related features.

appInstallTracked

Boolean appInstallTracked

Whether the app install is trackable or not.

appName

String appName

App name.

appType

Long appType

App type.

assetScore

Double assetScore

relevance score of an asset.

authDialogDataHelpUrl

String authDialogDataHelpUrl

The URL of a special landing page that helps people who are using an app begin publishing Open Graph activity

authDialogHeadline

String authDialogHeadline

One line description of an app that appears in the Login Dialog

authDialogPermsExplanation

String authDialogPermsExplanation

The text to explain why an app needs additional permissions. This appears in the Login Dialog

authReferralDefaultActivityPrivacy

String authReferralDefaultActivityPrivacy

The default privacy setting selected for Open Graph activities in the Auth Dialog.

authReferralEnabled

Long authReferralEnabled

Indicates whether Authenticated Referrals are enabled.

authReferralExtendedPerms

List<String> authReferralExtendedPerms

authReferralFriendPerms

List<String> authReferralFriendPerms

authReferralResponseType

String authReferralResponseType

The format that an app receives for the authentication token from the Login Dialog

authReferralUserPerms

List<String> authReferralUserPerms

canvasFluidHeight

Boolean canvasFluidHeight

Indicates whether the app uses fluid or settable height values for Canvas.

canvasFluidWidth

Long canvasFluidWidth

Indicates whether the app uses fluid or fixed width values for Canvas.

canvasUrl

String canvasUrl

The non-secure URL from which Canvas app content is loaded.

company

String company

The company the app belongs to.

configuredIosSso

Boolean configuredIosSso

True if the app has configured Single Sign-On on iOS.

contactEmail

String contactEmail

Email address listed for people using the app to contact developers.

context

Application.ApplicationContext context

Social context for the app.

createdTime

Date createdTime

Timestamp that indicates when the app was created.

creatorUid

String creatorUid

User ID of the creator of this app

dailyActiveUsers

Long dailyActiveUsers

The number of daily active users the app has.

dailyActiveUsersRank

Long dailyActiveUsersRank

Ranking of this app vs other apps comparing daily active users.

deauthCallbackUrl

String deauthCallbackUrl

URL that is pinged whenever a person removes the app.

defaultShareMode

String defaultShareMode

The platform that should be used to share content.

description

String description

The description of the app, as provided by the developer.

gdpv4Enabled

Boolean gdpv4Enabled

Indicates whether Login Version 4 is enabled for this app.

gdpv4NuxContent

String gdpv4NuxContent

Localized content for the login new user experience.

gdpv4NuxEnabled

Boolean gdpv4NuxEnabled

Indicates whether the New User Experience for login button must be shown or not.

hostingUrl

String hostingUrl

Webspace created with one of our hosting partners for this app.

iconUrl

String iconUrl

The URL of this app's icon.

iosBundleId

List<String> iosBundleId

iosSdkErrorCategories

List<Application.MobileSdkErrorCategory> iosSdkErrorCategories

iosSupportsNativeProxyAuthFlow

Boolean iosSupportsNativeProxyAuthFlow

Whether to support the native proxy login flow.

iosSupportsSystemAuth

Boolean iosSupportsSystemAuth

Whether to support the iOS integrated Login Dialog.

ipadAppStoreId

String ipadAppStoreId

ID of the app in the iPad App Store.

iphoneAppStoreId

String iphoneAppStoreId

ID of the app in the iPhone App Store.

lastUsedTime

Date lastUsedTime

last used time of this object by the current viewer

link

String link

A link to the app on Facebook.

logoUrl

String logoUrl

The URL of the app's logo.

mobileProfileSectionUrl

String mobileProfileSectionUrl

Mobile URL of the app section on a person's profile.

mobileWebUrl

String mobileWebUrl

URL to which Mobile users will be directed when using the app.

monthlyActiveUsers

String monthlyActiveUsers

The number of monthly active users the app has.

monthlyActiveUsersRank

Integer monthlyActiveUsersRank

Ranking of this app vs other apps comparing monthly active users.

namespace

String namespace

The string appended to apps.facebook.com/ to navigate to the app's canvas page

objectStoreUrls

com.restfb.types.Application.ApplicationObjectStoreURLs objectStoreUrls

Mobile store URLs for the app.

pageTabDefaultName

String pageTabDefaultName

The title of the app when used in a Page Tab.

pageTabUrl

String pageTabUrl

The non-secure URL from which Page Tab app content is loaded.

privacyPolicyUrl

String privacyPolicyUrl

The URL that links to a Privacy Policy for the app.

profileSectionUrl

String profileSectionUrl

URL of the app section on a user's profile for the desktop site.

restrictions

com.restfb.types.Application.ApplicationRestrictionInfo restrictions

Demographic restrictions for the app.

secureCanvasUrl

String secureCanvasUrl

The secure URL from which Canvas app content is loaded.

securePageTabUrl

String securePageTabUrl

The secure URL from which Page Tab app content is loaded.

serverIpWhitelist

String serverIpWhitelist

App requests must originate from this comma-separated list of IP addresses.

socialDiscovery

Long socialDiscovery

Indicates whether app usage stories show up in the Ticker or News Feed.

subcategory

String subcategory

The subcategory the app can be found under.

supportedPlatforms

List<String> supportedPlatforms

supportsApprequestsFastAppSwitch

com.restfb.types.Application.ApplicationFastAppSwitch supportsApprequestsFastAppSwitch

Indicates whether the app should do a fast-app-switch to the Facebook app to show the app requests dialog.

supportsAttribution

Boolean supportsAttribution

Indicates whether the app has not opted out of app install tracking.

supportsImplicitSdkLogging

Boolean supportsImplicitSdkLogging

Indicates whether the app has not opted out of the mobile SDKs sending data on SDK interactions

suppressNativeIosGdp

Boolean suppressNativeIosGdp

Whether to suppress the native iOS Login Dialog

termsOfServiceUrl

String termsOfServiceUrl

URL to Terms of Service that appears in the Login Dialog

urlSchemeSuffix

String urlSchemeSuffix

URL scheme suffix

useLegacyAuth

Boolean useLegacyAuth

Does the app use the legacy auth method?

userSupportEmail

String userSupportEmail

Main contact email for this app where people can receive support.

userSupportUrl

String userSupportUrl

URL shown in the Canvas footer that people can visit to get support for the app.

websiteUrl

String websiteUrl

URL of a website that integrates with this app.

weeklyActiveUsers

String weeklyActiveUsers

The number of weekly active users the app has.

Class com.restfb.types.Application.ApplicationAppAdDebugInfo

class ApplicationAppAdDebugInfo extends AbstractFacebookType implements Serializable

Serialized Fields

androidInstallsOverLastSevenDays

Long androidInstallsOverLastSevenDays

Number of reported Android installs over the last seven days.

androidMissingSettings

List<String> androidMissingSettings

androidSupportStatus

String androidSupportStatus

Status of iOS app ad support for this application.

iosInstallInvalidationSchemes

List<String> iosInstallInvalidationSchemes

iosInstallsOverLastSevenDays

Long iosInstallsOverLastSevenDays

Number of reported iOS installs over the last seven days.

iosMissingSettings

List<String> iosMissingSettings

iosSupportStatus

String iosSupportStatus

Status of iOS app ad support for this application.

isAppChildApp

Boolean isAppChildApp

Is the application childred of aonther application, i.e. is it a test application

isAppInDevMode

Boolean isAppInDevMode

Is the application in development mode.

isCpaEnabledForAndroid

Boolean isCpaEnabledForAndroid

Is the application allowed to use CPA bidding for Android.

isCpaEnabledForIos

Boolean isCpaEnabledForIos

Is the application allowed to use CPA bidding for iOS

isOcpmEnabled

Boolean isOcpmEnabled

Is the application allowed to use optimized CPM bidding.

lastAndroidDeferredDeepLinkCall

Date lastAndroidDeferredDeepLinkCall

Timestamp of most recent Android deferred deep link request.

lastAndroidInstall

Date lastAndroidInstall

Timestamp of most recent install event reported by Android SDK.

lastIosDeferredDeepLinkCall

Date lastIosDeferredDeepLinkCall

Timestamp of most recent iOS deferred deep link request.

lastIosInstall

Date lastIosInstall

Timestamp of most recent install event reported by iOS SDK.

Class com.restfb.types.Application.ApplicationContext

class ApplicationContext extends FacebookType implements Serializable

Class com.restfb.types.Application.MobileSdkErrorCategory

class MobileSdkErrorCategory extends AbstractFacebookType implements Serializable

Serialized Fields

name

String name

The name for the category.

recoveryMessage

String recoveryMessage

The user facing message that can be shown before attempting recovery.

recoveryOptions

List<String> recoveryOptions

The vector of user facing labels for recovery options.

Class com.restfb.types.AppRequest

class AppRequest extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

actionType

String actionType

Request action type for structured request

application

AppRequest.Application application

App associated with the request.

createdTime

Date createdTime

Timestamp when the request was created.

data

String data

Optional data passed with the request for tracking purposes

from

NamedFacebookType from

The sender user associated with the request.

message

String message

A string describing the request.

to

NamedFacebookType to

The recipient user associated with the request.

Class com.restfb.types.AppRequest.Application

class Application extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

canvasName

String canvasName

The application's canvas name.

namespace

String namespace

The application's namespace.

Class com.restfb.types.CategorizedFacebookType

class CategorizedFacebookType extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

The category field for this type.

Class com.restfb.types.Category

class Category extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

apiEnum

String apiEnum

fbPageCategories

List<Category> fbPageCategories

Class com.restfb.types.Checkin

class Checkin extends FacebookType implements Serializable

serialVersionUID:

2L

Serialized Fields

application

NamedFacebookType application

The ID and name of the application that made the check-in.

comments

List<Comment> comments

createdTime

Date createdTime

The time the check-in was created.

from

NamedFacebookType from

The ID and name of the user who made the check-in.

message

String message

The message the user added to the check-in.

place

Place place

The ID, name, and location of the Facebook Page that represents the location of the check-in.

tags

List<NamedFacebookType> tags

Class com.restfb.types.Comment

class Comment extends FacebookType implements Serializable

serialVersionUID:

2L

Serialized Fields

attachment

StoryAttachment attachment

Attachment (image) added to a comment.

To force Facebook to fill the attachment field you have to fetch the comment with the fields=attachment parameter, otherwise the attachments are null.

canComment

Boolean canComment

Specifies whether you can reply to this comment

Since:

1.6.13

canHide

Boolean canHide

Whether the viewer can hide this comment

Since:

1.7.1

canLike

Boolean canLike

Whether the viewer can like this comment

canRemove

Boolean canRemove

This field is returned only if the authenticated user can remove this comment.

Since:

1.6.10

canReplyPrivately

Boolean canReplyPrivately

Whether the viewer can send a private reply to this comment (Page viewers only)

commentCount

long commentCount

Number of replies to this comment.

comments

Comments comments

The replies to this comment

createdTime

Date createdTime

Date on which the comment was created.

from

From from

User who posted the comment.

isHidden

Boolean isHidden

Whether this comment is hidden. The original poster can still see the comment, along with the page admin and anyone else tagged in the comment

Since:

1.7.1

likeCount

Long likeCount

The number of likes on this comment.

Since:

1.6.10

likes

Likes likes

Duplicate mapping for "likes" since FB can return it differently in different situations.

-- GETTER -- The likes on this post.

Sometimes this can be null - check Comment.getLikeCount() instead in that case.

message

String message

Text contents of the comment.

messageTags

List<MessageTag> messageTags

object

NamedFacebookType object

Parent object this comment was made on.

Since:

1.7.1

parent

Comment parent

If this comment is a reply, this field returns the parent comment, otherwise no value

Since:

1.6.13

permalinkUrl

String permalinkUrl

The permanent static URL to the comment

privateReplyConversation

Conversation privateReplyConversation

For comments with private replies, gets conversation between the Page and author of the comment (Page viewers only)

reactions

Reactions reactions

The reactions for this post.

userLikes

Boolean userLikes

This field is returned only if the authenticated user likes this comment

Since:

1.6.10

Class com.restfb.types.Comments

class Comments extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

canComment

Boolean canComment

count

Long count

data

List<Comment> data

openGraphCanComment

Boolean openGraphCanComment

openGraphCommentOrder

String openGraphCommentOrder

order

String order

Order in which comments were returned.

ranked indicates the most interesting comments are sorted first.
chronological indicates comments are sorted by the oldest comments first.

summary

String summary

totalCount

Long totalCount

The count of comments on this node.

It is important to note that this value is changed depending on the filter modifier being used (where comment replies are available):

• if filter is stream then total_count will be a count of all comments (including replies) on the node.
• if filter is toplevel then total_count will be a count of all top-level comments on the node.

total_count can be greater than or equal to the actual number of comments returned due to privacy or deletion

Please request '{id}/comments?summary=true' explicitly if you would like the summary field which contains the count (now called 'total_count')

Class com.restfb.types.Conversation

class Conversation extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

canReply

Boolean canReply

Whether The Page can reply to the conversation

formerParticipants

List<NamedFacebookType> formerParticipants

link

String link

A URL for this conversation.

messageCount

Long messageCount

The number of messages in the conversation

messages

List<Message> messages

name

String name

The name of the message folder or source.

participants

List<ExtendedReferenceType> participants

senders

List<NamedFacebookType> senders

snippet

String snippet

The title of a message in the conversation

subject

String subject

The subject of this conversation.

subscribed

Boolean subscribed

Whether you are subscribed to the conversation

tags

List<Conversation.Tag> tags

threadKey

String threadKey

The new identifier for threads effective after September 24, 2017

unreadCount

Long unreadCount

The number of unread messages in the conversation

Facebook does not send the unread count if there aren't any new messages. In order to keep data consistency, we set the default value to zero. If this value is sent, the JsonMapper will override it.

updatedTime

Date updatedTime

Last update time of the conversation

wallpaper

String wallpaper

Wallpaper to display as a background for the thread

Class com.restfb.types.Conversation.Tag

class Tag extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

The name field for this type.

Class com.restfb.types.CopyrightReferenceContainer

class CopyrightReferenceContainer extends FacebookType implements Serializable

Serialized Fields

contentType

String contentType

copyrightCreationTime

String copyrightCreationTime

downloadHdUrl

String downloadHdUrl

durationInSec

Double durationInSec

fingerprintValidity

String fingerprintValidity

iswc

String iswc

publishedTime

Date publishedTime

thumbnailUrl

String thumbnailUrl

title

String title

universalContentId

String universalContentId

writerNames

List<String> writerNames

Class com.restfb.types.CoverPhoto

class CoverPhoto extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

offsetX

Integer offsetX

When non-zero, the cover image overflows horizontally. The value indicates the offset percentage of the total image width from the left [0-100]

offsetY

Integer offsetY

When non-zero, the cover photo overflows vertically. The value indicates the offset percentage of the total image height from the top [0-100]

source

String source

Direct URL for the person's cover photo image

Class com.restfb.types.DeAuth

class DeAuth extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

algorithm

String algorithm

issuedAt

Date issuedAt

profileId

String profileId

userId

String userId

Class com.restfb.types.DebugTokenError

class DebugTokenError extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

The error code for the error.

message

String message

The error message for the error.

subcode

Integer subcode

The error sub code for the error.

Class com.restfb.types.DebugTokenInfo

class DebugTokenInfo extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

appId

String appId

The ID of the application this access token is for.

application

String application

Name of the application this access token is for.

dataAccessExpiresAt

Date dataAccessExpiresAt

Timestamp when app's access to user data expires.

error

DebugTokenError error

Any error that a request to the graph api would return due to the access token.

expiresAt

Date expiresAt

Timestamp when this access token expires.

granularScopes

List<GranularScope> granularScopes

List of granular permissions that the user has granted for this app in this access token.

issuedAt

Date issuedAt

The date on which the access token was issued.

isValid

boolean isValid

Whether the token is valid.

metadata

JsonObject metadata

General metadata associated with the access token. Can contain data like 'sso', 'auth_type', 'auth_nonce'

profileId

String profileId

For impersonated access tokens, the ID of the page this token contains.

scopes

List<String> scopes

List of permissions that the user has granted for the app in this access token.

type

String type

userId

String userId

The ID of the user this access token is for.

Class com.restfb.types.DeviceCode

class DeviceCode extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Code used in the authorization poll

expiresIn

Integer expiresIn

The code expires in these seconds.

You should cancel the login flow after that time if you do not receive an access token

interval

Integer interval

Your device should poll the Device Login API every interval seconds to see if the authorization has been successful

userCode

String userCode

String to be shown to the user

verificationUri

String verificationUri

Url the user should call.

Here he should add the user code

Class com.restfb.types.EntityAtTextRange

class EntityAtTextRange extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

length

Integer length

The length, within the message field, of the object mentioned.

object

NamedFacebookType object

The object itself

offset

Integer offset

The offset, within the message field, of the object mentioned.

Class com.restfb.types.Event

class Event extends NamedFacebookType implements Serializable

serialVersionUID:

2L

Serialized Fields

attendingCount

Integer attendingCount

Number of people attending the event

canGuestsInvite

Boolean canGuestsInvite

Can guests invite friends.

category

String category

The category of the event.

cover

CoverPhoto cover

Cover picture

declinedCount

Integer declinedCount

Number of people who declined the event

description

String description

The long-form HTML description of the event.

endTime

Date endTime

The end time of the event.

guestListEnabled

Boolean guestListEnabled

Can see guest list.

interestedCount

Long interestedCount

Number of people interested in the event.

isCanceled

Boolean isCanceled

Whether the event has been marked as canceled

isDateOnly

Boolean isDateOnly

Should the time information be ignored in the dates for this event?

Since:

1.6.13

isPageOwned

Boolean isPageOwned

Whether the event is created by page or not.

maybeCount

Integer maybeCount

Number of people who maybe going to the event

noreplyCount

Integer noreplyCount

Number of people who did not reply to the event

owner

Event.Owner owner

The user who owns the event.

parentGroup

Group parentGroup

The group the event belongs to, if any.

picture

ProfilePictureSource picture

The event's picture.

Since:

1.6.13

place

Place place

Location associated with the event, if any.

privacy

String privacy

The visibility of this event. Can be 'OPEN', 'CLOSED', or 'SECRET'.

rsvpStatus

String rsvpStatus

The RSVP status of this event.

startTime

Date startTime

The start time of the event.

ticketUri

String ticketUri

The URL to a location to buy tickets for this event (on Events for Pages only).

Since:

1.6.13

timezone

String timezone

the timezone of the event

updatedTime

Date updatedTime

The last time the event was updated.

Class com.restfb.types.Event.Category

class Category extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

The unique identifier for this category.

name

String name

The name of this category.

Class com.restfb.types.Event.Owner

class Owner extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

The category for this owner.

categoryList

List<Event.Category> categoryList

id

String id

The unique identifier for this owner.

name

String name

The name of this owner.

Class com.restfb.types.ExtendedReferenceType

class ExtendedReferenceType extends NamedFacebookType implements Serializable

Serialized Fields

email

String email

userId

String userId

username

String username

Class com.restfb.types.FacebookType

class FacebookType extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

This object's unique Facebook ID.

metadata

FacebookType.Metadata metadata

This object's metadata, available by including the metadata=1 URL parameter in an API request.

type

String type

Class com.restfb.types.FacebookType.Metadata

class Metadata extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

connections

FacebookType.Metadata.Connections connections

The available connections for this object. -- GETTER --

fields

List<NamedFacebookType> fields

type

String type

The metadata type of the object -- GETTER --

Since:

1.6.16

Class com.restfb.types.FacebookType.Metadata.Connections

class Connections extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

activities

String activities

This object's 'activities' connection URL. -- GETTER --

albums

String albums

This object's 'albums' connection URL. -- GETTER --

books

String books

This object's 'books' connection URL. -- GETTER --

events

String events

This object's 'events' connection URL. -- GETTER --

family

String family

This object's 'family' connection URL. -- GETTER --

feed

String feed

This object's 'feed' connection URL. -- GETTER --

friends

String friends

This object's 'friends' connection URL. -- GETTER --

groups

String groups

This object's 'groups' connection URL. -- GETTER --

home

String home

This object's 'home' connection URL. -- GETTER --

inbox

String inbox

This object's 'inbox' connection URL. -- GETTER --

interests

String interests

This object's 'interests' connection URL. -- GETTER --

likes

String likes

This object's 'likes' connection URL. -- GETTER --

links

String links

This object's 'links' connection URL. -- GETTER --

movies

String movies

This object's 'movies' connection URL. -- GETTER --

music

String music

This object's 'music' connection URL. -- GETTER --

notes

String notes

This object's 'notes' connection URL. -- GETTER --

outbox

String outbox

This object's 'outbox' connection URL. -- GETTER --

photos

String photos

This object's 'photos' connection URL. -- GETTER --

picture

String picture

This object's 'picture' connection URL. -- GETTER --

posts

String posts

This object's 'posts' connection URL. -- GETTER --

statuses

String statuses

This object's 'statuses' connection URL. -- GETTER --

tagged

String tagged

This object's 'tagged' connection URL. -- GETTER --

television

String television

This object's 'television' connection URL. -- GETTER --

updates

String updates

This object's 'updates' connection URL. -- GETTER --

videos

String videos

This object's 'videos' connection URL. -- GETTER --

Class com.restfb.types.FriendList

class FriendList extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

listType

String listType

The type of the friends list; Possible values are: close_friends, acquaintances, restricted , user_created, education, work, current_city or family.

Class com.restfb.types.From

class From extends NamedFacebookType implements Serializable

Serialized Fields

json

String json

page

Page page

user

User user

Class com.restfb.types.GranularScope

class GranularScope extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

scope

String scope

The permission granted by the user.

targetIds

List<String> targetIds

The target ids of Pages, Groups, or business assets the user granted the above permission for.

Class com.restfb.types.Group

class Group extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

administrator

Boolean administrator

administrator

cover

CoverPhoto cover

Information about the group's cover photo.

description

String description

The group description.

email

String email

The email address to upload content to the group.

Only current members of the group can use this.

icon

String icon

The URL of the group's icon

Since:

1.6.16

link

String link

The URL for the group's website.

memberRequestCount

Long memberRequestCount

The number of pending member requests.

If the token is for an administrator, this is the total number of outstanding requests. If the token is for a group member, this will return the number of friends who have requested membership and also use the same app that is making the request.

owner

NamedFacebookType owner

An object containing the name and ID of the user who owns the group.

parent

NamedFacebookType parent

The parent of this group, if it exists.

privacy

String privacy

The privacy setting of the group, either 'OPEN', 'CLOSED', or 'SECRET'.

unread

Long unread

unread count

updatedTime

Date updatedTime

The last time the group was updated.

venue

Location venue

The location of this group, a structured address object.

Class com.restfb.types.Hours

class Hours extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

hours

Map<Hours.DayOfWeek,Map<Integer,Hours.Hour>> hours

Class com.restfb.types.Hours.Hour

class Hour extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

close

String close

open

String open

Class com.restfb.types.Insight

class Insight extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

The human-readable description of this Insight data.

period

String period

Length of the period during which the insights were collected, e.g. 'day', 'week' or 'month'.

title

String title

The human-readable title of this Insight data.

totalValue

InsightTotalValue totalValue

values

List<JsonObject> values

Class com.restfb.types.InsightBreakdown

class InsightBreakdown extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

dimensionKeys

List<String> dimensionKeys

results

List<InsightBreakdownResult> results

Class com.restfb.types.InsightBreakdownResult

class InsightBreakdownResult extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

dimensionValues

List<String> dimensionValues

value

Long value

Class com.restfb.types.InsightTotalValue

class InsightTotalValue extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

breakdowns

List<InsightBreakdown> breakdowns

value

Long value

Class com.restfb.types.InstagramUser

class InstagramUser extends NamedFacebookType implements Serializable

Serialized Fields

followCount

Long followCount

Number of Instagram users that this Instagram user follows

followedByCount

Long followedByCount

Number of Instagram users that follow this Instagram user

hasProfilePicture

Boolean hasProfilePicture

Indicates whether Instagram Account has a profile picture

isPrivate

Boolean isPrivate

Whether the Instagram user is private

isPublished

Boolean isPublished

Whether the Instagram user is published

mediaCount

Long mediaCount

Number of active media posted by this Instagram user

profilePic

String profilePic

URI to user's Instagram profile picture

username

String username

Instagram username

Class com.restfb.types.Likes

class Likes extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

canLike

Boolean canLike

returns if the user can like the object

data

List<Likes.LikeItem> data

hasLiked

Boolean hasLiked

returns if the user has liked the object

openGraphCanLike

Boolean openGraphCanLike

openGraphCount

Long openGraphCount

openGraphUserLikes

Boolean openGraphUserLikes

summary

String summary

totalCount

Long totalCount

The number of likes.

Class com.restfb.types.Likes.LikeItem

class LikeItem extends NamedFacebookType implements Serializable

Serialized Fields

createdTime

Date createdTime

created time is the date the Like was created.

may be null if Facebook does not provide this information

Class com.restfb.types.Link

class Link extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Date createdTime

The time at which this object was created, if available.

Since:

1.6.3

description

String description

The link description.

from

NamedFacebookType from

An object containing the name and ID of the user who posted the link.

icon

String icon

The link icon.

link

String link

The actual URL that was shared.

message

String message

The link message content.

picture

String picture

The picture associated with the link.

Class com.restfb.types.LiveVideo

class LiveVideo extends FacebookType implements Serializable

Serialized Fields

broadcastStartTime

Date broadcastStartTime

creationTime

Date creationTime

description

String description

embedHtml

String embedHtml

isManualMode

Boolean isManualMode

isReferenceOnly

Boolean isReferenceOnly

liveViews

Long liveViews

permalinkUrl

String permalinkUrl

plannedStartTime

Date plannedStartTime

previewUrl

String previewUrl

secondsLeft

Integer secondsLeft

secureStreamUrl

String secureStreamUrl

source

String source

status

String status

streamUrl

String streamUrl

title

String title

video

Video video

Class com.restfb.types.Location

class Location extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

city

String city

The city name of this location.

cityId

String cityId

City ID. Any city identified is also a city you can use for targeting ads.

country

String country

The country name of this location.

countryCode

String countryCode

Country code

latitude

Double latitude

The latitude of this location.

locatedIn

String locatedIn

The parent location if this location is located within another location.

longitude

Double longitude

The longitude of this location.

name

String name

The name of this location.

region

String region

The region of this location.

regionId

String regionId

Region ID. Specifies a geographic region, such as California. An identified region is the same as one you can use to target ads.

state

String state

The state name of this location.

street

String street

The street address of this location.

zip

String zip

The postal code of this location.

Class com.restfb.types.Message

class Message extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

List<Message.Attachment> attachments

createdTime

Date createdTime

The time the message was initially created.

from

ExtendedReferenceType from

The sender of this message

isUnsupported

boolean isUnsupported

message

String message

The text of the message

reactions

List<Message.Reaction> reactions

shares

List<Message.Share> shares

sticker

String sticker

Sticker contained in the message.

story

Message.Story story

subject

String subject

The subject of the message.

tags

List<String> tags

to

List<ExtendedReferenceType> to

unread

Integer unread

The "unread" count for this message.

unseen

Boolean unseen

Whether this message has been seen.

updatedTime

Date updatedTime

The time of the last update to this message.

Class com.restfb.types.Message.Attachment

class Attachment extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

fileUrl

String fileUrl

imageData

Message.ImageData imageData

When the attached file is an image, Facebook will also send information about its width, height and url.

mimeType

String mimeType

The attachment's mime type, for example image/jpeg.

name

String name

The attachment's filename, for example 121423423.jpg.

size

Long size

The size of the attachment in bytes.

videoData

Message.VideoData videoData

When the attached file is a video, Facebook will also send information about its width, height and url.

Class com.restfb.types.Message.AttachmentData

class AttachmentData extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

height

int height

The image's height.

previewUrl

String previewUrl

The image's preview url.

url

String url

The image's url.

width

int width

The image's width.

Class com.restfb.types.Message.ImageData

class ImageData extends Message.AttachmentData implements Serializable

serialVersionUID:

1L

Serialized Fields

animatedGifPreviewUrl

String animatedGifPreviewUrl

animatedGifUrl

String animatedGifUrl

animatedWebpPreviewUrl

String animatedWebpPreviewUrl

animatedWebpUrl

String animatedWebpUrl

imageType

int imageType

maxHeight

int maxHeight

The image's max height.

maxWidth

int maxWidth

The image's max width.

rawGifImage

String rawGifImage

rawWebpImage

String rawWebpImage

renderAsSticker

Boolean renderAsSticker

Class com.restfb.types.Message.Reaction

class Reaction extends AbstractFacebookType implements Serializable

Serialized Fields

reaction

String reaction

users

List<ExtendedReferenceType> users

Class com.restfb.types.Message.Share

class Share extends NamedFacebookType implements Serializable

Serialized Fields

description

String description

The description of the shared item.

link

String link

The URL to the shared item.

picture

String picture

Class com.restfb.types.Message.Story

class Story extends AbstractFacebookType implements Serializable

Serialized Fields

mention

Message.StoryMention mention

replyTo

Message.StoryReply replyTo

Class com.restfb.types.Message.StoryMention

class StoryMention extends FacebookType implements Serializable

Serialized Fields

link

String link

Class com.restfb.types.Message.StoryReply

class StoryReply extends FacebookType implements Serializable

Serialized Fields

link

String link

Class com.restfb.types.Message.VideoData

class VideoData extends Message.AttachmentData implements Serializable

serialVersionUID:

1L

Serialized Fields

length

int length

rotation

int rotation

videoType

int videoType

Class com.restfb.types.MessageTag

class MessageTag extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

length

Integer length

The length, within the message field, of the object mentioned.

offset

Integer offset

The offset, within the message field, of the object mentioned.

Class com.restfb.types.Milestone

class Milestone extends FacebookType implements Serializable

Serialized Fields

createdTime

Date createdTime

The creation time of the milestone.

description

String description

The description of the milestone.

endTime

Date endTime

The end time of the milestone. Page milestones have the same start and end time.

from

Page from

The Page that posted the milestone.

startTime

Date startTime

The start time of the milestone.

title

String title

The title of the milestone

updatedTime

Date updatedTime

The update time of the milestone.

Class com.restfb.types.MusicVideoCopyright

class MusicVideoCopyright extends FacebookType implements Serializable

Serialized Fields

creationTime

Date creationTime

displayedMatchesCount

Long displayedMatchesCount

inConflict

Boolean inConflict

isrc

String isrc

matchRule

VideoCopyrightRule matchRule

ownershipCountries

List<String> ownershipCountries

referenceFileStatus

String referenceFileStatus

ridgeMonitoringStatus

String ridgeMonitoringStatus

updateTime

Date updateTime

videoAsset

CopyrightReferenceContainer videoAsset

whitelistedFbUsers

List<User> whitelistedFbUsers

whitelistedIgUsers

List<String> whitelistedIgUsers

Class com.restfb.types.NamedFacebookType

class NamedFacebookType extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

The name field for this type.

Class com.restfb.types.Note

class Note extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

comments

List<Comment> comments

commentsAsObject

String commentsAsObject

createdTime

Date createdTime

The time the note was initially published.

from

NamedFacebookType from

The ID of the user who posted the note.

icon

String icon

The note icon.

message

String message

The note content, an HTML string.

subject

String subject

The title of the note.

updatedTime

Date updatedTime

The time the note was last updated.

Class com.restfb.types.Notification

class Notification extends FacebookType implements Serializable

Serialized Fields

application

Application application

The app responsible for generating the notification. Some of the core Facebook features have their own app that shows up here, such as likes when someone likes another person's content.

createdTime

Date createdTime

When the notification was created.

from

NamedFacebookType from

The entity (user, page, app, etc.) that 'sent', or is the source of the notification.

link

String link

The URL that clicking on the notification would take someone.

object

NamedFacebookType object

The object (this can be a post, a photo, a comment, etc.) that was the subject of the notification.

title

String title

The message text in the notification.

to

NamedFacebookType to

The entity that received the notification.

unread

Integer unread

Indicates that the notification is unread.

Note that 'read' notifications will not be accessible.

updatedTime

Date updatedTime

When the notification was last updated. When the notification was created.

Class com.restfb.types.OpenGraphActionType

class OpenGraphActionType extends NamedFacebookType implements Serializable

Serialized Fields

allowMultipleReferences

Boolean allowMultipleReferences

Whether multiple objects can be referenced by the action

appPreposition

String appPreposition

The preposition used to address the app

buttonText

String buttonText

Button text

description

String description

Description

isAppSecretRequired

Boolean isAppSecretRequired

Whether the app secret is required for API calls related to actions of this type

objectTypes

List<String> objectTypes

pluralPast

String pluralPast

The plural past form of the action

pluralPresent

String pluralPresent

The plural present form of the action

propertyConfig

Map<String,OpenGraphPropertyConfig> propertyConfig

singularPast

String singularPast

The singular past form of the action

singularPresent

String singularPresent

The singular present form of the action

tensesDisabled

Integer tensesDisabled

Bitmap of tenses that are disabled (the least significant bit relates to past tense, the second least significant relates to present tense

Class com.restfb.types.OpenGraphObjectType

class OpenGraphObjectType extends NamedFacebookType implements Serializable

Serialized Fields

article

String article

An article for the type name

plural

String plural

The plural form of the object

propertyConfig

Map<String,OpenGraphPropertyConfig> propertyConfig

singular

String singular

The singular form of the object

Class com.restfb.types.OpenGraphRating

class OpenGraphRating extends FacebookType implements Serializable

Serialized Fields

createdTime

Date createdTime

When the reviewer rated this object.

hasRating

Boolean hasRating

Was a rating included

hasReview

Boolean hasReview

Was there text in the rating

openGraphStory

PageRating openGraphStory

Open Graph story generated by the rating action

rating

Integer rating

Rating

recommendationType

RecommendationType recommendationType

Recommendation field for change on August 17, 2018

for more information check here: https://www.facebook.com/business/recommendations

reviewer

User reviewer

Person who rated the object

reviewText

String reviewText

Review text included in the review

Class com.restfb.types.Page

class Page extends CategorizedFacebookType implements Serializable

serialVersionUID:

2L

Serialized Fields

about

String about

General information about this page.

Since:

1.6.10

accessToken

String accessToken

An admin access_token for this page.

The current user must be an administrator of this page; only returned if specifically requested via the fields URL parameter, e.g. facebookClient.fetchObject("123", Page.class, Parameter.with("fields","access_token"))

Since:

1.6.5

adminNotes

List<PageAdminNote> adminNotes

affiliation

String affiliation

Affiliation of this person. Applicable to Pages representing people

Since:

1.10.0

appId

String appId

App ID for app-owned Pages and app Pages.

artistsWeLike

String artistsWeLike

Artists the band likes. Applicable to Bands

Since:

1.10.0

assetScore

Double assetScore

relevance score of an asset.

attire

String attire

Dress code of the business. Applicable to Restaurants or Nightlife. Can be one of Casual, Dressy or Unspecified

Since:

1.10.0

awards

String awards

The awards information of the film. Applicable to Films

Since:

1.10.0

bandInterests

String bandInterests

Band interests. Applicable to Bands

Since:

1.10.0

bandMembers

String bandMembers

Members of the band. Applicable to Bands

Since:

1.10.0

bestPage

Page bestPage

The best available Page on Facebook for the concept represented by this Page. The best available Page takes into account authenticity and the number of likes

Since:

1.10.0

bio

String bio

Biography of the band. Applicable to Bands

Since:

1.10.0

birthday

String birthday

Birthday of this person. Applicable to Pages representing people

Since:

1.10.0

bookingAgent

String bookingAgent

Booking agent of the band. Applicable to Bands.

Since:

1.7.0

built

String built

Year vehicle was built. Applicable to Vehicles

Since:

1.10.0

business

Business business

The Business associated with this Page.

canCheckin

Boolean canCheckin

Whether this page has check in functionality enabled.

canPost

Boolean canPost

Indicates whether the current session user can post on this page.

Since:

1.6.10

category

String category

The Page's category. e.g. Product/Service, Computers/Technology

categoryList

List<Category> categoryList

checkins

Integer checkins

The total number of users who have checked in to the Page.

companyOverview

String companyOverview

Overview of the page's company.

connectedInstagramAccount

IgUser connectedInstagramAccount

Instagram account connected to page via page settings

contactAddress

Page.MailingAddress contactAddress

The mailing or contact address for this page. This field will be blank if the contact address is the same as the physical address

Since:

1.10.0

countryPageLikes

Integer countryPageLikes

If this is a Page in a Global Pages hierarchy, the number of people who are being directed to this Page.

cover

Page.Cover cover

The cover photo.

Since:

1.6.10

culinaryTeam

String culinaryTeam

Culinary team of the business. Applicable to Restaurants or Nightlife

Since:

1.10.0

currentLocation

String currentLocation

Current location of the Page.

Since:

1.10.0

description

String description

A description of this page.

descriptionHtml

String descriptionHtml

The description of the Page in raw HTML.

Since:

1.10.0

directedBy

String directedBy

The director of the film. Applicable to Films.

Since:

1.7.0

displayedMessageResponseTime

String displayedMessageResponseTime

Page estimated message response time displayed to user

displaySubtext

String displaySubtext

Subtext about the Page being viewed.

emails

List<String> emails

engagement

Page.Engagement engagement

The social sentence and like count information for this Page. This is the same info used for the like button

Since:

1.10.0

fanCount

Long fanCount

The number of likes the page has.

featuredVideo

Video featuredVideo

Video Featured by the Page. Only visible to the Page admin

Since:

1.10.0

features

String features

Features of the vehicle. Applicable to Vehicles

Since:

1.10.0

followersCount

Long followersCount

Number of page followers

foodStyles

List<String> foodStyles

founded

String founded

When the page was founded.

generalInfo

String generalInfo

The general information for a page.

Since:

1.6.12

generalManager

String generalManager

General manager of the business. Applicable to Restaurants or Nightlife.

Since:

1.7.0

genre

String genre

The genre of the film. Applicable to Films

Since:

1.10.0

globalBrandPageName

String globalBrandPageName

The name of the Page with country codes appended for Global Brand Pages. Only visible to the Page admin

Since:

1.10.0

globalBrandParentPage

Page globalBrandParentPage

This brand's global (parent) Page.

Since:

1.10.0

globalBrandRootId

String globalBrandRootId

This brand's global Root ID.

groups

Connection<Group> groups

groups

hasAddedApp

Boolean hasAddedApp

Indicates whether this Page has added the app making the query in a Page tab.

Since:

1.10.0

hasTransitionedToNewPageExperience

Boolean hasTransitionedToNewPageExperience

Indicates whether a page has transitioned to new page experience or not

hasWhatsappBusinessNumber

Boolean hasWhatsappBusinessNumber

Indicates whether WhatsApp number connected to this page is a WhatsApp business number

hasWhatsappNumber

Boolean hasWhatsappNumber

has whatsapp number

hometown

String hometown

Hometown of the band. Applicable to Bands

Since:

1.10.0

hours

Hours hours

Opening hours

Since:

1.10.1

impressum

String impressum

Legal information about the Page publishers.

Since:

1.10.0

influences

String influences

Influences on the band. Applicable to Bands

Since:

1.10.0

insights

Connection<Insight> insights

This Page's Insights data

instagramAccounts

List<InstagramUser> instagramAccounts

instagramBusinessAccount

IgUser instagramBusinessAccount

Instagram account linked to page during Instagram business conversion flow

instantArticlesReviewStatus

String instantArticlesReviewStatus

Indicates the current Instant Articles review status for this page

isAlwaysOpen

Boolean isAlwaysOpen

Indicates whether this location is always open.

isChain

Boolean isChain

Indicates whether location is part of a chain

isCommunityPage

Boolean isCommunityPage

Is this a community page?

isEligibleForBrandedContent

Boolean isEligibleForBrandedContent

Indicates whether the page is eligible for the branded content tool

isMessengerBotGetStartedEnabled

Boolean isMessengerBotGetStartedEnabled

Indicates whether the page is a Messenger Platform Bot with Get Started button enabled

isMessengerPlatformBot

Boolean isMessengerPlatformBot

Indicates whether the page is a Messenger Platform Bot

isOwned

Boolean isOwned

Indicates whether page is owned

isPermanentlyClosed

Boolean isPermanentlyClosed

Whether the business corresponding to this Page is permanently closed.

Since:

1.10.0

isPublished

Boolean isPublished

Indicates whether the page is published and visible to non-admins.

Since:

1.6.10

isUnclaimed

Boolean isUnclaimed

Indicates whether the Page is unclaimed.

Since:

1.7.0

isWebhooksSubscribed

Boolean isWebhooksSubscribed

Indicates whether the application is subscribed for real time updates from this page

labels

List<PageLabel> labels

lastUsedTime

Date lastUsedTime

last used time of this object by the current viewer

leadgenTosAcceptanceTime

Date leadgenTosAcceptanceTime

Indicates the time when the TOS for running LeadGen Ads on the page was accepted

leadgenTosAccepted

Boolean leadgenTosAccepted

Indicates whether a user has accepted the TOS for running LeadGen Ads on the Page.

leadgenTosAcceptingUser

User leadgenTosAcceptingUser

Indicates the user who accepted the TOS for running LeadGen Ads on the page

likes

Likes likes

The Pages that this Page Likes.

likesCount

Long likesCount

The number of likes the page has.

Since Graph 2.6 you should use Page.fanCount instead

Since:

1.6.5

link

String link

The page's link.

location

Location location

The location of the place this page represents.

members

String members

Members of this org. Applicable to Pages representing Team Orgs

Since:

1.10.0

merchantId

String merchantId

The instant workflow merchant id associated with the Page

merchantReviewStatus

String merchantReviewStatus

Review status of the Page against FB commerce policies, this status decides whether the Page can use component flow

messengerAdsDefaultIcebreakers

List<String> messengerAdsDefaultIcebreakers

mission

String mission

The company mission. Applicable to Companies

mpg

String mpg

MPG of the vehicle. Applicable to Vehicles

Since:

1.10.0

nameWithLocationDescriptor

String nameWithLocationDescriptor

The name of a Location Page that provides additional location information for that Page beside its name.

Since:

1.7.0

network

String network

The TV network for the TV show. Applicable to TV Shows

Since:

1.10.0

newLikeCount

Long newLikeCount

The number of people who have liked the Page, since the last login. Only visible to a page admin

Since:

1.10.0

offerEligible

Boolean offerEligible

Offer eligibility status. Only visible to a page admin

Since:

1.10.0

overallStarRating

Double overallStarRating

Overall page rating based on rating survey from users on a scale of 1-5. This value is normalized and is not guaranteed to be a strict average of user ratings. If there are 0 or a small number of ratings, this field will not be returned.

ownerBusiness

Business ownerBusiness

owner business of this object

pageToken

String pageToken

parentPage

Page parentPage

Parent Page of this Page.

If the Page is part of a Global Root Structure and you have permission to the Global Root, the Global Root Parent Page is returned. If you do not have Global Root permission, the Market Page for your current region is returned as the Parent Page.

If your Page is not part of a Global Root Structure, the Parent Page is returned.

parking

Page.PageParking parking

Parking information. Applicable to Businesses and Places

paymentOptions

Page.PagePaymentOptions paymentOptions

Payment options accepted by the business. Applicable to Restaurants or Nightlife

Since:

1.10.0

personalInfo

String personalInfo

Personal information. Applicable to Pages representing People

Since:

1.10.0

personalInterests

String personalInterests

Personal interests. Applicable to Pages representing People

Since:

1.10.0

pharmaSafetyInfo

String pharmaSafetyInfo

Pharmacy safety information. Applicable to Pharmaceutical companies

Since:

1.10.0

phone

String phone

The phone number (not always normalized for country code) for the Page.

picture

ProfilePictureSource picture

The page's profile picture, if provided.

To force Facebook to fill the picture field you have to fetch the page with the fields=picture parameter, otherwise the picture is null.

placeType

String placeType

For places, the category of the place.

plotOutline

String plotOutline

The plot outline of the film. Applicable to Films

Since:

1.10.0

pressContact

String pressContact

Press contact information of the band. Applicable to Bands.

Since:

1.7.0

priceRange

String priceRange

Price range of the business. Applicable to Restaurants or Nightlife. Can be one of $ (0-10), $$ (10-30), $$$ (30-50), $$$$ (50+) or Unspecified

Since:

1.10.0

privacyInfoUrl

String privacyInfoUrl

Privacy url in page info section

producedBy

String producedBy

The productor of the film. Applicable to Films

Since:

1.10.0

products

String products

The page's products.

promotionEligible

Boolean promotionEligible

Reason why a post isn't eligible for boosting. Only visible to Page Admins

Since:

1.10.0

promotionIneligibleReason

String promotionIneligibleReason

Reason, for which boosted posts are not eligible. Only visible to a page admin

Since:

1.10.0

publicTransit

String publicTransit

Public transit to the business. Applicable to Restaurants or Nightlife

Since:

1.10.0

ratingCount

Integer ratingCount

Number of ratings for the page (limited to ratings that are publicly accessible

rawHours

List<JsonObject> rawHours

rawHoursMap

Map<String,String> rawHoursMap

recipient

String recipient

Messenger page scope id associated with page and a user using account_linking_token

recordLabel

String recordLabel

Record label of the band. Applicable to Bands

Since:

1.10.0

releaseDate

String releaseDate

The film's release date. Applicable to Films

Since:

1.10.0

restaurantServices

Page.PageRestaurantServices restaurantServices

Services the restaurant provides. Applicable to Restaurants

Since:

1.10.0

restaurantSpecialties

Page.PageRestaurantSpecialties restaurantSpecialties

The restaurant's specialties. Applicable to Restaurants

Since:

1.10.0

schedule

String schedule

The air schedule of the TV show. Applicable to TV Shows

Since:

1.10.0

screenNames

List<Page.ScreenName> screenNames

screenplayBy

String screenplayBy

The screenwriter of the film. Applicable to Films

Since:

1.10.0

season

String season

The season information of the TV Show. Applicable to TV Shows

Since:

1.10.0

singleLineAddress

String singleLineAddress

The page address, if any, in a simple single line format.

starring

String starring

The cast of the film. Applicable to Films

Since:

1.10.0

startInfo

Page.PageStartInfo startInfo

Information about when the entity represented by the Page was started

Since:

1.10.0

storeCode

String storeCode

Unique store code for this location Page

storeLocationDescriptor

String storeLocationDescriptor

Location Page's store location descriptor

storeNumber

String storeNumber

Unique store number for this location Page.

Since:

1.10.0

studio

String studio

The studio for the film production. Applicable to Films

Since:

1.10.0

talkingAboutCount

Long talkingAboutCount

The number of people that are talking about this page (last seven days).

Since:

1.6.10

temporaryStatus

String temporaryStatus

Indicates how the business corresponding to this Page is operating differently than usual. Possible values:

• differently_open
• temporarily_closed
• operating_as_usual
• no_data

unreadMessageCount

Long unreadMessageCount

Unread message count for the Page. Only visible to a page admin

Since:

1.10.0

unreadNotifCount

Long unreadNotifCount

Number of unread notifications. Only visible to a page admin

Since:

1.10.0

unseenMessageCount

Long unseenMessageCount

Unseen message count for the Page. Only visible to a page admin

Since:

1.10.0

userAccessExpireTime

Date userAccessExpireTime

username

String username

The page's username. The alias of the Page. For example, for www.facebook.com/platform the username is 'platform'

verificationStatus

String verificationStatus

Showing whether this Page is verified and in what color e.g. blue verified, gray verified or not verified

voipInfo

Page.VoipInfo voipInfo

Voip info

Since:

1.10.0

website

String website

The website URL

Since:

1.6.15

wereHereCount

Long wereHereCount

The number of visits to this Page's location. If the Page setting Show map, check-ins and star ratings on the Page (under Page Settings > Page Info > Address) is disabled, then this value will also be disabled

Since:

1.10.0

whatsappNumber

String whatsappNumber

whatsapp number

writtenBy

String writtenBy

The writer of the TV show. Applicable to TV Shows

Since:

1.10.0

Class com.restfb.types.Page.Cover

class Cover extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

coverId

String coverId

The ID of the photo.

offsetY

Integer offsetY

The percentage offset from top [0-100].

source

String source

The URL for the cover photo.

Class com.restfb.types.Page.Engagement

class Engagement extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

count

Long count

Number of people who like this.

countString

String countString

Abbreviated string representation of count.

countStringWithLike

String countStringWithLike

Abbreviated string representation of count if the viewer likes the object.

countStringWithoutLike

String countStringWithoutLike

Abbreviated string representation of count if the viewer does not like the object.

socialSentence

String socialSentence

Text that the like button would currently display.

socialSentenceWithLike

String socialSentenceWithLike

Text that the like button would display if the viewer likes the object.

socialSentenceWithoutLike

String socialSentenceWithoutLike

Text that the like button would display if the viewer does not like the object.

Class com.restfb.types.Page.MailingAddress

class MailingAddress extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

city

String city

Address city name.

cityPage

Page cityPage

Page representing the address city.

country

String country

Country of the address.

id

String id

The mailing address ID.

postalCode

String postalCode

Postal code of the address.

region

String region

Region or state of the address.

street1

String street1

Street address.

street2

String street2

Second part of the street address - apt, suite, etc.

Class com.restfb.types.Page.PageParking

class PageParking extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

lot

Boolean lot

Whether lot parking is available

street

Boolean street

Whether street parking is available

valet

Boolean valet

Whether valet parking is available

Class com.restfb.types.Page.PagePaymentOptions

class PagePaymentOptions extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

amex

Boolean amex

Whether the business accepts American Express as a payment option.

cashOnly

Boolean cashOnly

Whether the business accepts cash only as a payment option.

discover

Boolean discover

Whether the business accepts Discover as a payment option.

mastercard

Boolean mastercard

Whether the business accepts MasterCard as a payment option.

visa

Boolean visa

Whether the business accepts Visa as a payment option.

Class com.restfb.types.Page.PageRestaurantServices

class PageRestaurantServices extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

catering

Boolean catering

delivery

Boolean delivery

groups

Boolean groups

kids

Boolean kids

outdoor

Boolean outdoor

reserve

Boolean reserve

takeout

Boolean takeout

waiter

Boolean waiter

walkins

Boolean walkins

Class com.restfb.types.Page.PageRestaurantSpecialties

class PageRestaurantSpecialties extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

breakfast

Boolean breakfast

coffee

Boolean coffee

dinner

Boolean dinner

drinks

Boolean drinks

lunch

Boolean lunch

Class com.restfb.types.Page.PageStartDate

class PageStartDate extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

day

Integer day

month

Integer month

year

Integer year

Class com.restfb.types.Page.PageStartInfo

class PageStartInfo extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

date

Page.PageStartDate date

type

String type

Class com.restfb.types.Page.ScreenName

class ScreenName extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

serviceName

String serviceName

value

String value

Class com.restfb.types.Page.Settings

class Settings extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

setting

String setting

value

String value

Class com.restfb.types.Page.VoipInfo

class VoipInfo extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

hasMobileApp

Boolean hasMobileApp

hasPermission

Boolean hasPermission

isCallable

Boolean isCallable

isCallableWebrtc

Boolean isCallableWebrtc

isPushable

Boolean isPushable

reasonCode

Long reasonCode

reasonDescription

String reasonDescription

Class com.restfb.types.PageAdminNote

class PageAdminNote extends FacebookType implements Serializable

Serialized Fields

body

String body

Content of this note.

from

Page from

Page that owns the note.

user

User user

The user that this note is attached to.

Class com.restfb.types.PageCallToAction

class PageCallToAction extends FacebookType implements Serializable

Serialized Fields

androidApp

Application androidApp

App that stores the destination info on Android.

androidAppId

String androidAppId

ID of the App that stores the destination info on Android

androidDeeplink

String androidDeeplink

Destination deeplink for the call-to-action on Android

androidDestinationType

String androidDestinationType

Destination type for the call-to-action on Android.

Default value: NONE

may be: WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, NONE

androidPackageName

String androidPackageName

Destination app for the call-to-action on Android

androidUrl

String androidUrl

Destination url for the call-to-action on Android

createdTime

Date createdTime

Time when the call-to-action was created.

emailAddress

String emailAddress

Email address that can be contacted by a user.

from

Page from

Page that owns the call-to-action.

intlNumberWithPlus

String intlNumberWithPlus

International phone number with plus that can be called through a phone

iphoneApp

Application iphoneApp

App that stores the destination info on iPhone.

iphoneAppId

String iphoneAppId

ID fo the App that stores the destination info on iPhone

iphoneDeeplink

String iphoneDeeplink

Destination deeplink for the call-to-action on iPhone.

iphoneDestinationType

String iphoneDestinationType

Destination type for the call-to-action on iPhone.

Default value: NONE

may be: WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, NONE

iphoneUrl

String iphoneUrl

Destination url for the call-to-action on iPhone.

status

String status

Current running status of this action.

updatedTime

Date updatedTime

Time when the call-to-action was last updated.

webDestinationType

String webDestinationType

Destination type for the call-to-action on desktop.

Default value: NONE

may be: WEBSITE, MESSENGER, NONE

webUrl

String webUrl

Destination url for the call-to-action on desktop

Class com.restfb.types.PageConnection

class PageConnection extends CategorizedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Date createdTime

The time the connection was initially created.

Class com.restfb.types.PageLabel

class PageLabel extends NamedFacebookType implements Serializable

Serialized Fields

creationTime

Date creationTime

creatorId

NamedFacebookType creatorId

from

Page from

users

List<User> users

Class com.restfb.types.PageLifeEvent

class PageLifeEvent extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Date createdTime

The time when this milestone was published

description

String description

Description of the milestone.

endTime

Date endTime

The time when this milestone came to an end.

fromPage

Page fromPage

The information of the Page that owns the milestone.

isHidden

Boolean isHidden

Whether the milestone is hidden or not.

startTime

Date startTime

The time when this milestone was started.

title

String title

The title of the milestone.

updatedTime

Date updatedTime

The time when this milestone was updated.

Class com.restfb.types.PageRating

class PageRating extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

application

Application application

comments

Comments comments

data

String data

from

NamedFacebookType from

Person who rated the page

isDraft

Boolean isDraft

language

String language

likes

Likes likes

message

String message

noFeedStory

Boolean noFeedStory

place

Place place

publishTime

Date publishTime

Time the rating took place

ratingScale

Long ratingScale

ratingValue

Double ratingValue

recommendationType

RecommendationType recommendationType

reviewText

String reviewText

startTime

Date startTime

Time the rating took place

Class com.restfb.types.PageTab

class PageTab extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

application

Application application

The app that is in the tab

customImageUrl

String customImageUrl

URL for an image to be used as a custom icon

customName

String customName

Name to be used for the tab

imageUrl

String imageUrl

The location of the tab thumbnail image

isNonConnectionLandingTab

Boolean isNonConnectionLandingTab

A flag to identify whether the tab is a custom landing tab for users who are not connected to this Page

isPermanent

Boolean isPermanent

A flag to identify whether the tab can be removed from the Page

link

String link

A link directly to this Page tab

position

Integer position

Where this tab is located in the list of tabs

Class com.restfb.types.Payment

class Payment extends FacebookType implements Serializable

Serialized Fields

actions

List<Payment.Action> actions

application

Application application

The app associated with this payment

country

String country

Buyer's ISO Country Code, for tax purposes.

createdTime

Date createdTime

The time the payment was originally created.

disputes

List<Payment.Dispute> disputes

items

List<Payment.Item> items

payoutForeignExchangeRate

Double payoutForeignExchangeRate

Exchange rate used to calculate payout amount which is remitted in USD.

quantity

Integer quantity

The quantity of the product contained in the order

requestId

String requestId

The unique, optional app-created identifier passed into the JS function (255 character maximum)

tax

String tax

The tax parameter specifies if a payment is subject to VAT and, if so, how the tax was paid.

This can take on the following values:

• not_taxed: There's no VAT on this payment because it came from outside the European Union.
• already_paid: The tax on this payment has already been paid by the user's mobile carrier or other upstream party
• tax_remitted: Facebook paid the VAT on this payment on your behalf. The tax amount will be deducted from your payout.

taxCountry

String taxCountry

The country determined by Facebook for tax calculation of this purchase, given as an ISO 3166-1 alpha-2 country code. Note: This field is for your information only, and it should not be used for any recalculation or reconciliation purposes. If tax is equal to not_taxed or already_paid this field will be omitted.

test

Boolean test

Optional parameter that shows up when a payment is made by a payment tester listed in the app's dashboard. This represents a transaction that has not been charged to the consumer's payment instrument

user

User user

The consumer's first and last name along with their user id. May be omitted in some cases.

Class com.restfb.types.Payment.Action

class Action extends AbstractFacebookType implements Serializable

Serialized Fields

amount

String amount

The amount of money covered by this action.

currency

String currency

The currency of the above amount in this action.

status

String status

The status for this particular action. status can be:

• initiated: An initiated payment designates the payment was only initiated but not yet fully completed. You should not fulfill an order of this type with the consumer and you should not receive a real time update for a payment with this status. You will however get a real time update when the corresponding transaction is completed. Developers may see initiated state for certain payment methods which requires long time to settle, for example, certain methods require the costumer to fill-in a form online, print out a receipt and go to the bank offline to pay.
• completed: A completed status means the action was successfully completed. If the type was a charge you will want to fulfill the order to the consumer at this time. Similarly, if the action type was a refund you will want to retract the item from the consumer.
• failed: This designates a failed action for the underlying type. This value can be present for both a charge action type as well as a refund action type.

taxAmount

String taxAmount

The amount reduced from your payout for any taxes remitted by Facebook. If tax is equal to not_taxed or already_paid this field will be omitted.

timeCreated

Date timeCreated

When this action occurred.

timeUpdated

Date timeUpdated

When this action was last updated.

type

String type

The type of this particular action. type can be:

• charge: This designates the type of action that was taken on this payment was a charge. If the charge has a status of completed, then you should fulfill the order.
• refund: The refund type designates the payment has been refunded and the item sold to the consumer should be retracted if possible as you will no longer be paid out for this transaction.
• chargeback: A chargeback is initiated by a consumer with their bank disputing the payment in question. When a chargeback occurs, you should retract the in-game item from the costumer where possible as you will not be paid out for this order.
• chargeback_reversal: A chargeback_reversal occurs when a chargeback is retroactively reversed. In this case, you should reinstate the consumer's in-game item if possible as you will now be paid out for this payment.
• decline: A decline occurs when a funding source used to create a bundled transaction is declined at the moment of processing the payment. You should retract the in-game item from the consumer where possible as you will not be paid out for this order. More information on bundled transactions and declines can be found in Handling Disputes and Refunds.

Class com.restfb.types.Payment.Dispute

class Dispute extends AbstractFacebookType implements Serializable

Serialized Fields

reason

String reason

The reason the developer or Facebook gave to resolve the dispute, after it has been resolved.

status

String status

Current status of the dispute.

timeCreated

Date timeCreated

The time the dispute was created.

userComment

String userComment

Comment provided by the consumer when the dispute is initiated.

userEmail

String userEmail

Email provided by the consumer when the dispute is initiated.

Class com.restfb.types.Payment.Item

class Item extends AbstractFacebookType implements Serializable

Serialized Fields

product

String product

The product URL of this item.

quantity

Integer quantity

The number of this item purchased.

type

String type

The type of this item.

Class com.restfb.types.Photo

class Photo extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

album

Album album

The album this photo is in

backdatedTime

Date backdatedTime

Back dated time

Since:

1.6.15

backdatedTimeGranularity

String backdatedTimeGranularity

String that represents the back dated time granularity

Since:

1.6.15

canDelete

Boolean canDelete

A boolean indicating if the viewer can delete the photo

canTag

Boolean canTag

A boolean indicating if the viewer can tag the photo

comments

Comments comments

All of the comments on this photo.

Since:

1.6.5

createdTime

Date createdTime

The time the photo was initially published.

event

Event event

If this object has a place, the event associated with the place

from

From from

An object containing the name and ID of the user who posted the photo.

height

Integer height

The height of the photo, in pixels.

icon

String icon

The icon-sized source of the photo.

images

List<Photo.Image> images

insights

Connection<Insight> insights

likes

Likes likes

link

String link

A link to the photo on Facebook.

nameTags

List<EntityAtTextRange> nameTags

pageStoryId

String pageStoryId

ID of the page story this corresponds to. May not be on all photos. Applies only to published photos

picture

String picture

The album-sized view of the photo.

place

Place place

The location associated with this photo, if any.

Since:

1.6.10

position

Integer position

Deprecated.

Facebook will start returning 0 for this field starting on October 3, 2012.

The position of this photo in the album.

Since:

1.6.5

reactions

Reactions reactions

The reactions for this photo.

source

String source

Deprecated.

Use images field instead

The full-sized source of the photo.

tags

List<Photo.Tag> tags

updatedTime

Date updatedTime

The last time the photo or its caption was updated.

width

Integer width

The width of the photo, in pixels.

Class com.restfb.types.Photo.Image

class Image extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

height

Integer height

The height of the image in pixels.

source

String source

The source URL of the image.

width

Integer width

The width of the image in pixels.

Class com.restfb.types.Photo.Tag

class Tag extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Date createdTime

Date this tag was created.

x

Double x

X coordinate (as a percentage of distance from left vs. width).

y

Double y

Y coordinate (as a percentage of distance from top vs. height).

Class com.restfb.types.Place

class Place extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryList

List<Category> categoryList

location

Location location

Location containing geographic information such as latitude, longitude, country, and other fields (fields will vary based on geography and availability of information). It is possible for Facebook to return either this value or Place.getLocationAsString().

locationAsString

String locationAsString

Description for this location.

It is possible for Facebook to return either this value or Place.getLocation(). If Place.getLocation() returns null, then check this method to see if it has data, e.g. "Philadelphia, PA".

Since:

1.6.12

overallRating

Double overallRating

Overall Rating of Place, on a 5-star scale. 0 means not enough data to get a combined rating.

Class com.restfb.types.PlaceTag

class PlaceTag extends FacebookType implements Serializable

Serialized Fields

createdTime

Date createdTime

Time when the place was visited

place

Page place

The place that was visited

Class com.restfb.types.Post

class Post extends FacebookType implements Serializable

serialVersionUID:

3L

Serialized Fields

actions

List<Post.Action> actions

adminCreator

NamedFacebookType adminCreator

ID of admin who created the post. Applies to pages only

Since:

1.10.0

allowedAdvertisingObjectives

List<String> allowedAdvertisingObjectives

Objectives under which this post can be advertised

allowedAdvertisingObjects

String allowedAdvertisingObjects

Objectives under which this post can be advertised

application

NamedFacebookType application

The application used to create this post.

attachments

Post.Attachments attachments

Attachments added to a post. To force Facebook to fill the attachments field you have to fetch the post with the fields=attachments parameter, otherwise the attachments are null.

callToAction

PostCallToAction callToAction

The call to action type used in any Page posts for mobile app engagement ads

canReplyPrivately

Boolean canReplyPrivately

Whether the viewer can send a private reply to this post (Page viewers only)

caption

String caption

The caption of the link (appears beneath the link name). Hint for Graph API 3.3: Use attachment/title instead

childAttachments

List<Post> childAttachments

comments

Comments comments

The comments for this post.

commentsMirroringDomain

String commentsMirroringDomain

If comments are being mirrored to an external site, this function returns the domain of that external site.

createdTime

Date createdTime

The time the post was initially published.

description

String description

A description of the link (appears beneath the link caption). Hint for Graph API 3.3: Use attachment/description instead

feedTargeting

Post.FeedTargeting feedTargeting

Object that controls news feed targeting for this post. To force Facebook to fill the feed_targeting field you have to fetch the post with the fields=feed_targeting parameter, otherwise the feedTargeting is null.

Since:

1.11.0

from

From from

An object containing the ID and name of the user who posted the message.

fullPicture

String fullPicture

Full picture URL. you get the url to this posts full picture. To force Facebook to fill the full_picture field you have to fetch the post with the fields=full_picture parameter, otherwise the full_picture is null.

icon

String icon

A link to an icon representing the type of this post.

insights

Connection<Insight> insights

instagramEligibility

String instagramEligibility

Whether the post can be promoted on Instagram.

It returns the enum eligible if it can be promoted. Otherwise it returns an enum for why it cannot be promoted

isAppShare

Boolean isAppShare

Whether or not the post references an app.

isEligibleForPromotion

Boolean isEligibleForPromotion

isExpired

Boolean isExpired

Whether the post has expiration time that has passed

isHidden

Boolean isHidden

If this post is marked as hidden (applies to Pages only).

Since:

1.10.0

isInstagramEligible

Boolean isInstagramEligible

Whether this post can be promoted in Instagram.

isPopular

Boolean isPopular

Whether the post is currently popular. Based on whether the total actions as a percentage of reach exceeds a certain threshold

isPublished

Boolean isPublished

Indicates whether a scheduled post was published. (applies to scheduled Page Post only, for users post and instantly published posts this value is always true)

Since:

1.10.0

isSpherical

Boolean isSpherical

Whether the post is a spherical video post.

likes

Likes likes

Duplicate mapping for "likes" since FB can return it differently in different situations. -- GETTER -- The likes on this post.

Sometimes this can be null - check Post.getLikesCount() instead in that case.

likesCount

Long likesCount

Duplicate mapping for "likes" since FB can return it differently in different situations.

link

String link

The link attached to this post. Hint for Graph API 3.3: Use attachment/url_unshimmed instead

message

String message

The message.

messageTags

List<MessageTag> messageTags

multiShareEndCard

Boolean multiShareEndCard

Whether display the end card for a multi-link share post

multiShareOptimized

Boolean multiShareOptimized

Whether automatically select the order of the links in multi-link share post when used in an ad

name

String name

The name of the link. Hint for Graph API 3.3: Use attachment/title instead

objectId

String objectId

The Facebook object id for an uploaded photo or video. Hint for Graph API 3.3: Use attachment/target/id instead

Since:

1.6.5

parentId

String parentId

ID of the parent post

permalinkUrl

String permalinkUrl

The permanent static URL to the post on www.facebook.com.

Example: https://www.facebook.com/FacebookforDevelopers/posts/10153449196353553

picture

String picture

If available, a link to the picture included with this post.

place

Place place

The place where this post occurred.

Since:

1.6.8

privacy

Privacy privacy

The privacy settings for this post.

promotionStatus

String promotionStatus

Status of the promotion, if the post was promoted.

properties

List<Post.Property> properties

reactions

Reactions reactions

The reactions for this post.

scheduledPublishTime

Date scheduledPublishTime

UNIX timestamp of the scheduled publish time for the post.

shares

Post.Shares shares

Number of times the post has been shared.

source

String source

If available, the source link attached to this post (for example, a flash or video file). Hint for Graph API 3.3: Use attachment/media/source instead

sponsorTags

List<NamedFacebookType> sponsorTags

statusType

String statusType

The status_type of post this is, for example "approved_friend".

Since:

1.6.12

story

String story

Text from stories not intentionally generated by users

Since:

1.6.16

storyTags

List<MessageTag> storyTags

taggedTime

Date taggedTime

This field is available on tagged Posts.

target

NamedFacebookType target

The profile this was posted on if different from the author.

targeting

Post.Targeting targeting

Ads targeting information of the post.

timelineVisibility

String timelineVisibility

Timeline visibility information of the post.

to

List<NamedFacebookType> to

updatedTime

Date updatedTime

The time of the last comment on this post.

via

String via

ID of the user or Page the post was shared from

Class com.restfb.types.Post.Action

class Action extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

link

String link

The link for the action.

name

String name

Gets the name of the action.

Class com.restfb.types.Post.Attachments

class Attachments extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

data

List<StoryAttachment> data

All media attachments associated with this post.

Class com.restfb.types.Post.FeedTargeting

class FeedTargeting extends Post.Targeting implements Serializable

serialVersionUID:

1L

Serialized Fields

ageMax

Integer ageMax

Maximum age.

ageMin

Integer ageMin

Must be 13 or higher. Default is 0

collegeMajors

List<String> collegeMajors

collegeNetworks

List<FacebookType> collegeNetworks

collegeYears

List<Integer> collegeYears

educationStatuses

List<Integer> educationStatuses

fanOf

List<String> fanOf

genders

List<Integer> genders

interestedIn

List<Integer> interestedIn

interests

List<String> interests

relationshipStatuses

List<Integer> relationshipStatuses

relevantUntilTs

Date relevantUntilTs

workNetworks

List<NamedFacebookType> workNetworks

Class com.restfb.types.Post.KeyedType

class KeyedType extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

key

String key

Class com.restfb.types.Post.Property

class Property extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

href

String href

The URL of the property.

name

String name

The name of the property.

text

String text

The text of the property.

Class com.restfb.types.Post.Shares

class Shares extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

count

Long count

The number of shares.

Class com.restfb.types.Post.Targeting

class Targeting extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

cities

List<Post.KeyedType> cities

countries

List<String> countries

geoLocations

Post.FeedTargeting geoLocations

locales

List<Integer> locales

regions

List<Post.KeyedType> regions

Class com.restfb.types.PostCallToAction

class PostCallToAction extends FacebookType implements Serializable

Serialized Fields

value

PostCallToAction.PostCallToActionValue value

Class com.restfb.types.PostCallToAction.PostCallToActionValue

class PostCallToActionValue extends AbstractFacebookType implements Serializable

Serialized Fields

application

String application

leadGenFormId

String leadGenFormId

link

String link

linkCaption

String linkCaption

linkDescription

String linkDescription

linkFormat

String linkFormat

linkTitle

String linkTitle

page

String page

Class com.restfb.types.Privacy

class Privacy extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

allow

String allow

For CUSTOM settings, a comma-separated list of user IDs and friend list IDs that "can" see the post. This can also be ALL_FRIENDS or FRIENDS_OF_FRIENDS to include all members of those sets.

deny

String deny

For CUSTOM settings, a comma-separated list of user IDs and friend list IDs that "cannot" see the post.

description

String description

The privacy description.

friends

String friends

The privacy friends restriction.

networks

String networks

The privacy networks restriction.

value

String value

The description of the privacy value.

Class com.restfb.types.ProfilePictureSource

class ProfilePictureSource extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

height

Integer height

Picture height in pixels

isSilhouette

Boolean isSilhouette

Indicates whether the profile photo is the default 'silhouette' picture, or has been replaced

url

String url

URL of the profile picture

width

Integer width

Picture width in pixels

Class com.restfb.types.ProjectExperience

class ProjectExperience extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

endDate

Date endDate

from

User from

startDate

Date startDate

with

List<User> with

Class com.restfb.types.Reactions

class Reactions extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

data

List<Reactions.ReactionItem> data

summary

String summary

totalCount

Long totalCount

The number of reactions.

viewerReaction

String viewerReaction

returns the user reaction to the object

Class com.restfb.types.Reactions.ReactionItem

class ReactionItem extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

the id of the user who sent the reaction

name

String name

the name of the user who sent the reaction

type

String type

type of the reaction may be {NONE, LIKE, LOVE, WOW, HAHA, SAD, ANGRY}

Class com.restfb.types.ReelsUploadStartResponse

class ReelsUploadStartResponse extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

uploadUrl

String uploadUrl

videoId

String videoId

Class com.restfb.types.ResumableUploadStartResponse

class ResumableUploadStartResponse extends ResumableUploadTransferResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

uploadSessionId

String uploadSessionId

videoId

String videoId

Class com.restfb.types.ResumableUploadTransferResponse

class ResumableUploadTransferResponse extends AbstractFacebookType implements Serializable

Serialized Fields

endOffset

Long endOffset

startOffset

Long startOffset

Class com.restfb.types.Review

class Review extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

createdTime

Date createdTime

When the review was created.

Since:

1.6.16

from

NamedFacebookType from

The user that created the review.

Since:

1.6.16

message

String message

The review text, if any.

Since:

1.6.16

rating

int rating

The review rating.

Since:

1.6.16

to

NamedFacebookType to

The app to which this review applies.

Since:

1.6.16

Class com.restfb.types.SavedMessageResponse

class SavedMessageResponse extends FacebookType implements Serializable

Serialized Fields

category

String category

The message category of the saved response

image

String image

The image attached to this save response

isEnabled

Boolean isEnabled

Toggle whether to enable the message

message

String message

The message body of the saved response

title

String title

The title of the saved response

Class com.restfb.types.SearchPlace

class SearchPlace extends NamedFacebookType implements Serializable

Serialized Fields

about

String about

Information about the Place provided by the Page administrator.

appLinks

AppLinks appLinks

AppLinks to the Place on various devices.

categoryList

List<Category> categoryList

checkins

Long checkins

The number of checkins at this Place.

cover

CoverPhoto cover

Information about the cover photo.

description

String description

The description of the Place provided by the Page administrator.

engagement

Page.Engagement engagement

The social sentence and the like count information for this Place. This is the same information used for the like button.

hours

String hours

isAlwaysOpen

Boolean isAlwaysOpen

Indicates whether this Place is always open.

isPermanentlyClosed

Boolean isPermanentlyClosed

Indicates whether this Place is permanently closed.

isVerified

Boolean isVerified

Pages with a large number of followers can be manually verified by Facebook as having an authentic identity. This field indicates whether the Page has been verified by this process.

link

String link

The URL of the Facebook Page.

location

Location location

Location information about the Place. E.g., latitude and longitude, and address.

overallStarRating

Double overallStarRating

The overall page rating, based on rating survey from users, on a scale of 1-5. This value is normalized, and is not guaranteed to be a strict average of user ratings.

page

Page page

The Page node corresponding to the Place.

parking

Page.PageParking parking

Parking information about the Place.

paymentOptions

Page.PagePaymentOptions paymentOptions

Payment options accepted by the Place. Applicable to restaurants and nightlife.

phone

String phone

The Place's telephone number.

photos

List<Photo> photos

Photos for the Place. By default, this edge returns the profile photos for the Place. You can also use an optional type parameter with the value uploaded to get the photos uploaded by the Place.

picture

ProfilePictureSource picture

The pages's profile picture, if provided. To force Facebook to fill the picture field you have to fetch the page with the fields=picture parameter, otherwise the picture is null.

priceRange

String priceRange

Price range of the business. Applicable to Restaurants or Nightlife. Can be one of $ (0-10), $$ (10-30), $$$ (30-50), $$$$ (50+), or Unspecified

ratingCount

Long ratingCount

Number of ratings for the Place

restaurantServices

Page.PageRestaurantServices restaurantServices

The services that the restaurant provides.

restaurantSpecialties

Page.PageRestaurantSpecialties restaurantSpecialties

The restaurant's specialties.

singleLineAddress

String singleLineAddress

The Place's complete postal address, on a single line.

website

String website

The URL of the Place's website.

workflows

List<SearchPlace.PagesPlatformComponentFlowServiceConfig> workflows

The native component workflows for this Place. Workflows allow people to perform actions like requesting appointments, buying tickets, and ordering from restaurants on Facebook

Class com.restfb.types.SearchPlace.PagesPlatformComponentFlowServiceConfig

class PagesPlatformComponentFlowServiceConfig extends FacebookType implements Serializable

Serialized Fields

deeplink

String deeplink

flowCategory

String flowCategory

label

String label

Class com.restfb.types.Story

class Story extends AbstractFacebookType implements Serializable

Serialized Fields

creationTime

Date creationTime

mediaId

String mediaId

mediaType

String mediaType

postId

String postId

status

String status

url

String url

Class com.restfb.types.StoryAttachment

class StoryAttachment extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Returns text accompanying the attachment.

descriptionTags

List<EntityAtTextRange> descriptionTags

media

StoryAttachment.Media media

Returns media object (photo, link etc.) contained in the attachment.

mediaType

String mediaType

Type of the media such as (photo, video, link etc)

subAttachments

StoryAttachment.Attachments subAttachments

Returns list of subattachments that are associated with this attachment.

target

StoryAttachment.Target target

Returns object that the attachment links to.

title

String title

Returns title of the attachment.

unshimmedUrl

String unshimmedUrl

Unshimmed URL of the attachment.

url

String url

Returns URL of the attachment.

Class com.restfb.types.StoryAttachment.Attachments

class Attachments extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

data

List<StoryAttachment> data

Class com.restfb.types.StoryAttachment.Image

class Image extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

height

Integer height

src

String src

width

Integer width

Class com.restfb.types.StoryAttachment.Media

class Media extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

image

StoryAttachment.Image image

source

String source

Class com.restfb.types.StoryAttachment.Target

class Target extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

unshimmedUrl

String unshimmedUrl

url

String url

Class com.restfb.types.Subscription

class Subscription extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

active

Boolean active

Indicates whether or not the subscription is active.

callbackUrl

String callbackUrl

The URL that will receive the POST request when an update is triggered.

compatFields

List<String> compatFields

fields

List<Subscription.SubscriptionField> fields

One or more of the set of valid fields in this object to subscribe to. The set of valid fields is defined here: https://developers.facebook.com/docs/graph-api/real-time-updates/v2.3#subscribefields

object

String object

Indicates the object type that this subscription applies to. type: user, page, permissions, payments

Class com.restfb.types.Subscription.SubscriptionField

class SubscriptionField extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

version

Version version

versionAsString

String versionAsString

Class com.restfb.types.TestUser

class TestUser extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

You can use this access token to make API calls on behalf of the test user. This is available only if your app has been installed by the test user.

email

String email

If logging in manually (that is, not using the login_url), you can use this as the user's email address.

loginUrl

String loginUrl

You can login as the test user by going to this url.

password

String password

If logging in manually (that is, not using the login_url), you can use this as the user's password.

Class com.restfb.types.Thread

class Thread extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

comments

List<Message> comments

to

List<NamedFacebookType> to

unread

Integer unread

The amount of messages that are unread by the session profile.

unseen

Integer unseen

The amount of messages that are unseen by the session profile.

updatedTime

Date updatedTime

The time of the last comment on this post.

Class com.restfb.types.Translation

class Translation extends FacebookType implements Serializable

Serialized Fields

approvalStatus

String approvalStatus

The approval status of the string.

Possible values: auto-approved, approved, unapproved

description

String description

The provided description of the string.

nativeString

String nativeString

The original string that was translated.

translation

String translation

The translated string.

Class com.restfb.types.Url

class Url extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

appLinks

AppLinks appLinks

AppLinks data associated with this URL.

commentCount

int commentCount

The sum of comments on posts containing this URL on Facebook.

commentPluginCount

int commentPluginCount

The number shown in the comments plugin associated with the URL. This number does not include comments made on posts on Facebook.

engagement

String engagement

ogObject

Url.OGObject ogObject

The Open Graph object that is canonically associated with this URL.

reactionCount

int reactionCount

The sum of reactions across all posts containing the URL on Facebook.

share

String share

shareCount

int shareCount

The total shares of this URL all over Facebook. is set 0 if the share count is not present

Class com.restfb.types.Url.OGObject

class OGObject extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

The description of the object. -- GETTER --

image

String image

The image url -- GETTER --

title

String title

The title of the object. -- GETTER --

type

String type

The object type. -- GETTER --

updatedTime

Date updatedTime

When the object was last updated. -- GETTER --

url

String url

This URL. -- GETTER --

Class com.restfb.types.User

class User extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

ageRange

User.AgeRange ageRange

Unspecific age range that this person's age fits into.

bio

String bio

The user's biographical snippet.

birthday

String birthday

The user's birthday as a String.

Will always succeed, even if the user has specified month/year format only. If you'd like to use a typed version of this accessor, call User.getBirthdayAsDate() instead. "The person's birthday. This is a fixed format string, like `MM/DD/YYYY`. However, people can control who can see the year they were born separately from the month and day so this string can be only the year (YYYY) or the month + day (MM/DD)",

context

FacebookType context

Social context for this person

cover

CoverPhoto cover

The person's cover photo

currency

User.Currency currency

The user's currency preferences.

Further documentation available on Facebook's Displaying prices in user's currency page.

Since:

1.6.12

devices

List<User.UserDevice> devices

email

String email

The proxied or contact email address granted by the user.

favoriteAthletes

List<User.Experience> favoriteAthletes

favoriteTeams

List<User.Experience> favoriteTeams

firstName

String firstName

The user's first name.

gender

String gender

The user's gender.

hometown

NamedFacebookType hometown

Duplicate mapping for "hometown" since FB can return it differently in different situations. -- GETTER -- The user's hometown.

Sometimes this can be null - check User.getHometownName() instead in that case.

hometownAsString

String hometownAsString

Duplicate mapping for "hometown" since FB can return it differently in different situations.

idForAvatars

String idForAvatars

A profile based app scoped ID. It is used to query avatars

idsForApps

List<UserIDForApp> idsForApps

idsForBusiness

List<UserIDForApp> idsForBusiness

idsForPages

List<UserIDForPage> idsForPages

inspirationalPeople

List<User.Experience> inspirationalPeople

installed

Boolean installed

Is the app making the request installed?

installType

String installType

Install type.

invitableFriends

List<UserInvitableFriend> invitableFriends

isGuestUser

Boolean isGuestUser

if the current user is a guest user. should always return false.

isVerified

Boolean isVerified

People with large numbers of followers can have the authenticity of their identity manually verified by Facebook. This field indicates whether the person's profile is verified in this way. This is distinct from the verified field

isWorkAccount

Boolean isWorkAccount

labels

List<PageLabel> labels

languages

List<User.Experience> languages

lastName

String lastName

The user's last name.

likes

Likes likes

The user's Likes

link

String link

A link to the person's Timeline. The link will only resolve if the person clicking the link is logged into Facebook and is a friend of the person whose profile is being viewed.

locale

String locale

The user's locale.

location

NamedFacebookType location

he person's current location as entered by them on their profile. This field requires the `user_location` permission.

meetingFor

List<String> meetingFor

middleName

String middleName

The user's middle name.

nameFormat

String nameFormat

The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering.

paymentPricepoints

User.PaymentPricepoints paymentPricepoints

The person's payment pricepoints

picture

ProfilePictureSource picture

The user's picture, if provided. To force Facebook to fill the picture field you have to fetch the user with the fields=picture parameter, otherwise the picture is null.

Since:

1.6.16

profilePic

String profilePic

The profile picture URL of the Messenger user. The URL will expire.

publicKey

String publicKey

The person's PGP public key

quotes

String quotes

The user's favorite quotes.

sharedLoginUpgradeRequiredBy

Date sharedLoginUpgradeRequiredBy

The time that the shared loginneeds to be upgraded to Business Manager by

shortName

String shortName

Shortened, locale-aware name for the person.

significantOther

User significantOther

The user's significant other.

sports

List<User.Sport> sports

supportsDonateButtonInLiveVideo

Boolean supportsDonateButtonInLiveVideo

Whether the user can add a Donate Button to their Live Videos

thirdPartyId

String thirdPartyId

An anonymous, but unique identifier for the user.

timezone

Double timezone

The user's timezone offset.

tokenForBusiness

String tokenForBusiness

This returns a string which is the same for this person across all the apps managed by the same Business Manager.

Since:

1.7.0

updatedTime

Date updatedTime

Date the user's profile was updated.

verified

Boolean verified

Indicates whether the account has been verified. This is distinct from the is_verified field. Someone is considered verified if they take any of the following actions:

• Register for mobile
• Confirm their account via SMS
• Enter a valid credit card

videoUploadLimits

User.VideoUploadLimits videoUploadLimits

Video upload limits

Class com.restfb.types.User.AgeRange

class AgeRange extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

max

Integer max

The upper bounds of the range for this person's age.

min

Integer min

The lower bounds of the range for this person's age.

Class com.restfb.types.User.Currency

class Currency extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

currencyExchange

BigDecimal currencyExchange

The number of Facebook Credits that equate in value to one unit of user_currency.

currencyExchangeInverse

BigDecimal currencyExchangeInverse

The number of units of user_currency that equate in value to one Credit.

To calculate the local currency amount based on the credits price, compute credits_price * currency_exchange_inverse.

currencyOffset

BigDecimal currencyOffset

The number by which a price should be divided for display in user_currency units.

For example, a price of $1.20 will be represented by the Facebook API as "120", which you should divide by the USD currency_offset of 100 to arrive back at 1.20.

userCurrency

String userCurrency

The ISO-4217-3 code for the user's preferred currency (defaulting to USD if the user hasn't set one).

Class com.restfb.types.User.Experience

class Experience extends NamedFacebookType implements Serializable

Serialized Fields

description

String description

from

User from

with

List<User> with

Class com.restfb.types.User.PaymentPricepoint

class PaymentPricepoint extends AbstractFacebookType implements Serializable

Serialized Fields

credits

Double credits

localCurrency

String localCurrency

userPrice

String userPrice

Class com.restfb.types.User.PaymentPricepoints

class PaymentPricepoints extends AbstractFacebookType implements Serializable

Serialized Fields

mobile

List<User.PaymentPricepoint> mobile

Class com.restfb.types.User.SecureBrowsing

class SecureBrowsing extends AbstractFacebookType implements Serializable

Serialized Fields

enabled

Boolean enabled

Enabled

Class com.restfb.types.User.Sport

class Sport extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

with

List<NamedFacebookType> with

Class com.restfb.types.User.UserDevice

class UserDevice extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

hardware

String hardware

os

String os

Class com.restfb.types.User.VideoUploadLimits

class VideoUploadLimits extends AbstractFacebookType implements Serializable

Serialized Fields

length

Long length

size

Long size

Class com.restfb.types.UserIDForApp

class UserIDForApp extends FacebookType implements Serializable

Serialized Fields

app

Application app

Class com.restfb.types.UserIDForPage

class UserIDForPage extends FacebookType implements Serializable

Serialized Fields

page

Page page

Class com.restfb.types.UserInvitableFriend

class UserInvitableFriend extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

firstName

String firstName

lastName

String lastName

middleName

String middleName

picture

ProfilePictureSource picture

Class com.restfb.types.UserPermission

class UserPermission extends AbstractFacebookType implements Serializable

Serialized Fields

permission

String permission

status

String status

Class com.restfb.types.UserProfile

class UserProfile extends NamedFacebookType implements Serializable

Serialized Fields

firstName

String firstName

gender

String gender

isPaymentEnabled

Boolean isPaymentEnabled

lastAdReferral

UserProfile.LastAdReferral lastAdReferral

lastName

String lastName

locale

String locale

profilePic

String profilePic

timezone

String timezone

Class com.restfb.types.UserProfile.LastAdReferral

class LastAdReferral extends AbstractFacebookType implements Serializable

Serialized Fields

adId

String adId

source

String source

type

String type

Class com.restfb.types.Video

class Video extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

adBreaks

List<Integer> adBreaks

backdatedTime

Date backdatedTime

Back dated time

Since:

1.10.0

backdatedTimeGranularity

String backdatedTimeGranularity

String that represents the back dated time granularity

Since:

1.10.0

captions

List<VideoCaption> captions

comments

Comments comments

The comments for this video.

contentCategory

String contentCategory

The content category of this video.

contentTags

List<String> contentTags

createdTime

Date createdTime

The time the video was initially published.

customLabels

List<String> customLabels

description

String description

The long-form HTML description of the video.

embeddable

Boolean embeddable

Whether the video is embeddable.

embedHtml

String embedHtml

HTML that may be used to embed the video on another website.

event

Event event

If this object has a place, the event associated with the place.

feedType

String feedType

Whether or not the video is highlighted in Video Channel.

format

List<Video.VideoFormat> format

from

From from

An object containing the name and ID of the user who posted the video.

icon

String icon

An icon URL which represents the video.

isCrosspostingEligible

Boolean isCrosspostingEligible

Specifies if the video is eligible for crossposting.

isCrosspostVideo

Boolean isCrosspostVideo

isEpisode

Boolean isEpisode

Whether this video is episode or not.

isInstagramEligible

Boolean isInstagramEligible

Whether the video is eligible to be promoted on Instagram

isReferenceOnly

Boolean isReferenceOnly

Whether the video is exclusively used for copyright monitoring.

length

Double length

The length of the video, in seconds.

likes

Likes likes

People who like this. you need to add the field to the fields query parameter to get the likes list otherwise null is returned

liveAudienceCount

Integer liveAudienceCount

Number of unique people who watched the video broadcast when it was live.

liveStatus

String liveStatus

The live status of the video. Possible values contain LIVE, LIVE_STOPPED, VOD

message

String message

Deprecated.

FB seems to have removed this field.

The video title / caption.

musicVideoCopyright

MusicVideoCopyright musicVideoCopyright

The music video copyright of this video because of a missing object description in the graph reference, we use a Map here

permalinkUrl

String permalinkUrl

URL to the permalink page of the video

picture

String picture

A URL for the thumbnail picture of the video.

place

Place place

Location associated with the video, if any.

postViews

Integer postViews

The public view count of the video post, not aggregated with any other crossposts of the video.

premiereLivingRoomStatus

String premiereLivingRoomStatus

The status of the Premiere Watch Party, if any

privacy

Privacy privacy

Privacy setting for the video.

published

Boolean published

Whether a post about this video is published. This field is only accessible in Graph API 2.3 or later.

Since:

1.10.0

reactions

Reactions reactions

The reactions for this video.

scheduledPublishTime

Date scheduledPublishTime

The time that the video is scheduled to be published. This field is only accessible in Graph API 2.3 or later.

Since:

1.10.0

source

String source

A URL to the raw, playable video file.

Since:

1.6.5

status

Video.VideoStatus status

Object describing the status attributes of a video.

tags

List<NamedFacebookType> tags

thumbnails

Connection<Video.Thumbnail> thumbnails

title

String title

The video title or caption

universalVideoId

String universalVideoId

The publishers asset management code for this video.

updatedTime

Date updatedTime

The last time the video or its caption were updated.

videoInsights

Connection<Insight> videoInsights

views

Integer views

The public view count of the video.

Class com.restfb.types.Video.Thumbnail

class Thumbnail extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

height

Integer height

The height of the thumbnail

isPreferred

Boolean isPreferred

Whether this is the preferred thumbnail for the video

scale

Float scale

The scale of the thumbnail

uri

String uri

The uri of the thumbnail

width

Integer width

The width of the thumbnail

Class com.restfb.types.Video.VideoFormat

class VideoFormat extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

embedHtml

String embedHtml

HTML to embed the video in this format.

filter

String filter

The filter applied to this video format.

height

Integer height

The height of the video in this format.

picture

String picture

The thumbnail for the video in this format.

width

Integer width

The width of the video in this format.

Class com.restfb.types.Video.VideoPhase

class VideoPhase extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

bytesTransfered

Long bytesTransfered

errors

List<Video.VideoPhaseError> errors

publishStatus

String publishStatus

publishTime

Date publishTime

status

String status

Status of a videoPahse. not_started, in_progress, complete, error

Class com.restfb.types.Video.VideoPhaseError

class VideoPhaseError extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Long code

message

String message

Class com.restfb.types.Video.VideoStatus

class VideoStatus extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

processingProgress

Integer processingProgress

Video processing progress in percent [int 0 to 100].

processingVideoPhase

Video.VideoPhase processingVideoPhase

This structure contains information about progress through the processing phase. This phase encompasses generating alternate media encodings, thumbnails, and other assets necessary for publishing.

publishingVideoPhase

Video.VideoPhase publishingVideoPhase

This structure contains information about progress through the publishing phase. This phase encompasses adding the video to the page, and if scheduled, will describe when the video is intended to be published.

uploadingVideoPhase

Video.VideoPhase uploadingVideoPhase

This structure contains information about progress through the uploading phase. The bytes_transferred field can be used in conjunction with the upload endpoint to resume an interrupted upload.

videoStatus

String videoStatus

Status of a video. Either "ready" (uploaded, encoded, thumbnails extracted), "processing" (not ready yet) or "error" (processing failed).

Class com.restfb.types.VideoCaption

class VideoCaption extends AbstractFacebookType implements Serializable

Serialized Fields

createTime

Date createTime

isAutoGenerated

Boolean isAutoGenerated

isDefault

Boolean isDefault

locale

String locale

localeName

String localeName

uri

String uri

Class com.restfb.types.VideoCopyright

class VideoCopyright extends FacebookType implements Serializable

Serialized Fields

copyrightContentId

String copyrightContentId

The copyright content ID

creator

User creator

The account that created the copyright

monitoringStatus

String monitoringStatus

Whether the video is monitored successfully for copyright. The status could be NOT_EXAMED, COPYRIGHTED and ERROR.

monitoringType

String monitoringType

Whether the video is monitored for video, audio, or both

ownershipCountries

List<String> ownershipCountries

A string array of ISO 3166 format country codes, where the owner owns the rights of the content

referenceOwnerId

String referenceOwnerId

The ID of the reference video owner

ruleIds

List<VideoCopyrightRule> ruleIds

A list of matching rules applied to the copyrighted content

whitelistedIds

List<String> whitelistedIds

A list of page IDs or user IDs, who are allowed to use the copyrighted content.

Class com.restfb.types.VideoCopyrightRule

class VideoCopyrightRule extends NamedFacebookType implements Serializable

Serialized Fields

copyrights

List<String> copyrights

Copyrights associated with this copyright rules object

createdDate

Date createdDate

The date on which the rule was created

creator

User creator

The person who created the match rule

Class com.restfb.types.VideoList

class VideoList extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

creationTime

Date creationTime

The time when the playlist was created

description

String description

Description of the playlist

lastModified

Date lastModified

The time when the contents of the playlist was last changed

owner

From owner

Owner of the playlist

title

String title

Title of the playlist

Class com.restfb.types.VideoPoll

class VideoPoll extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

closeAfterVoting

Boolean closeAfterVoting

True if this is a Live poll with open voting and the card hides after voting

defaultOpen

Boolean defaultOpen

True if the poll should be open by default, false if it starts in a closed state

pollOptions

List<VideoPoll.VideoPollOption> pollOptions

question

String question

The poll question text

showGradient

Boolean showGradient

True if this is a Live poll and voting is open and there is a background gradient to highlight the voting card

showResults

Boolean showResults

True if this is a Live poll and voting is open and the results show after voting

status

String status

Live poll status

Class com.restfb.types.VideoPoll.VideoPollOption

class VideoPollOption extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

isCorrect

Boolean isCorrect

True if this answer is considered correct, otherwise false

order

Long order

Options appear in increasing numerical order within a poll

text

String text

Text to display to the user for this option

totalVotes

Long totalVotes

Total number of votes for this option

Package com.restfb.types.ads

Class com.restfb.types.ads.Ad

class Ad extends NamedAdsObject implements Serializable

Serialized Fields

accountId

String accountId

adlabels

List<AdLabel> adlabels

adReviewFeedback

AdgroupReviewFeedback adReviewFeedback

adset

AdSet adset

adsetId

String adsetId

bidAmount

Long bidAmount

bidInfo

Map<String,Long> bidInfo

bidType

String bidType

campaign

Campaign campaign

campaignId

String campaignId

configuredStatus

String configuredStatus

conversionSpecs

List<ConversionActionQuery> conversionSpecs

createdTime

Date createdTime

creative

AdCreative creative

demolinkHash

String demolinkHash

displaySequence

Long displaySequence

effectiveStatus

String effectiveStatus

engagementAudience

Boolean engagementAudience

failedDeliveryChecks

List<DeliveryCheck> failedDeliveryChecks

issuesInfo

List<AdgroupIssuesInfo> issuesInfo

lastUpdatedByAppId

String lastUpdatedByAppId

priority

Long priority

recommendations

List<AdRecommendation> recommendations

sourceAd

Ad sourceAd

sourceAdId

String sourceAdId

status

String status

targeting

Targeting targeting

targetingsentencelines

List<TargetingSentenceLine> targetingsentencelines

trackingAndConversionWithDefaults

TrackingAndConversionWithDefaults trackingAndConversionWithDefaults

trackingSpecs

List<ConversionActionQuery> trackingSpecs

updatedTime

Date updatedTime

Class com.restfb.types.ads.AdAccount

class AdAccount extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

accountGroups

List<AdAccountGroup> accountGroups

accountId

String accountId

accountStatus

Integer accountStatus

adAccountCreationRequest

AdAccountCreationRequest adAccountCreationRequest

adAccountPromotableObjects

AdAccountPromotableObjects adAccountPromotableObjects

age

Float age

agencyClientDeclaration

AgencyClientDeclaration agencyClientDeclaration

amountSpent

String amountSpent

balance

String balance

business

Business business

businessCity

String businessCity

businessCountryCode

String businessCountryCode

businessName

String businessName

businessState

String businessState

businessStreet

String businessStreet

businessStreet2

String businessStreet2

businessZip

String businessZip

capabilities

List<String> capabilities

createdTime

Date createdTime

currency

String currency

disableReason

Integer disableReason

endAdvertiser

String endAdvertiser

endAdvertiserName

String endAdvertiserName

extendedCreditInvoiceGroup

ExtendedCreditInvoiceGroup extendedCreditInvoiceGroup

failedDeliveryChecks

List<AdDeliveryCheck> failedDeliveryChecks

fundingSource

String fundingSource

fundingSourceDetails

FundingSourceDetails fundingSourceDetails

hasMigratedPermissions

Boolean hasMigratedPermissions

ioNumber

String ioNumber

isPersonal

String isPersonal

isPrepayAccount

Boolean isPrepayAccount

isTaxIdRequired

Boolean isTaxIdRequired

lastUsedTime

Date lastUsedTime

lineNumbers

List<Integer> lineNumbers

mediaAgency

String mediaAgency

minCampaignGroupSpendCap

String minCampaignGroupSpendCap

minDailyBudget

Integer minDailyBudget

offsitePixelsTosAccepted

Boolean offsitePixelsTosAccepted

owner

String owner

ownerBusiness

Business ownerBusiness

partner

String partner

rfSpec

ReachFrequencySpec rfSpec

spendCap

String spendCap

taxId

String taxId

taxIdStatus

Integer taxIdStatus

taxIdType

String taxIdType

timezoneId

Integer timezoneId

timezoneName

String timezoneName

timezoneOffsetHoursUtc

Float timezoneOffsetHoursUtc

tosAccepted

String tosAccepted

userAccessExpireTime

Date userAccessExpireTime

userRole

String userRole

Deprecated.

userTasks

List<String> userTasks

verticalName

String verticalName

Class com.restfb.types.ads.AdAccountActivity

class AdAccountActivity extends BaseAdsObject implements Serializable

Serialized Fields

billingAddressNew

String billingAddressNew

billingAddressOld

String billingAddressOld

createdBy

String createdBy

createdTime

String createdTime

creditNew

JsonObject creditNew

creditOld

JsonObject creditOld

creditStatusNew

String creditStatusNew

creditStatusOld

String creditStatusOld

currencyNew

String currencyNew

currencyOld

String currencyOld

dailySpendLimitNew

JsonObject dailySpendLimitNew

dailySpendLimitOld

JsonObject dailySpendLimitOld

eventTime

String eventTime

eventType

String eventType

fundingIdNew

String fundingIdNew

fundingIdOld

String fundingIdOld

gracePeriodTimeNew

Long gracePeriodTimeNew

gracePeriodTimeOld

Long gracePeriodTimeOld

managerIdNew

String managerIdNew

managerIdOld

String managerIdOld

nameNew

String nameNew

nameOld

String nameOld

spendCapNew

JsonObject spendCapNew

spendCapOld

JsonObject spendCapOld

statusNew

String statusNew

statusOld

String statusOld

termsNew

Long termsNew

termsOld

Long termsOld

tierNew

String tierNew

tierOld

String tierOld

timeUpdatedNew

String timeUpdatedNew

timeUpdatedOld

String timeUpdatedOld

Class com.restfb.types.ads.AdAccountCreationRequest

class AdAccountCreationRequest extends BaseAdsObject implements Serializable

Serialized Fields

adAccountsCurrency

String adAccountsCurrency

adAccountsInfo

List<JsonObject> adAccountsInfo

additionalComment

String additionalComment

addressInChinese

String addressInChinese

addressInEnglish

JsonObject addressInEnglish

addressInLocalLanguage

String addressInLocalLanguage

advertiserBusiness

Business advertiserBusiness

appealReason

JsonObject appealReason

business

Business business

businessRegistrationId

String businessRegistrationId

chineseLegalEntityName

String chineseLegalEntityName

contact

JsonObject contact

creator

User creator

creditCardId

String creditCardId

englishLegalEntityName

String englishLegalEntityName

extendedCreditId

String extendedCreditId

isSmb

Boolean isSmb

isTest

Boolean isTest

isUnderAuthorization

Boolean isUnderAuthorization

legalEntityNameInLocalLanguage

String legalEntityNameInLocalLanguage

mDisapprovalReasons

List<JsonObject> mDisapprovalReasons

oeRequestId

String oeRequestId

officialWebsiteUrl

String officialWebsiteUrl

planningAgencyBusiness

Business planningAgencyBusiness

planningAgencyBusinessId

String planningAgencyBusinessId

promotableAppIds

List<String> promotableAppIds

promotablePageIds

List<String> promotablePageIds

promotableUrls

List<String> promotableUrls

requestChangeReasons

List<JsonObject> requestChangeReasons

status

String status

subvertical

String subvertical

timeCreated

String timeCreated

vertical

String vertical

Class com.restfb.types.ads.AdAccountGroup

class AdAccountGroup extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

accountGroupId

String accountGroupId

accounts

List<AdAccountGroupAccount> accounts

The AdGroup Accounts in the ad account group.

status

Integer status

users

List<AdAccountGroupUser> users

The users who own the ad account group.

Class com.restfb.types.ads.AdAccountGroupAccount

class AdAccountGroupAccount extends AbstractFacebookType implements Serializable

Serialized Fields

accountId

String accountId

status

String status

Class com.restfb.types.ads.AdAccountGroupUser

class AdAccountGroupUser extends AbstractFacebookType implements Serializable

Serialized Fields

role

String role

uid

String uid

Class com.restfb.types.ads.AdAccountPromotableObjects

class AdAccountPromotableObjects extends BaseAdsObject implements Serializable

Serialized Fields

mPromotableAppIds

List<String> mPromotableAppIds

mPromotablePageIds

List<String> mPromotablePageIds

mPromotableUrls

List<String> mPromotableUrls

Class com.restfb.types.ads.AdAccountTargetingInsights

class AdAccountTargetingInsights extends NamedAdsObject implements Serializable

Serialized Fields

audienceSize

Long audienceSize

explorationRatio

Double explorationRatio

path

List<String> path

performanceRating

Long performanceRating

recommendationRating

Long recommendationRating

tags

List<String> tags

type

String type

Class com.restfb.types.ads.AdAssetFeedAdditionalData

class AdAssetFeedAdditionalData extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

brandPageId

String brandPageId

multiShareEndCard

Boolean multiShareEndCard

Class com.restfb.types.ads.AdAssetFeedSpec

class AdAssetFeedSpec extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalData

AdAssetFeedAdditionalData additionalData

adFormats

List<String> adFormats

assetCustomizationRules

List<JsonObject> assetCustomizationRules

autotranslate

List<String> autotranslate

bodies

List<AdAssetFeedSpecBody> bodies

callToActionTypes

List<String> callToActionTypes

captions

List<AdAssetFeedSpecCaption> captions

carousels

List<JsonObject> carousels

descriptions

List<AdAssetFeedSpecDescription> descriptions

groups

List<AdAssetFeedSpecGroupRule> groups

images

List<AdAssetFeedSpecImage> images

linkUrls

List<AdAssetFeedSpecLinkURL> linkUrls

optimizationType

String optimizationType

titles

List<AdAssetFeedSpecTitle> titles

videos

List<AdAssetFeedSpecVideo> videos

Class com.restfb.types.ads.AdAssetFeedSpecAssetLabel

class AdAssetFeedSpecAssetLabel extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Class com.restfb.types.ads.AdAssetFeedSpecGroupRule

class AdAssetFeedSpecGroupRule extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

bodyLabel

AdAssetFeedSpecAssetLabel bodyLabel

captionLabel

AdAssetFeedSpecAssetLabel captionLabel

descriptionLabel

AdAssetFeedSpecAssetLabel descriptionLabel

imageLabel

AdAssetFeedSpecAssetLabel imageLabel

linkUrlLabel

AdAssetFeedSpecAssetLabel linkUrlLabel

titleLabel

AdAssetFeedSpecAssetLabel titleLabel

videoLabel

AdAssetFeedSpecAssetLabel videoLabel

Class com.restfb.types.ads.AdAssetFeedSpecImage

class AdAssetFeedSpecImage extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

adlabels

List<AdAssetFeedSpecAssetLabel> adlabels

hash

String hash

mImageCrops

AdsImageCrops mImageCrops

url

String url

urlTags

String urlTags

Class com.restfb.types.ads.AdAssetFeedSpecVideo

class AdAssetFeedSpecVideo extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

adlabels

List<AdAssetFeedSpecAssetLabel> adlabels

captionIds

List<String> captionIds

thumbnailHash

String thumbnailHash

thumbnailUrl

String thumbnailUrl

urlTags

String urlTags

videoId

String videoId

Class com.restfb.types.ads.AdBidAdjustments

class AdBidAdjustments extends BaseAdsObject implements Serializable

Serialized Fields

ageRange

Map<String,Double> ageRange

mPageTypes

JsonObject mPageTypes

userGroups

String userGroups

Class com.restfb.types.ads.AdCampaignBidConstraint

class AdCampaignBidConstraint extends BaseAdsObject implements Serializable

Serialized Fields

roasAverageFloor

Long roasAverageFloor

Class com.restfb.types.ads.AdCampaignFrequencyControlSpecs

class AdCampaignFrequencyControlSpecs extends AbstractFacebookType implements Serializable

Serialized Fields

event

String event

Event name, only IMPRESSIONS currently.

intervalDays

Long intervalDays

Interval period in days, between 1 and 90 (inclusive)

maxFrequency

Long maxFrequency

The maximum frequency, only 1 is allowed now.

Class com.restfb.types.ads.AdCampaignIssuesInfo

class AdCampaignIssuesInfo extends AbstractFacebookType implements Serializable

Serialized Fields

errorCode

Long errorCode

errorMessage

String errorMessage

errorSummary

String errorSummary

errorType

String errorType

level

String level

Class com.restfb.types.ads.AdConversionPixel

class AdConversionPixel extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

creator

String creator

jsPixel

String jsPixel

lastFiringTime

String lastFiringTime

tag

String tag

value

String value

Class com.restfb.types.ads.AdCreative

class AdCreative extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

actorId

String actorId

The actor ID (Page ID) of this creative. This field is available only for mobile app ads created before 2015

actorImageHash

String actorImageHash

The image used for actor's icon. This field is available only for mobile app ads created before 2015

actorImageUrl

String actorImageUrl

The URL of the icon for the actor (Page ID) of this creative. This field is only available for mobile app ads created before 2015

actorName

String actorName

The title text used for actor. This field is available only for mobile app ads created before 2015

adlabels

List<AdLabel> adlabels

Ad Labels that are associated with this creative

applinkTreatment

String applinkTreatment

Deep link fallback behavior for dynamic product ads if the app is not installed.

assetFeedSpec

AdAssetFeedSpec assetFeedSpec

Used for Dynamic Creative to automatically experiment and deliver different variations of an ad's creative.

body

String body

The body of the ad

callToActionType

String callToActionType

The call to action button text and header text of legacy ads.

creativeId

String creativeId

imageCrops

AdsImageCrops imageCrops

A JSON object defining crop dimensions for the image specified. See image crop reference for more details

imageHash

String imageHash

Image hash for an image you can use in creatives. See image library for more details

imageUrl

String imageUrl

A URL for the image for this creative. The image specified at this URL will be saved into the ad account's image library

instagramActorId

String instagramActorId

Instagram actor ID

instagramPermalinkUrl

String instagramPermalinkUrl

Instagram permalink

instagramStoryId

String instagramStoryId

Instagram Story ID -- GETTER

instagramUserId

String instagramUserId

interactiveComponentsSpec

AdCreativeInteractiveComponentsSpec interactiveComponentsSpec

linkOgId

String linkOgId

The Open Graph (OG) ID for the link in this creative if the landing page has OG tags

linkUrl

String linkUrl

Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL. See connection objects for retrieving Page tabs' URLs. app_data parameters may be added to the url to pass data to a tab app

objectId

String objectId

The ID of the promoted_object or object that is relevant to the ad and ad type

objectStoryId

String objectStoryId

The ID of a page post to use in an ad. This ID can be retrieved by using the graph API to query the posts of the page. If an image is used in the post, it will be downloaded and available in your account's image library

objectStorySpec

AdCreativeObjectStorySpec objectStorySpec

The page id and the content to create a new unpublished page post specified using one of link_data, photo_data, video_data, offer_data, text_data or template_data

objectType

String objectType

The type of object that is being advertised. Allowed values are:

• PAGE
• DOMAIN
• EVENT
• STORE_ITEM: refers to an iTunes or Google Play store destination
• OFFER
• SHARE: from a page
• PHOTO
• STATUS: of a page
• VIDEO
• APPLICATION: app on Facebook
• INVALID: when an invalid object_id was specified such as a deleted object or if you do not have permission to see the object. In very few cases, this field may be empty if Facebook is unable to identify the type of advertised object

objectUrl

String objectUrl

Destination URL for a link ads not connected to a page

platformCustomizations

String platformCustomizations

Use this field to customize the media for different Facebook placements. Currently you can use this field for customizing images only. The media specified here replaces the original media defined in the ad creative when the ad displays on those placements. For example, if you define a media here for the instagram key, Facebook uses that media instead of the media defined in the ad creative when showing the ad on Instagram.

productSetId

String productSetId

The ID of the product set for this creative. See dynamic product ads for more detail

runStatus

String runStatus

The run status of this creative. Allowed values are:

• ACTIVE
• DELETED

sourceInstagramMediaId

String sourceInstagramMediaId

templateUrl

String templateUrl

The Tracking URL for dynamic product ads. See dynamic product ads for more detail

thumbnailUrl

String thumbnailUrl

The URL to a thumbnail for this creative. You can optionally request dimensions of this thumbnail by providing the thumbnail_width and thumbnail_height parameters. See example for more detail

title

String title

Title for a link ad (not connected to a Page)

urlTags

String urlTags

A set of query string parameters which will replace or be appended to urls clicked from page post ads, and canvas app install creatives only

usePageActorOverride

Boolean usePageActorOverride

videoId

String videoId

Class com.restfb.types.ads.AdCreativeInteractiveComponentsSpec

class AdCreativeInteractiveComponentsSpec extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

mComponents

List<String> mComponents

Class com.restfb.types.ads.AdCreativeLinkData

class AdCreativeLinkData extends AbstractFacebookType implements Serializable

Serialized Fields

additionalImageIndex

Long additionalImageIndex

The index (zero based) of the image from the additionalimages array to use as the ad image for a dynamic product ad

appLinkSpec

AdCreativeLinkDataAppLinkSpec appLinkSpec

Native deeplinks attached to the post

attachmentStyle

String attachmentStyle

The style of the attachment.

brandedContentSponsorPageId

String brandedContentSponsorPageId

The branded content sponsor page id.

brandedContentSponsorRelationship

String brandedContentSponsorRelationship

The branded content sponsor relationship option.

callToAction

AdCreativeLinkDataCallToAction callToAction

An optional call to action button. If not specified, on Instagram, a default CTA would be used, {"type":"LEARN_MORE","value": {"link":,}}.

canvasEnabled

Boolean canvasEnabled

If canvas experience is enabled post click

caption

String caption

Link caption. Overwrites the caption under the title in the link on Facebook. See post for more info. This setting is not used on Instagram.

childAttachments

List<AdCreativeLinkDataChildAttachment> childAttachments

description

String description

Link description. Overwrites the description in the link on Facebook. See post for more info. This setting is not used on Instagram.

eventId

String eventId

The id of a Facebook event. This is only to be used if this creative is for a Website Clicks campaign, the Call To Action is Buy Tickets, and the link points to the ticketing website of this Facebook event.

forceSingleLink

Boolean forceSingleLink

Whether to force the post to render in a single link format

imageCrops

AdsImageCrops imageCrops

How to the image should be cropped. Different placements use different crop specs. For example, Facebook News Feed uses the crop spec with 191x100 key, and Instagram uses 100x100 crop spec.

imageHash

String imageHash

Hash of an image in your image library with Facebook. Specify this field or picture but not both

link

String link

Link url. See post for more info. This field is required for a carousel ad .

message

String message

The main body of the post. See post for more info. This field is required for a carousel ad .

multiShareEndCard

Boolean multiShareEndCard

If set to false, removes the end card which displays the page icon. Default is true. Used by carousel ads.

multiShareOptimized

Boolean multiShareOptimized

If set to true, automatically select and order images and links. Default is true. Used by carousel ads.

name

String name

Name of the link. Overwrites the title of the link preview. See post for more info.

offerId

String offerId

The id of a Facebook native offer.

pageWelcomeMessage

String pageWelcomeMessage

A welcome text from page to user on Messenger once a user performs send message action on an ad.

picture

String picture

URL of a picture to use in the post. Specify this field or image_hash but not both. See post for more info. The image specified at the URL will be saved into the ad accounts image library

postClickConfiguration

AdCreativePostClickConfiguration postClickConfiguration

retailerItemIds

List<String> retailerItemIds

List of product IDs provided by the advertiser for Collections

Class com.restfb.types.ads.AdCreativeLinkDataAppLinkSpec

class AdCreativeLinkDataAppLinkSpec extends AbstractFacebookType implements Serializable

Serialized Fields

android

List<AndroidAppLink> android

ios

List<IosAppLink> ios

ipad

List<IosAppLink> ipad

iphone

List<IosAppLink> iphone

Class com.restfb.types.ads.AdCreativeLinkDataCallToAction

class AdCreativeLinkDataCallToAction extends AbstractFacebookType implements Serializable

Serialized Fields

type

String type

The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used based on the objective of your campaign.

value

AdCreativeLinkDataCallToActionValue value

JSON containing the call to action data.

Class com.restfb.types.ads.AdCreativeLinkDataCallToActionValue

class AdCreativeLinkDataCallToActionValue extends AbstractFacebookType implements Serializable

Serialized Fields

appDestination

String appDestination

The app destination type.

application

String application

Application related to the action.

appLink

String appLink

Deep link to the app.

eventId

String eventId

ID of the Facebook event which the attachment show event info

leadGenFormId

String leadGenFormId

The Lead Ad form id.

link

String link

The destination link when the CTA button is clicked.

linkCaption

String linkCaption

Caption shown in the attachment.

linkDescription

String linkDescription

Description of the link shown in the attachment.

linkFormat

String linkFormat

Link format of video.

linkTitle

String linkTitle

Title of the link shown in the attachment.

page

String page

ID of the Facebook page which the CTA button links to

productLink

String productLink

Open graph object url for canvas virtual good ads.

Class com.restfb.types.ads.AdCreativeLinkDataChildAttachment

class AdCreativeLinkDataChildAttachment extends AbstractFacebookType implements Serializable

Serialized Fields

callToAction

AdCreativeLinkDataCallToAction callToAction

description

String description

imageCrops

AdsImageCrops imageCrops

imageHash

String imageHash

link

String link

name

String name

picture

String picture

placeData

AdCreativePlaceData placeData

staticCard

Boolean staticCard

videoId

String videoId

Class com.restfb.types.ads.AdCreativeObjectStorySpec

class AdCreativeObjectStorySpec extends AbstractFacebookType implements Serializable

Serialized Fields

instagramActorId

String instagramActorId

The Instagram user account that the story will be posted to

linkData

AdCreativeLinkData linkData

The spec for a link page post or carousel ad

offerData

AdCreativeOfferData offerData

The spec for an offer page post.

pageId

String pageId

ID of a Facebook page. An unpublished page post will be created on this page. User must have Admin or Editor role for this page.

photoData

AdCreativePhotoData photoData

The spec for a photo page post.

templateData

AdCreativeLinkData templateData

The spec for a template link page post as used in Dynamic Product Ads.

textData

AdCreativeTextData textData

The spec for a text page post.

videoData

AdCreativeVideoData videoData

The spec for a video page post.

Class com.restfb.types.ads.AdCreativeOfferData

class AdCreativeOfferData extends AbstractFacebookType implements Serializable

Serialized Fields

claimLimit

Long claimLimit

couponType

String couponType

expirationTime

String expirationTime

imageUrl

String imageUrl

message

String message

redemptionLink

String redemptionLink

reminderTime

String reminderTime

title

String title

Class com.restfb.types.ads.AdCreativePhotoData

class AdCreativePhotoData extends AbstractFacebookType implements Serializable

Serialized Fields

brandedContentSponsorPageId

String brandedContentSponsorPageId

caption

String caption

mImageHash

String mImageHash

url

String url

Class com.restfb.types.ads.AdCreativePlaceData

class AdCreativePlaceData extends AbstractFacebookType implements Serializable

Serialized Fields

addressString

String addressString

label

String label

latitude

Double latitude

locationSourceId

String locationSourceId

longitude

Double longitude

type

String type

Class com.restfb.types.ads.AdCreativePostClickConfiguration

class AdCreativePostClickConfiguration extends AbstractFacebookType implements Serializable

Serialized Fields

postClickItemDescription

String postClickItemDescription

postClickItemHeadline

String postClickItemHeadline

Class com.restfb.types.ads.AdCreativeTextData

class AdCreativeTextData extends AbstractFacebookType implements Serializable

Serialized Fields

message

String message

Class com.restfb.types.ads.AdCreativeVideoData

class AdCreativeVideoData extends AbstractFacebookType implements Serializable

Serialized Fields

additionalImageIndex

Long additionalImageIndex

brandedContentSponsorPageId

String brandedContentSponsorPageId

brandedContentSponsorRelationship

String brandedContentSponsorRelationship

callToAction

AdCreativeLinkDataCallToAction callToAction

description

String description

imageHash

String imageHash

imageUrl

String imageUrl

linkDescription

String linkDescription

message

String message

offerId

String offerId

pageWelcomeMessage

String pageWelcomeMessage

postClickConfiguration

AdCreativePostClickConfiguration postClickConfiguration

retailerItemIds

List<String> retailerItemIds

targeting

Targeting targeting

title

String title

videoId

String videoId

Class com.restfb.types.ads.AdDeliveryCheck

class AdDeliveryCheck extends AbstractFacebookType implements Serializable

Serialized Fields

checkName

String checkName

description

String description

summary

String summary

Class com.restfb.types.ads.AdDynamicCreative

class AdDynamicCreative extends BaseAdsObject implements Serializable

Serialized Fields

previewUrl

String previewUrl

Class com.restfb.types.ads.AdgroupIssuesInfo

class AdgroupIssuesInfo extends AbstractFacebookType implements Serializable

Serialized Fields

errorCode

Long errorCode

errorMessage

String errorMessage

errorSummary

String errorSummary

errorType

String errorType

level

String level

Class com.restfb.types.ads.AdgroupPlacementSpecificReviewFeedback

class AdgroupPlacementSpecificReviewFeedback extends AbstractFacebookType implements Serializable

Serialized Fields

facebook

Map<String,String> facebook

instagram

Map<String,String> instagram

Class com.restfb.types.ads.AdgroupReviewFeedback

class AdgroupReviewFeedback extends AbstractFacebookType implements Serializable

Serialized Fields

global

Map<String,String> global

placementSpecific

AdgroupPlacementSpecificReviewFeedback placementSpecific

Class com.restfb.types.ads.AdImage

class AdImage extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

accountId

String accountId

The ad account that owns the image

createdTime

Date createdTime

Time the image was created

creatives

List<AdCreative> creatives

hash

String hash

The hash which uniquely identifies the image.

height

String height

The height of the image.

originalHeight

String originalHeight

The height of the image that was originally uploaded.

originalWidth

String originalWidth

The width of the image that was originally uploaded.

permalinkUrl

String permalinkUrl

A permanent URL of the image to use in story creatives.

status

String status

Status of the image

updatedTime

Date updatedTime

Time the image was updated

url

String url

A temporary URL which the image can be retrieved at. NOTE: do not use this URL in ad creative creation

url128

String url128

A temporary URL pointing to a version of the image resized to fit withing a 128x128 pixel box

width

String width

The width of the image.

Class com.restfb.types.ads.AdKeywords

class AdKeywords extends BaseAdsObject implements Serializable

Serialized Fields

brands

List<String> brands

productCategories

List<String> productCategories

productNames

List<String> productNames

searchTerms

List<String> searchTerms

Class com.restfb.types.ads.AdKeywordStats

class AdKeywordStats extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

actions

List<AdsActionStats> actions

The number of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Actions include Page likes, app installs, conversions, event responses and more. For example, 2 Page likes and 2 comments would be counted as 4 actions.

clicks

Integer clicks

The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs.

costPerTotalAction

Double costPerTotalAction

The average you've spent on actions. For example, if you spent $20 and you got 10 Page likes, each one cost an average of $2.

costPerUniqueClick

Double costPerUniqueClick

The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received.

cpc

Double cpc

The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.

cpm

Double cpm

The average cost you've paid to have 1,000 impressions on your ad.

cpp

Double cpp

The average cost you've paid to have your ad served to 1,000 unique people.

ctr

Double ctr

The number of clicks you received divided by the number of impressions.

frequency

Double frequency

The average number of times your ad was served to each person.

impressions

Integer impressions

The number of times your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column.

reach

Integer reach

The number of people your ad was served to.

spend

Double spend

The total amount you've spent so far.

totalActions

Integer totalActions

The number of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Actions include Page likes, app installs, conversions, event responses and more. For example, 2 Page likes and 2 comments would be counted as 4 actions.

totalUniqueActions

Integer totalUniqueActions

The number of unique people who took an action such as liking your Page or installing your app as a result of your ad. For example, if the same person likes and comments on a post, they will be counted as 1 unique person.

uniqueActions

List<AdsActionStats> uniqueActions

The number of unique people who took an action such as liking your Page or installing your app as a result of your ad. For example, if the same person likes and comments on a post, they will be counted as 1 unique person.

uniqueClicks

Integer uniqueClicks

The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it will count as 3 unique clicks.

uniqueCtr

Double uniqueCtr

The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%.

uniqueImpressions

Integer uniqueImpressions

The number of people your ad was served to.

Class com.restfb.types.ads.AdLabel

class AdLabel extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

account

AdAccount account

AdGroup Account

createdTime

Date createdTime

Created time

updatedTime

Date updatedTime

Updated time

Class com.restfb.types.ads.AdPreview

class AdPreview extends AbstractFacebookType implements Serializable

Serialized Fields

adFormat

String adFormat

body

String body

creative

String creative

post

String post

productItemIds

String productItemIds

Class com.restfb.types.ads.AdPromotedObject

class AdPromotedObject extends AbstractFacebookType implements Serializable

Serialized Fields

applicationId

String applicationId

customEventType

String customEventType

objectStoreUrl

String objectStoreUrl

offerId

String offerId

pageId

String pageId

pixelId

String pixelId

productSetId

String productSetId

Class com.restfb.types.ads.AdRecommendation

class AdRecommendation extends AbstractFacebookType implements Serializable

Serialized Fields

blameField

String blameField

code

Long code

confidence

String confidence

importance

String importance

message

String message

recommendationData

AdRecommendationData recommendationData

title

String title

Class com.restfb.types.ads.AdRecommendationData

class AdRecommendationData extends AbstractFacebookType implements Serializable

Serialized Fields

link

String link

Class com.restfb.types.ads.AdReportRun

class AdReportRun extends BaseAdsObject implements Serializable

Serialized Fields

accountId

String accountId

asyncPercentCompletion

Long asyncPercentCompletion

asyncStatus

String asyncStatus

dateStart

String dateStart

dateStop

String dateStop

emails

List<String> emails

friendlyName

String friendlyName

isBookmarked

Boolean isBookmarked

isRunning

Boolean isRunning

scheduleId

String scheduleId

timeCompleted

Long timeCompleted

timeRef

Long timeRef

Class com.restfb.types.ads.AdsActionStats

class AdsActionStats extends AbstractFacebookType implements Serializable

Serialized Fields

actionCarouselCardId

String actionCarouselCardId

The ID of the specific carousel card that people engaged with when they saw your ad.

actionCarouselCardName

String actionCarouselCardName

The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines.

actionDestination

String actionDestination

The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for your conversion pixel or an app configured with the software development kit (SDK).

actionDevice

String actionDevice

The device on which the conversion event you are tracking occurred. For example, "Desktop" if someone converted on a desktop computer.

actionTargetId

String actionTargetId

The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for your conversion pixel or an app configured with the software development kit (SDK).

actionType

String actionType

The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Action types include Page likes, app installs, conversions, event responses and more.

actionVideoType

String actionVideoType

Video metrics breakdown.

click1d

Double click1d

Metric value of attribution window "1d_click"

click28d

Double click28d

Metric value of attribution window "28d_click"

click7d

Double click7d

Metric value of attribution window "7d_click"

value

Double value

Metric value of default attribution window

view1d

Double view1d

Metric value of attribution window "1d_view"

view28d

Double view28d

Metric value of attribution window "28d_view"

view7d

Double view7d

Metric value of attribution window "7d_view"

Class com.restfb.types.ads.AdSet

class AdSet extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

accountId

String accountId

adcampaignGroup

Campaign adcampaignGroup

adKeywords

AdKeywords adKeywords

adLabels

List<AdLabel> adLabels

adsetSchedule

List<DayPart> adsetSchedule

assetFeedId

String assetFeedId

attributionSpec

List<JsonObject> attributionSpec

bestCreative

AdDynamicCreative bestCreative

bidAdjustments

AdBidAdjustments bidAdjustments

bidAmount

Long bidAmount

bidConstraints

AdCampaignBidConstraint bidConstraints

bidInfo

Map<String,Long> bidInfo

bidStrategy

BidStrategyEnum bidStrategy

billingEvent

String billingEvent

budgetRemaining

String budgetRemaining

campaign

Campaign campaign

campaignId

String campaignId

configuredStatus

String configuredStatus

createdTime

Date createdTime

creativeSequence

List<String> creativeSequence

dailyBudget

String dailyBudget

dailyMinSpendTarget

String dailyMinSpendTarget

dailySpendCap

String dailySpendCap

destinationType

String destinationType

effectiveStatus

String effectiveStatus

endTime

Date endTime

frequencyCap

Long frequencyCap

frequencyCapResetPeriod

Long frequencyCapResetPeriod

frequencyControlSpecs

List<AdCampaignFrequencyControlSpecs> frequencyControlSpecs

isAutobid

Boolean isAutobid

issuesInfo

List<AdCampaignIssuesInfo> issuesInfo

lifetimeBudget

String lifetimeBudget

lifetimeFrequencyCap

Long lifetimeFrequencyCap

lifetimeImps

Long lifetimeImps

mBidInfo

Map<String,Long> mBidInfo

mStatus

String mStatus

optimizationGoal

String optimizationGoal

pacingType

List<String> pacingType

promotedObject

AdPromotedObject promotedObject

recommendations

List<AdRecommendation> recommendations

rfPredictionId

String rfPredictionId

rtbFlag

Boolean rtbFlag

startTime

Date startTime

targeting

Targeting targeting

updatedTime

Date updatedTime

useNewAppClick

Boolean useNewAppClick

Class com.restfb.types.ads.AdsHistogramStats

class AdsHistogramStats extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

actionBrand

String actionBrand

actionCanvasComponentId

String actionCanvasComponentId

actionCanvasComponentName

String actionCanvasComponentName

actionCarouselCardId

String actionCarouselCardId

actionCarouselCardName

String actionCarouselCardName

actionCategory

String actionCategory

actionConvertedProductId

String actionConvertedProductId

actionDestination

String actionDestination

actionDevice

String actionDevice

actionEventChannel

String actionEventChannel

actionLinkClickDestination

String actionLinkClickDestination

actionLocationCode

String actionLocationCode

actionReaction

String actionReaction

actionTargetId

String actionTargetId

actionType

String actionType

actionVideoAssetId

String actionVideoAssetId

actionVideoSound

String actionVideoSound

actionVideoType

String actionVideoType

click1d

List<Long> click1d

click28d

List<Long> click28d

click7d

List<Long> click7d

dda

List<Long> dda

ev1d

List<Long> ev1d

inline

List<Long> inline

interactiveComponentStickerId

String interactiveComponentStickerId

interactiveComponentStickerResponse

String interactiveComponentStickerResponse

skanClick

List<Long> skanClick

skanView

List<Long> skanView

value

List<Long> value

view1d

List<Long> view1d

view28d

List<Long> view28d

view7d

List<Long> view7d

Class com.restfb.types.ads.AdsImageCrops

class AdsImageCrops extends AbstractFacebookType implements Serializable

Serialized Fields

thumb100x100

AdsImageCrops.AdsImageCropsSpec thumb100x100

thumb100x100String

String thumb100x100String

thumb100x72

AdsImageCrops.AdsImageCropsSpec thumb100x72

thumb100x72String

String thumb100x72String

thumb191x100

AdsImageCrops.AdsImageCropsSpec thumb191x100

thumb191x100String

String thumb191x100String

thumb400x150

AdsImageCrops.AdsImageCropsSpec thumb400x150

thumb400x150String

String thumb400x150String

thumb600x360

AdsImageCrops.AdsImageCropsSpec thumb600x360

thumb600x360String

String thumb600x360String

Class com.restfb.types.ads.AdsImageCrops.AdsImageCropsSpec

class AdsImageCropsSpec extends AbstractFacebookType implements Serializable

Serialized Fields

bottom

Long bottom

left

Long left

right

Long right

top

Long top

Class com.restfb.types.ads.AdsInsights

class AdsInsights extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

accountCurrency

String accountCurrency

accountId

String accountId

accountName

String accountName

actions

List<AdsActionStats> actions

actionValues

List<AdsActionStats> actionValues

adClickActions

List<AdsActionStats> adClickActions

adFormatAsset

String adFormatAsset

adId

String adId

adImpressionActions

List<AdsActionStats> adImpressionActions

adName

String adName

adsetEnd

String adsetEnd

adsetId

String adsetId

adsetName

String adsetName

adsetStart

String adsetStart

age

String age

ageTargeting

String ageTargeting

appId

String appId

attributionSetting

String attributionSetting

auctionBid

String auctionBid

auctionCompetitiveness

String auctionCompetitiveness

auctionMaxCompetitorBid

String auctionMaxCompetitorBid

bodyAsset

String bodyAsset

buyingType

String buyingType

callToActionAsset

String callToActionAsset

campaignId

String campaignId

campaignName

String campaignName

canvasAvgViewPercent

String canvasAvgViewPercent

canvasAvgViewTime

String canvasAvgViewTime

catalogSegmentActions

List<AdsActionStats> catalogSegmentActions

catalogSegmentValue

List<AdsActionStats> catalogSegmentValue

catalogSegmentValueMobilePurchaseRoas

List<AdsActionStats> catalogSegmentValueMobilePurchaseRoas

catalogSegmentValueOmniPurchaseRoas

List<AdsActionStats> catalogSegmentValueOmniPurchaseRoas

catalogSegmentValueWebsitePurchaseRoas

List<AdsActionStats> catalogSegmentValueWebsitePurchaseRoas

clicks

String clicks

coarseConversionValue

String coarseConversionValue

conversionLeadRate

String conversionLeadRate

conversionRateRanking

String conversionRateRanking

conversions

List<AdsActionStats> conversions

conversionValues

List<AdsActionStats> conversionValues

convertedProductQuantity

List<AdsActionStats> convertedProductQuantity

convertedProductValue

List<AdsActionStats> convertedProductValue

costPer15SecVideoView

List<AdsActionStats> costPer15SecVideoView

costPer2SecContinuousVideoView

List<AdsActionStats> costPer2SecContinuousVideoView

costPerActionType

List<AdsActionStats> costPerActionType

costPerAdClick

List<AdsActionStats> costPerAdClick

costPerConversion

List<AdsActionStats> costPerConversion

costPerConversionLead

String costPerConversionLead

costPerDdaCountbyConvs

String costPerDdaCountbyConvs

costPerEstimatedAdRecallers

String costPerEstimatedAdRecallers

costPerInlineLinkClick

String costPerInlineLinkClick

costPerInlinePostEngagement

String costPerInlinePostEngagement

costPerOneThousandAdImpression

List<AdsActionStats> costPerOneThousandAdImpression

costPerOutboundClick

List<AdsActionStats> costPerOutboundClick

costPerThruplay

List<AdsActionStats> costPerThruplay

costPerUniqueActionType

List<AdsActionStats> costPerUniqueActionType

costPerUniqueClick

String costPerUniqueClick

costPerUniqueConversion

List<AdsActionStats> costPerUniqueConversion

costPerUniqueInlineLinkClick

String costPerUniqueInlineLinkClick

costPerUniqueOutboundClick

List<AdsActionStats> costPerUniqueOutboundClick

country

String country

cpc

String cpc

cpm

String cpm

cpp

String cpp

createdTime

String createdTime

creativeMediaType

String creativeMediaType

ctr

String ctr

dateStart

Date dateStart

dateStop

Date dateStop

ddaCountbyConvs

String ddaCountbyConvs

ddaResults

List<JsonObject> ddaResults

descriptionAsset

String descriptionAsset

devicePlatform

String devicePlatform

dma

String dma

engagementRateRanking

String engagementRateRanking

estimatedAdRecallers

String estimatedAdRecallers

estimatedAdRecallersLowerBound

String estimatedAdRecallersLowerBound

estimatedAdRecallersUpperBound

String estimatedAdRecallersUpperBound

estimatedAdRecallRate

String estimatedAdRecallRate

estimatedAdRecallRateLowerBound

String estimatedAdRecallRateLowerBound

estimatedAdRecallRateUpperBound

String estimatedAdRecallRateUpperBound

fidelityType

String fidelityType

frequency

String frequency

frequencyValue

String frequencyValue

fullViewImpressions

String fullViewImpressions

fullViewReach

String fullViewReach

gender

String gender

genderTargeting

String genderTargeting

hourlyStatsAggregatedByAdvertiserTimeZone

String hourlyStatsAggregatedByAdvertiserTimeZone

hourlyStatsAggregatedByAudienceTimeZone

String hourlyStatsAggregatedByAudienceTimeZone

hsid

String hsid

imageAsset

String imageAsset

impressionDevice

String impressionDevice

impressions

String impressions

inlineLinkClickCtr

String inlineLinkClickCtr

inlineLinkClicks

String inlineLinkClicks

inlinePostEngagement

String inlinePostEngagement

instagramUpcomingEventRemindersSet

String instagramUpcomingEventRemindersSet

instantExperienceClicksToOpen

String instantExperienceClicksToOpen

instantExperienceClicksToStart

String instantExperienceClicksToStart

instantExperienceOutboundClicks

List<AdsActionStats> instantExperienceOutboundClicks

interactiveComponentTap

List<AdsActionStats> interactiveComponentTap

isConversionIdModeled

String isConversionIdModeled

labels

String labels

linkUrlAsset

String linkUrlAsset

location

String location

marketingMessagesBtnName

String marketingMessagesBtnName

marketingMessagesCostPerDelivered

String marketingMessagesCostPerDelivered

marketingMessagesCostPerLinkBtnClick

String marketingMessagesCostPerLinkBtnClick

marketingMessagesSpend

String marketingMessagesSpend

mdsaLandingDestination

String mdsaLandingDestination

mediaAssetUrl

String mediaAssetUrl

mediaCreator

String mediaCreator

mediaDestinationUrl

String mediaDestinationUrl

mediaFormat

String mediaFormat

mediaOriginUrl

String mediaOriginUrl

mediaTextContent

String mediaTextContent

mmm

String mmm

mobileAppPurchaseRoas

List<AdsActionStats> mobileAppPurchaseRoas

objective

String objective

optimizationGoal

String optimizationGoal

outboundClicks

List<AdsActionStats> outboundClicks

outboundClicksCtr

List<AdsActionStats> outboundClicksCtr

placePageId

String placePageId

placePageName

String placePageName

platformPosition

String platformPosition

postbackSequenceIndex

String postbackSequenceIndex

productId

String productId

publisherPlatform

String publisherPlatform

purchaseRoas

List<AdsActionStats> purchaseRoas

qualifyingQuestionQualifyAnswerRate

String qualifyingQuestionQualifyAnswerRate

qualityRanking

String qualityRanking

reach

String reach

redownload

String redownload

region

String region

skanCampaignId

String skanCampaignId

skanConversionId

String skanConversionId

skanVersion

String skanVersion

socialSpend

String socialSpend

spend

String spend

standardEventContentType

String standardEventContentType

titleAsset

String titleAsset

totalPostbacks

String totalPostbacks

totalPostbacksDetailed

List<AdsActionStats> totalPostbacksDetailed

totalPostbacksDetailedV4

List<AdsActionStats> totalPostbacksDetailedV4

uniqueActions

List<AdsActionStats> uniqueActions

uniqueClicks

String uniqueClicks

uniqueConversions

List<AdsActionStats> uniqueConversions

uniqueCtr

String uniqueCtr

uniqueInlineLinkClickCtr

String uniqueInlineLinkClickCtr

uniqueInlineLinkClicks

String uniqueInlineLinkClicks

uniqueLinkClicksCtr

String uniqueLinkClicksCtr

uniqueOutboundClicks

List<AdsActionStats> uniqueOutboundClicks

uniqueOutboundClicksCtr

List<AdsActionStats> uniqueOutboundClicksCtr

uniqueVideoContinuous2SecWatchedActions

List<AdsActionStats> uniqueVideoContinuous2SecWatchedActions

uniqueVideoView15Sec

List<AdsActionStats> uniqueVideoView15Sec

updatedTime

String updatedTime

video15SecWatchedActions

List<AdsActionStats> video15SecWatchedActions

video30SecWatchedActions

List<AdsActionStats> video30SecWatchedActions

videoAsset

String videoAsset

videoAvgTimeWatchedActions

List<AdsActionStats> videoAvgTimeWatchedActions

videoContinuous2SecWatchedActions

List<AdsActionStats> videoContinuous2SecWatchedActions

videoP100WatchedActions

List<AdsActionStats> videoP100WatchedActions

videoP25WatchedActions

List<AdsActionStats> videoP25WatchedActions

videoP50WatchedActions

List<AdsActionStats> videoP50WatchedActions

videoP75WatchedActions

List<AdsActionStats> videoP75WatchedActions

videoP95WatchedActions

List<AdsActionStats> videoP95WatchedActions

videoPlayActions

List<AdsActionStats> videoPlayActions

videoPlayCurveActions

List<AdsHistogramStats> videoPlayCurveActions

videoPlayRetention0To15sActions

List<AdsHistogramStats> videoPlayRetention0To15sActions

videoPlayRetention20To60sActions

List<AdsHistogramStats> videoPlayRetention20To60sActions

videoPlayRetentionGraphActions

List<AdsHistogramStats> videoPlayRetentionGraphActions

videoThruplayWatchedActions

List<AdsActionStats> videoThruplayWatchedActions

videoTimeWatchedActions

List<AdsActionStats> videoTimeWatchedActions

websiteCtr

List<AdsActionStats> websiteCtr

websitePurchaseRoas

List<AdsActionStats> websitePurchaseRoas

wishBid

String wishBid

Class com.restfb.types.ads.AdsPixel

class AdsPixel extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

creationTime

Date creationTime

lastFiredTime

Date lastFiredTime

ownerAdAccount

AdAccount ownerAdAccount

ownerBusiness

Business ownerBusiness

rules

String rules

rulevalidation

String rulevalidation

userAccessExpireTime

Date userAccessExpireTime

Class com.restfb.types.ads.AdsPixelStats

class AdsPixelStats extends AbstractFacebookType implements Serializable

Serialized Fields

count

Long count

value

String value

Class com.restfb.types.ads.AdsPixelStatsResult

class AdsPixelStatsResult extends AbstractFacebookType implements Serializable

Serialized Fields

aggregation

String aggregation

data

List<AdsPixelStats> data

timestamp

String timestamp

Class com.restfb.types.ads.AdStudy

class AdStudy extends NamedAdsObject implements Serializable

Serialized Fields

business

Business business

canceledTime

Date canceledTime

cooldownStartTime

Date cooldownStartTime

createdBy

User createdBy

createdTime

Date createdTime

description

String description

endTime

Date endTime

observationEndTime

Date observationEndTime

startTime

Date startTime

type

String type

updatedBy

User updatedBy

updatedTime

Date updatedTime

Class com.restfb.types.ads.AdStudyCell

class AdStudyCell extends NamedAdsObject implements Serializable

Serialized Fields

adEntitiesCount

Integer adEntitiesCount

controlPercentage

Double controlPercentage

treatmentPercentage

Double treatmentPercentage

Class com.restfb.types.ads.AdStudyObjective

class AdStudyObjective extends NamedAdsObject implements Serializable

Serialized Fields

customAttributes

List<String> customAttributes

Detected custom attributes for this objective

isPrimary

Boolean isPrimary

Is this the primary objective of the study

results

List<String> results

Results of the study for this objective

type

String type

The type of the objective

Class com.restfb.types.ads.AdTransaction

class AdTransaction extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

accountId

String accountId

ID of the source Ad Account

appAmount

Integer appAmount

Monetary amount given to the app for this transaction

billingEndTime

Integer billingEndTime

End time of the transaction's billing period

billingStartTime

Integer billingStartTime

Start time of the transaction's billing period

chargeType

String chargeType

Type of charge involved in the transaction

faturaId

Integer faturaId

ID for the Brazilian invoice (if transaction was made in Brazil) else 0

paymentOption

String paymentOption

Method used to pay for the transaction

productType

String productType

The type of ads included in this transaction

providerAmount

Integer providerAmount

Monetary amount charged to the user for this transaction

status

String status

Current status of the transaction

time

Integer time

Time at which the transaction was created

Class com.restfb.types.ads.AdUser

class AdUser extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

permissions

List<Integer> permissions

role

Integer role

Class com.restfb.types.ads.AgencyClientDeclaration

class AgencyClientDeclaration extends AbstractFacebookType implements Serializable

Serialized Fields

agencyRepresentingClient

Integer agencyRepresentingClient

Whether this account is for an agency representing a client.

clientBasedInFrance

Integer clientBasedInFrance

Whether the client is based in France.

clientCity

String clientCity

Client's city.

clientCountryCode

String clientCountryCode

Client's country code.

clientEmailAddress

String clientEmailAddress

Client's email address.

clientName

String clientName

Name of the client.

clientPostalCode

String clientPostalCode

Client's postal code.

clientProvince

String clientProvince

Client's province.

clientStreet

String clientStreet

First line of client's street address.

clientStreet2

String clientStreet2

Second line of client's street address.

hasWrittenMandateFromAdvertiser

Integer hasWrittenMandateFromAdvertiser

Whether the agency has a written mandate to advertise on behalf of this client.

isClientPayingInvoices

Integer isClientPayingInvoices

Whether the client is paying via invoice.

Class com.restfb.types.ads.AndroidAppLink

class AndroidAppLink extends com.restfb.types.ads.AbstractMobileAppLink implements Serializable

Serialized Fields

aPackage

String aPackage

clazz

String clazz

Class com.restfb.types.ads.AppLinks

class AppLinks extends BaseAdsObject implements Serializable

Serialized Fields

android

List<AndroidAppLink> android

ios

List<IosAppLink> ios

ipad

List<IosAppLink> ipad

iphone

List<IosAppLink> iphone

web

WebAppLink web

windows

List<WindowsAppLink> windows

windowsPhone

List<WindowsPhoneAppLink> windowsPhone

windowsUniversal

List<WindowsAppLink> windowsUniversal

Class com.restfb.types.ads.BaseAdsObject

class BaseAdsObject extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

Class com.restfb.types.ads.BroadTargetingCategories

class BroadTargetingCategories extends BaseAdsObject implements Serializable

Serialized Fields

categoryDescription

String categoryDescription

parentCategory

String parentCategory

path

List<String> path

size

Long size

source

String source

type

Long type

typeName

String typeName

untranslatedName

String untranslatedName

untranslatedParentName

String untranslatedParentName

Class com.restfb.types.ads.Business

class Business extends NamedAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

blockOfflineAnalytics

Boolean blockOfflineAnalytics

Specifies whether offline analytics for business is blocked.

createdBy

NamedAdsObject createdBy

The creator of this business.

createdTime

Date createdTime

The creation time of this business.

creationTime

Date creationTime

The creation time of this business.

extendedUpdatedTime

Date extendedUpdatedTime

The update time of the extended credits for this business.

isHidden

Boolean isHidden

If true, indicates the business is hidden.

link

String link

URI for business profile page.

paymentAccountId

String paymentAccountId

The ID for the payment account of this business.

primaryPage

Page primaryPage

The primary Facebook Page for this business.

profilePictureUri

String profilePictureUri

The profile picture URI of the business.

timezoneId

Integer timezoneId

This business's timezone.

twoFactorType

String twoFactorType

updatedBy

NamedAdsObject updatedBy

The person's name who last updated this business.

updateTime

Date updateTime

The time when this business was last updated.

userAccessExpireTime

Date userAccessExpireTime

verificationStatus

String verificationStatus

Verification status for this business.

vertical

String vertical

The vertical industry that this business associates with, or belongs to.

verticalId

Integer verticalId

The ID for the vertical industry.

Class com.restfb.types.ads.Campaign

class Campaign extends NamedAdsObject implements Serializable

Serialized Fields

accountId

String accountId

ID of the ad account that owns this campaign

adlabels

List<AdLabel> adlabels

Ad Labels associated with this campaign

bidStrategy

String bidStrategy

Bid strategy for this campaign

boostedObjectId

String boostedObjectId

The Boosted Object this campaign has associated, if any

brandLiftStudies

List<AdStudy> brandLiftStudies

Automated Brand Lift V2 studies for this ad set.

budgetRebalanceFlag

Boolean budgetRebalanceFlag

Whether to automatically rebalance budgets daily for all the adsets under this campaign.

budgetRemaining

String budgetRemaining

Remaining budget

buyingType

String buyingType

Buying type, possible values are:

• AUCTION: default
• RESERVED: for reach and frequency ads

canCreateBrandLiftStudy

Boolean canCreateBrandLiftStudy

If we can create a new automated brand lift study for the ad set.

canUseSpendCap

Boolean canUseSpendCap

Whether the campaign can set the spend cap

configuredStatus

String configuredStatus

If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this. possible values: ACTIVE, PAUSED, DELETED, ARCHIVED

createdTime

Date createdTime

Created Time

dailyBudget

String dailyBudget

The daily budget of the campaign

effectiveStatus

String effectiveStatus

The effective status of this campaign. possible values: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED

issuesInfo

List<AdCampaignIssuesInfo> issuesInfo

Issues for this campaign that prevented it from deliverying.

lastBudgetTogglingTime

Date lastBudgetTogglingTime

Last budget toggling time

lifetimeBudget

String lifetimeBudget

The lifetime budget of the campaign

objective

String objective

Campaign's objective

recommendations

List<AdRecommendation> recommendations

If there are recommendations for this campaign, this field includes them.

sourceCampaign

Campaign sourceCampaign

The source campaign that this campaign is copied from

sourceCampaignId

String sourceCampaignId

The source campaign id that this campaign is copied from

specialAdCategories

List<String> specialAdCategories

specialAdCategory

String specialAdCategory

Deprecated.

The campaign's Special Ad Category. One of HOUSING, EMPLOYMENT, CREDIT, or NONE.

spendCap

String spendCap

A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency.

startTime

Date startTime

Start Time

status

String status

If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.

stopTime

Date stopTime

Stop Time

toplineId

String toplineId

Topline ID

updatedTime

Date updatedTime

Updated Time

Class com.restfb.types.ads.ConversionActionQuery

class ConversionActionQuery extends AbstractFacebookType implements Serializable

Serialized Fields

actionType

List<String> actionType

Action type

application

List<String> application

Application

conversionId

List<String> conversionId

Rule based offsite conversion

event

List<String> event

Event

eventCreator

List<String> eventCreator

Event creator

eventType

List<String> eventType

Event Type

fbPixel

List<String> fbPixel

Facebook pixel id

fbPixelEvent

List<String> fbPixelEvent

Facebook pixel event

object

List<String> object

Object

objectDomain

List<String> objectDomain

Object domain

offer

List<String> offer

Offer

offerCreator

List<String> offerCreator

Offer creator

offsitePixel

List<String> offsitePixel

Offsite pixel

page

List<String> page

Page

pageParent

List<String> pageParent

Page parent

post

List<String> post

Post

postObject

List<String> postObject

Post object

postObjectWall

List<String> postObjectWall

Post object wall

postWall

List<String> postWall

Post wall

productSetId

List<String> productSetId

Product set id

question

List<String> question

Question

questionCreator

List<String> questionCreator

Question creator

response

List<String> response

Response

subtype

List<String> subtype

Subtype

Class com.restfb.types.ads.CustomAudience

class CustomAudience extends NamedAdsObject implements Serializable

Serialized Fields

accountId

String accountId

Ad Account ID

approximateCount

Long approximateCount

Approximate number of people in this audience

dataSource

CustomAudienceDataSource dataSource

JSON dictionary of type, sub_type to indicate by which method the custom audience was created.

deliveryStatus

CustomAudienceStatus deliveryStatus

JSON dictionary of code and description. Indicates whether or not an audience can be used in ads. There are two situations that an audience will make ads not deliverable. First, if the size is smaller than 20 people, the audience can't be delivered. Second, if for some reason the audience is disabled (such as violation of policy, expired), validation will fail when it is used in ads.

description

String description

Custom audience description

excludedCustomAudiences

List<CustomAudience> excludedCustomAudiences

externalEventSource

AdsPixel externalEventSource

Read-only JSON dictionary with key id containing the pixel id whose traffic generated this custom audience

includedCustomAudiences

List<CustomAudience> includedCustomAudiences

lastUsedTime

String lastUsedTime

last used time of this object by the current viewer

lookalikeAudienceIds

List<String> lookalikeAudienceIds

The IDs of the lookalike audiences generated from this audience

lookalikeSpec

LookalikeSpec lookalikeSpec

Generated only when the subtype is LOOKALIKE.

operationStatus

CustomAudienceStatus operationStatus

JSON dictionary of code to int value and description to a description string. The operation status represents the status of the last operation performed on an audience. In general, it will have following states:

• 0: Status not available
• 200: Normal: there is no updating or issues found
• 400: Warning: there is some message we would like advertisers to know
• 410: No upload: no file has been uploaded
• 411: Low match rate: low rate of matched people
• 412: High invalid rate: high rate of invalid people
• 421: No pixel: Your Facebook pixel hasn't been installed on your website yet
• 422: Pixel not firing: Your Facebook pixel isn't firing
• 423: Invalid pixel: Your Facebook pixel is invalid
• 431: Lookalike Audience refresh failed
• 432: Lookalike Audience build failed
• 433: Lookalike Audience build failed
• 434: Lookalike Audience build retrying
• 500: Error: there is some error and advertisers need to take action items to fix the error

optOutLink

String optOutLink

Your opt-out URL so people can choose not to be targeted

originAudienceId

Long originAudienceId

The ID of origin Custom Audience. The origin audience you create must have a minimum size of 100.

ownerBusiness

Business ownerBusiness

owner business of this object

permissionForActions

CustomAudiencePermission permissionForActions

JSON dictionary of permissions (string) to boolean value if the custom audience has that permission

pixelId

String pixelId

ID of the pixel which is collecting events for this Website Custom audience

retentionDays

Long retentionDays

Number of days to keep the user in this cluster. You can use any value between 1 and 180 days. Defaults to 14 days if not specified

rule

String rule

Audience rules to be applied on the referrer URL

subtype

String subtype

Type of custom audience, derived from original data source

timeContentUpdated

Long timeContentUpdated

Last update of people in this custom audience

timeCreated

Long timeCreated

Creation time

timeUpdated

Long timeUpdated

Last time this audience metadata was updated

Class com.restfb.types.ads.CustomAudienceDataSource

class CustomAudienceDataSource extends AbstractFacebookType implements Serializable

Serialized Fields

creationParams

String creationParams

subType

String subType

type

String type

Class com.restfb.types.ads.CustomAudiencePermission

class CustomAudiencePermission extends AbstractFacebookType implements Serializable

Serialized Fields

canEdit

Boolean canEdit

Permission to edit the audience

canSeeInsight

Boolean canSeeInsight

Permission to see insight of the audience

canShare

Boolean canShare

Capability to share audience based on gatekeeper

subtypeSupportsLookalike

Boolean subtypeSupportsLookalike

Capability to be used as seed for lookalike audience

supportsRecipientLookalike

Boolean supportsRecipientLookalike

Capability to be used as seed for lookalike audience for recipient ad accounts

Class com.restfb.types.ads.CustomAudienceStatus

class CustomAudienceStatus extends AbstractFacebookType implements Serializable

Serialized Fields

code

Long code

description

String description

Class com.restfb.types.ads.DayPart

class DayPart extends AbstractFacebookType implements Serializable

Serialized Fields

days

List<Long> days

endMinute

Long endMinute

startMinute

Long startMinute

Class com.restfb.types.ads.DeliveryCheck

class DeliveryCheck extends BaseAdsObject implements Serializable

Serialized Fields

checkName

String checkName

description

String description

extraInfo

DeliveryCheckExtraInfo extraInfo

summary

String summary

Class com.restfb.types.ads.DeliveryCheckExtraInfo

class DeliveryCheckExtraInfo extends BaseAdsObject implements Serializable

Serialized Fields

adgroupIds

List<String> adgroupIds

campaignIds

List<String> campaignIds

countries

List<String> countries

Class com.restfb.types.ads.DynamicPostChildAttachment

class DynamicPostChildAttachment extends AbstractFacebookType implements Serializable

Serialized Fields

description

String description

imageUrl

String imageUrl

link

String link

placeId

String placeId

productId

String productId

title

String title

Class com.restfb.types.ads.ExtendedCreditInvoiceGroup

class ExtendedCreditInvoiceGroup extends NamedAdsObject implements Serializable

Serialized Fields

autoEnroll

Boolean autoEnroll

customerPoNumber

String customerPoNumber

email

String email

emails

List<String> emails

Class com.restfb.types.ads.FieldData

class FieldData extends AbstractFacebookType implements Serializable

Serialized Fields

name

String name

values

List<String> values

Class com.restfb.types.ads.FlexibleTargeting

class FlexibleTargeting extends AbstractFacebookType implements Serializable

Serialized Fields

behaviors

List<IDName> behaviors

collegeYears

List<Long> collegeYears

connections

List<IDName> connections

customAudiences

List<IDName> customAudiences

educationMajors

List<IDName> educationMajors

educationSchools

List<IDName> educationSchools

educationStatuses

List<Long> educationStatuses

ethnicAffinity

List<IDName> ethnicAffinity

familyStatuses

List<IDName> familyStatuses

friendsOfConnections

List<IDName> friendsOfConnections

generation

List<IDName> generation

homeOwnership

List<IDName> homeOwnership

homeType

List<IDName> homeType

homeValue

List<IDName> homeValue

householdComposition

List<IDName> householdComposition

income

List<IDName> income

industries

List<IDName> industries

interestedIn

List<Long> interestedIn

interests

List<IDName> interests

lifeEvents

List<IDName> lifeEvents

moms

List<IDName> moms

netWorth

List<IDName> netWorth

officeType

List<IDName> officeType

politics

List<IDName> politics

relationshipStatuses

List<Long> relationshipStatuses

userAdclusters

List<IDName> userAdclusters

workEmployers

List<IDName> workEmployers

workPositions

List<IDName> workPositions

Class com.restfb.types.ads.FundingSourceDetails

class FundingSourceDetails extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Amount of Facebook Ads Coupon

coupon

FundingSourceDetailsCoupon coupon

Details of the Facebook Ads Coupon from the payment method

currency

String currency

Currency of the Facebook Ads Coupon

displayAmount

String displayAmount

How the amount of Facebook Ads Coupon is displayed

displayString

String displayString

How the payment method is shown

expiration

String expiration

When the coupon will expire

Class com.restfb.types.ads.FundingSourceDetailsCoupon

class FundingSourceDetailsCoupon extends AbstractFacebookType implements Serializable

Serialized Fields

amount

Long amount

currency

String currency

displayAmount

String displayAmount

expiration

String expiration

Class com.restfb.types.ads.IDName

class IDName extends NamedAdsObject implements Serializable

Class com.restfb.types.ads.IgBoostMediaAd

class IgBoostMediaAd extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

adId

String adId

adStatus

String adStatus

Class com.restfb.types.ads.IosAppLink

class IosAppLink extends com.restfb.types.ads.AbstractMobileAppLink implements Serializable

Serialized Fields

appStoreId

String appStoreId

Class com.restfb.types.ads.Lead

class Lead extends BaseAdsObject implements Serializable

Serialized Fields

adId

String adId

adName

String adName

adsetId

String adsetId

adsetName

String adsetName

campaignId

String campaignId

campaignName

String campaignName

createdTime

Date createdTime

customDisclaimerResponses

List<String> customDisclaimerResponses

fieldData

List<FieldData> fieldData

formId

String formId

The ID of the form.

isOrganic

Boolean isOrganic

post

Post post

Class com.restfb.types.ads.LeadgenForm

class LeadgenForm extends NamedAdsObject implements Serializable

Serialized Fields

createdTime

Date createdTime

cusomizedTcpaContent

String cusomizedTcpaContent

expiredLeadsCount

Long expiredLeadsCount

followUpActionText

String followUpActionText

The caption of the follow up action text on the final screen of the form.

followUpActionUrl

String followUpActionUrl

The destination of the follow up action text on the final screen of the form.

isContinuedFlow

Boolean isContinuedFlow

leadgenExportCsvUrl

String leadgenExportCsvUrl

leadsCount

Long leadsCount

locale

String locale

page

Page page

pageId

String pageId

The ID of the page to which this form belongs.

privacyPolicyUrl

String privacyPolicyUrl

The supplied privacy policy URL.

qualifiers

List<LeadGenQualifier> qualifiers

tcpaCompliance

Boolean tcpaCompliance

Class com.restfb.types.ads.LeadGenQualifier

class LeadGenQualifier extends BaseAdsObject implements Serializable

Serialized Fields

category

String category

fieldKey

String fieldKey

label

String label

question

String question

Class com.restfb.types.ads.LookalikeSpec

class LookalikeSpec extends AbstractFacebookType implements Serializable

Serialized Fields

country

String country

isFinancialService

Boolean isFinancialService

origin

List<LookalikeSpec.Origin> origin

ratio

Double ratio

startingRatio

Double startingRatio

targetCountries

List<String> targetCountries

type

String type

Class com.restfb.types.ads.LookalikeSpec.Origin

class Origin extends NamedAdsObject implements Serializable

Serialized Fields

deleted

Boolean deleted

true, returned only when the origin is deleted -- GETTER --

type

String type

custom_audience or conversion_pixel or page or app -- GETTER --

Class com.restfb.types.ads.MinimumBudget

class MinimumBudget extends AbstractFacebookType implements Serializable

Serialized Fields

currency

String currency

minDailyBudgetHighFreq

Long minDailyBudgetHighFreq

minDailyBudgetImp

Long minDailyBudgetImp

minDailyBudgetLowFreq

Long minDailyBudgetLowFreq

minDailyBudgetVideoViews

Long minDailyBudgetVideoViews

Class com.restfb.types.ads.NamedAdsObject

class NamedAdsObject extends BaseAdsObject implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.restfb.types.ads.OffsitePixel

class OffsitePixel extends BaseAdsObject implements Serializable

Serialized Fields

creator

String creator

ID and name of the ad account that first created the pixel

jsPixel

String jsPixel

JavaScript code for the pixel that you should place in the head of the conversion page

lastFiringTime

Date lastFiringTime

Last time the pixel was fired

tag

String tag

One of: checkout, registration, lead, key_page_view, add_to_cart, other

Class com.restfb.types.ads.PartnerCategory

class PartnerCategory extends NamedAdsObject implements Serializable

Serialized Fields

approximateCount

Long approximateCount

country

String country

description

String description

details

String details

isPrivate

Boolean isPrivate

parentCategory

String parentCategory

source

String source

status

String status

targetingType

String targetingType

Class com.restfb.types.ads.ProductCatalog

class ProductCatalog extends NamedAdsObject implements Serializable

Serialized Fields

business

Business business

fallbackImageUrl

List<String> fallbackImageUrl

feedCount

Long feedCount

productCount

Long productCount

storeCatalogSettings

StoreCatalogSettings storeCatalogSettings

userAccessExpireTime

Date userAccessExpireTime

vertical

String vertical

Class com.restfb.types.ads.ProductFeed

class ProductFeed extends BaseAdsObject implements Serializable

Serialized Fields

country

String country

An ISO 3166-1 Alpha 2 country code

createdTime

Date createdTime

Creation time of the product feed

defaultCurrency

String defaultCurrency

Default currency for products. If no currency is specified for items in the feed file, this value would be used

deletionEnabled

Boolean deletionEnabled

Allows products to be deleted if they are no longer included in a product feed

delimiter

String delimiter

The delimiter used in product feed file possible values: AUTODETECT, BAR, COMMA, TAB, TILDE, SEMICOLON

encoding

String encoding

The character encoding used by provided feed possible values: AUTODETECT, LATIN1, UTF8, UTF16LE, UTF16BE, UTF32LE, UTF32BE

fileName

String fileName

File name of the product feed. Will be overridden by name if present

latestUpload

ProductFeedUpload latestUpload

The latest upload session of the product feed

productCount

Long productCount

The total products of this product catalog

quotedFieldsMode

String quotedFieldsMode

Allows tabs and newlines within fields possible values: AUTODETECT, ON, OFF

schedule

ProductFeedSchedule schedule

The configuration for fetching a feed in a recurrant manner

Class com.restfb.types.ads.ProductFeedSchedule

class ProductFeedSchedule extends AbstractFacebookType implements Serializable

Serialized Fields

dayOfWeek

String dayOfWeek

The day of week to fetch feed, for weekly schedules. Allowed values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY

hour

Long hour

Hour of the day to fetch the product feed, 0-23 PST

interval

String interval

The interval at which the product feed gets fetched

mDayOfMonth

Long mDayOfMonth

The day of month to fetch feed, for monthly schedules e.g., 1 for first of month

minute

Long minute

Minute of the hour to fetch the product feed, 0-59

password

String password

undocumented field according to GitHub issue #497

url

String url

The location of the product feed to fetch

username

String username

The username that is needed to access the url

Class com.restfb.types.ads.ProductFeedUpload

class ProductFeedUpload extends BaseAdsObject implements Serializable

Serialized Fields

endTime

Date endTime

The time the upload was completed

inputMethod

String inputMethod

The input method the product feed was obtained with possible values: Manual Upload, Server Fetch

startTime

Date startTime

The time the upload process started

url

String url

The url to fetch the products from

Class com.restfb.types.ads.ProductGroup

class ProductGroup extends BaseAdsObject implements Serializable

Serialized Fields

retailerId

String retailerId

Retailer ID of the product group

variants

List<ProductVariant> variants

The list of product variants and their options in the order they need to be displayed on the UI

Class com.restfb.types.ads.ProductItem

class ProductItem extends NamedAdsObject implements Serializable

Serialized Fields

additionalImageUrls

List<String> additionalImageUrls

ageGroup

String ageGroup

applinks

AppLinks applinks

availability

String availability

brand

String brand

category

String category

color

String color

commerceInsights

ProductItemCommerceInsights commerceInsights

commerceTaxCategory

String commerceTaxCategory

condition

String condition

currency

String currency

customData

Map<String,String> customData

customLabel0

String customLabel0

customLabel1

String customLabel1

customLabel2

String customLabel2

customLabel3

String customLabel3

customLabel4

String customLabel4

description

String description

expirationDate

String expirationDate

fbProductCategory

String fbProductCategory

gender

String gender

googleProductCategory

String googleProductCategory

gtin

String gtin

imageFetchStatus

String imageFetchStatus

images

List<String> images

imageUrl

String imageUrl

inventory

Integer inventory

manufacturerPartNumber

String manufacturerPartNumber

material

String material

mobileLink

String mobileLink

orderingIndex

Long orderingIndex

parentProductId

String parentProductId

pattern

String pattern

price

String price

productCatalog

ProductCatalog productCatalog

productFeed

ProductFeed productFeed

productGroup

ProductGroup productGroup

productType

String productType

retailerId

String retailerId

retailerProductGroupId

String retailerProductGroupId

reviewRejectionReasons

List<String> reviewRejectionReasons

reviewStatus

String reviewStatus

salePrice

String salePrice

salePriceEndDate

String salePriceEndDate

salePriceStartDate

String salePriceStartDate

shippingWeightUnit

String shippingWeightUnit

shippingWeightValue

Double shippingWeightValue

shortDescription

String shortDescription

size

String size

startDate

String startDate

url

String url

visibility

String visibility

Class com.restfb.types.ads.ProductItemCommerceInsights

class ProductItemCommerceInsights extends AbstractFacebookType implements Serializable

Serialized Fields

messageSends

Long messageSends

organicImpressions

Long organicImpressions

paidImpressions

Long paidImpressions

Class com.restfb.types.ads.ProductSet

class ProductSet extends NamedAdsObject implements Serializable

Serialized Fields

filter

String filter

productCatalog

ProductCatalog productCatalog

productCount

Long productCount

Class com.restfb.types.ads.ProductVariant

class ProductVariant extends AbstractFacebookType implements Serializable

Serialized Fields

label

String label

Name of the variant to be displayed on the UI.

options

List<String> options

A vector of possible options of the variant in the order by which they will be shown on the UI.

productField

String productField

Name of the first-class or custom-data product item field describing a variant of the product.

Class com.restfb.types.ads.ReachFrequencyPrediction

class ReachFrequencyPrediction extends NamedAdsObject implements Serializable

Serialized Fields

accountId

Integer accountId

The ID of the Ad Account this reach frequency prediction belongs to

campaignGroupId

Integer campaignGroupId

The id of the campaign which this prediction belongs to

campaignId

String campaignId

The ID of the ad set to which this reach frequency prediction is assigned

campaignTimeStart

Date campaignTimeStart

Unix timestamp of the ad set start time

campaignTimeStop

Date campaignTimeStop

Unix timestamp of the ad set stop time

curveBudgetReach

String curveBudgetReach

The curve for budget and reach. It is a string in JSON format representing a JSON object with these fields.
num_points: the number of data points within the object.
reach: Data contained at corresponding indices of each array form a single data point. The "reach" values are presented in ascending order with the final value containing the maximum available reach.
budget: Data contained at corresponding indices of each array form a single data point. Cent of accounts currency.
impression: Data contained at corresponding indices of each array form a single data point. In video view buying, this is the number of view throughs (aka impression by conversion)raw_impression: Data contained at corresponding indices of each array form a single data point. In video view buying,impressions represents view throughs and raw_impressions representstotal number of views

dailyImpressionCurve

List<Double> dailyImpressionCurve

Daily Impression field represents a vector of predicted daily impressions for every single day. Measured from midnight to midnight in the advertiser timezone during the campaign duration.

destinationId

String destinationId

The ID of the Page or the ID of the app which the ad promotes.

expirationTime

Date expirationTime

Unix timestamp of the expiration time of prediction, if applicable

externalBudget

Integer externalBudget

Predicted budget in cents for the ad set, relevant if prediction mode is 0

externalImpression

Long externalImpression

Predicted impressions for the ad set

externalMaximumBudget

Long externalMaximumBudget

Maximum budget given the target, in cents

externalMaximumImpression

String externalMaximumImpression

Maximum number of impressions given the target

externalMaximumReach

Long externalMaximumReach

Maximum reach given the target

externalMinimumBudget

Long externalMinimumBudget

Minimum budget given the target, in cents

externalMinimumImpression

Long externalMinimumImpression

Minimum impressions given the target

externalMinimumReach

Long externalMinimumReach

Minimum reach given the target

externalReach

Long externalReach

Predicted reach for the ad set, relevant if prediction mode is 1

frequencyCap

Long frequencyCap

Lifetime frequency cap per user, always relevant, 0 means no frequncy cap

grpDmasAudienceSize

Double grpDmasAudienceSize

GRP: Audience size within DMAs based on Nielsen definition

holdoutPercentage

Long holdoutPercentage

Percent of users in holdout

instagramDestinationId

String instagramDestinationId

The Instagram account id if instagramstream placement is used, except in the case of Mobile App Installs ads.

intervalFrequencyCap

Long intervalFrequencyCap

Interval frequency cap which is set for a custom period

intervalFrequencyCapResetPeriod

Long intervalFrequencyCapResetPeriod

Custom reset period (hours) for interval frequency cap

pausePeriods

String pausePeriods

A list of time periods the associated campaign has been paused.

placementBreakdown

String placementBreakdown

Predicted impression distribution on different placements, including: msite: Facebook mobile sites
android: Facebook android
ios: Facebook ios
desktop: Facebook desktop news feed and right hand column
ig_android: Instagram android
ig_ios: Instagram ios
ig_others: Other Instagram placements ## ReachFrequencyEstimatesPlacementBreakdown

predictionMode

Long predictionMode

The prediction mode, 0 = given reach, predict budget,
1 = given budget, predict reach

predictionProgress

Long predictionProgress

Represents percentage value indicating the prediction progress (values 0-100). When 100 check status to indicate whether the prediction was successful.

reservationStatus

Long reservationStatus

Reservation status. 0 = Cancelled prediction,
1 = Reserved prediction,
2 = Prediction has been attached to a campaign

status

Long status

Represents the status of the prediction, refer to Response Status

storyEventType

Long storyEventType

Used to indicated the prediction is for video ads or not. If it is for video, the prediction will not include devices that cannot play video

targetAudienceSize

Long targetAudienceSize

Unique 30-day active users for given targetting specs. Used as tip to indicate the maximum possible audience size if campaign length is increased

targetSpec

Targeting targetSpec

A string in JSON format representing the targeting specs specified on creation.

timeCreated

Date timeCreated

The time when this reach frequency prediction was created

timeUpdated

Date timeUpdated

Unix timestamp when the row is updated

Class com.restfb.types.ads.ReachFrequencySpec

class ReachFrequencySpec extends AbstractFacebookType implements Serializable

Serialized Fields

countries

List<String> countries

maxCampaignDuration

String maxCampaignDuration

maxDaysToFinish

String maxDaysToFinish

minCampaignDuration

String minCampaignDuration

minReachLimits

String minReachLimits

Class com.restfb.types.ads.RTBDynamicPost

class RTBDynamicPost extends FacebookType implements Serializable

Serialized Fields

childAttachments

List<DynamicPostChildAttachment> childAttachments

comments

Comments comments

created

Date created

description

String description

imageUrl

String imageUrl

likes

Likes likes

link

String link

message

String message

ownerId

String ownerId

placeId

String placeId

productId

String productId

title

String title

Class com.restfb.types.ads.Rule

class Rule extends AbstractFacebookType implements Serializable

Class com.restfb.types.ads.RuleData

class RuleData extends Rule implements Serializable

Serialized Fields

operator

RuleOp operator

type

String type

Class com.restfb.types.ads.RuleOp

class RuleOp extends Rule implements Serializable

Serialized Fields

type

String type

value

String value

Class com.restfb.types.ads.RuleOpAnd

class RuleOpAnd extends RuleOp implements Serializable

Serialized Fields

ruleList

List<Rule> ruleList

Class com.restfb.types.ads.RuleOpOr

class RuleOpOr extends RuleOp implements Serializable

Serialized Fields

ruleList

List<Rule> ruleList

Class com.restfb.types.ads.StoreCatalogSettings

class StoreCatalogSettings extends BaseAdsObject implements Serializable

Serialized Fields

page

Page page

Class com.restfb.types.ads.Targeting

class Targeting extends AbstractFacebookType implements Serializable

Serialized Fields

adgroupId

String adgroupId

ageMax

Long ageMax

ageMin

Long ageMin

appInstallState

String appInstallState

audienceNetworkPositions

List<String> audienceNetworkPositions

behaviors

List<IDName> behaviors

cities

List<IDName> cities

collegeYears

List<Long> collegeYears

connections

List<IDName> connections

countries

List<String> countries

country

List<String> country

countryGroups

List<String> countryGroups

customAudiences

List<IDName> customAudiences

devicePlatforms

List<String> devicePlatforms

dynamicAudienceIds

List<String> dynamicAudienceIds

educationMajors

List<IDName> educationMajors

educationSchools

List<IDName> educationSchools

educationStatuses

List<Long> educationStatuses

effectiveAudienceNetworkPositions

List<String> effectiveAudienceNetworkPositions

effectiveDevicePlatforms

List<String> effectiveDevicePlatforms

effectiveFacebookPositions

List<String> effectiveFacebookPositions

effectiveInstagramPositions

List<String> effectiveInstagramPositions

effectiveMessengerPositions

List<String> effectiveMessengerPositions

effectivePublisherPlatforms

List<String> effectivePublisherPlatforms

engagementSpecs

List<TargetingDynamicRule> engagementSpecs

ethnicAffinity

List<IDName> ethnicAffinity

excludedConnections

List<IDName> excludedConnections

excludedCustomAudiences

List<IDName> excludedCustomAudiences

excludedDynamicAudienceIds

List<String> excludedDynamicAudienceIds

excludedEngagementSpecs

List<TargetingDynamicRule> excludedEngagementSpecs

excludedGeoLocations

TargetingGeoLocation excludedGeoLocations

excludedProductAudienceSpecs

List<TargetingProductAudienceSpec> excludedProductAudienceSpecs

excludedPublisherCategories

List<String> excludedPublisherCategories

excludedPublisherListIds

List<String> excludedPublisherListIds

excludeReachedSince

List<String> excludeReachedSince

exclusions

FlexibleTargeting exclusions

facebookPositions

List<String> facebookPositions

familyStatuses

List<IDName> familyStatuses

fbDealId

Long fbDealId

flexibleSpec

List<FlexibleTargeting> flexibleSpec

friendsOfConnections

List<IDName> friendsOfConnections

genders

List<Long> genders

generation

List<IDName> generation

geoLocations

TargetingGeoLocation geoLocations

homeOwnership

List<IDName> homeOwnership

homeType

List<IDName> homeType

homeValue

List<IDName> homeValue

householdComposition

List<IDName> householdComposition

id

String id

income

List<IDName> income

industries

List<IDName> industries

instagramPositions

List<String> instagramPositions

instreamVideoSponsorshipPlacements

List<String> instreamVideoSponsorshipPlacements

interestedIn

List<Long> interestedIn

interests

List<IDName> interests

isWhatsappDestinationAd

Boolean isWhatsappDestinationAd

keywords

List<String> keywords

lifeEvents

List<IDName> lifeEvents

locales

List<Long> locales

messengerPositions

List<String> messengerPositions

moms

List<IDName> moms

mProspectingAudience

TargetingProspectingAudience mProspectingAudience

mPublisherVisibilityCategories

List<String> mPublisherVisibilityCategories

netWorth

List<IDName> netWorth

officeType

List<IDName> officeType

pageTypes

List<String> pageTypes

placePageSetIds

List<String> placePageSetIds

platforms

List<String> platforms

politicalViews

List<Long> politicalViews

politics

List<IDName> politics

productAudienceSpecs

List<TargetingProductAudienceSpec> productAudienceSpecs

publisherPlatforms

List<String> publisherPlatforms

radius

String radius

regions

List<IDName> regions

relationshipStatuses

List<Long> relationshipStatuses

rtbFlag

Boolean rtbFlag

siteCategory

List<String> siteCategory

targetingOptimization

String targetingOptimization

userAdclusters

List<IDName> userAdclusters

userDevice

List<String> userDevice

userEvent

List<Long> userEvent

userOs

List<String> userOs

wirelessCarrier

List<String> wirelessCarrier

workEmployers

List<IDName> workEmployers

workPositions

List<IDName> workPositions

zips

List<String> zips

Class com.restfb.types.ads.TargetingDynamicRule

class TargetingDynamicRule extends AbstractFacebookType implements Serializable

Serialized Fields

actionType

String actionType

adGroupId

String adGroupId

campaignGroupId

String campaignGroupId

campaignId

String campaignId

impressionCount

String impressionCount

pageId

String pageId

post

String post

retentionSeconds

String retentionSeconds

Class com.restfb.types.ads.TargetingGeoLocation

class TargetingGeoLocation extends AbstractFacebookType implements Serializable

Serialized Fields

cities

List<TargetingGeoLocationCity> cities

countries

List<String> countries

countryGroups

List<String> countryGroups

customLocations

List<TargetingGeoLocationCustomLocation> customLocations

electoralDistricts

List<TargetingGeoLocationElectoralDistrict> electoralDistricts

geoMarkets

List<TargetingGeoLocationMarket> geoMarkets

locationTypes

List<String> locationTypes

places

List<TargetingGeoLocationPlace> places

regions

List<TargetingGeoLocationRegion> regions

zips

List<TargetingGeoLocationZip> zips

Class com.restfb.types.ads.TargetingGeoLocationCity

class TargetingGeoLocationCity extends com.restfb.types.ads.AbstractTargetingGeoLocation implements Serializable

Serialized Fields

radius

Long radius

region

String region

regionId

String regionId

Class com.restfb.types.ads.TargetingGeoLocationCustomLocation

class TargetingGeoLocationCustomLocation extends AbstractFacebookType implements Serializable

Serialized Fields

addressString

String addressString

latitude

Double latitude

longitude

Double longitude

maxPopulation

Long maxPopulation

minPopulation

Long minPopulation

primaryCityId

Long primaryCityId

radius

Double radius

regionId

Long regionId

Class com.restfb.types.ads.TargetingGeoLocationElectoralDistrict

class TargetingGeoLocationElectoralDistrict extends AbstractFacebookType implements Serializable

Serialized Fields

country

String country

electoralDistrict

String electoralDistrict

key

String key

name

String name

Class com.restfb.types.ads.TargetingGeoLocationMarket

class TargetingGeoLocationMarket extends AbstractFacebookType implements Serializable

Serialized Fields

country

String country

key

String key

marketType

String marketType

name

String name

Class com.restfb.types.ads.TargetingGeoLocationPlace

class TargetingGeoLocationPlace extends com.restfb.types.ads.AbstractTargetingGeoLocation implements Serializable

Serialized Fields

latitude

Double latitude

longitude

Double longitude

primaryCityId

Long primaryCityId

radius

Double radius

regionId

Long regionId

Class com.restfb.types.ads.TargetingGeoLocationRegion

class TargetingGeoLocationRegion extends AbstractFacebookType implements Serializable

Serialized Fields

country

String country

key

String key

name

String name

Class com.restfb.types.ads.TargetingGeoLocationZip

class TargetingGeoLocationZip extends AbstractFacebookType implements Serializable

Serialized Fields

country

String country

key

String key

name

String name

primaryCityId

Long primaryCityId

regionId

Long regionId

Class com.restfb.types.ads.TargetingProductAudienceSpec

class TargetingProductAudienceSpec extends AbstractFacebookType implements Serializable

Serialized Fields

exclusions

List<TargetingProductAudienceSubSpec> exclusions

inclusions

List<TargetingProductAudienceSubSpec> inclusions

productSetId

String productSetId

Class com.restfb.types.ads.TargetingProductAudienceSubSpec

class TargetingProductAudienceSubSpec extends AbstractFacebookType implements Serializable

Serialized Fields

retentionSeconds

Long retentionSeconds

rule

Rule rule

ruleJson

JsonObject ruleJson

Class com.restfb.types.ads.TargetingProspectingAudience

class TargetingProspectingAudience extends BaseAdsObject implements Serializable

Serialized Fields

sources

List<JsonObject> sources

Class com.restfb.types.ads.TargetingResponseDemographic

class TargetingResponseDemographic extends NamedAdsObject implements Serializable

Serialized Fields

audienceSize

Long audienceSize

description

String description

disambiguationCategory

String disambiguationCategory

path

List<String> path

topic

String topic

type

String type

Class com.restfb.types.ads.TargetingResponseEducation

class TargetingResponseEducation extends NamedAdsObject implements Serializable

Serialized Fields

coverage

Long coverage

subtext

String subtext

Class com.restfb.types.ads.TargetingResponseGeographic

class TargetingResponseGeographic extends NamedAdsObject implements Serializable

Serialized Fields

addressString

String addressString

countryCode

String countryCode

countryName

String countryName

key

String key

latitude

String latitude

longitude

String longitude

primaryCity

String primaryCity

primaryCityId

Long primaryCityId

region

String region

regionId

Long regionId

supportsCity

Boolean supportsCity

supportsRegion

Boolean supportsRegion

type

String type

Class com.restfb.types.ads.TargetingResponseGeographicMetadata

class TargetingResponseGeographicMetadata extends AbstractFacebookType implements Serializable

Serialized Fields

data

String data

metaData

com.restfb.types.ads.TargetingResponseGeographicMetadata.MetaData metaData

Class com.restfb.types.ads.TargetingResponseRadiusSuggestion

class TargetingResponseRadiusSuggestion extends AbstractFacebookType implements Serializable

Serialized Fields

distanceUnit

String distanceUnit

suggestedRadius

Long suggestedRadius

Class com.restfb.types.ads.TargetingSentenceLine

class TargetingSentenceLine extends BaseAdsObject implements Serializable

Serialized Fields

params

Targeting params

targetingsentencelines

List<String> targetingsentencelines

check TargetingSentenceLine.getTargetingsentencelinesAsObjectList() to fetch the items as objects

targetingsentencelinesAsObjectList

List<TargetingSentenceLine.TargetingSentenceLineItem> targetingsentencelinesAsObjectList

Class com.restfb.types.ads.TargetingSentenceLine.TargetingSentenceLineItem

class TargetingSentenceLineItem extends AbstractFacebookType implements Serializable

Serialized Fields

children

List<String> children

content

String content

Class com.restfb.types.ads.TrackingAndConversionWithDefaults

class TrackingAndConversionWithDefaults extends BaseAdsObject implements Serializable

Serialized Fields

customConversion

List<JsonObject> customConversion

customTracking

List<JsonObject> customTracking

defaultConversion

List<JsonObject> defaultConversion

defaultTracking

List<JsonObject> defaultTracking

Class com.restfb.types.ads.UserPermission

class UserPermission extends AbstractFacebookType implements Serializable

Serialized Fields

adaccountPermissions

String adaccountPermissions

businessPersona

NamedAdsObject businessPersona

createdBy

String createdBy

createdTime

Date createdTime

email

String email

pagePermissions

String pagePermissions

role

String role

status

String status

updatedBy

String updatedBy

updatedTime

Date updatedTime

user

NamedAdsObject user

Class com.restfb.types.ads.WebAppLink

class WebAppLink extends com.restfb.types.ads.AbstractUrlAppLink implements Serializable

Serialized Fields

shouldFallback

Boolean shouldFallback

Class com.restfb.types.ads.WindowsAppLink

class WindowsAppLink extends AbstractFacebookType implements Serializable

Serialized Fields

appId

String appId

appName

String appName

packageFamilyName

String packageFamilyName

url

String url

Class com.restfb.types.ads.WindowsPhoneAppLink

class WindowsPhoneAppLink extends com.restfb.types.ads.AbstractMobileAppLink implements Serializable

Serialized Fields

appId

String appId

Package com.restfb.types.instagram

Class com.restfb.types.instagram.CopyrightCheckInformation

class CopyrightCheckInformation extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

status

CopyrightCheckInformation.Status status

Class com.restfb.types.instagram.CopyrightCheckInformation.Status

class Status extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

matchesFound

Boolean matchesFound

status

String status

Class com.restfb.types.instagram.IgBoostEligibilityInfo

class IgBoostEligibilityInfo extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

eligibleToBoost

Boolean eligibleToBoost

Class com.restfb.types.instagram.IgComment

class IgComment extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

from

IgFrom from

An object containing: id — IGSID of the Instagram user who created the IG Comment. username — Username of the Instagram user who created the IG Comment.

hidden

Boolean hidden

Whether the comment is hidden

likeCount

Long likeCount

Number of likes on the comment

media

IgMedia media

Media on which the comment is made

parentId

String parentId

ID of the parent IG Comment if this comment was created on another IG Comment (i.e. a reply to another comment.

replies

List<IgComment> replies

text

String text

Text of the comment

timestamp

Date timestamp

Timestamp of comment

user

IgUser user

Deprecated.

with Graph API 12 or December 13, 2021 for all versions

User who made the comment

username

String username

User will only be returned when queried by owner of comment. Otherwise, username is the only field that will be returned.

Class com.restfb.types.instagram.IgContainer

class IgContainer extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

status

String status

statusCode

String statusCode

Class com.restfb.types.instagram.IgContentPublishingLimit

class IgContentPublishingLimit extends AbstractFacebookType implements Serializable

Serialized Fields

config

IgContentPublishingLimit.Config config

quotaUsage

String quotaUsage

Class com.restfb.types.instagram.IgFrom

class IgFrom extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

username

String username

Class com.restfb.types.instagram.IgHashtag

class IgHashtag extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Class com.restfb.types.instagram.IgMedia

class IgMedia extends IgMediaChild implements Serializable

serialVersionUID:

1L

Serialized Fields

boostAdsList

List<IgBoostMediaAd> boostAdsList

boostEligibilityInfo

IgBoostEligibilityInfo boostEligibilityInfo

The field provides information about boosting eligibility of a IG instagram media as an ad and additional details if not eligible.

caption

String caption

Caption. Excludes album children. The @ symbol is excluded, unless the app user can perform admin-equivalent tasks on the Facebook Page connected to the Instagram account used to create the caption.

children

List<IgMediaChild> children

comments

List<IgComment> comments

commentsCount

Long commentsCount

Count of comments on the media.

Excludes comments on album child media and the media's caption. Includes replies on comments.

copyrightCheckInformation

CopyrightCheckInformation copyrightCheckInformation

insights

List<Insight> insights

isCommentEnabled

Boolean isCommentEnabled

Indicates if comments are enabled or disabled. Excludes album children.

isSharedToFeed

Boolean isSharedToFeed

Reels only. If true, indicates the reel can appear in both the Feed and Reels tabs.

If false, indicates the reel can only appear in the Reels tab.

likeCount

Long likeCount

Count of likes on the media.

Excludes likes on album child media and likes on promoted posts created from the media. Includes replies on comments.

• v10.0 and older calls: value will be 0 if the media owner has hidden like counts it.
• v11.0+ calls: field will be omitted if media owner has hidden like counts on it.

thumbnailUrl

String thumbnailUrl

Media thumbnail URL. Only available on VIDEO media.

videoTitle

String videoTitle

Deprecated.

Omitted from response.

IGTV media title.

Class com.restfb.types.instagram.IgMediaChild

class IgMediaChild extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

igId

String igId

mediaProductType

String mediaProductType

Surface where the media is published. Can be AD, FEED, or STORY.

mediaType

String mediaType

Media type. Can be CAROUSEL_ALBUM, IMAGE, or VIDEO.

mediaUrl

String mediaUrl

Media URL. Will be omitted from responses if the media contains copyrighted material, or has been flagged for a copyright violation.

owner

IgUser owner

Deprecated.

with Graph API 12 or December 13, 2021 for all versions

ID of Instagram user who created the media. Only returned if the app user making the query also created the media, otherwise username field will be returned instead.

permalink

String permalink

Permanent URL to the media.

shortcode

String shortcode

Shortcode to the media.

thumbnailUrl

String thumbnailUrl

Media thumbnail URL. Only available on VIDEO media.

timestamp

Date timestamp

ISO 8601 formatted creation date in UTC (default is UTC ±00:00)

username

String username

Username of user who created the media.

Class com.restfb.types.instagram.IgMentionedMedia

class IgMentionedMedia extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

mentionedMedia

IgMedia mentionedMedia

Class com.restfb.types.instagram.IgUser

class IgUser extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

biography

String biography

Biography of the user

businessDiscovery

IgUser businessDiscovery

Loads business discovery information

followersCount

Long followersCount

Active follower count of the user

followsCount

Long followsCount

Active follows count of the user

igId

Long igId

Ig Id of the user

insights

List<Insight> insights

media

List<IgMedia> media

Deprecated.

mediaConnection

Connection<IgMedia> mediaConnection

mediaCount

Long mediaCount

Filtered media count of the user

profilePictureUrl

String profilePictureUrl

The cdn url to query the raw profile picture of the user

username

String username

Username handle of the user

website

String website

Url in the profile

Class com.restfb.types.instagram.IgUserProfile

class IgUserProfile extends NamedFacebookType implements Serializable

Serialized Fields

followerCount

Integer followerCount

Follower count of the user

isBusinessFollowUser

Boolean isBusinessFollowUser

A flag indicating whether the business follow the user or not

isUserFollowBusiness

Boolean isUserFollowBusiness

A flag indicating whether the user follow the business or not

isVerifiedUser

Boolean isVerifiedUser

Verification status of the user

profilePic

String profilePic

URL to the Profile picture. The URL will expire in a few days.

username

String username

The username for the customer's Instagram account

Package com.restfb.types.oembed

Class com.restfb.types.oembed.BaseOEmbed

class BaseOEmbed extends AbstractFacebookType implements Serializable

Serialized Fields

height

Long height

The height in pixels required to display the HTML.

html

String html

The HTML used to display the page.

providerName

String providerName

Name of the provider (Facebook)

providerUrl

String providerUrl

URL of the provider (Facebook)

type

String type

The oEmbed resource type. See https://oembed.com/.

version

String version

Always 1.0. See https://oembed.com/

width

Long width

The width in pixels required to display the HTML.

Class com.restfb.types.oembed.OEmbedPage

class OEmbedPage extends BaseOEmbed implements Serializable

Class com.restfb.types.oembed.OEmbedPost

class OEmbedPost extends BaseOEmbed implements Serializable

Serialized Fields

authorName

String authorName

The name of the Facebook user that owns the post.

authorUrl

String authorUrl

A URL for the author/owner of the post.

Class com.restfb.types.oembed.OEmbedVideo

class OEmbedVideo extends BaseOEmbed implements Serializable

Serialized Fields

authorName

String authorName

The name of the Facebook user that owns the video.

authorUrl

String authorUrl

A URL for the author/owner of the video.

Package com.restfb.types.send

Class com.restfb.types.send.AbstractButton

class AbstractButton extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

title

String title

type

String type

Class com.restfb.types.send.AccountLinkButton

class AccountLinkButton extends AbstractButton implements Serializable

Serialized Fields

url

String url

Class com.restfb.types.send.AccountUnlinkButton

class AccountUnlinkButton extends AbstractButton implements Serializable

Class com.restfb.types.send.BasicRefData

class BasicRefData extends AbstractFacebookType implements Serializable

Serialized Fields

ref

String ref

Class com.restfb.types.send.Bubble

class Bubble extends AbstractFacebookType implements Serializable

Serialized Fields

buttons

List<AbstractButton> buttons

defaultAction

DefaultAction defaultAction

imageUrl

String imageUrl

itemUrl

String itemUrl

subtitle

String subtitle

title

String title

Class com.restfb.types.send.ButtonTemplatePayload

class ButtonTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

buttons

List<AbstractButton> buttons

text

String text

Class com.restfb.types.send.BuyButton

class BuyButton extends AbstractButton implements Serializable

Serialized Fields

payload

String payload

paymentSummary

PaymentSummary paymentSummary

Class com.restfb.types.send.CallButton

class CallButton extends AbstractButton implements Serializable

Serialized Fields

payload

String payload

Class com.restfb.types.send.CallToAction

class CallToAction extends AbstractFacebookType implements Serializable

Serialized Fields

payload

String payload

Class com.restfb.types.send.CommentIdMessageRecipient

class CommentIdMessageRecipient extends AbstractFacebookType implements Serializable

Serialized Fields

commentId

String commentId

Class com.restfb.types.send.DefaultAction

class DefaultAction extends WebButton implements Serializable

Class com.restfb.types.send.GamePlayButton

class GamePlayButton extends AbstractButton implements Serializable

Serialized Fields

gameMetadata

GamePlayButton.GameMetadata gameMetadata

payload

String payload

Class com.restfb.types.send.GamePlayButton.GameMetadata

class GameMetadata extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

contextId

String contextId

playerId

String playerId

Class com.restfb.types.send.GenericTemplatePayload

class GenericTemplatePayload extends SharableTemplatePayload implements Serializable

Serialized Fields

elements

List<Bubble> elements

imageAspectRatio

ImageAspectRatioEnum imageAspectRatio

Class com.restfb.types.send.Greeting

class Greeting extends AbstractFacebookType implements Serializable

Serialized Fields

locale

String locale

Locale of the greeting text. Facebook will show this greeting text when user locale matches the provided locale. You must at least specify greeting text for the default locale. This is the text Facebook will fall back to if they don't find another matching the user's locale. See the list of supported locales.

text

String text

The greeting text for the specific locale.

Class com.restfb.types.send.HomeUrl

class HomeUrl extends AbstractFacebookType implements Serializable

Serialized Fields

inTest

Boolean inTest

Controls whether users not assigned a role for your bot or its Facebook page can see the Chat Extension. This should be set to true until the Chat Extension is ready to be used by others.

url

String url

The URL to be invoked from drawer. Must be whitelisted. Must use https.

webviewHeightRatio

String webviewHeightRatio

Controls the height of webview. Only allowed value is tall.

webviewShareButton

String webviewShareButton

Controls whether the share button in the webview is enabled. Either show or hide, defaults to "hide"

Class com.restfb.types.send.IceBreaker

class IceBreaker extends AbstractFacebookType implements Serializable

Serialized Fields

payload

String payload

question

String question

Class com.restfb.types.send.IdMessageRecipient

class IdMessageRecipient extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

Class com.restfb.types.send.ListTemplatePayload

class ListTemplatePayload extends SharableTemplatePayload implements Serializable

Serialized Fields

buttons

List<AbstractButton> buttons

Deprecated.

elements

List<ListViewElement> elements

Deprecated.

topElementStyle

ListTemplatePayload.TopElementStyleEnum topElementStyle

Deprecated.

Value must be large or compact. Default to large if not specified

Class com.restfb.types.send.ListViewElement

class ListViewElement extends AbstractFacebookType implements Serializable

Serialized Fields

buttons

List<AbstractButton> buttons

defaultAction

DefaultAction defaultAction

imageUrl

String imageUrl

subtitle

String subtitle

title

String title

Class com.restfb.types.send.LocationAttachment

class LocationAttachment extends MessageAttachment implements Serializable

Serialized Fields

payload

com.restfb.types.send.LocationAttachment.LocationPayload payload

Class com.restfb.types.send.MediaAttachment

class MediaAttachment extends MessageAttachment implements Serializable

Serialized Fields

payload

com.restfb.types.send.MediaAttachment.MediaAttachmentPayload payload

Class com.restfb.types.send.Message

class Message extends AbstractFacebookType implements Serializable

Serialized Fields

attachment

MessageAttachment attachment

metadata

String metadata

quickReplies

List<QuickReply> quickReplies

text

String text

Class com.restfb.types.send.MessageAttachment

class MessageAttachment extends AbstractFacebookType implements Serializable

Serialized Fields

type

String type

Class com.restfb.types.send.MessageCreativeResponse

class MessageCreativeResponse extends AbstractFacebookType implements Serializable

Serialized Fields

messageCreativeId

String messageCreativeId

Class com.restfb.types.send.MessengerProfileProperties

class MessengerProfileProperties extends AbstractFacebookType implements Serializable

Serialized Fields

accountLinkingUrl

String accountLinkingUrl

getStarted

CallToAction getStarted

greeting

List<Greeting> greeting

homeUrl

HomeUrl homeUrl

paymentSettings

PaymentSettings paymentSettings

persistentMenu

PersistentMenu persistentMenu

targetAudience

TargetAudience targetAudience

whitelistedDomains

List<String> whitelistedDomains

Class com.restfb.types.send.NestedButton

class NestedButton extends AbstractButton implements Serializable

Serialized Fields

callToActions

List<MenuItem> callToActions

Top-level menu items that user can interact with.

Class com.restfb.types.send.OneTimeNotifMessageRecipient

class OneTimeNotifMessageRecipient extends AbstractFacebookType implements Serializable

Serialized Fields

oneTimeNotifToken

String oneTimeNotifToken

Class com.restfb.types.send.OneTimeNotifReqTemplatePayload

class OneTimeNotifReqTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

payload

String payload

title

String title

Class com.restfb.types.send.OpenGraphTemplatePayload

class OpenGraphTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

elements

List<OpenGraphTemplatePayload.Element> elements

Deprecated.

Class com.restfb.types.send.PageMessageTag

class PageMessageTag extends AbstractFacebookType implements Serializable

Serialized Fields

description

String description

tag

String tag

Class com.restfb.types.send.PaymentSettings

class PaymentSettings extends AbstractFacebookType implements Serializable

Serialized Fields

privacyUrl

String privacyUrl

The URL of the privacy policy for your bot. Required for buy button payments.

publicKey

String publicKey

Your public key. Used to encrypt all webview payments, and buy button implementations that use tokenized payments.

testers

List<String> testers

A list of IDs for people that will test payments in your bot. These people will send a mock payment when they tap the buy button.

Class com.restfb.types.send.PersistentMenu

class PersistentMenu extends AbstractFacebookType implements Serializable

Serialized Fields

callToActions

List<MenuItem> callToActions

Top-level menu items that user can interact with.

composerInputDisabled

Boolean composerInputDisabled

Set to true to disable user input in the menu. This means users will only be able to interact with your bot via the menu, postbacks, buttons, and webviews.

locale

String locale

Locale of the menu. We will show this menu when user locale matches the provided locale. You must at least specify a menu for the default locale. This is the menu we will fall back to if we don't find another matching the user's locale. See the list of supported locales.

Class com.restfb.types.send.PhoneMessageRecipient

class PhoneMessageRecipient extends AbstractFacebookType implements Serializable

Serialized Fields

name

PhoneMessageRecipient.Name name

phoneNumber

String phoneNumber

Class com.restfb.types.send.PhoneMessageRecipient.Name

class Name extends AbstractFacebookType implements Serializable

Serialized Fields

firstName

String firstName

lastName

String lastName

Class com.restfb.types.send.PostbackButton

class PostbackButton extends AbstractButton implements Serializable

Serialized Fields

payload

String payload

Class com.restfb.types.send.PostIdMessageRecipient

class PostIdMessageRecipient extends AbstractFacebookType implements Serializable

Serialized Fields

postId

String postId

Class com.restfb.types.send.QuickReply

class QuickReply extends AbstractFacebookType implements Serializable

Serialized Fields

contentType

String contentType

imageUrl

String imageUrl

payload

String payload

title

String title

Class com.restfb.types.send.ReceiptAddress

class ReceiptAddress extends AbstractFacebookType implements Serializable

Serialized Fields

city

String city

country

String country

postalCode

String postalCode

state

String state

street1

String street1

street2

String street2

Class com.restfb.types.send.ReceiptAdjustment

class ReceiptAdjustment extends AbstractFacebookType implements Serializable

Serialized Fields

amount

String amount

name

String name

Class com.restfb.types.send.ReceiptElement

class ReceiptElement extends AbstractFacebookType implements Serializable

Serialized Fields

currency

String currency

imageUrl

String imageUrl

price

double price

quantity

int quantity

subtitle

String subtitle

title

String title

Class com.restfb.types.send.ReceiptSummary

class ReceiptSummary extends AbstractFacebookType implements Serializable

Serialized Fields

shippingCost

double shippingCost

subtotal

double subtotal

totalCost

double totalCost

totalTax

double totalTax

Class com.restfb.types.send.ReceiptTemplatePayload

class ReceiptTemplatePayload extends SharableTemplatePayload implements Serializable

Serialized Fields

address

ReceiptAddress address

adjustments

List<ReceiptAdjustment> adjustments

currency

String currency

elements

List<ReceiptElement> elements

merchantName

String merchantName

orderNumber

String orderNumber

orderUrl

String orderUrl

paymentMethod

String paymentMethod

recipientName

String recipientName

summary

ReceiptSummary summary

timestamp

Long timestamp

Class com.restfb.types.send.SendResponse

class SendResponse extends AbstractFacebookType implements Serializable

Serialized Fields

attachmentId

String attachmentId

messageId

String messageId

recipientId

String recipientId

result

String result

Class com.restfb.types.send.SharableTemplatePayload

class SharableTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

sharable

Boolean sharable

Class com.restfb.types.send.ShareButton

class ShareButton extends AbstractButton implements Serializable

Class com.restfb.types.send.SponsoredMessageResponse

class SponsoredMessageResponse extends AbstractFacebookType implements Serializable

Serialized Fields

broadcastId

String broadcastId

Class com.restfb.types.send.TargetAudience

class TargetAudience extends AbstractFacebookType implements Serializable

Serialized Fields

audienceType

String audienceType

Audience type. Valid values include all, custom, or none.

countries

TargetAudience.Countries countries

country object. Needs to be specified only when audience_type is custom.

Class com.restfb.types.send.TargetAudience.Countries

class Countries extends AbstractFacebookType implements Serializable

Serialized Fields

blacklist

List<String> blacklist

List of ISO 3166 Alpha-2 codes. Users in any of the blacklist countries won't see your bot on discovery surfaces on Messenger Platform.

whitelist

List<String> whitelist

List of ISO 3166 Alpha-2 codes. Users in any of the whitelist countries will see your bot on discovery surfaces on Messenger Platform.

Class com.restfb.types.send.TemplateAttachment

class TemplateAttachment extends MessageAttachment implements Serializable

Serialized Fields

payload

TemplatePayload payload

Class com.restfb.types.send.TemplatePayload

class TemplatePayload extends AbstractFacebookType implements Serializable

Serialized Fields

templateType

String templateType

Class com.restfb.types.send.UserRefMessageRecipient

class UserRefMessageRecipient extends AbstractFacebookType implements Serializable

Serialized Fields

userRef

String userRef

Class com.restfb.types.send.WebButton

class WebButton extends AbstractButton implements Serializable

Serialized Fields

fallbackUrl

String fallbackUrl

messengerExtensions

Boolean messengerExtensions

url

String url

webviewHeightRatio

WebviewHeightEnum webviewHeightRatio

webviewShareButton

String webviewShareButton

Package com.restfb.types.send.airline

Class com.restfb.types.send.airline.AirlineBoardingPassTemplatePayload

class AirlineBoardingPassTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

boardingPassList

List<BoardingPass> boardingPassList

introMessage

String introMessage

locale

String locale

themeColor

String themeColor

Class com.restfb.types.send.airline.AirlineCheckinTemplatePayload

class AirlineCheckinTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

checkinUrl

String checkinUrl

flightInfoList

List<FlightInfo> flightInfoList

introMessage

String introMessage

locale

String locale

pnrNumber

String pnrNumber

themeColor

String themeColor

Class com.restfb.types.send.airline.AirlineField

class AirlineField extends AbstractFacebookType implements Serializable

Serialized Fields

label

String label

value

String value

Class com.restfb.types.send.airline.AirlineItineraryTemplatePayload

class AirlineItineraryTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

basePrice

double basePrice

currency

String currency

flightInfoList

List<FlightInfo> flightInfoList

introMessage

String introMessage

locale

String locale

passengerInfoList

List<PassengerInfo> passengerInfoList

passengerSegmentInfoList

List<PassengerSegmentInfo> passengerSegmentInfoList

pnrNumber

String pnrNumber

priceInfoList

List<PriceInfo> priceInfoList

tax

double tax

themeColor

String themeColor

totalPrice

double totalPrice

Class com.restfb.types.send.airline.AirlineUpdateTemplatePayload

class AirlineUpdateTemplatePayload extends TemplatePayload implements Serializable

Serialized Fields

introMessage

String introMessage

locale

String locale

pnrNumber

String pnrNumber

themeColor

String themeColor

updateFlightInfo

FlightInfo updateFlightInfo

updateType

String updateType

Class com.restfb.types.send.airline.BoardingPass

class BoardingPass extends AbstractFacebookType implements Serializable

Serialized Fields

aboveBarCodeImageUrl

String aboveBarCodeImageUrl

auxiliaryFields

List<AirlineField> auxiliaryFields

barcodeImageUrl

String barcodeImageUrl

flightInfo

FlightInfo flightInfo

headerImageUrl

String headerImageUrl

headerTextField

String headerTextField

logoImageUrl

String logoImageUrl

passengerName

String passengerName

pnrNumber

String pnrNumber

qrCode

String qrCode

seat

String seat

secondaryFields

List<AirlineField> secondaryFields

travelClass

String travelClass

Class com.restfb.types.send.airline.FlightAirport

class FlightAirport extends AbstractFacebookType implements Serializable

Serialized Fields

airportCode

String airportCode

city

String city

gate

String gate

terminal

String terminal

Class com.restfb.types.send.airline.FlightInfo

class FlightInfo extends AbstractFacebookType implements Serializable

Serialized Fields

aircraftType

String aircraftType

arrivalAirport

FlightAirport arrivalAirport

connectionId

String connectionId

departureAirport

FlightAirport departureAirport

flightNumber

String flightNumber

flightSchedule

FlightSchedule flightSchedule

segmentId

String segmentId

travelClass

String travelClass

Class com.restfb.types.send.airline.FlightSchedule

class FlightSchedule extends AbstractFacebookType implements Serializable

Serialized Fields

arrivalTime

Date arrivalTime

boardingTime

Date boardingTime

departureTime

Date departureTime

Class com.restfb.types.send.airline.PassengerInfo

class PassengerInfo extends AbstractFacebookType implements Serializable

Serialized Fields

name

String name

passengerId

String passengerId

ticketNumber

String ticketNumber

Class com.restfb.types.send.airline.PassengerSegmentInfo

class PassengerSegmentInfo extends AbstractFacebookType implements Serializable

Serialized Fields

passengerId

String passengerId

productInfoList

List<ProductInfo> productInfoList

seat

String seat

seatType

String seatType

segmentId

String segmentId

Class com.restfb.types.send.airline.PriceInfo

class PriceInfo extends AbstractFacebookType implements Serializable

Serialized Fields

amount

double amount

currency

String currency

title

String title

Class com.restfb.types.send.airline.ProductInfo

class ProductInfo extends AbstractFacebookType implements Serializable

Serialized Fields

title

String title

value

String value

Package com.restfb.types.send.buybutton

Class com.restfb.types.send.buybutton.PaymentSummary

class PaymentSummary extends AbstractFacebookType implements Serializable

Serialized Fields

currency

String currency

merchantName

String merchantName

paymentType

PaymentTypeEnum paymentType

priceList

List<PriceListItem> priceList

requestedUserInfo

List<RequestedUserInfoEnum> requestedUserInfo

testPayment

boolean testPayment

Class com.restfb.types.send.buybutton.PriceListItem

class PriceListItem extends AbstractFacebookType implements Serializable

Serialized Fields

amount

String amount

label

String label

Package com.restfb.types.send.media

Class com.restfb.types.send.media.MediaTemplateAttachmentElement

class MediaTemplateAttachmentElement extends AbstractFacebookType implements Serializable

Serialized Fields

attachmentId

String attachmentId

buttons

List<AbstractButton> buttons

mediaType

String mediaType

Class com.restfb.types.send.media.MediaTemplateUrlElement

class MediaTemplateUrlElement extends AbstractFacebookType implements Serializable

Serialized Fields

buttons

List<AbstractButton> buttons

mediaType

String mediaType

url

String url

Package com.restfb.types.threads

Class com.restfb.types.threads.TdMedia

class TdMedia extends FacebookType implements Serializable

serialVersionUID:

-1L

Serialized Fields

allowlistedCountryCodes

List<String> allowlistedCountryCodes

altText

String altText

The accessibility text label or description for an image or video in a Threads post

children

List<TdMedia> children

List of child posts. This only shows up for carousel posts.

isQuotePost

Boolean isQuotePost

Indicates if the media is a quoted post made by another user

linkAttachmentUrl

String linkAttachmentUrl

link attachment URL of the URL that is attachment with highlight. See here: https://developers.facebook.com/docs/threads/posts#tags-and-links-in-posts

mediaProductType

String mediaProductType

Surface where the media is published. In the case of Threads, the value is THREADS.

mediaType

TdMediaType mediaType

The media type for a Threads post will be one of these values: TEXT_POST, IMAGE, VIDEO, CAROUSEL_ALBUM, or REPOST_FACADE.

mediaUrl

String mediaUrl

The post’s media URL.

owner

TdProfile owner

Instagram user ID who created the post.

permalink

String permalink

Permanent link to the post. Will be omitted if the media contains copyrighted material or has been flagged for a copyright violation.

shortcode

String shortcode

Shortcode of the media.

text

String text

Represents text for a Threads post.

thumbnailUrl

String thumbnailUrl

URL of thumbnail. This only shows up for Threads media with video.

timestamp

Date timestamp

Post time. The publish date in ISO 8601 format.

username

String username

Instagram username who created the post.

Class com.restfb.types.threads.TdMediaContainer

class TdMediaContainer extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

errorMessage

TdMediaContainer.ErrorMessage errorMessage

id

String id

status

TdMediaContainer.Status status

Class com.restfb.types.threads.TdProfile

class TdProfile extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

Instagram user ID. This is returned by default.

name

String name

name of the Threads profile

threadsBiography

String threadsBiography

Biography text on Threads profile.

threadsProfilePictureUrl

String threadsProfilePictureUrl

URL of the user's profile picture on Threads.

username

String username

Handle or unique username on Threads. This is the same as the username on Instagram.

Class com.restfb.types.threads.TdQuota

class TdQuota extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

replyConfig

TdQuota.TdReplyConfig replyConfig

replyQuotaUsage

Long replyQuotaUsage

Class com.restfb.types.threads.TdQuota.TdReplyConfig

class TdReplyConfig extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

quotaDuration

Long quotaDuration

quotaTotal

Long quotaTotal

Class com.restfb.types.threads.TdReply

class TdReply extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

children

List<TdReply> children

List of child posts. This only shows for carousel replies.

hasReplies

Boolean hasReplies

true if the Threads post or reply has replies that you can see.

hideStatus

TdReply.TdHideStatus hideStatus

Whether or not the reply is hidden. Values: NOT_HUSHED, UNHUSHED, HIDDEN, COVERED, BLOCKED, RESTRICTED

isQuotePost

Boolean isQuotePost

Indicates if the media is a quoted reply made by another user.

isReply

Boolean isReply

true if the Threads media is a reply. false if the Threads media is a top-level post.

isReplyOwnedByMe

Boolean isReplyOwnedByMe

true if your user is the owner of the Threads reply.
false if another user is the owner of the Threads reply.

mediaProductType

String mediaProductType

Surface where the media is published. In the case of Threads, the value is THREADS.

mediaType

TdMediaType mediaType

The media type for a Threads reply. Values: TEXT_POST, IMAGE, VIDEO, CAROUSEL_ALBUM

mediaUrl

String mediaUrl

The post’s media URL. This only shows for image, video, and carousel replies.

permalink

String permalink

Permanent link to the post. Will be omitted if the media contains copyrighted material or has been flagged for a copyright violation. Note: This only works for public users or your own user.

repliedTo

TdReply repliedTo

Media ID of the immediate parent of the reply. Note: This only appears on replies.

replyAudience

TdReply.TdReplyAudience replyAudience

Who can reply to your post.

rootPost

TdReply rootPost

Media ID of the top-level post or original thread in the reply tree. Note: This only appears on replies.

shortcode

String shortcode

Shortcode of the media.

text

String text

Represents text for a Threads reply. This is optional on image, video, and carousel replies.

thumbnailUrl

String thumbnailUrl

URL of thumbnail. This only shows for Threads replies with video.

timestamp

Date timestamp

The publish date and time of the post in ISO 8601 format.

username

String username

Instagram username who created the post. Note: This only works for public users or your own user.

Package com.restfb.types.webhook.base

Class com.restfb.types.webhook.base.From

class From extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

name

String name

Package com.restfb.types.webhook.messaging.nlp

Class com.restfb.types.webhook.messaging.nlp.NlpError

class NlpError extends Object implements Serializable

Serialized Fields

code

String code

message

String message

Class com.restfb.types.webhook.messaging.nlp.NlpLocation.Coords

class Coords extends AbstractFacebookType implements Serializable

Serialized Fields

latitude

Double latitude

longitude

Double longitude

Class com.restfb.types.webhook.messaging.nlp.NlpLocation.External

class External extends AbstractFacebookType implements Serializable

Serialized Fields

geonames

String geonames

wikidata

String wikidata

wikipedia

String wikipedia

Class com.restfb.types.webhook.messaging.nlp.NlpLocation.Place

class Place extends AbstractFacebookType implements Serializable

Serialized Fields

coords

NlpLocation.Coords coords

external

NlpLocation.External external

grain

String grain

name

String name

timeZone

TimeZone timeZone

timezoneAsString

String timezoneAsString

type

String type

Package com.restfb.types.webhook.messaging.payment

Class com.restfb.types.webhook.messaging.payment.Amount

class Amount extends Object implements Serializable

Serialized Fields

amount

Double amount

Total amount

currency

String currency

Currency of amount

Class com.restfb.types.webhook.messaging.payment.PaymentCredential

class PaymentCredential extends Object implements Serializable

Serialized Fields

chargeId

String chargeId

Payment provider charge id

providerType

String providerType

Payment provider type

Class com.restfb.types.webhook.messaging.payment.ReuqestedUserInfo

class ReuqestedUserInfo extends Object implements Serializable

Serialized Fields

contactEmail

String contactEmail

Person's email

contactName

String contactName

Person's name

contactPhone

String contactPhone

Person's phone number

shippingAddress

ShippingAddress shippingAddress

Person's shipping address

Class com.restfb.types.webhook.messaging.payment.ShippingAddress

class ShippingAddress extends Object implements Serializable

Serialized Fields

city

String city

Shipping address city

country

String country

Shipping address country

id

String id

ID of shipping address

postalCode

String postalCode

Shipping address postal code

state

String state

Shipping address state

street1

String street1

Shipping address street, first line

street2

String street2

Shipping address street, second line

Package com.restfb.types.whatsapp

Class com.restfb.types.whatsapp.CurrencyAmount

class CurrencyAmount extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

String amount

Value of the amount in whole currency units (USD 123.45 = "123.45")

amountInHundredths

String amountInHundredths

Value of the amount in hundredths, i.e. (USD 123.45 = "12345", JYP 1 = "100")

currency

String currency

Currency in which amount is given

offsettedAmount

String offsettedAmount

Value of the amount in cents (USD 123.45 = "12345")

Class com.restfb.types.whatsapp.ExtendedCredit

class ExtendedCredit extends FacebookType implements Serializable

Serialized Fields

allocatedAmount

CurrencyAmount allocatedAmount

The total amount of credit that has been granted to other businesses. Going forward, credentials are measured in USD at the top level, and attachable to ad accounts of multiple currencies.

balance

CurrencyAmount balance

The total amount spent. This is calculated by adding parent ad account and all child ad accounts. Going forward, credentials are measured in USD at the top level, and attachable to ad accounts of multiple currencies.

creditAvailable

CurrencyAmount creditAvailable

The credit available to this business

creditType

String creditType

The type of extended credit used. The most common are ADS_BUSINESS and ADS_SEQUENTIAL

isAccessRevoked

Boolean isAccessRevoked

Returns true if credit owner removed access for previously shared credit line

isAutomatedExperience

Boolean isAutomatedExperience

Whether this credential is using the fully automated experience

legalEntityName

String legalEntityName

The legal entity name of the owner of a line

liableBizName

String liableBizName

When this credit is chosen as the payment method, the business name of the liable_party

maxBalance

CurrencyAmount maxBalance

The amount of credit available to a specific business. Going forward, credentials are measured in USD at the top level, and attachable to ad accounts of multiple currencies.

onlineMaxBalance

CurrencyAmount onlineMaxBalance

The raw credit limit for an entire business. Going forward, credentials are measured in USD at the top level, and attachable to ad accounts of multiple currencies.

ownerBusiness

Business ownerBusiness

The business account responsible for extended credit payment

ownerBusinessName

String ownerBusinessName

The name of the business account responsible for extended credit payment

partitionFrom

String partitionFrom

The name of the business that granted the credit line. For ADS_SEQUENTIAL credit types

sendBillToBizNname

String sendBillToBizNname

When this credit is chosen as the payment method, the business name of the bill_to_party

Class com.restfb.types.whatsapp.WABAAnalytics

class WABAAnalytics extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

countryCodes

List<String> countryCodes

dataPoints

List<WABAAnalyticsDataPoint> dataPoints

granularity

String granularity

phoneNumbers

List<String> phoneNumbers

Class com.restfb.types.whatsapp.WABAAnalyticsDataPoint

class WABAAnalyticsDataPoint extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

delivered

Long delivered

Number of messages delivered

end

Long end

End time of this data point

received

Long received

Number of messages received

sent

Long sent

Number of messages sent

start

Long start

Start time of this data point

Class com.restfb.types.whatsapp.WABAMessageTemplate

class WABAMessageTemplate extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

The category type of the message template

components

List<WhatsAppMessageTemplateComponent> components

content

String content

Message template string with placeholders for parameters

language

List<String> language

The languages (and locale) of the element translation

lastUpdatedTime

Date lastUpdatedTime

The timestamp indicating the last time the message template was updated

nameOrContent

String nameOrContent

String as a query parameter to filter message templates name or content containing this variable

qualityScore

WhatsAppHSMQualityScoreShape qualityScore

rejectedReason

String rejectedReason

The reason the message template was rejected

status

String status

The status of the message template

Class com.restfb.types.whatsapp.WABAOnBehalfOfComputedInfo

class WABAOnBehalfOfComputedInfo extends NamedFacebookType implements Serializable

Serialized Fields

status

String status

Class com.restfb.types.whatsapp.WhatsAppBusinessAccount

class WhatsAppBusinessAccount extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

accountReviewStatus

String accountReviewStatus

Status from account review process

analytics

WABAAnalytics analytics

Analytics data of the WhatsApp Business Account

currency

String currency

The currency in which the payment transactions for the WhatsApp Business Account will be processed

eligibleForSendingNotifications

Boolean eligibleForSendingNotifications

Whether or not the WhatsApp Business Account is eligible for sending notifications

ineligibleForSendingNotificationsReason

String ineligibleForSendingNotificationsReason

The reason why the WhatsApp Business Account is ineligible for delivery This field will be null when the eligible_for_sending_notifications field is false

messageTemplateNamespace

String messageTemplateNamespace

Namespace string for the message templates that belong to the WhatsApp Business Account

onBehalfOfBusinessInfo

WABAOnBehalfOfComputedInfo onBehalfOfBusinessInfo

The "on behalf of" information for the WhatsApp Business Account

primaryFundingId

String primaryFundingId

Primary funding ID for the WhatsApp Business Account paid service

purchaseOrderNumber

String purchaseOrderNumber

The purchase order number supplied by the business for payment management purposes

status

String status

Status of the WhatsApp Business Account. Default: ACTIVE

timezoneId

String timezoneId

The timezone of the WhatsApp Business Account

Class com.restfb.types.whatsapp.WhatsAppBusinessAccountToNumberCurrentStatus

class WhatsAppBusinessAccountToNumberCurrentStatus extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

accountMode

String accountMode

certificate

String certificate

countryCode

String countryCode

Deprecated.

countryDialCode

String countryDialCode

Deprecated.

displayPhoneNumber

String displayPhoneNumber

nameStatus

String nameStatus

newCertificate

String newCertificate

newNameStatus

String newNameStatus

qualityRating

String qualityRating

Deprecated.

qualityScore

WhatsAppPhoneQualityScoreShape qualityScore

status

String status

verifiedName

String verifiedName

Deprecated.

Class com.restfb.types.whatsapp.WhatsAppHSMQualityScoreShape

class WhatsAppHSMQualityScoreShape extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

date

Date date

reasons

List<String> reasons

score

String score

Class com.restfb.types.whatsapp.WhatsAppMessageTemplate

class WhatsAppMessageTemplate extends NamedFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

The category type of the message template

components

List<WhatsAppMessageTemplateComponent> components

language

String language

The language (and locale) of the element translation

messageSendTtlSeconds

Long messageSendTtlSeconds

previousCategory

String previousCategory

qualityScore

WhatsAppHSMQualityScoreShape qualityScore

Quality score of the HSM

rejectedReason

String rejectedReason

The reason the message template was rejected

status

String status

The status of the message template

Class com.restfb.types.whatsapp.WhatsAppMessageTemplateComponent

class WhatsAppMessageTemplateComponent extends AbstractFacebookType implements Serializable

Serialized Fields

buttons

List<WhatsAppMessageTemplateComponent.Button> buttons

format

WhatsAppMessageTemplateComponent.Format format

text

String text

type

WhatsAppMessageTemplateComponent.Type type

Class com.restfb.types.whatsapp.WhatsAppNameVerificationRequest

class WhatsAppNameVerificationRequest extends FacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

verifiedName

String verifiedName

Package com.restfb.types.whatsapp.platform

Class com.restfb.types.whatsapp.platform.Message

class Message extends AbstractFacebookType implements Serializable

Serialized Fields

audio

Audio audio

bizOpaqueCallbackData

String bizOpaqueCallbackData

An arbitrary 256B string, useful for tracking (optional). Cloud API only

button

Button button

contacts

List<MessageContact> contacts

context

Context context

document

Document document

errors

List<Error> errors

from

String from

id

String id

identity

Identity identity

image

Image image

interactive

Interactive interactive

location

Location location

reaction

Reaction reaction

referral

Referral referral

sticker

Sticker sticker

system

System system

text

Text text

timestamp

Date timestamp

type

MessageType type

video

Video video

Class com.restfb.types.whatsapp.platform.Metadata

class Metadata extends AbstractFacebookType implements Serializable

Serialized Fields

displayPhoneNumber

String displayPhoneNumber

phoneNumberId

String phoneNumberId

Class com.restfb.types.whatsapp.platform.Profile

class Profile extends AbstractFacebookType implements Serializable

Serialized Fields

name

String name

Class com.restfb.types.whatsapp.platform.SendMessage

class SendMessage extends AbstractFacebookType implements Serializable

Serialized Fields

audio

Audio audio

contacts

List<Contact> contacts

context

Context context

document

Document document

image

Image image

interactive

Interactive interactive

location

Location location

messagingProduct

String messagingProduct

reaction

Reaction reaction

sticker

Sticker sticker

text

Text text

to

String to

type

SendMessage.Type type

video

Video video

Class com.restfb.types.whatsapp.platform.Status

class Status extends AbstractFacebookType implements Serializable

Serialized Fields

bizOpaqueCallbackData

String bizOpaqueCallbackData

Arbitrary string included in sent message.

conversation

Conversation conversation

errors

List<Error> errors

id

String id

pricing

Pricing pricing

recipientId

String recipientId

status

Status.StatusType status

timestamp

Date timestamp

Class com.restfb.types.whatsapp.platform.SuccessfulResponse

class SuccessfulResponse extends AbstractFacebookType implements Serializable

Serialized Fields

contacts

List<SuccessfulResponse.MessageContact> contacts

messages

List<SuccessfulResponse.MessageResponse> messages

messagingProduct

String messagingProduct

Class com.restfb.types.whatsapp.platform.SuccessfulResponse.MessageContact

class MessageContact extends AbstractFacebookType implements Serializable

Serialized Fields

input

String input

waId

String waId

Class com.restfb.types.whatsapp.platform.SuccessfulResponse.MessageResponse

class MessageResponse extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

Package com.restfb.types.whatsapp.platform.message

Class com.restfb.types.whatsapp.platform.message.Audio

class Audio extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

ID for the audio file

mimeType

String mimeType

Mime type for the audio file

sha256

String sha256

audio hash

voice

boolean voice

true if this is a voice message

Class com.restfb.types.whatsapp.platform.message.Button

class Button extends AbstractFacebookType implements Serializable

Serialized Fields

payload

String payload

text

String text

Class com.restfb.types.whatsapp.platform.message.Contact

class Contact extends AbstractFacebookType implements Serializable

Serialized Fields

profile

Profile profile

waId

String waId

Class com.restfb.types.whatsapp.platform.message.Context

class Context extends AbstractFacebookType implements Serializable

Serialized Fields

forwarded

boolean forwarded

Set to true if the message received by the business has been forwarded

frequentlyForwarded

boolean frequentlyForwarded

Set to true if the message received by the business has been forwarded more than 5 times.

from

String from

The WhatsApp ID for the customer who replied to an inbound message

id

String id

The message ID for the sent message for an inbound reply

Class com.restfb.types.whatsapp.platform.message.Document

class Document extends AbstractFacebookType implements Serializable

Serialized Fields

caption

String caption

Caption for the document, if provided

filename

String filename

Name for the file on the sender's device

id

String id

ID for the document

mimeType

String mimeType

Mime type for the document

sha256

String sha256

Document hash

Class com.restfb.types.whatsapp.platform.message.Error

class Error extends AbstractFacebookType implements Serializable

Serialized Fields

code

String code

details

String details

errorData

Error.ErrorData errorData

message

String message

title

String title

Class com.restfb.types.whatsapp.platform.message.Error.ErrorData

class ErrorData extends AbstractFacebookType implements Serializable

Serialized Fields

details

String details

Class com.restfb.types.whatsapp.platform.message.Identity

class Identity extends AbstractFacebookType implements Serializable

Serialized Fields

acknowledged

String acknowledged

State of acknowledgment

createdTimestamp

Date createdTimestamp

The time when the WhatsApp Business Management API detected the customer may have changed their profile information

customerIdentityChanged

String customerIdentityChanged

hash

String hash

The ID for the messages system customer_identity_changed

Class com.restfb.types.whatsapp.platform.message.Image

class Image extends AbstractFacebookType implements Serializable

Serialized Fields

caption

String caption

Caption for the image, if provided

id

String id

ID for the image

mimeType

String mimeType

Mime type for the image

sha256

String sha256

Image hash

Class com.restfb.types.whatsapp.platform.message.Interactive

class Interactive extends AbstractFacebookType implements Serializable

Serialized Fields

buttonReply

Interactive.Reply buttonReply

listReply

Interactive.Reply listReply

type

Interactive.Type type

Class com.restfb.types.whatsapp.platform.message.Interactive.Reply

class Reply extends AbstractFacebookType implements Serializable

Serialized Fields

description

String description

id

String id

title

String title

Class com.restfb.types.whatsapp.platform.message.Location

class Location extends AbstractFacebookType implements Serializable

Serialized Fields

address

String address

latitude

Double latitude

longitude

Double longitude

name

String name

url

String url

Class com.restfb.types.whatsapp.platform.message.MessageContact

class MessageContact extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

name

MessageContact.ContactName name

phones

List<MessageContact.ContactPhone> phones

Class com.restfb.types.whatsapp.platform.message.MessageContact.ContactName

class ContactName extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

firstName

String firstName

formattedName

String formattedName

lastName

String lastName

Class com.restfb.types.whatsapp.platform.message.MessageContact.ContactPhone

class ContactPhone extends AbstractFacebookType implements Serializable

serialVersionUID:

1L

Serialized Fields

phone

String phone

type

String type

waId

String waId

Class com.restfb.types.whatsapp.platform.message.Reaction

class Reaction extends AbstractFacebookType implements Serializable

Serialized Fields

emoji

String emoji

messageId

String messageId

Class com.restfb.types.whatsapp.platform.message.Referral

class Referral extends AbstractFacebookType implements Serializable

Serialized Fields

body

String body

headline

String headline

imageUrl

String imageUrl

mediaType

Referral.MediaType mediaType

sourceId

String sourceId

sourceType

Referral.SourceType sourceType

sourceUrl

String sourceUrl

thumbnailUrl

String thumbnailUrl

videoUrl

String videoUrl

Class com.restfb.types.whatsapp.platform.message.Sticker

class Sticker extends AbstractFacebookType implements Serializable

Serialized Fields

id

String id

ID for the sticker

mimeType

String mimeType

image/webp

sha256

String sha256

Hash for the sticker

Class com.restfb.types.whatsapp.platform.message.System

class System extends AbstractFacebookType implements Serializable

Serialized Fields

body

String body

Describes the change to the customer's identity or phone number

customer

String customer

The WhatsApp ID for the customer prior to the update

identity

String identity

Hash for the identity fetched from server

newWaId

String newWaId

New WhatsApp ID for the customer when their phone number is updated. Available on webhook versions V11 and below

type

String type

Type of system update.

waId

String waId

New WhatsApp ID for the customer when their phone number is updated. Available on webhook versions V12 and above

Class com.restfb.types.whatsapp.platform.message.Text

class Text extends AbstractFacebookType implements Serializable

Serialized Fields

body

String body

Class com.restfb.types.whatsapp.platform.message.Video

class Video extends AbstractFacebookType implements Serializable

Serialized Fields

caption

String caption

The caption for the video, if provided

filename

String filename

The name for the file on the sender's device

id

String id

The ID for the video

mimeType

String mimeType

The mime type for the video file

sha256

String sha256

Image hash

Package com.restfb.types.whatsapp.platform.send

Class com.restfb.types.whatsapp.platform.send.Audio

class Audio extends Media implements Serializable

Class com.restfb.types.whatsapp.platform.send.Contact

class Contact extends AbstractFacebookType implements Serializable

Serialized Fields

addresses

List<Address> addresses

birthday

String birthday

emails

List<Email> emails

name

Name name

org

Organisation org

phones

List<Phone> phones

urls

List<Url> urls

Class com.restfb.types.whatsapp.platform.send.Context

class Context extends AbstractFacebookType implements Serializable

Serialized Fields

messageId

String messageId

Class com.restfb.types.whatsapp.platform.send.Document

class Document extends Media implements Serializable

Class com.restfb.types.whatsapp.platform.send.Image

class Image extends Media implements Serializable

Class com.restfb.types.whatsapp.platform.send.Interactive

class Interactive extends AbstractFacebookType implements Serializable

Serialized Fields

action

Action action

body

Body body

footer

Footer footer

header

Header header

type

Interactive.Type type

Class com.restfb.types.whatsapp.platform.send.Location

class Location extends AbstractFacebookType implements Serializable

Serialized Fields

address

String address

latitude

Double latitude

longitude

Double longitude

name

String name

Class com.restfb.types.whatsapp.platform.send.Media

class Media extends AbstractFacebookType implements Serializable

Serialized Fields

caption

String caption

filename

String filename

id

String id

link

String link

provider

String provider

Class com.restfb.types.whatsapp.platform.send.Reaction

class Reaction extends AbstractFacebookType implements Serializable

Serialized Fields

emoji

String emoji

messageId

String messageId

Class com.restfb.types.whatsapp.platform.send.Sticker

class Sticker extends Media implements Serializable

Class com.restfb.types.whatsapp.platform.send.Text

class Text extends AbstractFacebookType implements Serializable

Serialized Fields

body

String body

previewUrl

Boolean previewUrl

Class com.restfb.types.whatsapp.platform.send.Video

class Video extends Media implements Serializable

Package com.restfb.types.whatsapp.platform.send.contact

Class com.restfb.types.whatsapp.platform.send.contact.Address

class Address extends AbstractFacebookType implements Serializable

Serialized Fields

city

String city

country

String country

countryCode

String countryCode

state

String state

street

String street

type

String type

zip

String zip

Class com.restfb.types.whatsapp.platform.send.contact.Email

class Email extends AbstractFacebookType implements Serializable

Serialized Fields

email

String email

type

String type

Class com.restfb.types.whatsapp.platform.send.contact.Name

class Name extends AbstractFacebookType implements Serializable

Serialized Fields

firstName

String firstName

formattedName

String formattedName

lastLame

String lastLame

middleName

String middleName

prefix

String prefix

suffix

String suffix

Class com.restfb.types.whatsapp.platform.send.contact.Organisation

class Organisation extends AbstractFacebookType implements Serializable

Serialized Fields

company

String company

department

String department

title

String title

Class com.restfb.types.whatsapp.platform.send.contact.Phone

class Phone extends AbstractFacebookType implements Serializable

Serialized Fields

phone

String phone

type

String type

waId

String waId

Class com.restfb.types.whatsapp.platform.send.contact.Url

class Url extends AbstractFacebookType implements Serializable

Serialized Fields

type

String type

url

String url

Package com.restfb.types.whatsapp.platform.send.interactive

Class com.restfb.types.whatsapp.platform.send.interactive.Action

class Action extends AbstractFacebookType implements Serializable

Serialized Fields

button

String button

buttons

List<Button> buttons

catalogId

String catalogId

productRetailerId

String productRetailerId

sections

List<Section> sections

Class com.restfb.types.whatsapp.platform.send.interactive.Body

class Body extends AbstractFacebookType implements Serializable

Serialized Fields

text

String text

Class com.restfb.types.whatsapp.platform.send.interactive.Button

class Button extends AbstractFacebookType implements Serializable

Serialized Fields

reply

com.restfb.types.whatsapp.platform.send.interactive.Button.Reply reply

type

String type

Class com.restfb.types.whatsapp.platform.send.interactive.Footer

class Footer extends AbstractFacebookType implements Serializable

Serialized Fields

text

String text

Class com.restfb.types.whatsapp.platform.send.interactive.Header

class Header extends AbstractFacebookType implements Serializable

Serialized Fields

document

Document document

image

Image image

text

String text

type

Header.Type type

video

Video video

Class com.restfb.types.whatsapp.platform.send.interactive.Section

class Section extends AbstractFacebookType implements Serializable

Serialized Fields

productItems

List<Section.Product> productItems

rows

List<Section.Row> rows

title

String title

Class com.restfb.types.whatsapp.platform.send.interactive.Section.Product

class Product extends AbstractFacebookType implements Serializable

Serialized Fields

productRetailerId

String productRetailerId

Class com.restfb.types.whatsapp.platform.send.interactive.Section.Row

class Row extends AbstractFacebookType implements Serializable

Serialized Fields

description

String description

id

String id

title

String title

Package com.restfb.types.whatsapp.platform.status

Class com.restfb.types.whatsapp.platform.status.Conversation

class Conversation extends AbstractFacebookType implements Serializable

Serialized Fields

expirationTimestamp

Date expirationTimestamp

id

String id

origin

Conversation.Origin origin

Class com.restfb.types.whatsapp.platform.status.Conversation.Origin

class Origin extends AbstractFacebookType implements Serializable

Serialized Fields

type

CategoryType type

Class com.restfb.types.whatsapp.platform.status.Pricing

class Pricing extends AbstractFacebookType implements Serializable

Serialized Fields

billable

boolean billable

category

CategoryType category

pricingModel

String pricingModel

Package com.restfb.util

Class com.restfb.util.SoftHashMap

class SoftHashMap extends AbstractMap<K,V> implements Serializable

serialVersionUID:

1L

Serialized Fields

hash

Map<K,SoftReference<V>> hash

The internal HashMap that will hold the SoftReference.

queue

ReferenceQueue<V> queue

Reference queue for cleared SoftReference objects.

reverseLookup

Map<SoftReference<V>,K> reverseLookup