Package com.broadleafcommerce.datafeed.feedprovider.meta.api.autoconfigure

Class CommerceManagerFeedAPIConfigurationProperties.CommerceManagerFeedAPIPublicationConfigurationProperties

java.lang.Object

com.broadleafcommerce.datafeed.service.publisher.configuration.AbstractDataFeedPublicationConfigurationProperties

com.broadleafcommerce.datafeed.feedprovider.meta.api.autoconfigure.CommerceManagerFeedAPIConfigurationProperties.CommerceManagerFeedAPIPublicationConfigurationProperties

Enclosing class:

CommerceManagerFeedAPIConfigurationProperties

public static class CommerceManagerFeedAPIConfigurationProperties.CommerceManagerFeedAPIPublicationConfigurationProperties
extends AbstractDataFeedPublicationConfigurationProperties

Captures key details required to construct a CommerceManagerFeedAPIPublicationConfiguration. See Feed documentation

Constructor Summary

Constructors

Constructor	Description
CommerceManagerFeedAPIPublicationConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
String	getAccessToken()	Qualified access token (with adequate permissions to control the commerce catalog associate with the datafeed, and the meta developer application used to interact with the API).
String	getAndroidAppName()	Use of this field is entirely depending on the element transformer implementation.
String	getAndroidPackage()	Use of this field is entirely depending on the element transformer implementation.
String	getAndroidUrlPrefix()	Use of this field is entirely depending on the element transformer implementation.
String	getApiHost()	Host name for connecting to the datafeed API.
String	getDataFeedId()	The id of the datafeed to which uploads should occur.
String	getFeedPathTemplate()	String.format(String, Object...) style template URL path for connecting to the datafeed API.
String	getFileType()	The type of file that should be created and submitted to Meta/Facebook.
String	getIosAppName()	Use of this field is entirely depending on the element transformer implementation.
String	getIosAppStoreId()	Use of this field is entirely depending on the element transformer implementation.
String	getIosUrlPrefix()	Use of this field is entirely depending on the element transformer implementation.
String	getIpadAppName()	Use of this field is entirely depending on the element transformer implementation.
String	getIpadAppStoreId()	Use of this field is entirely depending on the element transformer implementation.
String	getIpadUrlPrefix()	Use of this field is entirely depending on the element transformer implementation.
String	getIphoneAppName()	Use of this field is entirely depending on the element transformer implementation.
String	getIphoneAppStoreId()	Use of this field is entirely depending on the element transformer implementation.
String	getIphoneUrlPrefix()	Use of this field is entirely depending on the element transformer implementation.
String	getLinkPrefix()	For fields that require building links (such as the product link), this is an optional prefix to make it a fully qualified URL.
void	setAccessToken(String accessToken)	Qualified access token (with adequate permissions to control the commerce catalog associate with the datafeed, and the meta developer application used to interact with the API).
void	setAndroidAppName(String androidAppName)	Use of this field is entirely depending on the element transformer implementation.
void	setAndroidPackage(String androidPackage)	Use of this field is entirely depending on the element transformer implementation.
void	setAndroidUrlPrefix(String androidUrlPrefix)	Use of this field is entirely depending on the element transformer implementation.
void	setApiHost(String apiHost)	Host name for connecting to the datafeed API.
void	setDataFeedId(String dataFeedId)	The id of the datafeed to which uploads should occur.
void	setFeedPathTemplate(String feedPathTemplate)	String.format(String, Object...) style template URL path for connecting to the datafeed API.
void	setFileType(String fileType)	The type of file that should be created and submitted to Meta/Facebook.
void	setIosAppName(String iosAppName)	Use of this field is entirely depending on the element transformer implementation.
void	setIosAppStoreId(String iosAppStoreId)	Use of this field is entirely depending on the element transformer implementation.
void	setIosUrlPrefix(String iosUrlPrefix)	Use of this field is entirely depending on the element transformer implementation.
void	setIpadAppName(String ipadAppName)	Use of this field is entirely depending on the element transformer implementation.
void	setIpadAppStoreId(String ipadAppStoreId)	Use of this field is entirely depending on the element transformer implementation.
void	setIpadUrlPrefix(String ipadUrlPrefix)	Use of this field is entirely depending on the element transformer implementation.
void	setIphoneAppName(String iphoneAppName)	Use of this field is entirely depending on the element transformer implementation.
void	setIphoneAppStoreId(String iphoneAppStoreId)	Use of this field is entirely depending on the element transformer implementation.
void	setIphoneUrlPrefix(String iphoneUrlPrefix)	Use of this field is entirely depending on the element transformer implementation.
void	setLinkPrefix(String linkPrefix)	For fields that require building links (such as the product link), this is an optional prefix to make it a fully qualified URL.

Methods inherited from class com.broadleafcommerce.datafeed.service.publisher.configuration.AbstractDataFeedPublicationConfigurationProperties

getBlcAppIdContextHint, getBlcFeedPublicationConfigDisplayName, getBlcTenantIdContextHint, getFeedProcessType, getIncludedLocaleLanguageTags, setBlcAppIdContextHint, setBlcFeedPublicationConfigDisplayName, setBlcTenantIdContextHint, setFeedProcessType, setIncludedLocaleLanguageTags

Methods inherited from class java.lang.Object

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

Constructor Details

CommerceManagerFeedAPIPublicationConfigurationProperties

public CommerceManagerFeedAPIPublicationConfigurationProperties()

Method Details

getApiHost

public String getApiHost()

Host name for connecting to the datafeed API. Default is graph.facebook.com

getFeedPathTemplate

public String getFeedPathTemplate()

String.format(String, Object...) style template URL path for connecting to the datafeed API. Should include a %s placeholder for the dataFeedId. Default is /%s/uploads

getDataFeedId

public String getDataFeedId()

The id of the datafeed to which uploads should occur. This is a Meta/Facebook generated value available in the Meta Commerce Manager UI. The assumed structure is a separate datafeed/catalog per locale.

getAccessToken

public String getAccessToken()

Qualified access token (with adequate permissions to control the commerce catalog associate with the datafeed, and the meta developer application used to interact with the API). This is usually generated in the Meta Business Settings for a created System User.

getFileType

public String getFileType()

The type of file that should be created and submitted to Meta/Facebook. Default is CSV.

See Also:

• DefaultFeedFileTypes

getLinkPrefix

@Nullable
public String getLinkPrefix()

For fields that require building links (such as the product link), this is an optional prefix to make it a fully qualified URL. Use of this field is entirely dependent on the element transformer implementation. For example, this could be 'https://www.mysite.com', such that it can be prepended to product URLs to form 'https://www.mysite.com/my/product/url'.

getAndroidAppName

@Nullable
public String getAndroidAppName()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.android_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getAndroidPackage

@Nullable
public String getAndroidPackage()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.android_package', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getAndroidUrlPrefix

@Nullable
public String getAndroidUrlPrefix()

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.android_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIosAppName

@Nullable
public String getIosAppName()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ios_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIosUrlPrefix

@Nullable
public String getIosUrlPrefix()

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.ios_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIosAppStoreId

@Nullable
public String getIosAppStoreId()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ios_app_store_id', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIpadAppName

@Nullable
public String getIpadAppName()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ipad_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIpadAppStoreId

@Nullable
public String getIpadAppStoreId()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ipad_app_store_id', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIpadUrlPrefix

@Nullable
public String getIpadUrlPrefix()

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.ipad_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIphoneUrlPrefix

@Nullable
public String getIphoneUrlPrefix()

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.iphone_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIphoneAppStoreId

@Nullable
public String getIphoneAppStoreId()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.iphone_app_store_id', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

getIphoneAppName

@Nullable
public String getIphoneAppName()

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.iphone_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setApiHost

public void setApiHost(String apiHost)

Host name for connecting to the datafeed API. Default is graph.facebook.com

setFeedPathTemplate

public void setFeedPathTemplate(String feedPathTemplate)

String.format(String, Object...) style template URL path for connecting to the datafeed API. Should include a %s placeholder for the dataFeedId. Default is /%s/uploads

setDataFeedId

public void setDataFeedId(String dataFeedId)

The id of the datafeed to which uploads should occur. This is a Meta/Facebook generated value available in the Meta Commerce Manager UI. The assumed structure is a separate datafeed/catalog per locale.

setAccessToken

public void setAccessToken(String accessToken)

Qualified access token (with adequate permissions to control the commerce catalog associate with the datafeed, and the meta developer application used to interact with the API). This is usually generated in the Meta Business Settings for a created System User.

setFileType

public void setFileType(String fileType)

The type of file that should be created and submitted to Meta/Facebook. Default is CSV.

See Also:

• DefaultFeedFileTypes

setLinkPrefix

public void setLinkPrefix(@Nullable
 String linkPrefix)

For fields that require building links (such as the product link), this is an optional prefix to make it a fully qualified URL. Use of this field is entirely dependent on the element transformer implementation. For example, this could be 'https://www.mysite.com', such that it can be prepended to product URLs to form 'https://www.mysite.com/my/product/url'.

setAndroidAppName

public void setAndroidAppName(@Nullable
 String androidAppName)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.android_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setAndroidPackage

public void setAndroidPackage(@Nullable
 String androidPackage)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.android_package', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setAndroidUrlPrefix

public void setAndroidUrlPrefix(@Nullable
 String androidUrlPrefix)

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.android_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIosAppName

public void setIosAppName(@Nullable
 String iosAppName)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ios_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIosUrlPrefix

public void setIosUrlPrefix(@Nullable
 String iosUrlPrefix)

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.ios_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIosAppStoreId

public void setIosAppStoreId(@Nullable
 String iosAppStoreId)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ios_app_store_id', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIpadAppName

public void setIpadAppName(@Nullable
 String ipadAppName)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ipad_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIpadAppStoreId

public void setIpadAppStoreId(@Nullable
 String ipadAppStoreId)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.ipad_app_store_id', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIpadUrlPrefix

public void setIpadUrlPrefix(@Nullable
 String ipadUrlPrefix)

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.ipad_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIphoneUrlPrefix

public void setIphoneUrlPrefix(@Nullable
 String iphoneUrlPrefix)

Use of this field is entirely depending on the element transformer implementation. This should be the prefix to use for 'applink.iphone_url', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIphoneAppStoreId

public void setIphoneAppStoreId(@Nullable
 String iphoneAppStoreId)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.iphone_app_store_id', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/

setIphoneAppName

public void setIphoneAppName(@Nullable
 String iphoneAppName)

Use of this field is entirely depending on the element transformer implementation. This should be the value to use for 'applink.iphone_app_name', as documented in https://developers.facebook.com/docs/marketing-api/catalog/guides/product-deep-links/