Retrieve Program Feature

Retrieve available and active features for the specified payment program.

This endpoint returns the program features that are available for the specified program. For each available feature type, the features object will contain the corresponding feature object as described below. If the program does not support any of the available feature types the features object will be empty.

LINK_TRACKING

ParameterTypeRequiredDescription
websitestring or nullYesTracking URL or parameter(s) for the website link
menustring or nullYesTracking URL or parameter(s) for the menu link
urlstring or nullYesTracking URL or parameter(s) for the CTA link

NEGATIVE_KEYWORD_TARGETING

ParameterTypeRequiredDescription
suggested_keywordslist of stringNoList of search terms for which your biz ad might be shown. Please note: This list consists of up to 25 possible keywords where your ad may appear. Those suggestions are based on common searches associated with the business category. The 25 suggestions are not exhaustive, your ad will also appear on searches not shown in the list of suggestions.
blocked_keywordslist of stringYesList of currently blocked keywords. You can use this field to update the list of terms you would like to block. Please note: You are allowed to add custom search terms outside of the suggested keywords list. Suggested keywords list is for guidance purposes.

STRICT_CATEGORY_TARGETING

ParameterTypeRequiredDescription
enabledboolYes

AD_SCHEDULING

ParameterTypeRequiredDescription
uses_opening_hoursboolYesShould the ad only be delivered while the business is open?
i.e. if {'uses_opening_hours': true } and the business's hours are 8-5pm, a 6pm search wouldn't be eligible for this ad.

CUSTOM_LOCATION_TARGETING

ParameterTypeRequiredDescription
businesseslist[object]YesList of all businesses that are part of the ad campaign.
businesses[].business_idstringYesBusiness ID
businesses[].locationslist[string]YesList of 0 up to 25 locations. These locations can be zip codes, cities, neighbourhoods, counties or state names but must be within the US.

AD_GOAL

ParameterTypeRequiredDescription
ad_goalboolYesMust be one of DEFAULT, CALLS, or WEBSITE_CLICKS

CALL_TRACKING

ParameterTypeRequiredDescription
enabledboolYesIndicates whether call tracking is enabled or disabled on a campaign level.
businesseslist[object]YesList of all businesses that are part of the ad campaign.
businesses[].business_idstringYesBusiness ID
businesses[].metered_phone_numberstring or nullYesPhone number which will be used as a call tracking number for the provided business in the ad campaign.

SERVICE_OFFERINGS_TARGETING

Note: This feature is deprecated and will soon be removed, please use Negative Keyword Targeting instead.

ParameterTypeRequiredDescription
disabled_service_offeringslist[string]YesList of all service offerings that are disabled for an ad campaign. For a GET request, this field will be populated with the disabled service offerings for all categories in the ad campaign. For a POST request this field is required and should contain all the service offerings the caller wants to disable for the ad campaign.
enabled_service_offeringslist[string]YesList of all service offerings that are enabled for an ad campaign. For a GET request, this field will be populated with the enabled service offerings for all categories in the ad campaign. For a POST request, this field can be omitted.

BUSINESS_HIGHLIGHTS

ParameterTypeRequiredDescription
active_business_highlightslist[string]YesCurrently active business highlights enabled
available_business_highlightslist[string]YesValid business highlights available to select from
mutually_exclusive_business_highlightslist[list[string]]YesPairs of business highlights that can't be enabled together

VERIFIED_LICENSE

ParameterTypeRequiredDescription
licenses[].license_numberstringYesLicense number provided by issuing agency/authority
licenses[].license_expiry_datestringNoLicense expiry date (format YYYY-MM-DD)
licenses[].license_tradestringNoBusiness or trade for which a license was issued
licenses[].license_issuing_agencystringNoAgency/authority that issued the license
licenses[].license_verification_statusstringYesLicense verification status, one of PENDING, VERIFIED or REJECTED
licenses[].license_verification_failure_reasonstringNoLicense verification failure reason

CUSTOM_RADIUS_TARGETING

ParameterTypeRequiredDescription
custom_radiusfloatNoRadius in miles (1 to 60)
By default, custom_radius is null which means this feature is inactive.

CUSTOM_AD_TEXT

ParameterTypeRequiredDescription
custom_review_idstringNoIdentifier of the review from which to extract the text.
custom_textstringNoCustom text to be shown.

*Note: Only one field can be set
By default, this is set to null, which means the ad text is set by Yelp.

CUSTOM_AD_PHOTO

ParameterTypeRequiredDescription
custom_photo_idstringNoIdentifier of the photo to show on the custom ad.

BUSINESS_LOGO

ParameterTypeRequiredDescription
business_logo_urlstringNoURL to the business's brand logo if in use.
In POST, URL must be publicly accessible image file of type: jpeg / png / gif / tiff

YELP_PORTFOLIO

ParameterTypeRequiredDescription
projects[].project_idstringYesIdentifier of a project
projects[].publishedbooleanYesWhether the project is published

📘

This endpoint is part of the Program Feature API, visit Program Feature API to learn more.

Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!