CreateAdPreviewShopping
Create a shopping ad preview given an ad account ID, catalog product group ID, and creative type.
Stored Procedure Specific Information
Pinterest allows only a small subset of columns to be used in the EXECUTE query. These columns can typically only be used with the = comparison.
The CreateAdPreviewShopping stored procedure requires AdAccountId, CatalogProductGroupId and CreativeType to be specified.
For example:
EXEC CreateAdPreviewShopping AdAccountId = '549769357724', CatalogProductGroupId = '2614055967136', CreativeType = 'SHOPPING'
Input
| Name | Type | Required | Description |
| AdAccountId | String | True | Unique identifier of an ad account. |
| CatalogProductGroupId | String | True | Catalog Product Group Id. |
| CreativeType | String | True | Ad format of the shopping ad preview.
The allowed values are SHOPPING, COLLECTION, CAROUSEL, MAX_WIDTH_COLLECTION. |
| CustomizableCtaType | String | False | Select a call to action (CTA) to display below your ad. Available only for ads with direct links enabled.
The allowed values are GET_OFFER, LEARN_MORE, ORDER_NOW, SHOP_NOW, SIGN_UP, SUBSCRIBE, BUY_NOW, CONTACT_US, GET_QUOTE, VISIT_SITE, APPLY_NOW, BOOK_NOW, REQUEST_DEMO, REGISTER_NOW, FIND_A_DEALER, ADD_TO_CART, WATCH_NOW, READ_MORE, BUY_TICKETS, DONATE_NOW, DOWNLOAD, EXPLORE_MORE, FIND_A_LOCATION, FIND_RETAILERS, GET_DEAL, GET_RECIPE, GET_SHOWTIMES, ON_SALE, PLAY_GAME, TRY_IT, TAKE_A_PEEK. |
| HeroImageTitle | String | False | Title displayed below ad. |
| HeroImageUrl | String | False | Hero image URL. |
| HeroPinId | String | False | Pin id for the hero image. When creative type is COLLECTION, either hero_pin_id or (hero_image_url, hero_image_title) is required. |
| ImageTag | String | False | Multi image template tag. |
| ItemId | String | False | Item id for product to preview standard shopping ads, optional and only applicable when creative type is SHOPPING. |
| PreferredMediaType | String | False | Preferred media type.
The allowed values are VIDEO, IMAGE. |
| VideoTag | String | False | Multi video template tag, image_tag and video_tag are mutual exclusive. |
| ShowPromotion | Boolean | False | Include promotion data in preview when available on catalog item. Defaults to false. |
Result Set Columns
| Name | Type | Description |
| Status | String | Returns the execution status of the stored procedure. |
| Url | String | Preview URL, expires in 7 days. |