Creation fields
Name | Type | Description | Notes |
---|---|---|---|
ad_group_id | str | ID of the ad group that contains the ad. | [optional] |
android_deep_link | str, none_type | Deep link URL for Android devices. | [optional] |
carousel_android_deep_links | [str], none_type | Comma-separated deep links for the carousel pin on Android. | [optional] |
carousel_destination_urls | [str], none_type | Comma-separated destination URLs for the carousel pin to promote. | [optional] |
carousel_ios_deep_links | [str], none_type | Comma-separated deep links for the carousel pin on iOS. | [optional] |
click_tracking_url | str, none_type | Tracking url for the ad clicks. | [optional] |
creative_type | CreativeType | [optional] | |
destination_url | str, none_type | Destination URL. | [optional] |
ios_deep_link | str, none_type | Deep link URL for iOS devices. | [optional] |
is_pin_deleted | bool | Is original pin deleted? | [optional] |
is_removable | bool | Is pin repinnable? | [optional] |
name | str, none_type | Name of the ad - 255 chars max. | [optional] |
status | EntityStatus | [optional] | |
tracking_urls | {str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type | [optional] | |
view_tracking_url | str, none_type | Tracking URL for ad impressions. | [optional] |
lead_form_id | str, none_type | Lead form ID for lead ad generation. | [optional] |
grid_click_type | GridClickType | [optional] | |
customizable_cta_type | str, none_type | Select a call to action (CTA) to display below your ad. Available only for ads with direct links enabled. CTA options for consideration and conversion campaigns are LEARN_MORE, SHOP_NOW, BOOK_NOW, SIGN_UP, VISIT_SITE, BUY_NOW, GET_OFFER, ORDER_NOW, ADD_TO_CART (for conversion campaigns with add to cart conversion events only) | [optional] |
quiz_pin_data | {str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type | Before creating a quiz ad, you must create an organic Pin using POST/Create Pin for each result in the quiz. Quiz ads cannot be saved by a Pinner. Quiz ad results can be saved. | [optional] |
any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |