com.facebook.ads.sdk

Class ProductCatalog

java.lang.Object

com.facebook.ads.sdk.APINode

com.facebook.ads.sdk.ProductCatalog

All Implemented Interfaces:

APIResponse

public class ProductCatalog
extends APINode

This class is auto-generated. For any issues or feature requests related to this class, please let us know on github and we'll fix in our codegen framework. We'll not be able to accept pull request for this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProductCatalog.APIRequestCreateAgency
static class	ProductCatalog.APIRequestCreateAssignedUser
static class	ProductCatalog.APIRequestCreateBatch
static class	ProductCatalog.APIRequestCreateCatalogStore
static class	ProductCatalog.APIRequestCreateCategory
static class	ProductCatalog.APIRequestCreateCpasLsbImageBank
static class	ProductCatalog.APIRequestCreateExternalEventSource
static class	ProductCatalog.APIRequestCreateHomeListing
static class	ProductCatalog.APIRequestCreateHotel
static class	ProductCatalog.APIRequestCreateHotelRoomsBatch
static class	ProductCatalog.APIRequestCreateItemsBatch
static class	ProductCatalog.APIRequestCreateLocalizedItemsBatch
static class	ProductCatalog.APIRequestCreatePricingVariablesBatch
static class	ProductCatalog.APIRequestCreateProduct
static class	ProductCatalog.APIRequestCreateProductFeed
static class	ProductCatalog.APIRequestCreateProductGroup
static class	ProductCatalog.APIRequestCreateProductSet
static class	ProductCatalog.APIRequestCreateVehicle
static class	ProductCatalog.APIRequestCreateVersionItemsBatch
static class	ProductCatalog.APIRequestDelete
static class	ProductCatalog.APIRequestDeleteAgencies
static class	ProductCatalog.APIRequestDeleteAssignedUsers
static class	ProductCatalog.APIRequestDeleteExternalEventSources
static class	ProductCatalog.APIRequestGet
static class	ProductCatalog.APIRequestGetAgencies
static class	ProductCatalog.APIRequestGetAssignedUsers
static class	ProductCatalog.APIRequestGetAutomotiveModels
static class	ProductCatalog.APIRequestGetCategories
static class	ProductCatalog.APIRequestGetCheckBatchRequestStatus
static class	ProductCatalog.APIRequestGetCollaborativeAdsLsbImageBank
static class	ProductCatalog.APIRequestGetCollaborativeAdsShareSettings
static class	ProductCatalog.APIRequestGetCreatorAssetCreatives
static class	ProductCatalog.APIRequestGetDataSources
static class	ProductCatalog.APIRequestGetDestinations
static class	ProductCatalog.APIRequestGetDiagnostics
static class	ProductCatalog.APIRequestGetEventStats
static class	ProductCatalog.APIRequestGetExternalEventSources
static class	ProductCatalog.APIRequestGetFlights
static class	ProductCatalog.APIRequestGetHomeListings
static class	ProductCatalog.APIRequestGetHotelRoomsBatch
static class	ProductCatalog.APIRequestGetHotels
static class	ProductCatalog.APIRequestGetPricingVariablesBatch
static class	ProductCatalog.APIRequestGetProductFeeds
static class	ProductCatalog.APIRequestGetProductGroups
static class	ProductCatalog.APIRequestGetProducts
static class	ProductCatalog.APIRequestGetProductSets
static class	ProductCatalog.APIRequestGetProductSetsBatch
static class	ProductCatalog.APIRequestGetVehicleOffers
static class	ProductCatalog.APIRequestGetVehicles
static class	ProductCatalog.APIRequestUpdate
static class	ProductCatalog.EnumAdditionalVerticalOption
static class	ProductCatalog.EnumItemSubType
static class	ProductCatalog.EnumPermittedRoles
static class	ProductCatalog.EnumPermittedTasks
static class	ProductCatalog.EnumSegmentUseCases
static class	ProductCatalog.EnumStandard
static class	ProductCatalog.EnumTasks
static class	ProductCatalog.EnumVertical

Field Summary

Fields

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

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

context, header, rawValue

Constructor Summary

Constructors

Constructor and Description
ProductCatalog(Long id, APIContext context)
ProductCatalog(String id, APIContext context)

Method Summary

Modifier and Type	Method and Description
ProductCatalog	copyFrom(ProductCatalog instance)
ProductCatalog.APIRequestCreateAgency	createAgency()
ProductCatalog.APIRequestCreateAssignedUser	createAssignedUser()
ProductCatalog.APIRequestCreateBatch	createBatch()
ProductCatalog.APIRequestCreateCatalogStore	createCatalogStore()
ProductCatalog.APIRequestCreateCategory	createCategory()
ProductCatalog.APIRequestCreateCpasLsbImageBank	createCpasLsbImageBank()
ProductCatalog.APIRequestCreateExternalEventSource	createExternalEventSource()
ProductCatalog.APIRequestCreateHomeListing	createHomeListing()
ProductCatalog.APIRequestCreateHotel	createHotel()
ProductCatalog.APIRequestCreateHotelRoomsBatch	createHotelRoomsBatch()
ProductCatalog.APIRequestCreateItemsBatch	createItemsBatch()
ProductCatalog.APIRequestCreateLocalizedItemsBatch	createLocalizedItemsBatch()
ProductCatalog.APIRequestCreatePricingVariablesBatch	createPricingVariablesBatch()
ProductCatalog.APIRequestCreateProduct	createProduct()
ProductCatalog.APIRequestCreateProductFeed	createProductFeed()
ProductCatalog.APIRequestCreateProductGroup	createProductGroup()
ProductCatalog.APIRequestCreateProductSet	createProductSet()
ProductCatalog.APIRequestCreateVehicle	createVehicle()
ProductCatalog.APIRequestCreateVersionItemsBatch	createVersionItemsBatch()
ProductCatalog.APIRequestDelete	delete()
ProductCatalog.APIRequestDeleteAgencies	deleteAgencies()
ProductCatalog.APIRequestDeleteAssignedUsers	deleteAssignedUsers()
ProductCatalog.APIRequestDeleteExternalEventSources	deleteExternalEventSources()
ProductCatalog	fetch()
static ProductCatalog	fetchById(Long id, APIContext context)
static ProductCatalog	fetchById(String id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<ProductCatalog>	fetchByIdAsync(Long id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<ProductCatalog>	fetchByIdAsync(String id, APIContext context)
static APINodeList<ProductCatalog>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<APINodeList<ProductCatalog>>	fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)
ProductCatalog.APIRequestGet	get()
ProductCatalog.APIRequestGetAgencies	getAgencies()
ProductCatalog.APIRequestGetAssignedUsers	getAssignedUsers()
ProductCatalog.APIRequestGetAutomotiveModels	getAutomotiveModels()
ProductCatalog.APIRequestGetCategories	getCategories()
ProductCatalog.APIRequestGetCheckBatchRequestStatus	getCheckBatchRequestStatus()
ProductCatalog.APIRequestGetCollaborativeAdsLsbImageBank	getCollaborativeAdsLsbImageBank()
ProductCatalog.APIRequestGetCollaborativeAdsShareSettings	getCollaborativeAdsShareSettings()
APIContext	getContext()
ProductCatalog.APIRequestGetCreatorAssetCreatives	getCreatorAssetCreatives()
ProductCatalog.APIRequestGetDataSources	getDataSources()
ProductCatalog.APIRequestGetDestinations	getDestinations()
ProductCatalog.APIRequestGetDiagnostics	getDiagnostics()
ProductCatalog.APIRequestGetEventStats	getEventStats()
ProductCatalog.APIRequestGetExternalEventSources	getExternalEventSources()
CollaborativeAdsShareSettings	getFieldAdAccountToCollaborativeAdsShareSettings()
CollaborativeAdsShareSettings	getFieldAgencyCollaborativeAdsShareSettings()
Business	getFieldBusiness()
StoreCatalogSettings	getFieldCatalogStore()
CommerceMerchantSettings	getFieldCommerceMerchantSettings()
User	getFieldCreatorUser()
ProductCatalogImageSettings	getFieldDaDisplaySettings()
String	getFieldDefaultImageUrl()
List<String>	getFieldFallbackImageUrl()
Long	getFieldFeedCount()
String	getFieldId()
Boolean	getFieldIsCatalogSegment()
Boolean	getFieldIsLocalCatalog()
String	getFieldName()
Business	getFieldOwnerBusiness()
Long	getFieldProductCount()
StoreCatalogSettings	getFieldStoreCatalogSettings()
String	getFieldUserAccessExpireTime()
String	getFieldVertical()
ProductCatalog.APIRequestGetFlights	getFlights()
ProductCatalog.APIRequestGetHomeListings	getHomeListings()
ProductCatalog.APIRequestGetHotelRoomsBatch	getHotelRoomsBatch()
ProductCatalog.APIRequestGetHotels	getHotels()
String	getId()
static APIRequest.ResponseParser<ProductCatalog>	getParser()
ProductCatalog.APIRequestGetPricingVariablesBatch	getPricingVariablesBatch()
ProductCatalog.APIRequestGetProductFeeds	getProductFeeds()
ProductCatalog.APIRequestGetProductGroups	getProductGroups()
ProductCatalog.APIRequestGetProducts	getProducts()
ProductCatalog.APIRequestGetProductSets	getProductSets()
ProductCatalog.APIRequestGetProductSetsBatch	getProductSetsBatch()
ProductCatalog.APIRequestGetVehicleOffers	getVehicleOffers()
ProductCatalog.APIRequestGetVehicles	getVehicles()
static ProductCatalog	loadJSON(String json, APIContext context, String header)
static APINodeList<ProductCatalog>	parseResponse(String json, APIContext context, APIRequest request, String header)
void	setContext(APIContext context)
String	toString()
ProductCatalog.APIRequestUpdate	update()

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

getException, getHeader, getRawResponse, getRawResponseAsJsonObject, getRawValue, head, parseResponse

Methods inherited from class java.lang.Object

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

Field Detail

gson

protected static com.google.gson.Gson gson

Constructor Detail

ProductCatalog

public ProductCatalog(Long id,
                      APIContext context)

ProductCatalog

public ProductCatalog(String id,
                      APIContext context)

Method Detail

fetch

public ProductCatalog fetch()
                     throws APIException

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchByIds

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

Throws:

APIException

fetchByIdsAsync

public static com.google.common.util.concurrent.ListenableFuture<APINodeList<ProductCatalog>> fetchByIdsAsync(List<String> ids,
                                                                                                              List<String> fields,
                                                                                                              APIContext context)
                                                                                                       throws APIException

Throws:

APIException

getId

public String getId()

Overrides:

getId in class APINode

loadJSON

public static ProductCatalog loadJSON(String json,
                                      APIContext context,
                                      String header)

parseResponse

public static APINodeList<ProductCatalog> parseResponse(String json,
                                                        APIContext context,
                                                        APIRequest request,
                                                        String header)
                                                 throws APIException.MalformedResponseException

Throws:

APIException.MalformedResponseException

getContext

public APIContext getContext()

Overrides:

getContext in class APINode

setContext

public void setContext(APIContext context)

Overrides:

setContext in class APINode

toString

public String toString()

Overrides:

toString in class APINode

deleteAgencies

public ProductCatalog.APIRequestDeleteAgencies deleteAgencies()

getAgencies

public ProductCatalog.APIRequestGetAgencies getAgencies()

createAgency

public ProductCatalog.APIRequestCreateAgency createAgency()

deleteAssignedUsers

public ProductCatalog.APIRequestDeleteAssignedUsers deleteAssignedUsers()

getAssignedUsers

public ProductCatalog.APIRequestGetAssignedUsers getAssignedUsers()

createAssignedUser

public ProductCatalog.APIRequestCreateAssignedUser createAssignedUser()

getAutomotiveModels

public ProductCatalog.APIRequestGetAutomotiveModels getAutomotiveModels()

createBatch

public ProductCatalog.APIRequestCreateBatch createBatch()

createCatalogStore

public ProductCatalog.APIRequestCreateCatalogStore createCatalogStore()

getCategories

public ProductCatalog.APIRequestGetCategories getCategories()

createCategory

public ProductCatalog.APIRequestCreateCategory createCategory()

getCheckBatchRequestStatus

public ProductCatalog.APIRequestGetCheckBatchRequestStatus getCheckBatchRequestStatus()

getCollaborativeAdsLsbImageBank

public ProductCatalog.APIRequestGetCollaborativeAdsLsbImageBank getCollaborativeAdsLsbImageBank()

getCollaborativeAdsShareSettings

public ProductCatalog.APIRequestGetCollaborativeAdsShareSettings getCollaborativeAdsShareSettings()

createCpasLsbImageBank

public ProductCatalog.APIRequestCreateCpasLsbImageBank createCpasLsbImageBank()

getCreatorAssetCreatives

public ProductCatalog.APIRequestGetCreatorAssetCreatives getCreatorAssetCreatives()

getDataSources

public ProductCatalog.APIRequestGetDataSources getDataSources()

getDestinations

public ProductCatalog.APIRequestGetDestinations getDestinations()

getDiagnostics

public ProductCatalog.APIRequestGetDiagnostics getDiagnostics()

getEventStats

public ProductCatalog.APIRequestGetEventStats getEventStats()

deleteExternalEventSources

public ProductCatalog.APIRequestDeleteExternalEventSources deleteExternalEventSources()

getExternalEventSources

public ProductCatalog.APIRequestGetExternalEventSources getExternalEventSources()

createExternalEventSource

public ProductCatalog.APIRequestCreateExternalEventSource createExternalEventSource()

getFlights

public ProductCatalog.APIRequestGetFlights getFlights()

getHomeListings

public ProductCatalog.APIRequestGetHomeListings getHomeListings()

createHomeListing

public ProductCatalog.APIRequestCreateHomeListing createHomeListing()

getHotelRoomsBatch

public ProductCatalog.APIRequestGetHotelRoomsBatch getHotelRoomsBatch()

createHotelRoomsBatch

public ProductCatalog.APIRequestCreateHotelRoomsBatch createHotelRoomsBatch()

getHotels

public ProductCatalog.APIRequestGetHotels getHotels()

createHotel

public ProductCatalog.APIRequestCreateHotel createHotel()

createItemsBatch

public ProductCatalog.APIRequestCreateItemsBatch createItemsBatch()

createLocalizedItemsBatch

public ProductCatalog.APIRequestCreateLocalizedItemsBatch createLocalizedItemsBatch()

getPricingVariablesBatch

public ProductCatalog.APIRequestGetPricingVariablesBatch getPricingVariablesBatch()

createPricingVariablesBatch

public ProductCatalog.APIRequestCreatePricingVariablesBatch createPricingVariablesBatch()

getProductFeeds

public ProductCatalog.APIRequestGetProductFeeds getProductFeeds()

createProductFeed

public ProductCatalog.APIRequestCreateProductFeed createProductFeed()

getProductGroups

public ProductCatalog.APIRequestGetProductGroups getProductGroups()

createProductGroup

public ProductCatalog.APIRequestCreateProductGroup createProductGroup()

getProductSets

public ProductCatalog.APIRequestGetProductSets getProductSets()

createProductSet

public ProductCatalog.APIRequestCreateProductSet createProductSet()

getProductSetsBatch

public ProductCatalog.APIRequestGetProductSetsBatch getProductSetsBatch()

getProducts

public ProductCatalog.APIRequestGetProducts getProducts()

createProduct

public ProductCatalog.APIRequestCreateProduct createProduct()

getVehicleOffers

public ProductCatalog.APIRequestGetVehicleOffers getVehicleOffers()

getVehicles

public ProductCatalog.APIRequestGetVehicles getVehicles()

createVehicle

public ProductCatalog.APIRequestCreateVehicle createVehicle()

createVersionItemsBatch

public ProductCatalog.APIRequestCreateVersionItemsBatch createVersionItemsBatch()

delete

public ProductCatalog.APIRequestDelete delete()

get

public ProductCatalog.APIRequestGet get()

update

public ProductCatalog.APIRequestUpdate update()

getFieldAdAccountToCollaborativeAdsShareSettings

public CollaborativeAdsShareSettings getFieldAdAccountToCollaborativeAdsShareSettings()

getFieldAgencyCollaborativeAdsShareSettings

public CollaborativeAdsShareSettings getFieldAgencyCollaborativeAdsShareSettings()

getFieldBusiness

public Business getFieldBusiness()

getFieldCatalogStore

public StoreCatalogSettings getFieldCatalogStore()

getFieldCommerceMerchantSettings

public CommerceMerchantSettings getFieldCommerceMerchantSettings()

getFieldCreatorUser

public User getFieldCreatorUser()

getFieldDaDisplaySettings

public ProductCatalogImageSettings getFieldDaDisplaySettings()

getFieldDefaultImageUrl

public String getFieldDefaultImageUrl()

getFieldFallbackImageUrl

public List<String> getFieldFallbackImageUrl()

getFieldFeedCount

public Long getFieldFeedCount()

getFieldId

public String getFieldId()

getFieldIsCatalogSegment

public Boolean getFieldIsCatalogSegment()

getFieldIsLocalCatalog

public Boolean getFieldIsLocalCatalog()

getFieldName

public String getFieldName()

getFieldOwnerBusiness

public Business getFieldOwnerBusiness()

getFieldProductCount

public Long getFieldProductCount()

getFieldStoreCatalogSettings

public StoreCatalogSettings getFieldStoreCatalogSettings()

getFieldUserAccessExpireTime

public String getFieldUserAccessExpireTime()

getFieldVertical

public String getFieldVertical()

copyFrom

public ProductCatalog copyFrom(ProductCatalog instance)

getParser

public static APIRequest.ResponseParser<ProductCatalog> getParser()