Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 3.89 KB

AdGroupCreateRequest.md

File metadata and controls

28 lines (23 loc) · 3.89 KB
Raw

AdGroupCreateRequest

Properties

Name Type Description Notes
name str Ad group name.
campaign_id str Campaign ID of the ad group.
billable_event ActionType
status str Ad group/entity status. [optional]
budget_in_micro_currency int, none_type Budget in micro currency. This field is REQUIRED for non-CBO (campaign budget optimization) campaigns. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups. [optional]
bid_in_micro_currency int, none_type Bid price in micro currency. This field is REQUIRED for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH, VIDEO_VIEW/VIDEO_V_50_MRC. [optional]
optimization_goal_metadata {str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type Optimization goals for objective-based performance campaigns. REQUIRED when campaign's `objective_type` is set to `"WEB_CONVERSION"`. [optional]
budget_type str [optional] if omitted the server will use the default value of "DAILY"
start_time int, none_type Ad group start time. Unix timestamp in seconds. Defaults to current time. [optional]
end_time int, none_type Ad group end time. Unix timestamp in seconds. [optional]
targeting_spec TargetingSpec [optional]
lifetime_frequency_cap int Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions)) ad groups. A CPM ad group has an IMPRESSION <a href=&quot;https://developers.pinterest.com/docs/redoc/#section/Billable-event\&quot;&gt;billable_event&lt;/a> value. This field REQUIRES the `end_time` field. [optional]
tracking_urls {str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type Third-party tracking URLs.<br> JSON object with the format: {&quot;<a href=&quot;https://developers.pinterest.com/docs/redoc/#section/Tracking-URL-event\&quot;&gt;Tracking event enum</a>&quot;:[URL string array],...}<br> For example: {&quot;impression&quot;: [&quot;URL1&quot;, &quot;URL2&quot;], &quot;click&quot;: [&quot;URL1&quot;, &quot;URL2&quot;, &quot;URL3&quot;]}.<br>Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs.<br><br> For more information, see <a href=&quot;https://help.pinterest.com/en/business/article/third-party-and-dynamic-tracking\" target=&quot;_blank&quot;>Third-party and dynamic tracking</a>. [optional]
auto_targeting_enabled bool [optional] if omitted the server will use the default value of True
placement_group str <a href=&quot;https://developers.pinterest.com/docs/redoc/#section/Placement-group\&quot;&gt;Placement group</a>. [optional]
pacing_delivery_type str [optional] if omitted the server will use the default value of "STANDARD"
bid_strategy_type str, none_type Bid strategy type [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]

[Back to Model list] [Back to API list] [Back to README]