MarketingChannelInterface
in
MarketingChannelInterface interface
Tags
Table of Contents
- PRODUCT_LISTINGS_NOT_APPLICABLE = 'not-applicable'
- PRODUCT_LISTINGS_SYNC_FAILED = 'sync-failed'
- PRODUCT_LISTINGS_SYNC_IN_PROGRESS = 'sync-in-progress'
- PRODUCT_LISTINGS_SYNCED = 'synced'
- get_campaigns() : array<string|int, MarketingCampaign>
- Returns an array of the channel's marketing campaigns.
- get_description() : string
- Returns the description of the marketing channel.
- get_errors_count() : int
- Returns the number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).
- get_icon_url() : string
- Returns the path to the channel icon.
- get_name() : string
- Returns the name of the marketing channel.
- get_product_listings_status() : string
- Returns the status of the marketing channel's product listings.
- get_setup_url() : string
- Returns the URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.
- get_slug() : string
- Returns the unique identifier string for the marketing channel extension, also known as the plugin slug.
- get_supported_campaign_types() : array<string|int, MarketingCampaignType>
- Returns an array of marketing campaign types that the channel supports.
- is_setup_completed() : bool
- Returns the setup status of the marketing channel.
Constants
PRODUCT_LISTINGS_NOT_APPLICABLE
public
mixed
PRODUCT_LISTINGS_NOT_APPLICABLE
= 'not-applicable'
PRODUCT_LISTINGS_SYNC_FAILED
public
mixed
PRODUCT_LISTINGS_SYNC_FAILED
= 'sync-failed'
PRODUCT_LISTINGS_SYNC_IN_PROGRESS
public
mixed
PRODUCT_LISTINGS_SYNC_IN_PROGRESS
= 'sync-in-progress'
PRODUCT_LISTINGS_SYNCED
public
mixed
PRODUCT_LISTINGS_SYNCED
= 'synced'
Methods
get_campaigns()
Returns an array of the channel's marketing campaigns.
public
get_campaigns() : array<string|int, MarketingCampaign>
Return values
array<string|int, MarketingCampaign> —get_description()
Returns the description of the marketing channel.
public
get_description() : string
Return values
string —get_errors_count()
Returns the number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).
public
get_errors_count() : int
Return values
int — The number of issues to resolve, or 0 if there are no issues with the channel.get_icon_url()
Returns the path to the channel icon.
public
get_icon_url() : string
Return values
string —get_name()
Returns the name of the marketing channel.
public
get_name() : string
Return values
string —get_product_listings_status()
Returns the status of the marketing channel's product listings.
public
get_product_listings_status() : string
Return values
string —get_setup_url()
Returns the URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.
public
get_setup_url() : string
Return values
string —get_slug()
Returns the unique identifier string for the marketing channel extension, also known as the plugin slug.
public
get_slug() : string
Return values
string —get_supported_campaign_types()
Returns an array of marketing campaign types that the channel supports.
public
get_supported_campaign_types() : array<string|int, MarketingCampaignType>
Return values
array<string|int, MarketingCampaignType> — Array of marketing campaign type objects.is_setup_completed()
Returns the setup status of the marketing channel.
public
is_setup_completed() : bool