openapi: 3.0.3 info: version: 5.13.0 title: Pinterest Ad API description: This is the description of your API. contact: name: Pinterest, Inc. url: https://developers.pinterest.com/ license: name: MIT url: https://spdx.org/licenses/MIT termsOfService: https://developers.pinterest.com/terms/ servers: - url: https://api.pinterest.com/v5 tags: - name: Ad paths: /ad_accounts: get: summary: List ad accounts description: 'Get a list of the ad_accounts that the "operation user_account" has access to. - This includes ad_accounts they own and ad_accounts that are owned by others who have granted them Business Access.' tags: - Ad operationId: ad_accounts/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/query_bookmark' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_include_shared_accounts' responses: '200': description: response content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: description: Ad accounts items: $ref: '#/components/schemas/AdAccount' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: summary: Create ad account description: 'Create a new ad account. Different ad accounts can support different currencies, payment methods, etc. An ad account is needed to create campaigns, ad groups, and ads; other accounts (your employees or partners) can be assigned business access and appropriate roles to access an ad account.

You can set up up to 50 ad accounts per user. (The user must have a business account to create an ad account.)

For more, see Create an advertiser account.' tags: - Ad operationId: ad_accounts/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled requestBody: content: application/json: schema: $ref: '#/components/schemas/AdAccountCreateRequest' description: Ad account to create. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdAccount' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error /ad_accounts/{ad_account_id}: get: summary: Get ad account description: Get an ad account operationId: ad_accounts/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdAccount' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/ad_groups: get: summary: List ad groups description: 'List ad groups based on provided campaign IDs or ad group IDs.(campaign_ids or ad_group_ids).

Note:

Provide only campaign_id or ad_group_id. Do not provide both.' operationId: ad_groups/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_campaign_ids' - $ref: '#/components/parameters/query_ad_group_ids' - $ref: '#/components/parameters/query_entity_statuses' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' - $ref: '#/components/parameters/query_translate_interests_to_names' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/AdGroupResponse' description: Success '400': description: Invalid ad account group parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account group parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad post: summary: Create ad groups description: "Create multiple new ad groups. All ads in a given ad group will have the same budget, bid, run dates, targeting, and placement (search, browse, other). For more information, click here.

\nNote:\n- 'bid_in_micro_currency' and 'budget_in_micro_currency' should be expressed in microcurrency amounts based on the currency field set in the advertiser's profile.

\n

Microcurrency is used to track very small transactions, based on the currency set in the advertisers profile.

\n

A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertisers profile.

\n

Equivalency equations, using dollars as an example currency:

\n\n

To convert between currency and microcurrency, using dollars as an example currency:

\n\n- Ad groups belong to ad campaigns. Some types of campaigns (e.g. budget optimization) have limits on the number of ad groups they can hold. If you exceed those limits, you will get an error message.\n- Start and end time cannot be set for ad groups that belong to CBO campaigns. Currently, campaigns with the following objective types: TRAFFIC, AWARENESS, WEB_CONVERSIONS, and CATALOG_SALES will default to CBO." operationId: ad_groups/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/AdGroupCreateRequest' maxItems: 30 minItems: 1 type: array description: List of ad groups to create, size limit [1, 30]. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdGroupArrayResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad patch: summary: Update ad groups description: Update multiple existing ad groups. operationId: ad_groups/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/AdGroupUpdateRequest' maxItems: 30 minItems: 1 type: array description: List of ad groups to update, size limit [1, 30]. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdGroupArrayResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/ad_groups/analytics: get: summary: Get ad group analytics description: 'Get analytics for the specified ad groups in the specified ad_account_id, filtered by the specified options. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: ad_groups/analytics security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_ad_group_ids_required' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdGroupsAnalyticsResponse' description: Success '400': description: Invalid ad account group analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account group analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ad_groups/targeting_analytics: get: summary: Get targeting analytics for ad groups description: 'Get targeting analytics for one or more ad groups. For the requested ad group(s) and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. "age_bucket") for applicable values (e.g. "45-49").

- The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: ad_groups_targeting_analytics/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_ad_group_ids_required' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_targeting_types' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' - $ref: '#/components/parameters/query_attribution_types' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MetricsResponse' description: Success default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ad_groups/audience_sizing: post: summary: Get audience sizing description: "Get potential audience size for an ad group with given targeting criteria. \nPotential audience size estimates the number of people you may be able to reach per month with your campaign. \nIt is based on historical advertising data and the targeting criteria you select.\nIt does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments." operationId: ad_groups/audience_sizing security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdGroupAudienceSizingRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdGroupAudienceSizingResponse' description: Success '400': description: Invalid ad group audience sizing parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad group audience sizing parameters. '403': description: No access to requested audience list or product group. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 403 message: You don't have access to the requested audience list or product group. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/ad_groups/{ad_group_id}: get: summary: Get ad group description: 'Get a specific ad given the ad ID. If your pin is rejected, rejected_reasons will contain additional information from the Ad Review process. For more information about our policies and rejection reasons see the Pinterest advertising standards.' operationId: ad_groups/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_ad_group_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdGroupResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/ad_previews: post: summary: Create ad preview with pin or image description: 'Create an ad preview given an ad account ID and either an existing organic pin ID or the URL for an image to be used to create the Pin and the ad.

If you are creating a preview from an existing Pin, that Pin must be promotable: that is, it must have a clickthrough link and meet other requirements. (See Ads Overview.)

You can view the returned preview URL on a webpage or iframe for 7 days, after which the URL expires. Collection ads are not currently supported ad preview.' tags: - Ad operationId: ad_previews/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: description: Create ad preview with pin or image. required: true content: application/json: schema: $ref: '#/components/schemas/AdPreviewRequest' responses: '200': description: Successful ad preview creation. content: application/json: schema: $ref: '#/components/schemas/AdPreviewURLResponse' '400': description: Invalid Pin parameters response content: application/json: schema: $ref: '#/components/schemas/Error' examples: InvalidPinUrl: value: code: 1 message: Whoops! It looks like you entered an invalid URL. Try creating a Pin again with a valid URL. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /ad_accounts/{ad_account_id}/ads: get: summary: List ads description: "List ads that meet the filters provided:\n - Listed campaign ids or ad group ids or ad ids\n - Listed entity statuses

\nIf no filter is provided, all ads in the ad account are returned.

\nNote:

\nProvide only campaign_id or ad_group_id or ad_id. Do not provide more than one type.

\nReview status is provided for each ad; if review_status is REJECTED, the rejected_reasons field will contain additional information.\nFor more, see Pinterest advertising standards." operationId: ads/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_campaign_ids' - $ref: '#/components/parameters/query_ad_group_ids' - $ref: '#/components/parameters/query_ad_ids' - $ref: '#/components/parameters/query_entity_statuses' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/AdResponse' description: Success '400': description: Invalid ad account ads parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad post: description: Create multiple new ads. Request must contain ad_group_id, creative_type, and the source Pin pin_id. operationId: ads/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/AdCreateRequest' maxItems: 30 minItems: 1 type: array description: List of ads to create, size limit [1, 30]. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdArrayResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create ads tags: - Ad patch: description: Update multiple existing ads operationId: ads/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/AdUpdateRequest' maxItems: 30 minItems: 1 type: array description: List of ads to update, size limit [1, 30] required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdArrayResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Update ads tags: - Ad /ad_accounts/{ad_account_id}/ads/analytics: get: summary: Get ad analytics description: 'Get analytics for the specified ads in the specified ad_account_id, filtered by the specified options. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: ads/analytics security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_ad_ids_required' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsAnalyticsResponse' description: Success '400': description: Invalid ad account ads analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ads_credit/discounts: get: summary: Get ads credit discounts description: 'Returns the list of discounts applied to the account. This endpoint might not be available to all apps. Learn more.' operationId: ads_credits_discounts/get security: - pinterest_oauth2: - ads:read - billing:read x-ratelimit-category: ads_read x-sandbox: disabled tags: - Ad parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_bookmark' - $ref: '#/components/parameters/query_page_size' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/AdsCreditDiscountsResponse' description: Success default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' /ad_accounts/{ad_account_id}/ads_credit/redeem: post: summary: Redeem ad credits description: 'Redeem ads credit on behalf of the ad account id and apply it towards billing. This endpoint might not be available to all apps. Learn more.' tags: - Ad operationId: ads_credit/redeem security: - pinterest_oauth2: - ads:write - billing:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: description: Redeem ad credits request. required: true content: application/json: schema: $ref: '#/components/schemas/AdsCreditRedeemRequest' responses: '200': description: Successfully redeemed ad credits. content: application/json: schema: $ref: '#/components/schemas/AdsCreditRedeemResponse' '400': description: Error thrown when unable to redeem offer code. content: application/json: schema: $ref: '#/components/schemas/Error' examples: ValidationError: value: code: 15 message: Unable to redeem offer code. Try again later. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /ad_accounts/{ad_account_id}/ads/targeting_analytics: get: summary: Get targeting analytics for ads description: 'Get targeting analytics for one or more ads. For the requested ad(s) and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. "age_bucket") for applicable values (e.g. "45-49").

- The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: ad_targeting_analytics/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_ad_ids_required' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_targeting_types' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' - $ref: '#/components/parameters/query_attribution_types' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MetricsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/ads/{ad_id}: get: summary: Get ad description: 'Get a specific ad given the ad ID. If your pin is rejected, rejected_reasons will contain additional information from the Ad Review process. For more information about our policies and rejection reasons see the Pinterest advertising standards.' operationId: ads/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_ad_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/analytics: get: summary: Get ad account analytics description: 'Get analytics for the specified ad_account_id, filtered by the specified options. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time.' operationId: ad_account/analytics security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdAccountAnalyticsResponse' description: Success '400': description: Invalid ad account analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/audience_insights: get: summary: Get audience insights description: 'Get Audience Insights for an ad account. The response will return insights for 3 types of audiences: the ad account''s engaged audience on Pinterest, the ad account''s total audience on Pinterest and Pinterest''s total audience.

Learn more about Audience Insights.' operationId: audience_insights/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_audience_insight_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AudienceInsightsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/audiences: get: summary: List audiences description: Get list of audiences for the ad account. operationId: audiences/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_bookmark' - description: 'The order in which to sort the items returned: ASCENDING or DESCENDING by ID. For received audiences, it is sorted by sharing event time. Note that higher-value IDs are associated with more-recently added items.' in: query name: order required: false schema: type: string example: ASCENDING enum: - ASCENDING - DESCENDING - $ref: '#/components/parameters/query_page_size' - description: 'This feature is currently in beta and not available to all apps. Filter audiences by ownership type.' in: query name: ownership_type required: false example: OWNED schema: type: string default: OWNED enum: - OWNED - RECEIVED responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/Audience' description: Success '400': description: Invalid ad account audience parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account audience parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad post: description: 'Create an audience you can use in targeting for specific ad groups. Targeting combines customer information with the ways users interact with Pinterest to help you reach specific groups of users; you can include or exclude specific audience_ids when you create an ad group.

For more, see Audience targeting.' operationId: audiences/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/AudienceCreateRequest' description: List of ads to create, size limit [1, 30] required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Audience' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create audience tags: - Ad /ad_accounts/{ad_account_id}/audiences/{audience_id}: get: summary: Get audience description: Get a specific audience given the audience ID. operationId: audiences/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_audience_id' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Audience' '404': description: Audience not found. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad patch: summary: Update audience description: Update (edit or remove) an existing targeting audience. operationId: audiences/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_audience_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/AudienceUpdateRequest' description: The audience to be updated. responses: '200': content: application/json: schema: $ref: '#/components/schemas/Audience' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/audiences/custom: post: summary: Create custom audience description: Create a custom audience and find the audiences you want your ads to reach. operationId: audiences/create_custom security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: description: Custom audience to create. required: true content: application/json: schema: $ref: '#/components/schemas/AudienceCreateCustomRequest' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Audience' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/bid_floor: post: description: "List bid floors for your campaign configuration. Bid floors are given in microcurrency values based on the currency in the bid floor specification.

\n

Microcurrency is used to track very small transactions, based on the currency set in the advertisers profile.

\n

A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser s profile.

\n

Equivalency equations, using dollars as an example currency:

\n\n

To convert between currency and microcurrency, using dollars as an example currency:

\n\nFor more on bid floors see Set your bid." operationId: ad_groups_bid_floor/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/BidFloorRequest' description: Parameters to get bid_floor info required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BidFloor' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Get bid floors tags: - Ad /ad_accounts/{ad_account_id}/billing_profiles: get: summary: Get billing profiles description: 'Get billing profiles in the advertiser account. This endpoint might not be available to all apps. Learn more.' operationId: billing_profiles/get security: - pinterest_oauth2: - ads:read - billing:read x-ratelimit-category: ads_read x-sandbox: disabled tags: - Ad parameters: - $ref: '#/components/parameters/path_ad_account_id' - description: Return active billing profiles, if false return all billing profiles. in: query name: is_active required: true schema: type: boolean - $ref: '#/components/parameters/query_bookmark' - $ref: '#/components/parameters/query_page_size' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/BillingProfilesResponse' description: Success default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' /ad_accounts/{ad_account_id}/bulk/download: post: summary: Get advertiser entities in bulk description: 'Create an asynchronous report that may include information on campaigns, ad groups, product groups, ads, and/or keywords; can filter by campaigns. Though the entities may be active, archived, or paused, only active entities will return data.' operationId: bulk_download/create security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDownloadRequest' description: Parameters to get ad entities in bulk required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkDownloadResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/bulk/upsert: post: description: 'Either create or update any combination of campaigns, ad groups, product groups, ads, or keywords. Note that this request will be processed asynchronously; the response will include a request_id that can be used to obtain the status of the request.' operationId: bulk_upsert/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkUpsertRequest' description: Parameters to get create/update ad entities in bulk required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkUpsertResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create/update ad entities in bulk tags: - Ad /ad_accounts/{ad_account_id}/bulk/{bulk_request_id}: get: description: 'Get the status of a bulk request by request_id, along with a download URL that will allow you to download the new or updated entity data (campaigns, ad groups, product groups, ads, or keywords).' operationId: bulk_request/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_bulk_request_id' - $ref: '#/components/parameters/include_details' responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkUpsertStatusResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Download advertiser entities in bulk tags: - Ad /ad_accounts/{ad_account_id}/campaigns: get: summary: List campaigns description: 'Get a list of the campaigns in the specified ad_account_id, filtered by the specified options. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.' operationId: campaigns/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_campaign_ids' - $ref: '#/components/parameters/query_entity_statuses' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/CampaignResponse' description: Success '400': description: Invalid ad account campaign parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account campaign parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad post: summary: Create campaigns description: "Create multiple new campaigns. Every campaign has its own campaign_id and houses one or more ad groups, which contain one or more ads.\nFor more, see Set up your campaign.

\nNote:\n- The values for 'lifetime_spend_cap' and 'daily_spend_cap' are microcurrency amounts based on the currency field set in the advertiser's profile. (e.g. USD)

\n

Microcurrency is used to track very small transactions, based on the currency set in the advertisers profile.

\n

A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertisers profile.

\n

Equivalency equations, using dollars as an example currency:

\n\n

To convert between currency and microcurrency, using dollars as an example currency:

\n" tags: - Ad operationId: campaigns/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: description: Array of campaigns. required: true content: application/json: schema: type: array maxItems: 30 minItems: 1 items: $ref: '#/components/schemas/CampaignCreateRequest' responses: '200': description: response content: application/json: schema: $ref: '#/components/schemas/CampaignCreateResponse' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: summary: Update campaigns description: "Update multiple ad campaigns based on campaign_ids.

\nNote:

\n -

The values for 'lifetime_spend_cap' and 'daily_spend_cap' are microcurrency amounts based on the currency field set in the advertiser's profile. (e.g. USD)

\n

Microcurrency is used to track very small transactions, based on the currency set in the advertisers profile.

\n

A microcurrency unit is 10^(-6) of the standard unit of currency selected in the advertiser s profile.

\n

Equivalency equations, using dollars as an example currency:

\n\n

To convert between currency and microcurrency, using dollars as an example currency:

\n" tags: - Ad operationId: campaigns/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: description: Array of campaigns. required: true content: application/json: schema: type: array maxItems: 30 minItems: 1 items: $ref: '#/components/schemas/CampaignUpdateRequest' responses: '200': description: response content: application/json: schema: $ref: '#/components/schemas/CampaignUpdateResponse' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /ad_accounts/{ad_account_id}/campaigns/analytics: get: summary: Get campaign analytics description: 'Get analytics for the specified campaigns in the specified ad_account_id, filtered by the specified options. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: campaigns/analytics security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_campaign_ids_required' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignsAnalyticsResponse' description: Success '400': description: Invalid ad account campaign analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account campaign analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/campaigns/targeting_analytics: get: summary: Get targeting analytics for campaigns description: 'Get targeting analytics for one or more campaigns. For the requested account and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. "age_bucket") for applicable values (e.g. "45-49").

- The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: campaign_targeting_analytics/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_campaign_ids_required' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_targeting_types' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' - $ref: '#/components/parameters/query_attribution_types' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MetricsResponse' description: Success default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/campaigns/{campaign_id}: get: summary: Get campaign description: Get a specific campaign given the campaign ID. operationId: campaigns/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_campaign_id' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CampaignResponse' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/conversion_tags: get: summary: Get conversion tags description: List conversion tags associated with an ad account. operationId: conversion_tags/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_filter_deleted' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConversionTagListResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad x-sandbox: disabled post: x-sandbox: disabled summary: Create conversion tag description: 'Create a conversion tag, also known as Pinterest tag, with the option to enable enhanced match.

The Pinterest Tag tracks actions people take on the ad account s website after they view the ad account''s ad on Pinterest. The advertiser needs to customize this tag to track conversions.

For more information, see:

Set up the Pinterest tag

Pinterest Tag

Enhanced match' operationId: conversion_tags/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConversionTagCreate' description: Conversion Tag to create required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConversionTagResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/conversion_tags/ocpm_eligible: get: summary: Get Ocpm eligible conversion tags description: Get Ocpm eligible conversion tag events for an ad account. security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read operationId: ocpm_eligible_conversion_tags/get parameters: - $ref: '#/components/parameters/path_ad_account_id' x-sandbox: disabled responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ConversionTagsOcpmEligibleResponse' default: description: Unexpected errors content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/conversion_tags/page_visit: get: summary: Get page visit conversion tags description: Get all page visit conversion tag events for an ad account. operationId: page_visit_conversion_tags/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/ConversionEventResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/conversion_tags/{conversion_tag_id}: get: x-sandbox: disabled summary: Get conversion tag description: Get information about an existing conversion tag. operationId: conversion_tags/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_conversion_tag_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConversionTagResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/customer_lists: post: description: "

Create a customer list from your records(hashed or plain-text email addresses, or hashed MAIDs or IDFAs).

\n

A customer list is one of the four types of Pinterest audiences: for more information, see Audience targeting\nor the Audiences section of the ads management guide.

\n

Please review our requirements for what type of information is allowed when uploading a customer list.

\n

When you create a customer list, the system scans the list for existing Pinterest accounts;\nthe list must include at least 100 Pinterest accounts. Your original list will be deleted when the matching process\nis complete. The filtered list containing only the Pinterest accounts that were included in your starting\nlist is what will be used to create the audience.

\n

Note that once you have created your customer list, you must convert it into an audience (of the CUSTOMER_LIST type)\nusing the create audience endpoint before it can be used.

" operationId: customer_lists/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerListRequest' description: Parameters to get Customer lists info required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerList' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create customer lists tags: - Ad get: description: "

Get a set of customer lists including id and name based on the filters provided.

\n

(Customer lists are a type of audience.) For more information, see\nAudience targeting\n or the Audiences\nsection of the ads management guide.

" operationId: customer_lists/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/CustomerList' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Get customer lists tags: - Ad /ad_accounts/{ad_account_id}/customer_lists/{customer_list_id}: get: summary: Get customer list description: Gets a specific customer list given the customer list ID. operationId: customer_lists/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_customer_list_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerList' description: Success default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad patch: description: "

Append or remove records to/from an existing customer list. (A customer list is one of the four types of Pinterest audiences.)

\n

When you add records to an existing customer list, the system scans the additions for existing Pinterest\naccounts; those are the records that will be added to your CUSTOMER_LIST audience. Your original list of records\n to add will be deleted when the matching process is complete.

\n

For more information, see Audience targeting\nor the Audiences\nsection of the ads management guide.

" operationId: customer_lists/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_customer_list_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerListUpdateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerList' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Update customer list tags: - Ad /ad_accounts/{ad_account_id}/events: post: summary: Send conversions description: 'The Pinterest API offers advertisers a way to send Pinterest their conversion information (including web conversions, in-app conversions, or even offline conversions) based on their ad_account_id. The request body should be a JSON object. - This endpoint requires an access_token be generated through Ads Manager. Review the Conversions Guide for more details. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Audience, Campaign. (Note that the token can be used across multiple ad accounts under an user ID.) - This endpoint has a rate limit of 5,000 calls per minute per ad account. - If the merchant is submitting this information using both Pinterest conversion tags and the Pinterest API, Pinterest will remove duplicate information before reporting. (Note that events that took place offline cannot be deduplicated.)' operationId: events/create tags: - Ad security: - pinterest_oauth2: - ads:write - conversion_token: [] x-ratelimit-category: ads_conversions x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - name: test description: 'Include query param ?test=true to mark the request as a test request. The events will not be recorded but the API will still return the same response messages. Use this mode to verify your requests are working and your events are constructed correctly. Warning: If you use this query parameter, be certain that it is off (set to false or deleted) before sending a legitimate (non-testing) request.' in: query required: false schema: type: boolean requestBody: description: Conversion events. required: true content: application/json: schema: $ref: '#/components/schemas/ConversionEvents' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConversionApiResponse' description: Success '400': description: The request was invalid. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 4196 message: The request was invalid. '401': description: Not authorized to send conversion events content: application/json: schema: $ref: '#/components/schemas/Error' examples: UnauthorizedAccess: value: code: 2 message: Authentication failed. '403': description: Unauthorized access. content: application/json: schema: $ref: '#/components/schemas/Error' examples: UnauthorizedAccess: value: code: 29 message: You are not permitted to access that resource. '422': content: application/json: schema: $ref: '#/components/schemas/DetailedError' description: Not all events were successfully processed. '429': description: 'This request exceeded a rate limit. This can happen if the client exceeds one of the published rate limits within a short time window.' content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 8 message: 'This request exceeded a rate limit. This can happen if the client exceeds one of the published rate limits within a short time window.' '503': description: The endpoint has been ramped down and is currently not accepting any traffic. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 4197 message: The endpoint has been ramped down and is currently not accepting any traffic. default: description: Unexpected errors content: application/json: schema: $ref: '#/components/schemas/Error' /ad_accounts/{ad_account_id}/insights/audiences: get: summary: Get audience insights scope and type description: Get the scope and type of available audiences, which along with a date, is an audience that has recently had an interaction (referred to here as a type) on pins. Interacted pins can belong to at least the most common **partner** or **Pinterest** scopes. This means that user interactions made on advertiser or partner pins will have the **partner** scope. You can also have user interactions performed in general on Pinterest with the **Pinterest** scope. In that case, you can then use the returned type and scope values together on requests to other endpoints to retrieve insight metrics for a desired audience. operationId: audience_insights_scope_and_type/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AudienceDefinitionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/keywords: get: summary: Get keywords description: '

Get a list of keywords based on the filters provided. If no filter is provided, it will default to the ad_account_id filter, which means it will only return keywords that specifically have parent_id set to the ad_account_id. Note: Keywords can have ad_account_ids, campaign_ids, and ad_group_ids set as their parent_ids. Keywords created through Ads Manager will have their parent_id set to an ad_group_id, not ad_account_id.

For more information, see Keyword targeting.

Notes:

For more information on match types, see match type enums.

Returns:

' operationId: keywords/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_campaign_id' - $ref: '#/components/parameters/query_ad_group_id' - $ref: '#/components/parameters/query_match_types' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/Keyword' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad post: summary: Create keywords description: '

Create keywords for following entity types(advertiser, campaign, ad group or ad).

For more information, see Keyword targeting.

Notes:

For more information on match types, see match type enums.

Returns:

Rate limit: WRITE.

' operationId: keywords/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KeywordsRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeywordsResponse' description: Success default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad patch: summary: Update keywords description:

Update one or more keywords' bid and archived fields.

Archiving a keyword effectively deletes it - keywords no longer receive metrics and no longer visible within the parent entity's keywords list.

operationId: keywords/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/KeywordUpdateBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeywordsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/keywords/metrics: get: summary: Get country's keyword metrics description: 'See keyword metrics for a specified country, aggregated across all of Pinterest. (Definitions are available from the "Get delivery metrics definitions" API endpoint).' operationId: country_keywords_metrics/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_country_code' - $ref: '#/components/parameters/query_keywords' responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeywordsMetricsArrayResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/lead_forms: get: summary: Get lead forms description: 'This feature is currently in beta and not available to all apps, if you''re interested in joining the beta, please reach out to your Pinterest account manager. Gets all Lead Forms associated with an ad account ID. For more, see Lead ads.' operationId: lead_forms/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/LeadFormResponse' description: Success '400': description: Invalid ad account lead forms parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account lead forms parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}: get: summary: Get lead form by id description: 'This feature is currently in beta and not available to all apps, if you''re interested in joining the beta, please reach out to your Pinterest account manager. Gets a lead form given it''s ID. It must also be associated with the provided ad account ID. For more, see Lead ads.' operationId: lead_form/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_lead_form_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadFormResponse' description: Success '400': description: Invalid ad account lead forms parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 1 message: Invalid ad account lead forms parameters. '404': description: The lead form ID for the given ad account ID does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 4842 message: Lead form is not found. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}/test: post: summary: Create lead form test data description: 'Create lead form test data based on the list of answers provided as part of the body. - List of answers should follow the questions creation order. This endpoint is currently in beta and not available to all apps. Learn more.' operationId: lead_form_test/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_lead_form_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/LeadFormTestRequest' description: Subscription to create. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadFormTestResponse' description: Success '400': description: Invalid parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 1 message: Invalid parameters. '404': description: Lead not found. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 4842 message: Lead not found. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/leads/subscriptions: post: summary: Create lead ads subscription description: "Create a lead ads webhook subscription.\nSubscriptions allow Pinterest to deliver lead data from Ads Manager directly to the subscriber. Subscriptions can exist for a specific lead form or at ad account level. \n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n- Advertisers can set up multiple integrations using ad_account_id + lead_form_id but only one integration per unique records.\n- For data security, egress lead data is encrypted with AES-256-GCM.\n\nThis endpoint is currently in beta and not available to all apps. Learn more." tags: - Ad operationId: ad_accounts_subscriptions/post security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/AdAccountCreateSubscriptionRequest' description: Subscription to create. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdAccountCreateSubscriptionResponse' description: Success '400': description: Invalid input parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 1 message: Advertiser ID must be numeric. '403': description: Can't access this subscription. content: application/json: schema: $ref: '#/components/schemas/Error' examples: NotIntegrationOwner: value: code: 4182 message: Can't access this subscription. default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' get: summary: Get lead ads subscriptions description: 'Get the advertiser''s list of lead ads subscriptions. - Only requests for the OWNER or ADMIN of the ad_account will be allowed. This endpoint is currently in beta and not available to all apps. Learn more.' operationId: ad_accounts_subscriptions/get_list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/AdAccountGetSubscriptionResponse' description: Success '403': description: Can't access this subscription. content: application/json: schema: $ref: '#/components/schemas/Error' examples: NotIntegrationOwner: value: code: 29 message: You are not permitted to access that resource. default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/leads/subscriptions/{subscription_id}: get: summary: Get lead ads subscription description: 'Get a specific lead ads subscription record. - Only requests for the OWNER or ADMIN of the ad_account will be allowed. This endpoint is currently in beta and not available to all apps. Learn more.' operationId: ad_accounts_subscriptions/get_by_id security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_subscription_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdAccountGetSubscriptionResponse' description: Success '400': description: Invalid input parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 1 message: Advertiser ID must be numeric. '403': description: Can't access this subscription. content: application/json: schema: $ref: '#/components/schemas/Error' examples: NotIntegrationOwner: value: code: 29 message: You are not permitted to access that resource. '404': description: Subscription not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: CommerceIntegrationNotFound: value: code: 4517 message: Subscription for given ids not found. default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad delete: summary: Delete lead ads subscription description: 'Delete an existing lead ads webhook subscription by ID. - Only requests for the OWNER or ADMIN of the ad_account will be allowed. This endpoint is currently in beta and not available to all apps. Learn more.' operationId: ad_accounts_subscriptions/del_by_id security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_subscription_id' responses: '204': description: Subscription deleted successfully '400': description: Invalid input parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 1 message: Advertiser ID must be numeric. '403': description: You are not authorized to delete this subscription. content: application/json: schema: $ref: '#/components/schemas/Error' examples: NotIntegrationOwner: value: code: 29 message: You are not permitted to access that resource. '404': description: Subscription not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: CommerceIntegrationNotFound: value: code: 4517 message: Subscription for given ids not found. default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/mmm_reports: get: summary: Get advertiser Marketing Mix Modeling (MMM) report. description: 'Get an mmm report for an ad account. This returns a URL to an mmm metrics report given a token returned from the create mmm report endpoint.' operationId: analytics/get_mmm_report security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_token_required' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetMMMReportResponse' description: Success '400': description: Invalid ad account ads analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad post: summary: Create a request for a Marketing Mix Modeling (MMM) report description: 'This creates an asynchronous mmm report based on the given request. It returns a token that you can use to download the report when it is ready. NOTE: An additional limit of 5 queries per minute per advertiser applies to this endpoint while it''s in beta release.' operationId: analytics/create_mmm_report security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMMMReportRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateMMMReportResponse' description: Success '400': description: Invalid ad account ads analytics mmm parameters content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads analytics mmm parameters default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/order_lines: get: summary: Get order lines description: List existing order lines associated with an ad account. operationId: order_lines/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/OrderLine' description: Success default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/order_lines/{order_line_id}: get: summary: Get order line description: Get a specific existing order line associated with an ad account. operationId: order_lines/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_order_line_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderLine' description: Success default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/product_group_promotions: post: description: Add one or more product groups from your catalog to an existing ad group. (Product groups added to an ad group are a 'product group promotion.') operationId: product_group_promotions/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductGroupPromotionCreateRequest' description: List of Product Group Promotions to create, size limit [1, 30]. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProductGroupPromotionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create product group promotions tags: - Ad patch: description: Update multiple existing Product Group Promotions (by product_group_id) operationId: product_group_promotions/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductGroupPromotionUpdateRequest' description: Parameters to update Product group promotions required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProductGroupPromotionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Update product group promotions tags: - Ad get: description: 'List existing product group promotions associated with an ad account. Include either ad_group_id or product_group_promotion_ids in your request. Note: ad_group_ids and product_group_promotion_ids are mutually exclusive parameters. Only provide one. If multiple options are provided, product_group_promotion_ids takes precedence over ad_group_ids. If none are provided, the endpoint returns an error.' operationId: product_group_promotions/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_product_group_promotion_ids' - $ref: '#/components/parameters/query_entity_statuses' - $ref: '#/components/parameters/query_ad_group_id' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/ProductGroupPromotionResponseItem' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Get product group promotions tags: - Ad /ad_accounts/{ad_account_id}/product_group_promotions/{product_group_promotion_id}: get: description: Get a product group promotion by id operationId: product_group_promotions/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_product_group_promotion_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProductGroupPromotionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Get a product group promotion by id tags: - Ad /ad_accounts/{ad_account_id}/product_groups/analytics: get: summary: Get product group analytics description: 'Get analytics for the specified product groups in the specified ad_account_id, filtered by the specified options. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: product_groups/analytics security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_product_group_ids_required' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProductGroupAnalyticsResponse' description: Success '400': description: Invalid ad account ads analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/product_groups/catalogs: get: deprecated: true description: This endpoint is completely deprecated. Please use List product groups from Catalogs API instead. operationId: ad_accounts_catalogs_product_groups/list security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_feed_profile_id' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/CatalogProductGroup' description: Success '400': description: Invalid ad account ads parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads parameters. '401': description: Access Denied. This can happen if account is not yet approved to operate as Merchant on Pinterest. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Merchant data not found. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' summary: Get catalog product groups tags: - Ad /ad_accounts/{ad_account_id}/reports: get: summary: Get the account analytics report created by the async call description: 'This returns a URL to an analytics report given a token returned from the post request report creation call. You can use the URL to download the report. The link is valid for five minutes and the report is valid for one hour. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.' operationId: analytics/get_report security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_token_required' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsAnalyticsGetAsyncResponse' description: Success '400': description: Invalid ad account ads analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad post: summary: Create async request for an account analytics report description: 'This returns a token that you can use to download the report when it is ready. Note that this endpoint requires the parameters to be passed as JSON-formatted in the request body. This endpoint does not support URL query parameters. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 914 days before the current date in UTC time and the max time range supported is 186 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days. - If level is PRODUCT_ITEM, the furthest back you can are allowed to pull data is 92 days before the current date in UTC time and the max time range supported is 31 days. - If level is PRODUCT_ITEM, ad_ids and ad_statuses parameters are not allowed. Any columns related to pin promotion and ad is not allowed either.' operationId: analytics/create_report security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdsAnalyticsCreateAsyncRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsAnalyticsCreateAsyncResponse' description: Success '400': description: Invalid ad account ads analytics parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account ads analytics parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/sandbox: delete: summary: Delete ads data for ad account in API Sandbox description: "Delete an ad account and all the ads data associated with that account. \nA string message is returned indicating the status of the delete operation.\n\nNote: This endpoint is only allowed in the Pinterest API Sandbox (https://api-sandbox.pinterest.com/v5). \nGo to https://developers.pinterest.com/docs/dev-tools/sandbox/ for more information." operationId: sandbox/delete security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' responses: '200': description: OK content: application/json: schema: type: string example: Delete Success '400': description: Invalid ad account id. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account id default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ssio/accounts: get: summary: Get Salesforce account details including bill-to information. description: 'Get Salesforce account details including bill-to information to be used in insertion orders process for ad_account_id. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.' operationId: ssio_accounts/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SSIOAccountResponse' description: Success '400': description: Invalid request parameter. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid request parameter. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ssio/insertion_orders: post: summary: Create insertion order through SSIO. description: 'Create insertion order through SSIO for ad_account_id. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.' operationId: ssio_insertion_order/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/SSIOCreateInsertionOrderRequest' description: Order line to create. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SSIOCreateInsertionOrderResponse' description: Success '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid request. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad patch: summary: Edit insertion order through SSIO. description: 'Edit insertion order through SSIO for ad_account_id. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.' operationId: ssio_insertion_order/edit security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/SSIOEditInsertionOrderRequest' description: Order line to create. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SSIOEditInsertionOrderResponse' description: Success '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid request. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ssio/insertion_orders/status: get: summary: Get insertion order status by ad account id. description: 'Get insertion order status for account id ad_account_id. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.' operationId: ssio_insertion_orders_status/get_by_ad_account security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_bookmark' - $ref: '#/components/parameters/query_page_size' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: description: Insertion orders status by ad acount id items: $ref: '#/components/schemas/SSIOInsertionOrderStatus' description: Success '400': description: Invalid request parameter. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid request parameter. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ssio/insertion_orders/{pin_order_id}/status: get: summary: Get insertion order status by pin order id. description: 'Get insertion order status for pin order id pin_order_id. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.' operationId: ssio_insertion_orders_status/get_by_pin_order_id security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_pin_order_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SSIOInsertionOrderStatusResponse' description: Success '400': description: Invalid request parameter. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid request parameter. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/ssio/order_lines: get: summary: Get Salesforce order lines by ad account id. description: 'Get Salesforce order lines for account id ad_account_id. - The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.' operationId: ssio_order_lines/get_by_ad_account security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_bookmark' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_pin_order_id' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: description: SSIO order lines by ad acount id items: $ref: '#/components/schemas/SSIOOrderLine' description: Success '400': description: Invalid request parameter. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid request parameter. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/targeting_analytics: get: summary: Get targeting analytics for an ad account description: 'Get targeting analytics for an ad account. For the requested account and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. "age_bucket") for applicable values (e.g. "45-49").

- The token''s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager. - If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days. - If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days.' operationId: ad_account_targeting_analytics/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_start_date' - $ref: '#/components/parameters/query_end_date' - $ref: '#/components/parameters/query_targeting_types' - $ref: '#/components/parameters/query_columns' - $ref: '#/components/parameters/query_granularity' - $ref: '#/components/parameters/query_conversion_attribution_click_window_days' - $ref: '#/components/parameters/query_conversion_attribution_engagement_window_days' - $ref: '#/components/parameters/query_conversion_attribution_view_window_days' - $ref: '#/components/parameters/query_conversion_attribution_conversion_report_time' - $ref: '#/components/parameters/query_attribution_types' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MetricsResponse' description: Success default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/targeting_templates: get: summary: List targeting templates description: Get a list of the targeting templates in the specified ad_account_id operationId: targeting_template/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_order' - in: query description: Include audience sizing in result or not name: include_sizing required: false schema: type: boolean default: false - description: Search keyword for targeting templates in: query name: search_query example: gaming required: false schema: type: string - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/TargetingTemplateResponseData' description: Success '400': description: Invalid ad account id. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account id default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad post: summary: Create targeting templates description: "

Targeting templates allow advertisers to save a set of targeting details including audience lists,\n keywords & interest, demographics, and placements to use more than once during the campaign creation process.

\n

Templates can be used to build out basic targeting criteria that you plan to use across campaigns and to reuse\n performance targeting from prior campaigns for new campaigns.

" operationId: targeting_template/create security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: description: targeting template creation entity required: true content: application/json: schema: $ref: '#/components/schemas/TargetingTemplateCreate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TargetingTemplateGetResponseData' description: Success '400': description: Invalid ad account id. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account id default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad patch: summary: Update targeting templates description:

Update the targeting template given advertiser ID and targeting template ID

operationId: targeting_template/update security: - pinterest_oauth2: - ads:write x-ratelimit-category: ads_write x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' requestBody: description: Operation type and targeting template ID required: true content: application/json: schema: $ref: '#/components/schemas/TargetingTemplateUpdateRequest' responses: '200': description: Success '400': description: Invalid ad account id. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account id default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad /ad_accounts/{ad_account_id}/templates: get: summary: List templates description: Gets all Templates associated with an ad account ID. operationId: templates/list security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_order' - $ref: '#/components/parameters/query_bookmark' responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/Paginated' - type: object properties: items: type: array items: $ref: '#/components/schemas/TemplateResponse' description: Success '400': description: Invalid ad account template parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account template parameters default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/templates/{template_id}/reports: post: summary: Create async request for an analytics report using a template description: 'This takes a template ID and an optional custom timeframe and constructs an asynchronous report based on the template. It returns a token that you can use to download the report when it is ready.' operationId: analytics/create_template_report security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_analytics x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/path_template_id' - $ref: '#/components/parameters/query_start_date_async' - $ref: '#/components/parameters/query_end_date_async' - $ref: '#/components/parameters/query_granularity_async' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdsAnalyticsCreateAsyncResponse' description: Success '400': description: Invalid ad account ads analytics template parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: 400 message: Invalid ad account analytics template parameters. default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' tags: - Ad /ad_accounts/{ad_account_id}/terms_of_service: get: description: Get the text of the terms of service and see whether the advertiser has accepted the terms of service. operationId: terms_of_service/get x-sandbox: enabled parameters: - $ref: '#/components/parameters/path_ad_account_id' - $ref: '#/components/parameters/query_include_html' - $ref: '#/components/parameters/query_tos_type' security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read responses: '200': content: application/json: schema: $ref: '#/components/schemas/TermsOfService' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Get terms of service tags: - Ad /resources/ad_account_countries: get: summary: Get ad accounts countries description: Get Ad Accounts countries operationId: ad_account_countries/get security: - pinterest_oauth2: - ads:read x-ratelimit-category: ads_read x-sandbox: enabled responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdAccountsCountryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error tags: - Ad components: schemas: AdGroupArrayResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdGroupArrayResponseElement' EntityStatus: type: string description: Entity status example: ACTIVE enum: - ACTIVE - PAUSED - ARCHIVED - DRAFT - DELETED_DRAFT AudienceDefinitionType: description: Generated audience type to request. type: string properties: scope: enum: - IMPRESSION_PLUS_ENGAGEMENT - ENGAGEMENT KeywordUpdate: title: KeywordUpdate type: object properties: id: type: string description: Keyword ID. example: '2886364308355' pattern: ^\d+$ title: id archived: type: boolean description: Is keyword archived? example: false title: archived bid: type: integer minimum: 1 description: Keyword custom bid in microcurrency - null if inherited from parent ad group. example: 200000 nullable: true title: bid required: - id ProductGroupPromotionCreateRequestElement: type: object title: ProductGroupPromotionCreateRequestElement allOf: - $ref: '#/components/schemas/ProductGroupPromotion' - type: object properties: creative_type: $ref: '#/components/schemas/CreativeType' MetricsReportingLevel: type: string description: Level of the reporting request example: CAMPAIGN enum: - ADVERTISER - ADVERTISER_TARGETING - CAMPAIGN - CAMPAIGN_TARGETING - AD_GROUP - AD_GROUP_TARGETING - PIN_PROMOTION - PIN_PROMOTION_TARGETING - KEYWORD - PRODUCT_GROUP - PRODUCT_GROUP_TARGETING - PRODUCT_ITEM AdsAnalyticsCreateAsyncRequest: type: object allOf: - type: object properties: start_date: description: 'Metric report start date (UTC). Format: YYYY-MM-DD' type: string pattern: ^(\d{4})-(\d{2})-(\d{2})$ example: '2020-12-20' end_date: description: 'Metric report end date (UTC). Format: YYYY-MM-DD' type: string pattern: ^(\d{4})-(\d{2})-(\d{2})$ example: '2020-12-20' granularity: description: TOTAL - metrics are aggregated over the specified date range.
DAY - metrics are broken down daily.
HOUR - metrics are broken down hourly.
WEEKLY - metrics are broken down weekly.
MONTHLY - metrics are broken down monthly type: string allOf: - $ref: '#/components/schemas/Granularity' click_window_days: description: Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. type: integer allOf: - $ref: '#/components/schemas/ConversionAttributionWindowDays' default: 30 engagement_window_days: description: Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. type: integer allOf: - $ref: '#/components/schemas/ConversionAttributionWindowDays' default: 30 view_window_days: description: Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. type: integer allOf: - $ref: '#/components/schemas/ConversionAttributionWindowDays' default: 1 conversion_report_time: description: 'The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.' type: string allOf: - $ref: '#/components/schemas/ConversionReportTimeType' default: TIME_OF_AD_ACTION attribution_types: description: List of types of attribution for the conversion report type: array items: $ref: '#/components/schemas/ConversionReportAttributionType' required: - start_date - end_date - granularity - type: object allOf: - type: object properties: campaign_ids: type: array description: List of campaign ids example: - '12345678' items: type: string pattern: ^\d+$ maxItems: 500 minItems: 1 - type: object properties: campaign_statuses: type: array description: List of status values for filtering example: - RUNNING - PAUSED items: $ref: '#/components/schemas/CampaignSummaryStatus' maxItems: 6 minItems: 1 - type: object properties: campaign_objective_types: type: array description: List of values for filtering. ["WEB_SESSIONS"] in BETA. example: - AWARENESS - VIDEO_VIEW items: $ref: '#/components/schemas/ObjectiveType' maxItems: 6 minItems: 1 - type: object properties: ad_group_ids: type: array description: List of ad group ids example: - '12345678' items: type: string pattern: ^\d+$ maxItems: 500 minItems: 1 - type: object properties: ad_group_statuses: type: array description: List of values for filtering example: - RUNNING - PAUSED items: $ref: '#/components/schemas/AdGroupSummaryStatus' maxItems: 6 minItems: 1 - type: object properties: ad_ids: type: array description: List of ad ids [This parameter is no supported for Product Item Level Reports] example: - '12345678' items: type: string pattern: ^\d+$ maxItems: 500 minItems: 1 - type: object properties: ad_statuses: type: array description: List of values for filtering [This parameter is not supported for Product Item Level Reports] example: - APPROVED - PAUSED items: $ref: '#/components/schemas/PinPromotionSummaryStatus' maxItems: 6 minItems: 1 - type: object properties: product_group_ids: type: array description: List of product group ids example: - '12345678' items: type: string pattern: ^\d+$ maxItems: 500 minItems: 1 - type: object properties: product_group_statuses: type: array description: List of values for filtering example: - RUNNING - PAUSED items: $ref: '#/components/schemas/ProductGroupSummaryStatus' maxItems: 6 minItems: 1 - type: object properties: product_item_ids: type: array description: List of product item ids example: - '12345678' items: type: string pattern: ^\d+$ maxItems: 500 minItems: 1 - $ref: '#/components/schemas/TargetingTypeFilter' - type: object properties: metrics_filters: type: array description: List of metrics filters minItems: 1 items: $ref: '#/components/schemas/AdsAnalyticsMetricsFilter' - type: object required: - level - columns properties: columns: description: Metric and entity columns. Pin promotion and ad related columns are not supported for the Product Item level reports. type: array items: $ref: '#/components/schemas/ReportingColumnAsync' level: type: string description: Level of the report allOf: - $ref: '#/components/schemas/MetricsReportingLevel' example: CAMPAIGN report_format: description: Specification for formatting the report data. Reports in JSON will not zero-fill metrics, whereas reports in CSV will. Both report formats will omit rows where all the columns are equal to 0. type: string allOf: - $ref: '#/components/schemas/DataOutputFormat' default: JSON primary_sort: type: string allOf: - type: string description: Whether to first sort the report by date or by ID. BY_DATE is recommended for large requests. BY_DATE for JSON format is currently not supported. example: BY_ID enum: - BY_ID - BY_DATE default: BY_ID Audience: properties: ad_account_id: description: Ad account ID. example: '549755885175' pattern: ^\d+$ title: ad_account_id type: string id: description: Audience ID. example: '1234' pattern: ^\d+$ title: id type: string name: description: Audience name. example: ACME Tools title: name type: string audience_type: type: string description: 'Audience types: ACTALIKE, ENGAGEMENT, CUSTOMER_LIST and VISITOR' title: audience_type description: description: Audience description. example: People who love making quilts. nullable: true title: description type: string rule: $ref: '#/components/schemas/AudienceRule' size: description: Audience size. example: 1000 nullable: true title: size type: integer status: type: string description: Audience status. READY, INITIALIZING, TOO_SMALL - Each audience list needs to have at least 100 people with Pinterest accounts before you can start using it. title: status type: description: Always "audience". example: audience title: type type: string created_timestamp: description: Creation time. Unix timestamp in seconds. example: 1451431341 nullable: true title: created_time type: integer updated_timestamp: description: Last update time. Unix timestamp in seconds. example: 1451431341 nullable: true title: updated_time type: integer title: Audience type: object AdCountry: type: string description: Country ID from ISO 3166-1 alpha-2. example: US enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW AdCreateRequest: type: object allOf: - $ref: '#/components/schemas/AdCommon' - $ref: '#/components/schemas/AdPinId' - type: object title: Request schema for creating ads required: - ad_group_id - pin_id - creative_type ReportingColumnAsync: type: string description: Reporting columns example: SPEND_IN_MICRO_DOLLAR enum: - SPEND_IN_MICRO_DOLLAR - PAID_IMPRESSION - SPEND_IN_DOLLAR - CPC_IN_MICRO_DOLLAR - ECPC_IN_MICRO_DOLLAR - ECPC_IN_DOLLAR - CTR - ECTR - OUTBOUND_CTR - COST_PER_OUTBOUND_CLICK - CAMPAIGN_NAME - CAMPAIGN_STATUS - PIN_PROMOTION_STATUS - AD_STATUS - PIN_ID - TOTAL_ENGAGEMENT - ENGAGEMENT_1 - ENGAGEMENT_2 - ECPE_IN_DOLLAR - ENGAGEMENT_RATE - EENGAGEMENT_RATE - ECPM_IN_MICRO_DOLLAR - REPIN_RATE - CTR_2 - CAMPAIGN_ID - ADVERTISER_ID - AD_ACCOUNT_ID - PIN_PROMOTION_ID - AD_ID - AD_GROUP_ID - CAMPAIGN_ENTITY_STATUS - CAMPAIGN_MANAGED_STATUS - CAMPAIGN_OBJECTIVE_TYPE - CPM_IN_MICRO_DOLLAR - CPM_IN_DOLLAR - AD_GROUP_NAME - AD_GROUP_STATUS - AD_GROUP_ENTITY_STATUS - PRODUCT_GROUP_ID - PRODUCT_GROUP_STATUS - ORDER_LINE_ID - ORDER_LINE_NAME - CLICKTHROUGH_1 - REPIN_1 - IMPRESSION_1 - IMPRESSION_1_GROSS - CLICKTHROUGH_1_GROSS - OUTBOUND_CLICK_1 - CLICKTHROUGH_2 - REPIN_2 - IMPRESSION_2 - OUTBOUND_CLICK_2 - TOTAL_CLICKTHROUGH - TOTAL_IMPRESSION - TOTAL_IMPRESSION_USER - TOTAL_IMPRESSION_FREQUENCY - COST_PER_OUTBOUND_CLICK_IN_DOLLAR - TOTAL_ENGAGEMENT_PAGE_VISIT - TOTAL_ENGAGEMENT_SIGNUP - TOTAL_ENGAGEMENT_CHECKOUT - TOTAL_ENGAGEMENT_CUSTOM - TOTAL_ENGAGEMENT_ADD_TO_CART - TOTAL_ENGAGEMENT_LEAD - TOTAL_ENGAGEMENT_SEARCH - TOTAL_ENGAGEMENT_WATCH_VIDEO - TOTAL_ENGAGEMENT_VIEW_CATEGORY - TOTAL_ENGAGEMENT_APP_INSTALL - TOTAL_ENGAGEMENT_UNKNOWN - TOTAL_CLICK_PAGE_VISIT - TOTAL_CLICK_SIGNUP - TOTAL_CLICK_CHECKOUT - TOTAL_CLICK_CUSTOM - TOTAL_CLICK_ADD_TO_CART - TOTAL_CLICK_LEAD - TOTAL_CLICK_SEARCH - TOTAL_CLICK_WATCH_VIDEO - TOTAL_CLICK_VIEW_CATEGORY - TOTAL_CLICK_APP_INSTALL - TOTAL_CLICK_UNKNOWN - TOTAL_VIEW_PAGE_VISIT - TOTAL_VIEW_SIGNUP - TOTAL_VIEW_CHECKOUT - TOTAL_VIEW_CUSTOM - TOTAL_VIEW_ADD_TO_CART - TOTAL_VIEW_LEAD - TOTAL_VIEW_SEARCH - TOTAL_VIEW_WATCH_VIDEO - TOTAL_VIEW_VIEW_CATEGORY - TOTAL_VIEW_APP_INSTALL - TOTAL_VIEW_UNKNOWN - TOTAL_CONVERSIONS - TOTAL_ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_PAGE_VISIT_QUANTITY - TOTAL_ENGAGEMENT_SIGNUP_QUANTITY - TOTAL_ENGAGEMENT_CHECKOUT_QUANTITY - TOTAL_ENGAGEMENT_CUSTOM_QUANTITY - TOTAL_ENGAGEMENT_ADD_TO_CART_QUANTITY - TOTAL_ENGAGEMENT_LEAD_QUANTITY - TOTAL_ENGAGEMENT_SEARCH_QUANTITY - TOTAL_ENGAGEMENT_WATCH_VIDEO_QUANTITY - TOTAL_ENGAGEMENT_VIEW_CATEGORY_QUANTITY - TOTAL_ENGAGEMENT_UNKNOWN_QUANTITY - TOTAL_CLICK_PAGE_VISIT_QUANTITY - TOTAL_CLICK_SIGNUP_QUANTITY - TOTAL_CLICK_CHECKOUT_QUANTITY - TOTAL_CLICK_CUSTOM_QUANTITY - TOTAL_CLICK_ADD_TO_CART_QUANTITY - TOTAL_CLICK_LEAD_QUANTITY - TOTAL_CLICK_SEARCH_QUANTITY - TOTAL_CLICK_WATCH_VIDEO_QUANTITY - TOTAL_CLICK_VIEW_CATEGORY_QUANTITY - TOTAL_CLICK_UNKNOWN_QUANTITY - TOTAL_VIEW_PAGE_VISIT_QUANTITY - TOTAL_VIEW_SIGNUP_QUANTITY - TOTAL_VIEW_CHECKOUT_QUANTITY - TOTAL_VIEW_CUSTOM_QUANTITY - TOTAL_VIEW_ADD_TO_CART_QUANTITY - TOTAL_VIEW_LEAD_QUANTITY - TOTAL_VIEW_SEARCH_QUANTITY - TOTAL_VIEW_WATCH_VIDEO_QUANTITY - TOTAL_VIEW_VIEW_CATEGORY_QUANTITY - TOTAL_VIEW_UNKNOWN_QUANTITY - TOTAL_CONVERSIONS_QUANTITY - TOTAL_WEB_SESSIONS - WEB_SESSIONS_1 - WEB_SESSIONS_2 - ONSITE_CHECKOUTS_1 - PIN_PROMOTION_NAME - AD_NAME - CAMPAIGN_LIFETIME_SPEND_CAP - CAMPAIGN_DAILY_SPEND_CAP - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_PAGE_VISIT_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_PAGE_VISIT_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_PAGE_VISIT_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_SIGNUP_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_SIGNUP_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_SIGNUP_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_SIGNUP_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_SIGNUP_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_SIGNUP_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_SIGNUP_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_SIGNUP_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_SIGNUP_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_CHECKOUT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_CHECKOUT_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_CHECKOUT_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_CHECKOUT_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_CHECKOUT_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_CHECKOUT_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_CHECKOUT_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_CHECKOUT_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_CHECKOUT_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_CUSTOM_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_CUSTOM_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_CUSTOM_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_CUSTOM_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_CUSTOM_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_CUSTOM_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_CUSTOM_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_CUSTOM_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_CUSTOM_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_ADD_TO_CART_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_ADD_TO_CART_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_ADD_TO_CART_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_LEAD_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_LEAD_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_LEAD_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_LEAD_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_LEAD_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_LEAD_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_LEAD_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_LEAD_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_LEAD_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_SEARCH_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_SEARCH_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_SEARCH_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_SEARCH_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_SEARCH_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_SEARCH_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_SEARCH_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_SEARCH_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_SEARCH_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_APP_INSTALL_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_APP_INSTALL_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_APP_INSTALL_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_APP_INSTALL_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_APP_INSTALL_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_APP_INSTALL_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_UNKNOWN_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_UNKNOWN_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_UNKNOWN_DESKTOP_ACTION_TO_TABLET_CONVERSION - TOTAL_UNKNOWN_MOBILE_ACTION_TO_DESKTOP_CONVERSION - TOTAL_UNKNOWN_MOBILE_ACTION_TO_MOBILE_CONVERSION - TOTAL_UNKNOWN_MOBILE_ACTION_TO_TABLET_CONVERSION - TOTAL_UNKNOWN_TABLET_ACTION_TO_DESKTOP_CONVERSION - TOTAL_UNKNOWN_TABLET_ACTION_TO_MOBILE_CONVERSION - TOTAL_UNKNOWN_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_PAGE_VISIT - TOTAL_SIGNUP - TOTAL_CHECKOUT - TOTAL_CUSTOM - TOTAL_LEAD - TOTAL_APP_INSTALL - TOTAL_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_CHECKOUT_QUANTITY - PAGE_VISIT_COST_PER_ACTION - APP_INSTALL_COST_PER_ACTION - PAGE_VISIT_ROAS - CHECKOUT_ROAS - CUSTOM_ROAS - VIDEO_3SEC_VIEWS_1 - VIDEO_P100_COMPLETE_1 - VIDEO_P0_COMBINED_1 - VIDEO_P25_COMBINED_1 - VIDEO_P50_COMBINED_1 - VIDEO_P75_COMBINED_1 - VIDEO_P95_COMBINED_1 - VIDEO_MRC_VIEWS_1 - VIDEO_3SEC_VIEWS_2 - VIDEO_P100_COMPLETE_2 - VIDEO_P0_COMBINED_2 - VIDEO_P25_COMBINED_2 - VIDEO_P50_COMBINED_2 - VIDEO_P75_COMBINED_2 - VIDEO_P95_COMBINED_2 - VIDEO_MRC_VIEWS_2 - VIDEO_LENGTH - CPV_IN_MICRO_DOLLAR - ECPV_IN_DOLLAR - CPCV_IN_MICRO_DOLLAR - ECPCV_IN_DOLLAR - CPCV_P95_IN_MICRO_DOLLAR - ECPCV_P95_IN_DOLLAR - TOTAL_VIDEO_3SEC_VIEWS - TOTAL_VIDEO_P100_COMPLETE - TOTAL_VIDEO_P0_COMBINED - TOTAL_VIDEO_P25_COMBINED - TOTAL_VIDEO_P50_COMBINED - TOTAL_VIDEO_P75_COMBINED - TOTAL_VIDEO_P95_COMBINED - TOTAL_VIDEO_MRC_VIEWS - VIDEO_AVG_WATCHTIME_IN_SECOND_1 - VIDEO_AVG_WATCHTIME_IN_SECOND_2 - TOTAL_VIDEO_AVG_WATCHTIME_IN_SECOND - TOTAL_DESTINATION_VIEWS - TOTAL_REPIN_RATE - WEB_CHECKOUT_COST_PER_ACTION - WEB_CHECKOUT_ROAS - TOTAL_WEB_CHECKOUT - TOTAL_WEB_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_CHECKOUT - TOTAL_WEB_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_CHECKOUT - TOTAL_WEB_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_CHECKOUT - TOTAL_WEB_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR - INAPP_CHECKOUT_COST_PER_ACTION - INAPP_CHECKOUT_ROAS - TOTAL_INAPP_CHECKOUT - TOTAL_INAPP_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_CLICK_CHECKOUT - TOTAL_INAPP_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_ENGAGEMENT_CHECKOUT - TOTAL_INAPP_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_VIEW_CHECKOUT - TOTAL_INAPP_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR - OFFLINE_CHECKOUT_COST_PER_ACTION - OFFLINE_CHECKOUT_ROAS - TOTAL_OFFLINE_CHECKOUT - TOTAL_OFFLINE_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_CLICK_CHECKOUT - TOTAL_OFFLINE_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_ENGAGEMENT_CHECKOUT - TOTAL_OFFLINE_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_VIEW_CHECKOUT - TOTAL_OFFLINE_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR - PINTEREST_CHECKOUT_COST_PER_ACTION - PINTEREST_CHECKOUT_ROAS - TOTAL_PINTEREST_CHECKOUT - TOTAL_PINTEREST_CHECKOUT_VALUE_IN_MICRO_DOLLAR - WEB_ADD_TO_CART_COST_PER_ACTION - WEB_ADD_TO_CART_ROAS - TOTAL_WEB_ADD_TO_CART - TOTAL_WEB_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_ADD_TO_CART - TOTAL_WEB_CLICK_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_ADD_TO_CART - TOTAL_WEB_ENGAGEMENT_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_ADD_TO_CART - TOTAL_WEB_VIEW_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - INAPP_ADD_TO_CART_COST_PER_ACTION - INAPP_ADD_TO_CART_ROAS - TOTAL_INAPP_ADD_TO_CART - TOTAL_INAPP_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_CLICK_ADD_TO_CART - TOTAL_INAPP_CLICK_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_ENGAGEMENT_ADD_TO_CART - TOTAL_INAPP_ENGAGEMENT_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_VIEW_ADD_TO_CART - TOTAL_INAPP_VIEW_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR - WEB_PAGE_VISIT_COST_PER_ACTION - WEB_PAGE_VISIT_ROAS - TOTAL_WEB_PAGE_VISIT - TOTAL_WEB_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_PAGE_VISIT - TOTAL_WEB_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_PAGE_VISIT - TOTAL_WEB_ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_PAGE_VISIT - TOTAL_WEB_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - WEB_SIGNUP_COST_PER_ACTION - WEB_SIGNUP_ROAS - TOTAL_WEB_SIGNUP - TOTAL_WEB_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_SIGNUP - TOTAL_WEB_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_SIGNUP - TOTAL_WEB_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_SIGNUP - TOTAL_WEB_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR - INAPP_SIGNUP_COST_PER_ACTION - INAPP_SIGNUP_ROAS - TOTAL_INAPP_SIGNUP - TOTAL_INAPP_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_CLICK_SIGNUP - TOTAL_INAPP_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_ENGAGEMENT_SIGNUP - TOTAL_INAPP_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_VIEW_SIGNUP - TOTAL_INAPP_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR - OFFLINE_SIGNUP_COST_PER_ACTION - OFFLINE_SIGNUP_ROAS - TOTAL_OFFLINE_SIGNUP - TOTAL_OFFLINE_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_CLICK_SIGNUP - TOTAL_OFFLINE_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_ENGAGEMENT_SIGNUP - TOTAL_OFFLINE_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_VIEW_SIGNUP - TOTAL_OFFLINE_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR - WEB_WATCH_VIDEO_COST_PER_ACTION - WEB_WATCH_VIDEO_ROAS - TOTAL_WEB_WATCH_VIDEO - TOTAL_WEB_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_WATCH_VIDEO - TOTAL_WEB_CLICK_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_WATCH_VIDEO - TOTAL_WEB_ENGAGEMENT_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_WATCH_VIDEO - TOTAL_WEB_VIEW_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - WEB_LEAD_COST_PER_ACTION - WEB_LEAD_ROAS - TOTAL_WEB_LEAD - TOTAL_WEB_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_LEAD - TOTAL_WEB_CLICK_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_LEAD - TOTAL_WEB_ENGAGEMENT_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_LEAD - TOTAL_WEB_VIEW_LEAD_VALUE_IN_MICRO_DOLLAR - OFFLINE_LEAD_COST_PER_ACTION - OFFLINE_LEAD_ROAS - TOTAL_OFFLINE_LEAD - TOTAL_OFFLINE_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_CLICK_LEAD - TOTAL_OFFLINE_CLICK_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_ENGAGEMENT_LEAD - TOTAL_OFFLINE_ENGAGEMENT_LEAD_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_VIEW_LEAD - TOTAL_OFFLINE_VIEW_LEAD_VALUE_IN_MICRO_DOLLAR - WEB_SEARCH_COST_PER_ACTION - WEB_SEARCH_ROAS - TOTAL_WEB_SEARCH - TOTAL_WEB_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_SEARCH - TOTAL_WEB_CLICK_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_SEARCH - TOTAL_WEB_ENGAGEMENT_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_SEARCH - TOTAL_WEB_VIEW_SEARCH_VALUE_IN_MICRO_DOLLAR - INAPP_SEARCH_COST_PER_ACTION - INAPP_SEARCH_ROAS - TOTAL_INAPP_SEARCH - TOTAL_INAPP_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_CLICK_SEARCH - TOTAL_INAPP_CLICK_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_ENGAGEMENT_SEARCH - TOTAL_INAPP_ENGAGEMENT_SEARCH_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_VIEW_SEARCH - TOTAL_INAPP_VIEW_SEARCH_VALUE_IN_MICRO_DOLLAR - WEB_VIEW_CATEGORY_COST_PER_ACTION - WEB_VIEW_CATEGORY_ROAS - TOTAL_WEB_VIEW_CATEGORY - TOTAL_WEB_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_VIEW_CATEGORY - TOTAL_WEB_CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_VIEW_CATEGORY - TOTAL_WEB_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_VIEW_CATEGORY - TOTAL_WEB_VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - WEB_CUSTOM_COST_PER_ACTION - WEB_CUSTOM_ROAS - TOTAL_WEB_CUSTOM - TOTAL_WEB_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_CUSTOM - TOTAL_WEB_CLICK_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_CUSTOM - TOTAL_WEB_ENGAGEMENT_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_CUSTOM - TOTAL_WEB_VIEW_CUSTOM_VALUE_IN_MICRO_DOLLAR - OFFLINE_CUSTOM_COST_PER_ACTION - OFFLINE_CUSTOM_ROAS - TOTAL_OFFLINE_CUSTOM - TOTAL_OFFLINE_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_CLICK_CUSTOM - TOTAL_OFFLINE_CLICK_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_ENGAGEMENT_CUSTOM - TOTAL_OFFLINE_ENGAGEMENT_CUSTOM_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_VIEW_CUSTOM - TOTAL_OFFLINE_VIEW_CUSTOM_VALUE_IN_MICRO_DOLLAR - WEB_UNKNOWN_COST_PER_ACTION - WEB_UNKNOWN_ROAS - TOTAL_WEB_UNKNOWN - TOTAL_WEB_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_CLICK_UNKNOWN - TOTAL_WEB_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_ENGAGEMENT_UNKNOWN - TOTAL_WEB_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_WEB_VIEW_UNKNOWN - TOTAL_WEB_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR - INAPP_UNKNOWN_COST_PER_ACTION - INAPP_UNKNOWN_ROAS - TOTAL_INAPP_UNKNOWN - TOTAL_INAPP_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_CLICK_UNKNOWN - TOTAL_INAPP_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_ENGAGEMENT_UNKNOWN - TOTAL_INAPP_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_VIEW_UNKNOWN - TOTAL_INAPP_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR - OFFLINE_UNKNOWN_COST_PER_ACTION - OFFLINE_UNKNOWN_ROAS - TOTAL_OFFLINE_UNKNOWN - TOTAL_OFFLINE_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_CLICK_UNKNOWN - TOTAL_OFFLINE_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_ENGAGEMENT_UNKNOWN - TOTAL_OFFLINE_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR - TOTAL_OFFLINE_VIEW_UNKNOWN - TOTAL_OFFLINE_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR - INAPP_APP_INSTALL_COST_PER_ACTION - INAPP_APP_INSTALL_ROAS - TOTAL_INAPP_APP_INSTALL - TOTAL_INAPP_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_CLICK_APP_INSTALL - TOTAL_INAPP_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_ENGAGEMENT_APP_INSTALL - TOTAL_INAPP_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_VIEW_APP_INSTALL - TOTAL_INAPP_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - IDEA_PIN_PRODUCT_TAG_VISIT_1 - IDEA_PIN_PRODUCT_TAG_VISIT_2 - TOTAL_IDEA_PIN_PRODUCT_TAG_VISIT - LEADS - COST_PER_LEAD - QUIZ_COMPLETED - QUIZ_COMPLETION_RATE - SHOWCASE_PIN_CLICKTHROUGH - SHOWCASE_SUBPAGE_CLICKTHROUGH - SHOWCASE_SUBPIN_CLICKTHROUGH - SHOWCASE_SUBPAGE_IMPRESSION - SHOWCASE_SUBPIN_IMPRESSION - SHOWCASE_SUBPAGE_SWIPE_LEFT - SHOWCASE_SUBPAGE_SWIPE_RIGHT - SHOWCASE_SUBPIN_SWIPE_LEFT - SHOWCASE_SUBPIN_SWIPE_RIGHT - SHOWCASE_SUBPAGE_REPIN - SHOWCASE_SUBPIN_REPIN - SHOWCASE_SUBPAGE_CLOSEUP - SHOWCASE_CARD_THUMBNAIL_SWIPE_FORWARD - SHOWCASE_CARD_THUMBNAIL_SWIPE_BACKWARD - SHOWCASE_AVERAGE_SUBPAGE_CLOSEUP_PER_SESSION - TOTAL_CHECKOUT_CONVERSION_RATE - TOTAL_VIEW_CATEGORY_CONVERSION_RATE - TOTAL_ADD_TO_CART_CONVERSION_RATE - TOTAL_SIGNUP_CONVERSION_RATE - TOTAL_PAGE_VISIT_CONVERSION_RATE - TOTAL_LEAD_CONVERSION_RATE - TOTAL_SEARCH_CONVERSION_RATE - TOTAL_WATCH_VIDEO_CONVERSION_RATE - TOTAL_UNKNOWN_CONVERSION_RATE - TOTAL_CUSTOM_CONVERSION_RATE - STANDARD_AD_FEED_ITEM_ID CampaignResponse: type: object allOf: - $ref: '#/components/schemas/CampaignId' - $ref: '#/components/schemas/CampaignCommon' - type: object properties: objective_type: $ref: '#/components/schemas/ObjectiveType' created_time: type: integer description: Campaign creation time. Unix timestamp in seconds. example: 1432744744 updated_time: type: integer description: UTC timestamp. Last update time. example: 1432744744 type: type: string description: Always "campaign". example: campaign is_flexible_daily_budgets: type: boolean description: Determines if a campaign has flexible daily budgets setup. example: true nullable: true is_campaign_budget_optimization: type: boolean description: Determines if a campaign automatically generate ad-group level budgets given a campaign budget to maximize campaign outcome. When transitioning from non-cbo to cbo, all previous child ad group budget will be cleared. example: true nullable: true LeadFormStatus: type: string description: Status of the lead form example: DRAFT enum: - DRAFT - ACTIVE CampaignCreateResponseItem: type: object properties: data: $ref: '#/components/schemas/CampaignCreateResponseData' exceptions: type: array items: $ref: '#/components/schemas/Exception' AdGroupsAnalyticsResponse: type: array items: type: object properties: AD_GROUP_ID: description: The ID of the ad group that this metrics belongs to. type: string pattern: ^\d+$ DATE: description: Current metrics date. Only returned when granularity is a time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`) type: string format: date required: - AD_GROUP_ID additionalProperties: true example: DATE: '2021-04-01' AD_GROUP_ID: '547602124502' SPEND_IN_DOLLAR: 30 TOTAL_CLICKTHROUGH: 216 TargetingTypeFilter: type: object properties: targeting_types: type: array description: List of targeting types. Requires `level` to be a value ending in `_TARGETING`. ["AGE_BUCKET_AND_GENDER"] is in BETA and not yet available to all users. items: $ref: '#/components/schemas/AdsAnalyticsTargetingType' maxItems: 5 minItems: 1 BulkDownloadResponse: type: object example: request_id: '2680059592705' properties: request_id: description: ID of the bulk request. example: '2680059592705' type: string AdGroupArrayResponseElement: type: object properties: data: $ref: '#/components/schemas/AdGroupResponse' exceptions: type: array items: $ref: '#/components/schemas/Exception' CustomerListUpdateRequest: properties: records: description: Records list. Can be any combination of emails, MAIDs, or IDFAs. Emails must be lowercase and can be plain text or hashed using SHA1, SHA256, or MD5. MAIDs and IDFAs must be hashed with SHA1, SHA256, or MD5. example: email2@pinterest.com,email6@pinterest.com, title: records type: string operation_type: allOf: - $ref: '#/components/schemas/UserListOperationType' title: operation_type type: string exceptions: $ref: '#/components/schemas/Exception' type: object required: - operation_type - records title: CustomerListUpdate type: object BulkUpsertRequest: type: object description: Two set of objects to be managed asyncronusly by bulk. One for creations, one for modifications. properties: create: $ref: '#/components/schemas/BulkUpsertRequestCreate' update: $ref: '#/components/schemas/BulkUpsertRequestUpdate' BulkOutputFormat: type: string description: Bulk file output format enum: - CSV - JSON AdsAnalyticsCreateAsyncResponse: type: object properties: report_status: type: string allOf: - $ref: '#/components/schemas/BulkReportingJobStatus' token: type: string message: type: string nullable: true CampaignUpdateResponse: type: object allOf: - $ref: '#/components/schemas/CampaignCreateResponse' CampaignUpdateRequest: type: object allOf: - $ref: '#/components/schemas/CampaignId' - $ref: '#/components/schemas/CampaignCommon' - $ref: '#/components/schemas/CampaignCreateCommon' - type: object properties: is_campaign_budget_optimization: type: boolean nullable: true allOf: - $ref: '#/components/schemas/CampaignIsCampaignBudgetOptimization' is_flexible_daily_budgets: type: boolean nullable: true allOf: - $ref: '#/components/schemas/CampaignIsFlexibleDailyBudgets' is_automated_campaign: type: boolean nullable: true allOf: - $ref: '#/components/schemas/CampaignIsAutomatedCampaign' status: type: string nullable: true allOf: - $ref: '#/components/schemas/EntityStatus' objective_type: type: string nullable: true allOf: - $ref: '#/components/schemas/ObjectiveType' required: - id - ad_account_id MatchType: type: string description: Keyword match type example: BROAD enum: - BROAD - PHRASE - EXACT - EXACT_NEGATIVE - PHRASE_NEGATIVE BulkUpsertRequestCreate: type: object description: Request for creation of entities in bulk. properties: campaigns: type: array items: $ref: '#/components/schemas/CampaignCreateRequest' ad_groups: type: array items: $ref: '#/components/schemas/AdGroupCreateRequest' ads: type: array items: $ref: '#/components/schemas/AdCreateRequest' product_groups: type: array items: $ref: '#/components/schemas/ProductGroupPromotionCreateRequest' keywords: type: array items: $ref: '#/components/schemas/KeywordsRequest' AudienceDemographicValue: title: AudienceDemographicValue description: Demographic detail for a single audience demographic type: object properties: key: title: key description: Unique key for demographic item type: string example: us name: title: name description: Display name for demographic type: string example: United States ratio: title: ratio description: Value of demographic item as a percent of total audience type: number example: 0.551 example: name: United States key: us ratio: 0.551 AdArrayResponseElement: type: object properties: data: $ref: '#/components/schemas/AdResponse' exceptions: $ref: '#/components/schemas/Exception' AudienceUpdateRequest: type: object allOf: - $ref: '#/components/schemas/AudienceCommon' - title: AudienceUpdateRequest type: object properties: description: $ref: '#/components/schemas/AudienceDescription' operation_type: $ref: '#/components/schemas/AudienceUpdateOperationType' ConversionTagListResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/ConversionTagResponse' ConversionAttributionWindowDays: type: integer enum: - 0 - 1 - 7 - 14 - 30 - 60 Board: title: Board description: Board type: object properties: id: type: string readOnly: true example: '549755885175' created_at: type: string description: Date and time of board creation. readOnly: true format: date-time example: '2020-01-01T20:10:40-00:00' board_pins_modified_at: type: string description: Date and time of last board pins modified. readOnly: true format: date-time example: '2020-01-01T20:10:40-00:00' name: type: string example: Summer Recipes description: type: string nullable: true example: My favorite summer recipes collaborator_count: type: integer description: Count of collaborators on the board. minimum: 0 readOnly: true example: 17 pin_count: type: integer description: Count of pins on the board. minimum: 0 readOnly: true example: 5 follower_count: type: integer description: Board follower count. readOnly: true minimum: 0 example: 13 media: type: object readOnly: true description: Board media. properties: image_cover_url: type: string nullable: true description: Board cover image. example: https://i.pinimg.com/400x300/fd/cd/d5/fdcdd5a6d8a80824add0d054125cd957.jpg pin_thumbnail_urls: type: array description: Board pin thumbnail urls. items: type: string example: - https://i.pinimg.com/150x150/b4/57/10/b45710f1ede96af55230f4b43935c4af.jpg - https://i.pinimg.com/150x150/dd/ff/46/ddff4616e39c1935cd05738794fa860e.jpg - https://i.pinimg.com/150x150/84/ac/59/84ac59b670ccb5b903dace480a98930c.jpg - https://i.pinimg.com/150x150/4c/54/6f/4c546f521be85e30838fb742bfff6936.jpg owner: allOf: - $ref: '#/components/schemas/BoardOwner' type: object readOnly: true privacy: type: string default: PUBLIC description: Privacy setting for a board. Learn more about secret boards and protected boards enum: - PUBLIC - PROTECTED - SECRET required: - name KeywordUpdateBody: type: object properties: keywords: description: 'Keywords to update. Object array. Each object has 3 possible fields:
1. "id": (required) keyword ID
2. "archived": boolean. Should keyword be archived?
3. "bid": number
For example: [{"id":"2886610576653", "archived": false, "bid": 20000}, {"id":"2886610576654", "archived": true, "bid": 20000}, ...]' type: array items: $ref: '#/components/schemas/KeywordUpdate' title: keywords required: - keywords OptimizationGoalMetadata: type: object properties: conversion_tag_v3_goal_metadata: properties: attribution_windows: properties: click_window_days: type: integer engagement_window_days: type: integer view_window_days: type: integer type: object conversion_event: type: string enum: - PAGE_VISIT - SIGNUP - CHECKOUT - CUSTOM - VIEW_CATEGORY - SEARCH - ADD_TO_CART - WATCH_VIDEO - LEAD - APP_INSTALL conversion_tag_id: type: string pattern: ^[0-9]+$ cpa_goal_value_in_micro_currency: type: string pattern: ^[0-9]+$ is_roas_optimized: description: Ad group is ROAS optimized nullable: true title: is_roas_optimized type: boolean learning_mode_type: description: Conversion learning model type enum: - NOT_ACTIVE - ACTIVE - null example: ACTIVE nullable: true title: ConversionLearningModeType type: string type: object frequency_goal_metadata: properties: frequency: type: integer timerange: type: string description: User entity counts time range example: DAY enum: - THIRTY_DAY - DAY - SEVEN_DAY - TWENTY_MINUTE - TEN_MINUTE - TWENTY_FOUR_HOUR type: object scrollup_goal_metadata: properties: scrollup_goal_value_in_micro_currency: pattern: ^[0-9]+$ type: string nullable: true type: object SSIOAccountAddress: type: object properties: display: description: Address display example: 475 Brannan Street, San Francisco, CA 94103 type: string purpose: description: Purpose for which the address is used, usually Billing or Businness example: Billing type: string address_id: description: Salesforce id for address example: a1C1N000004MUrLUAW type: string order_legal_entity: description: Legal entity for this insertion order example: PIN US OU type: string AdCommon: type: object description: Creation fields properties: ad_group_id: description: ID of the ad group that contains the ad. example: '2680059592705' type: string pattern: ^(AG)?\d+$ android_deep_link: description: Deep link URL for Android devices. Not currently available. Using this field will generate an error. nullable: true type: string carousel_android_deep_links: description: Comma-separated deep links for the carousel pin on Android. type: array nullable: true items: type: string carousel_destination_urls: description: Comma-separated destination URLs for the carousel pin to promote. type: array nullable: true items: type: string carousel_ios_deep_links: description: Comma-separated deep links for the carousel pin on iOS. type: array nullable: true items: type: string click_tracking_url: description: Tracking url for the ad clicks. type: string nullable: true creative_type: $ref: '#/components/schemas/CreativeType' destination_url: description: Destination URL. type: string nullable: true ios_deep_link: description: Deep link URL for iOS devices. Not currently available. Using this field will generate an error. type: string nullable: true is_pin_deleted: description: Is original pin deleted? example: false type: boolean is_removable: description: Is pin repinnable? example: false type: boolean name: description: Name of the ad - 255 chars max. type: string nullable: true status: $ref: '#/components/schemas/EntityStatus' tracking_urls: type: object allOf: - $ref: '#/components/schemas/TrackingUrls' nullable: true view_tracking_url: description: Tracking URL for ad impressions. type: string nullable: true lead_form_id: description: Lead form ID for lead ad generation. type: string pattern: ^(AG)?\d+$ nullable: true grid_click_type: $ref: '#/components/schemas/GridClickType' customizable_cta_type: type: string description: 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_WEBSITE, BUY_NOW, GET_OFFER, ORDER_NOW, ADD_TO_CART (for conversion campaigns with add to cart conversion events only) example: LEARN_MORE nullable: true enum: - GET_OFFER - LEARN_MORE - ORDER_NOW - SHOP_NOW - SIGN_UP - SUBSCRIBE - BUY_NOW - CONTACT_US - GET_QUOTE - VISIT_WEBSITE - APPLY_NOW - BOOK_NOW - REQUEST_DEMO - REGISTER_NOW - FIND_A_DEALER - ADD_TO_CART - WATCH_NOW - READ_MORE - null quiz_pin_data: type: object allOf: - $ref: '#/components/schemas/QuizPinData' description: 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. nullable: true AdsCreditRedeemRequest: type: object required: - offerCodeHash - validateOnly properties: offerCodeHash: description: Takes in a SHA256 hash of the offerCode. example: 138e9e0ff7e38cf511b880975eb574c09aa9d5e1657590ab0431040da68caa67 type: string pattern: ^[a-z0-9]*$ validateOnly: description: If true, only validate if we can redeem offer code. Otherwise it will actually apply the offer code to the account example: true type: boolean BulkReportingJobStatus: type: string description: Possible status for a bulk reporting job example: FINISHED enum: - DOES_NOT_EXIST - FINISHED - IN_PROGRESS - EXPIRED - FAILED - CANCELLED BusinessAccessRole: type: string description: Permission role for business access. example: ADMIN enum: - OWNER - ADMIN - ANALYST - SOS_READER - FINANCE_MANAGER - AUDIENCE_MANAGER - CAMPAIGN_MANAGER - CATALOGS_MANAGER - RESTRICTED_OWNER - PROFILE_MANAGER - PROFILE_PUBLISHER - RESOURCE_PINNER_LIST_OWNER - RESOURCE_PINNER_LIST_READER - BIZ_PINNER_LIST_SHARER - RESOURCE_CONVERSION_TAGS_READER BudgetType: description: Budget type. If DAILY, an ad group's daily spend will not exceed the budget parameter value. If LIFETIME, the end_time parameter is **REQUIRED**, and the ad group spend is spread evenly between the ad group `start_time` and `end_time` range. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. For CBO campaigns, only "CBO_ADGROUP" is allowed. For WEB_SESSIONS campaigns, only "LIFETIME" is allowed. For update, only draft ad groups may update budget type. example: DAILY enum: - DAILY - LIFETIME - CBO_ADGROUP type: string Granularity: type: string description: Granularity enum: - TOTAL - DAY - HOUR - WEEK - MONTH AdAccountCreateRequest: title: AdAccountCreate type: object example: country: US owner_user_id: '383791336903426391' name: ACME Tools properties: country: $ref: '#/components/schemas/Country' name: description: Ad Account name. example: ACME Tools maxLength: 256 title: name type: string owner_user_id: description: Advertiser's owning user ID. example: '383791336903426391' pattern: ^\d+$ title: owner_user_id type: string TargetingTemplateGetResponseData: type: object allOf: - $ref: '#/components/schemas/TargetingTemplateResponseData' - type: object title: TargetingTemplateGetResponseData properties: valid: nullable: true description: Inform if the targeting template is valid (ex. would be false if has revoked audience) type: boolean example: true AdResponse: type: object allOf: - $ref: '#/components/schemas/AdCommon' - $ref: '#/components/schemas/AdPinId' - type: object properties: ad_account_id: description: The ID of the advertiser that this ad belongs to. example: '549755885175' type: string pattern: ^\d+$ campaign_id: description: ID of the ad campaign that contains this ad. example: '626735565838' type: string pattern: ^\d+$ collection_items_destination_url_template: description: Destination URL template for all items within a collections drawer. type: string nullable: true created_time: description: Pin creation time. Unix timestamp in seconds. example: 1451431341 type: integer id: description: The ID of this ad. example: '687195134316' type: string pattern: ^\d+$ rejected_reasons: description: Enum reason why the pin was rejected. Returned if review_status is "REJECTED". type: array items: type: string description: ad disapproval reasons enum: - HASHTAGS - PROMOTIONS_AND_PRICES - TARGETING - LANDING_PAGE - CAPS_AND_SYMBOLS - SHOCKING - WEIGHT_LOSS - PROHIBITED_PRODUCT - AUTHENTICITY - NUDITY - CONFUSING_DESIGN - URGENCY - RATINGS - APP - ALCOHOL - CONTESTS - POLITICAL - OTHER - IMAGE - NAR - INCONSISTENT - CLICKBAIT - NO_DESCRIPTION - LOW_QUALITY - EXAGGERATED_CLAIMS - PINTEREST_BRAND - ALCOHOL_NO_SALE - LANDING_PAGE_SPEED - LANDING_PAGE_HARDWALL - LANDING_PAGE_BROKEN - LANDING_PAGE_QUALITY - OUT_OF_STOCK - IMAGE_LOW_QUALITY - IMAGE_BUSY - IMAGE_POORLY_EDITED - IMAGE_BEFORE_AFTER - UGC - FAKE_BUTTONS - WEAPONS - SENSITIVE - UNACCEPTABLE_BUSINESS - SUSPICIOUS_CLAIMS - PHARMA - SUSPICIOUS_SUPPLEMENTS - ILLEGAL_RECREATIONAL_DRUG - LOW_QUALITY_LANDING_PAGE - RESTRICTED_HEALTHCARE - INCONSISTENT_LANG_FR rejection_labels: description: Text reason why the pin was rejected. Returned if review_status is "REJECTED". type: array items: type: string review_status: type: string description: Ad review status example: PENDING enum: - OTHER - PENDING - REJECTED - APPROVED type: description: Always "ad". example: pinpromotion type: string updated_time: description: Last update time. Unix timestamp in seconds. example: 1451431341 type: integer summary_status: type: string allOf: - $ref: '#/components/schemas/PinPromotionSummaryStatus' description: Ad summary status GridClickType: type: string description: Where a user is taken after clicking on an ad in grid.

Note: This parameter is read-only and is set to DIRECT_TO_DESTINATION by default for direct links supported ads. grid_click_type values provided will be ignored. example: CLOSEUP nullable: true enum: - CLOSEUP - DIRECT_TO_DESTINATION AudienceCreateCustomRequest: type: object allOf: - $ref: '#/components/schemas/AudienceCommon' - title: AudienceCreateCustomRequest required: - sharing_type - name - rule - data_party properties: sharing_type: $ref: '#/components/schemas/AudienceSharingType' data_party: $ref: '#/components/schemas/AudienceDataParty' category: type: string example: DLX Demographics TermsOfService: example: has_accepted: true html: example test id: '2650449554526' ad_account_id: '549755885175' properties: id: description: The ID of the terms of service example: '2650449554526' title: id type: string html: description: The terms of service content example: example test nullable: true title: html type: string has_accepted: description: Whether the ad account has accepted terms of service. example: true title: hasAccepted type: boolean ad_account_id: description: The ID of the ad account. example: '549755885175' title: adAccountId type: string title: TermsOfService type: object TargetingTemplateResponseData: type: object allOf: - $ref: '#/components/schemas/TargetingTemplateCommon' - type: object title: TargetingTemplateResponseData properties: id: description: Targeting template ID. example: '643' type: string pattern: ^\d+$ created_time: description: Targeting template created time. Unix timestamp in seconds. example: 1432744744 title: created_time type: integer updated_time: description: Targeting template updated time.Unix timestamp in seconds. example: 1432744744 title: updated_time type: integer ad_account_id: description: The ID of the advertiser that this targeting template belongs to. example: '549755885175' type: string pattern: ^\d+$ status: type: string description: Indicate targeting template is active or Deleted allOf: - type: string description: Indicate targeting template is active or Deleted example: ACTIVE default: ACTIVE enum: - ACTIVE - DELETED sizing: $ref: '#/components/schemas/TargetingTemplateAudienceSizing' AudienceDemographics: title: AudienceDemographics description: Audience demographics type: object properties: ages: title: ages description: Ages distribution. type: array items: $ref: '#/components/schemas/AudienceDemographicValue' genders: title: genders description: Gender distribution. type: array items: $ref: '#/components/schemas/AudienceDemographicValue' devices: title: devices description: Device usage distribution. type: array items: $ref: '#/components/schemas/AudienceDemographicValue' metros: title: metros description: Geographic metro area distribution. type: array items: $ref: '#/components/schemas/AudienceDemographicValue' countries: title: countries description: Country area distribution. type: array items: $ref: '#/components/schemas/AudienceDemographicValue' KeywordsCommon: type: object properties: bid: type: integer description: Keyword custom bid in microcurrency - null if inherited from parent ad group. example: 200000 nullable: true match_type: $ref: '#/components/schemas/MatchTypeResponse' value: type: string description: Keyword value (120 chars max). required: - match_type - value KeywordsRequest: type: object properties: keywords: type: array description: Keyword JSON array. Each array element has 3 fields items: $ref: '#/components/schemas/KeywordsCommon' parent_id: description: Keyword parent entity ID (advertiser, campaign, ad group). example: '383791336903426391' pattern: ^((AG)|C)?\d+$ title: parent_id type: string required: - keywords - parent_id KeywordMetrics: description: Keyword metrics JSON title: KeywordMetrics type: object properties: avg_cpc_in_micro_currency: example: 100000 title: avg_cpc_in_micro_currency description: Average cost per click type: number keyword_query_volume: example: 5M+ title: keyword_query_volume description: Keyword's search frequency. This value is based on keyword frequency in pepsi client response type: string TargetingTemplateCommon: type: object properties: name: type: string example: Gaming description: targeting template name auto_targeting_enabled: type: boolean default: true description: Enable auto-targeting for ad group. Also known as "expanded targeting". targeting_attributes: $ref: '#/components/schemas/TargetingSpec' placement_group: $ref: '#/components/schemas/PlacementGroupType' keywords: type: array example: - value: cats match_type: EXACT_NEGATIVE items: $ref: '#/components/schemas/TargetingTemplateKeyword' tracking_urls: $ref: '#/components/schemas/TrackingUrls' SSIOInsertionOrderCommon: type: object properties: start_date: description: 'Starting date of time period. Format: YYYY-MM-DD' type: string pattern: ^(\d{4})-(\d{2})-(\d{2})$ example: '2020-12-20' end_date: description: 'End date of time period. Format: YYYY-MM-DD' type: string pattern: ^(\d{4})-(\d{2})-(\d{2})$ example: '2020-12-20' po_number: description: The po number type: string budget_amount: type: number description: If Budget order line, the budget amount. example: 5000000 billing_contact_firstname: description: The billing contact first name type: string billing_contact_lastname: description: The billing contact last name type: string billing_contact_email: description: The billing contact email example: test@example type: string media_contact_firstname: description: The media contact first name type: string media_contact_lastname: description: The media contact last name type: string media_contact_email: description: The media contact email example: test@example type: string agency_link: description: URL link for agency type: string user_email: description: The email of user submitting the insertion order example: test@example type: string CreateMMMReportResponse: type: object properties: code: example: 0 type: number data: title: CreateMMMReportResponseData type: object properties: report_status: type: string allOf: - $ref: '#/components/schemas/BulkReportingJobStatus' token: type: string message: type: string nullable: true status: example: success type: string MMMReportingTargetingType: type: string description: Ad targeting types for MMM report example: APPTYPE enum: - APPTYPE - COUNTRY - CREATIVE_TYPE - GENDER - LOCATION OrderLine: type: object allOf: - $ref: '#/components/schemas/OrderLines' - type: object properties: campaign_ids: description: Associated List of campaign IDs. example: - '626735565838' items: type: string title: campaign_ids type: array required: - campaign_ids title: OrderLine AdAccountAnalyticsResponse: type: array items: type: object properties: AD_ACCOUNT_ID: description: The ID of the advertiser that this metrics belongs to. type: string pattern: ^\d+$ DATE: description: Current metrics date. Only returned when granularity is a time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`) type: string format: date required: - AD_ACCOUNT_ID additionalProperties: true example: DATE: '2021-04-01' AD_ACCOUNT_ID: '547602124502' SPEND_IN_DOLLAR: 30 TOTAL_CLICKTHROUGH: 216 AudienceInsightsResponse: title: AudienceInsightsResponse description: Audience interests and demographics. type: object properties: categories: title: categories description: Category interest distribution type: array items: $ref: '#/components/schemas/AudienceCategory' demographics: $ref: '#/components/schemas/AudienceDemographics' type: $ref: '#/components/schemas/AudienceInsightType' date: title: date description: Generation date type: string nullable: true example: '2022-10-09' pattern: ^\d{4}-\d{2}-\d{2}$ size: title: size description: Population count. type: integer example: 10000 size_is_upper_bound: title: size_is_upper_bound description: Indicates whether the audience size has been rounded up to the next highest upper boundary. type: boolean example: true AdUpdateRequest: type: object allOf: - $ref: '#/components/schemas/AdCommon' - type: object title: AdUpdateRequest properties: id: type: string example: '687195134316' pattern: ^\d+$ description: The ID of this ad. title: id pin_id: type: string description: Pin ID. This field may only be updated for draft ads. example: '394205773611545468' pattern: ^\d+$ nullable: true required: - id ProductGroupPromotionResponseItem: type: object title: ProductGroupPromotionResponseItem properties: data: $ref: '#/components/schemas/ProductGroupPromotionResponseElement' exceptions: nullable: true items: nullable: true $ref: '#/components/schemas/Exception' AdsAnalyticsFilterOperator: type: string description: Filter operator for sync reporting example: LESS_THAN enum: - LESS_THAN - GREATER_THAN SSIOAccountResponse: type: object properties: eligible: description: Advertiser eligible to create order lines example: true type: boolean can_edit: description: Advertiser eligible to update order lines example: true type: boolean billto_infos: type: array description: An array of Salesforce account information that includes address, io terms, etc. items: $ref: '#/components/schemas/SSIOAccountItem' currency: type: string example: USD pmp_names: type: array items: $ref: '#/components/schemas/SSIOAccountPMPName' error: description: Error indicator from Salesforce which could be "No Error" example: No Error type: string SSIOCreateInsertionOrderResponse: type: object properties: pin_order_id: description: Salesforce order id type: string ActionType: type: string description: Ad group billable event type. For update, only draft ad groups may update billable event. example: CLICKTHROUGH enum: - CLICKTHROUGH - IMPRESSION - VIDEO_V_50_MRC ConversionTagCreate: type: object allOf: - $ref: '#/components/schemas/ConversionTagConfigs' example: name: ACME Tools Tag properties: name: description: Conversion tag name. example: ACME Tools Tag title: name type: string required: - name title: ConversionTagCreate CampaignCreateResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CampaignCreateResponseItem' MetricsResponse: properties: data: items: type: object type: array example: - targeting_type: KEYWORD targeting_value: christmas decor ideas metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: APPTYPE targeting_value: iphone metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: APPTYPE targeting_value: ipad metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: APPTYPE targeting_value: web metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: APPTYPE targeting_value: web_mobile metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: APPTYPE targeting_value: android_mobile metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: APPTYPE targeting_value: android_tablet metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: GENDER targeting_value: female metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: LOCATION targeting_value: 500 metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: PLACEMENT targeting_value: SEARCH metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: COUNTRY targeting_value: US metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: TARGETED_INTEREST targeting_value: Food and Drinks metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: PINNER_INTEREST targeting_value: Chocolate Cookies metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: AUDIENCE_INCLUDE targeting_value: 254261234567 metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: GEO targeting_value: US:94102 metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: AGE_BUCKET targeting_value: 45-49 metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 - targeting_type: REGION targeting_value: US-CA metrics: AD_GROUP_ID: 2680067996745 DATE: '2022-04-26' SPEND_IN_DOLLAR: 240 type: object AdsAnalyticsMetricsFilter: type: object properties: field: $ref: '#/components/schemas/AdsAnalyticsFilterColumn' operator: $ref: '#/components/schemas/AdsAnalyticsFilterOperator' values: type: array description: List of values for filtering items: type: number minItems: 1 required: - field - operator - values CampaignCommon: type: object description: Campaign Data properties: ad_account_id: description: Campaign's Advertiser ID. If you want to create a campaign in a Business Account shared account you need to specify the Business Access advertiser ID in both the query path param as well as the request body schema. example: '549755885175' type: string pattern: ^\d+$ name: type: string description: Campaign name. example: ACME Tools status: type: string allOf: - $ref: '#/components/schemas/EntityStatus' lifetime_spend_cap: description: Campaign total spending cap. Required for Campaign Budget Optimization (CBO) campaigns. This and "daily_spend_cap" cannot be set at the same time. example: 1432744744 type: integer nullable: true daily_spend_cap: description: Campaign daily spending cap. Required for Campaign Budget Optimization (CBO) campaigns. This and "lifetime_spend_cap" cannot be set at the same time. example: 1432744744 type: integer nullable: true order_line_id: description: Order line ID that appears on the invoice. example: '549755885175' type: string pattern: ^\d+$ nullable: true tracking_urls: type: object nullable: true allOf: - $ref: '#/components/schemas/TrackingUrls' start_time: type: integer description: Campaign start time. Unix timestamp in seconds. Only used for Campaign Budget Optimization (CBO) campaigns. example: 1580865126 nullable: true end_time: type: integer description: Campaign end time. Unix timestamp in seconds. Only used for Campaign Budget Optimization (CBO) campaigns. example: 1644023526 nullable: true summary_status: type: string allOf: - $ref: '#/components/schemas/CampaignSummaryStatus' MatchTypeResponse: type: string description: Keyword match type nullable: true example: BROAD enum: - BROAD - PHRASE - EXACT - EXACT_NEGATIVE - PHRASE_NEGATIVE - null CampaignIsCampaignBudgetOptimization: type: boolean description: Determines if a campaign automatically generate ad-group level budgets given a campaign budget to maximize campaign outcome. When transitioning from non-cbo to cbo, all previous child ad group budget will be cleared. example: true default: false TrackingUrls: description: Third-party tracking URLs. Up to three tracking URLs - with a max length of 2,000 - are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. For more information, see Third-party and dynamic tracking. example: impression: - URL1 - URL2 click: - URL1 - URL2 engagement: - URL1 - URL2 buyable_button: - URL1 - URL2 audience_verification: - URL1 - URL2 type: object nullable: true properties: impression: type: array items: type: string click: type: array items: type: string engagement: type: array items: type: string buyable_button: type: array items: type: string audience_verification: type: array items: type: string SSIOInsertionOrderStatusResponse: allOf: - $ref: '#/components/schemas/SSIOInsertionOrderStatus' - type: object LeadFormQuestionType: type: string description: Lead form question type example: FIRST_NAME enum: - CUSTOM - FULL_NAME - FIRST_NAME - LAST_NAME - EMAIL - PHONE_NUMBER - ZIP_CODE - AGE - GENDER - CITY - COUNTRY - PREFERRED_CONTACT_METHOD - STATE_PROVINCE - ADDRESS - DATE_OF_BIRTH ConversionReportAttributionType: type: string description: Attribution type. Refers to the Pinterest Tag endpoints example: INDIVIDUAL enum: - INDIVIDUAL - HOUSEHOLD UserListOperationType: description: User list operation type (add or remove) enum: - ADD - REMOVE example: REMOVE title: UserListOperationType type: string QuizPinOption: description: ' This field contains multiple options to a quiz question.' example: id: 1 text: Where do you thrive? type: object nullable: true properties: id: type: number text: type: string CampaignsAnalyticsResponse: type: array items: type: object properties: CAMPAIGN_ID: description: The ID of the campaing that this metrics belongs to. type: string pattern: ^\d+$ DATE: description: Current metrics date. Only returned when granularity is a time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`) type: string format: date required: - CAMPAIGN_ID additionalProperties: true example: DATE: '2021-04-01' CAMPAIGN_ID: '547602124502' SPEND_IN_DOLLAR: 30 TOTAL_CLICKTHROUGH: 216 BulkDownloadRequest: type: object description: Ad entities to get in bulk request. properties: entity_types: type: array items: type: string allOf: - $ref: '#/components/schemas/BulkEntityType' minItems: 1 maxItems: 5 description: All entity types specified will be downloaded. Fewer types result in faster downloads. example: - CAMPAIGN - AD_GROUP entity_ids: type: array items: type: string pattern: ^\d+$ description: All entities specified by these IDs as well as their children and grandchildren will be downloaded if the entity type is one of the types requested to be downloaded. updated_since: type: string pattern: ^\d+$ example: '1622848072' description: Unix UTC timestamp to retrieve all entities that have changed since this time. campaign_filter: type: object properties: start_time: type: string pattern: ^\d+$ example: '1622848072' description: Unix UTC timestamp. end_time: type: string pattern: ^\d+$ example: '1622848072' description: Unix UTC timestamp. name: type: string example: campaign name description: Campaign name campaign_status: type: array items: $ref: '#/components/schemas/CampaignSummaryStatus' objective_type: type: array items: $ref: '#/components/schemas/ObjectiveType' output_format: type: string allOf: - $ref: '#/components/schemas/BulkOutputFormat' default: JSON AdsCreditRedeemResponse: type: object properties: success: description: Returns true if the offer code was successfully applied(validateOnly=false) or can be applied(validateOnly=true). type: boolean example: false errorCode: description: Error code type if error occurs type: integer nullable: true example: 2708 errorMessage: description: Reason for failure type: string nullable: true example: The offer has already been redeemed by this advertiser AudienceDataParty: description: Whether the data is owned by the partner (1p) or by the data provider (3p) type: string enum: - 1p - 3p ProductGroupPromotionResponseElement: type: object title: ProductGroupPromotionResponseElement allOf: - $ref: '#/components/schemas/ProductGroupPromotion' - type: object properties: creative_type: $ref: '#/components/schemas/CreativeType' AdGroupResponse: type: object allOf: - $ref: '#/components/schemas/AdGroupCommon' - type: object properties: id: description: Ad group ID. type: string pattern: ^\d+$ example: '2680060704746' ad_account_id: description: Advertiser ID. type: string pattern: ^\d+$ example: '549755885175' created_time: description: Ad group creation time. Unix timestamp in seconds. type: integer example: 1476477189 updated_time: description: Ad group last update time. Unix timestamp in seconds. type: integer example: 1476477189 type: description: Always "adgroup". type: string default: adgroup conversion_learning_mode_type: type: string description: oCPM learn mode example: ACTIVE nullable: true enum: - NOT_ACTIVE - ACTIVE - null summary_status: type: string allOf: - $ref: '#/components/schemas/AdGroupSummaryStatus' description: Ad group summary status. feed_profile_id: description: Feed Profile ID associated to the adgroup. type: string example: '626736533506' dca_assets: description: '[DCA] The Dynamic creative assets to use for DCA. Dynamic Creative Assembly (DCA) accepts basic creative assets of an ad (image, video, title, call to action, logo etc). Then it automatically generates optimized ad combinations based on these assets.' TargetingTemplateUpdateRequest: required: - operation_type - id type: object properties: operation_type: enum: - REMOVE type: string id: description: Targeting template ID example: '643' type: string pattern: ^\d+$ SSIOEditInsertionOrderRequest: type: object allOf: - $ref: '#/components/schemas/SSIOInsertionOrderCommon' - type: object properties: oracle_line_id: description: LineId in the Oracle DB type: string salesforce_order_id: description: OrderId in SFDC type: string salesforce_order_line_id: description: OrderLineId in SFDC type: string ads_manager_order_line_id: description: Ads manager OrderLineId type: string LeadFormTestRequest: title: LeadFormTestRequest description: Request to create test data for lead data test API. type: object properties: answers: description: Test lead answers. Should follow the creation order. type: array items: type: string example: - John - Doe - abc@email.com - '987654321' required: - answers AdPreviewURLResponse: example: url: https://ads.pinterest.com/ad-preview/58f1a0e9ab0bd0f99462a0e4c5dd7e8297888c8a36331e88f757abe8f0295d31/ properties: url: description: '''Preview URL, expires in 7 days. Can be used in an iframe. For example: https://ads.pinterest.com/ad-preview/74667c814dd2b19/ The preview object ID/key is the last param - 74667c814dd2b19''' example: https://ads.pinterest.com/ad-preview/58f1a0e9ab0bd0f99462a0e4c5dd7e8297888c8a36331e88f757abe8f0295d31/ title: url type: string title: AdPreviewURLResponse type: object OrderLineStatus: description: Order Line Status enum: - ACTIVE - PAUSED - DELETED example: ACTIVE title: OrderLineStatus type: string MMMReportingColumn: type: string description: Marketing Mix Modeling (MMM) Reporting Columns example: SPEND_IN_DOLLAR enum: - SPEND_IN_DOLLAR - SPEND_IN_MICRO_DOLLAR - ECPC_IN_DOLLAR - ECTR - CAMPAIGN_NAME - TOTAL_ENGAGEMENT - EENGAGEMENT_RATE - ECPM_IN_DOLLAR - CAMPAIGN_ID - ADVERTISER_ID - AD_GROUP_ID - AD_GROUP_NAME - CLICKTHROUGH_1 - IMPRESSION_1 - CLICKTHROUGH_2 - IMPRESSION_2 - TOTAL_CLICKTHROUGH - TOTAL_IMPRESSION - ADVERTISER_NAME - SPEND_ORDER_LINE_PAID_TYPE ProductGroupPromotion: properties: id: description: ID of the product group promotion. example: '2680059592705' title: id type: string pattern: ^\d+$ ad_group_id: description: ID of the ad group the product group belongs to. example: '2680059592705' pattern: ^(AG)?\d+$ title: ad_group_id type: string bid_in_micro_currency: description: The bid in micro currency. example: 14000000 title: bid_in_micro_currency type: integer nullable: true included: description: True if the group is BIDDABLE, false if it should be EXCLUDED from serving ads. example: true nullable: true title: included type: boolean definition: description: The full product group definition path example: '*/product_type_0=''kitchen''/product_type_1=''beverage appliances''' nullable: true title: definition type: string relative_definition: description: The definition of the product group, relative to its parent - an attribute name/value pair example: product_type_1='beverage appliances' nullable: true title: relative_definition type: string parent_id: description: The parent Product Group ID of this Product Group example: '1231234' nullable: true title: parent_id type: string pattern: ^\d+$ slideshow_collections_title: description: Slideshow Collections Title example: slideshow title nullable: true title: slideshow_collections_title type: string slideshow_collections_description: description: Slideshow Collections Description example: slideshow description nullable: true title: slideshow_collections_description type: string is_mdl: description: If set to true products promoted in this product group will use the Mobile Deep Link specified in your catalog example: true nullable: true title: is_mdl type: boolean status: $ref: '#/components/schemas/EntityStatus' tracking_url: description: Tracking template for proudct group promotions. 4000 limit example: https://www.pinterest.com nullable: true title: tracking_url type: string catalog_product_group_id: description: ID of the catalogs product group that this product group promotion references example: '1231235' title: catalog_product_group_id type: string pattern: ^\d+$ nullable: true catalog_product_group_name: description: Catalogs product group name example: catalogProductGroupName title: product_group_promotion_name type: string nullable: true collections_hero_pin_id: description: Hero Pin ID if this PG is promoted as a Collection example: '123123' nullable: true title: collections_hero_pin_id type: string pattern: ^\d+$ collections_hero_destination_url: description: Collections Hero Destination Url example: http://www.pinterest.com nullable: true title: collections_hero_destination_url type: string grid_click_type: $ref: '#/components/schemas/GridClickType' type: object title: ProductGroupPromotion AdsAnalyticsGetAsyncResponse: type: object properties: report_status: type: string allOf: - $ref: '#/components/schemas/BulkReportingJobStatus' url: type: string nullable: true size: type: number nullable: true AudienceUpdateOperationType: title: operation_type type: string description: Audience operation type (update or remove). example: UPDATE default: UPDATE enum: - UPDATE - REMOVE LeadFormTestResponse: title: LeadFormTestResponse type: object description: Response for lead data test API. properties: subscription_id: description: Subscription ID. example: '8078432025948590686' type: string pattern: ^\d+$ AdsAnalyticsResponse: type: array items: type: object properties: AD_ID: description: The ID of the ad that this metrics belongs to. type: string pattern: ^\d+$ DATE: description: Current metrics date. Only returned when granularity is a time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`) type: string format: date required: - AD_ID additionalProperties: true example: DATE: '2021-04-01' AD_ID: '547602124502' SPEND_IN_DOLLAR: 30 TOTAL_CLICKTHROUGH: 216 BulkUpsertStatus: type: string enum: - RUNNING - SUCCEEDED - FAILED example: SUCCEEDED AdGroupUpdateRequest: type: object allOf: - $ref: '#/components/schemas/AdGroupCommon' - type: object properties: id: description: Ad group ID. type: string pattern: ^\d+$ example: '2680060704746' required: - id CampaignCreateCommon: type: object allOf: - $ref: '#/components/schemas/CampaignCommon' - type: object properties: status: type: string default: ACTIVE allOf: - $ref: '#/components/schemas/EntityStatus' is_flexible_daily_budgets: type: boolean default: false allOf: - $ref: '#/components/schemas/CampaignIsFlexibleDailyBudgets' default_ad_group_budget_in_micro_currency: type: integer description: When transitioning from campaign budget optimization to non-campaign budget optimization, the default_ad_group_budget_in_micro_currency will propagate to each child ad groups daily budget. Unit is micro currency of the associated advertiser account. example: 0 nullable: true is_automated_campaign: type: boolean default: false allOf: - $ref: '#/components/schemas/CampaignIsAutomatedCampaign' EnhancedMatchStatusType: description: The enhanced match status of the tag enum: - UNKNOWN - NOT_VALIDATED - VALIDATING_IN_PROGRESS - VALIDATION_COMPLETE - null example: VALIDATION_COMPLETE nullable: true title: EnhancedMatchStatusType type: string BillingProfilesResponse: type: object properties: id: description: Billing ID. type: string pattern: ^\d+$ example: '12312451231' card_type: description: Type of the card. type: string enum: - UNKNOWN - VISA - MASTERCARD - AMERICAN_EXPRESS - DISCOVER - ELO example: VISA status: description: Status of the billing. type: string enum: - UNSPECIFIED - VALID - INVALID - PENDING - DELETED - SECONDARY - PENDING_SECONDARY example: INVALID advertiser_id: description: Advertiser ID of the billing. type: string pattern: ^\d+$ example: '12312451231' payment_method_brand: description: Brand of the payment method. type: string enum: - UNKNOWN - VISA - MASTERCARD - AMERICAN_EXPRESS - DISCOVER - SOFORT - DINERS_CLUB - ELO - CARTE_BANCAIRE example: VISA KeywordsResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/KeywordError' keywords: type: array items: $ref: '#/components/schemas/Keyword' AdPreviewRequest: oneOf: - example: image_url: https://somewebsite.com/someimage.jpg title: My Preview Image properties: image_url: description: Image URL. example: https://somewebsite.com/someimage.jpg title: image_url type: string title: description: Title displayed below ad. example: My Preview Image title: title type: string required: - image_url - title title: AdPreviewCreateFromImage type: object - example: pin_id: '7389479023' properties: pin_id: description: Pin ID. example: '7389479023' title: pin_id type: string required: - pin_id title: AdPreviewCreateFromPin type: object Error: title: Error type: object properties: code: type: integer message: type: string required: - code - message AudienceType: description: Audience type enum: - CUSTOMER_LIST - VISITOR - ENGAGEMENT - ACTALIKE - PERSONA example: ACTALIKE title: AudienceType type: string ProductGroupPromotionResponse: type: object title: ProductGroupPromotionResponse properties: items: type: array items: $ref: '#/components/schemas/ProductGroupPromotionResponseItem' LeadFormResponse: type: object allOf: - $ref: '#/components/schemas/LeadFormCommon' - type: object properties: id: description: The ID of this lead form example: '7765300871171' type: string pattern: ^\d+$ ad_account_id: description: The Ad Account ID that this lead form belongs to. example: '549755885175' type: string pattern: ^\d+$ created_time: description: Lead form creation time. Unix timestamp in seconds. example: 1451431341 type: integer updated_time: description: Last update time. Unix timestamp in seconds. example: 1451431341 type: integer Exception: title: Generic exception class to be used within schemas type: object properties: code: type: integer example: 2 description: Exception error code. message: type: string example: Advertiser not found. description: Exception message. ConversionTagsOcpmEligibleResponse: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ConversionEventResponse' example: '12345': - conversion_event: PAGE_LOAD created_time: 1564768710 conversion_tag_id: '2614324385652' ad_account_id: '549757463328' - conversion_event: CHECKOUT created_time: 1564710210 conversion_tag_id: '2614324315793' ad_account_id: '549757463328' AdsCreditDiscountsResponse: type: object properties: active: description: True if the offer code is currently active. type: boolean example: true advertiser_id: description: Advertiser ID the offer was applied to. type: string pattern: ^\d+$ example: '12312451231' discountType: description: The type of discount of this credit type: string nullable: true enum: - COUPON - CREDIT - COUPON_APPLIED - CREDIT_APPLIED - MARKETING_OFFER_CREDIT - MARKETING_OFFER_CREDIT_APPLIED - GOODWILL_CREDIT - GOODWILL_CREDIT_APPLIED - INTERNAL_CREDIT - INTERNAL_CREDIT_APPLIED - PREPAID_CREDIT - PREPAID_CREDIT_APPLIED - SALES_INCENTIVE_CREDIT - SALES_INCENTIVE_CREDIT_APPLIED - CREDIT_EXPIRED - FUTURE_CREDIT - REFERRAL_CREDIT - INVOICE_SALES_INCENTIVE_CREDIT - INVOICE_SALES_INCENTIVE_CREDIT_APPLIED - PREPAID_CREDIT_REFUND - null discountInMicroCurrency: description: The discount applied in the offers currency value. type: number nullable: true example: 125000000 discountCurrency: type: string nullable: true description: Currency value for the discount. example: USD title: description: Human readable title of the offer code. type: string nullable: true example: Ads Credits remainingDiscountInMicroCurrency: type: number nullable: true description: The credits left to spend. example: 125000000 AudienceDefinitionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AudienceDefinition' ProductGroupAnalyticsResponse: type: array items: type: object properties: PRODUCT_GROUP_ID: description: The ID of the product group that this metrics belongs to. type: string pattern: ^\d+$ DATE: description: Current metrics date. Only returned when granularity is a time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`) type: string format: date required: - PRODUCT_GROUP_ID additionalProperties: true example: DATE: '2021-04-01' PRODUCT_GROUP_ID: '74629351736530' SPEND_IN_DOLLAR: 30 TOTAL_CLICKTHROUGH: 216 SSIOAccountPMPName: type: object properties: name: description: Display name example: Bidalgo type: string id: description: Salesforce id for PMP example: 0011N00001LW2aSQAT type: string TargetingSpec: description: Ad group targeting specification defining the ad group target audience. For example, `{"APPTYPE":["iphone"], "GENDER":["male"], "LOCALE":["en-US"], "LOCATION":["501"], "AGE_BUCKET":["25-34"]}` type: object properties: AGE_BUCKET: type: array nullable: true description: Age ranges. If the AGE_BUCKET field is missing, the default behavior in terms of ad delivery is that **All age buckets** will be targeted. example: - 35-44 - 50-54 items: type: string enum: - 18-24 - 21+ - 25-34 - 35-44 - 45-49 - 50-54 - 55-64 - 65+ APPTYPE: type: array nullable: true description: Allowed devices. If the APPTYPE field is missing, the default behavior in terms of ad delivery is that **All devices/apptypes** will be targeted. example: - ipad - iphone items: type: string enum: - android_mobile - android_tablet - ipad - iphone - web - web_mobile AUDIENCE_EXCLUDE: type: array nullable: true description: 'Excluded customer list IDs. Used to drive new customer acquisition goals. For example: ["2542620905475"]. Audience lists need to have at least 100 people with Pinterest accounts in them. If the AUDIENCE_EXCLUDE field is missing, the default behavior in terms of ad delivery is that **No users will be excluded**.' items: type: string pattern: ^\d+$ minItems: 100 AUDIENCE_INCLUDE: type: array nullable: true description: 'Targeted customer list IDs. For example: ["2542620905473"]. Audience lists need to have at least 100 people with Pinterest accounts in them Audience lists need to have at least 100 people with Pinterest accounts in them. If the AUDIENCE_INCLUDE field is missing, the default behavior in terms of ad delivery is that **All users will be included**.' items: type: string pattern: ^\d+$ minItems: 100 GENDER: type: array nullable: true description: 'Targeted genders. Values: ["unknown","male","female"]. If the GENDER field is missing, the default behavior in terms of ad delivery is that **All genders will be targeted**.' items: type: string enum: - unknown - male - female GEO: type: array nullable: true description: Location region codes, e.g., "BE-VOV" (East Flanders, Belgium) For complete list, click here or postal codes, e.g., "US-94107". Use either region codes or postal codes but not both. At least one of LOCATION or GEO must be specified. If the GEO field is missing, then only LOCATION values will be targeted (see LOCATION field below). items: type: string INTEREST: type: array description: Array of interest object IDs. If the INTEREST field is missing, the default behavior in terms of ad delivery is that **All interests will be targeted**. items: type: string LOCALE: type: array nullable: true description: 24 ISO 639-1 two letter language codes. If the LOCALE field is missing, the default behavior in terms of ad delivery is that **All languages will be targeted, only english non-sublanguage will be targeted**. items: type: string LOCATION: type: array nullable: true description: 22 ISO Alpha 2 two letter country codes or US Nielsen DMA (Designated Market Area) codes (location region codes) (e.g., ["US", "807"]). For complete list, click here. Location-Country and Location-Metro codes apply. At least one of LOCATION or GEO must be specified. If the LOCATION field is missing, then only GEO values will be targeted (see GEO field above). items: type: string SHOPPING_RETARGETING: type: array nullable: true description: "Array of object: lookback_window\t[Integer]: Number of days ago to start lookback timeframe for dynamic retargeting tag_types [Array of integer]: Event types to target for dynamic retargeting exclusion_window [Integer]: Number of days ago to stop lookback timeframe for dynamic retargeting" items: type: object example: lookback_window: 30 exclusion_window: 14 tag_types: - 0 - 6 properties: lookback_window: description: Number of days ago to start lookback timeframe for dynamic retargeting example: 30 title: lookback_window type: integer tag_types: description: Event types to target for dynamic retargeting example: - 0 - 6 items: type: integer title: tag_types type: array exclusion_window: description: Number of days ago to stop lookback timeframe for dynamic retargeting example: 14 title: exclusion_window type: integer title: TargetingSpec_SHOPPING_RETARGETING TARGETING_STRATEGY: type: array nullable: true description: '' items: enum: - CHOOSE_YOUR_OWN - FIND_NEW_CUSTOMERS - RECONNECT_WITH_USERS LeadFormQuestion: type: object properties: question_type: $ref: '#/components/schemas/LeadFormQuestionType' custom_question_field_type: $ref: '#/components/schemas/LeadFormQuestionFieldType' custom_question_label: description: Question label for a custom question. nullable: true type: string custom_question_options: description: Question options for a custom question. nullable: true type: array minItems: 0 maxItems: 5 items: type: string ConversionEventsUserData: description: Object containing customer information data. Note, It is required at least one of 1) em, 2) hashed_maids or 3) pair client_ip_address + client_user_agent. type: object anyOf: - properties: em: description: Sha256 hashes of lowercase version of user's email addresses. Used for matching. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 411e44ce1261728ffd2c0686e44e3fffe413c0e2c5adc498bc7da883d476b9c8 - 09831ea51bd1b7b32a836683a00a9ccaf3d05f59499f42d9883412ed79289969 hashed_maids: description: Sha256 hashes of user's "Google Advertising IDs" (GAIDs) or "Apple's Identifier for Advertisers" (IDFAs). Used for matching. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 0192518eb84137ccfe82c8b6322d29631dae7e28ed9d0f6dd5f245d73a58c5f1 - 837b850ac46d62b2272a71de73c27801ff011ac1e36c5432620c8755cf90db46 client_ip_address: description: The user's IP address, which can be either in IPv4 or IPv6 format. Used for matching. We highly recommend this for all events. It may improve reporting performance such as ROAS/CPA. type: string example: 216.3.128.12 client_user_agent: description: The user agent string of the user's web browser. We highly recommend this for all events. It may improve reporting performance such as ROAS/CPA. type: string example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.87 Safari/537.36 required: - em - properties: em: description: Sha256 hashes of lowercase version of user's email addresses. Used for matching. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 411e44ce1261728ffd2c0686e44e3fffe413c0e2c5adc498bc7da883d476b9c8 - 09831ea51bd1b7b32a836683a00a9ccaf3d05f59499f42d9883412ed79289969 hashed_maids: description: Sha256 hashes of user's "Google Advertising IDs" (GAIDs) or "Apple's Identifier for Advertisers" (IDFAs). Used for matching. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 0192518eb84137ccfe82c8b6322d29631dae7e28ed9d0f6dd5f245d73a58c5f1 - 837b850ac46d62b2272a71de73c27801ff011ac1e36c5432620c8755cf90db46 client_ip_address: description: The user's IP address, which can be either in IPv4 or IPv6 format. Used for matching. We highly recommend this for all events. It may improve reporting performance such as ROAS/CPA. type: string example: 216.3.128.12 client_user_agent: description: The user agent string of the user's web browser. We highly recommend this for all events. It may improve reporting performance such as ROAS/CPA. type: string example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.87 Safari/537.36 required: - hashed_maids - properties: em: description: Sha256 hashes of lowercase version of user's email addresses. Used for matching. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 411e44ce1261728ffd2c0686e44e3fffe413c0e2c5adc498bc7da883d476b9c8 - 09831ea51bd1b7b32a836683a00a9ccaf3d05f59499f42d9883412ed79289969 hashed_maids: description: Sha256 hashes of user's "Google Advertising IDs" (GAIDs) or "Apple's Identifier for Advertisers" (IDFAs). Used for matching. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 0192518eb84137ccfe82c8b6322d29631dae7e28ed9d0f6dd5f245d73a58c5f1 - 837b850ac46d62b2272a71de73c27801ff011ac1e36c5432620c8755cf90db46 client_ip_address: description: The user's IP address, which can be either in IPv4 or IPv6 format. Used for matching. We highly recommend this for all events. It may improve reporting performance such as ROAS/CPA. type: string example: 216.3.128.12 client_user_agent: description: The user agent string of the user's web browser. We highly recommend this for all events. It may improve reporting performance such as ROAS/CPA. type: string example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.87 Safari/537.36 required: - client_ip_address - client_user_agent properties: ph: description: Sha256 hashes of user's phone numbers, only digits with country code, area code, and number. Remove any symbols, letters, spaces and leading zeros. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 45df139772a81b6011bdc1c9cc3d1cb408fc0b10ec0c5cb9d4d4e107f0ddc49d ge: description: Sha256 hashes of user's gender, in lowercase. Either "f" or "m" or "n" for non-binary gender. type: array items: type: string example: - 0d248e82c62c9386878327d491c762a002152d42ab2c391a31c44d9f62675ddf db: description: Sha256 hashes of user's date of birthday, given as year, month, and day. type: array items: type: string example: - d4426a0086d10f12ad265539ae8d54221dc67786053d511407204b76e99d7739 ln: description: Sha256 hashes of user's last name, in lowercase. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 7e546b3aa43f989dd359672e6c3409d4f9d4e8f155ae1e9b90ee060985468c19 fn: description: Sha256 hashes of user's first name, in lowercase. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - ec1e6a072231703f1bc41429052fff8c00a7e0c6aaec2e7107241ca8f3ceb6b2 ct: description: Sha256 hashes of user's city, in lowercase, and without spaces or punctuation. User residency city (mostly billing). type: array items: type: string example: - 4ac01a129bfd10385c9278c2cf2c46fac5ab57350841234f587c8522a2e4ce36 st: description: Sha256 hashes of user's state, given as a two-letter code in lowercase. User residency state (mostly billing). type: array items: type: string example: - 49a6d05b8e4b516656e464271d9dd38d0a7e0142f7f49546f4dabd2720cafc34 zp: description: Sha256 hashes of user's zipcode, only digits. User residency zipcode (mostly billing). type: array items: type: string example: - fd5f56b40a79a385708428e7b32ab996a681080a166a2206e750eb4819186145 country: description: Sha256 hashes of two-character ISO-3166 country code indicating the user's country, in lowercase. type: array items: type: string example: - 9b202ecbc6d45c6d8901d989a918878397a3eb9d00e8f48022fc051b19d21a1d external_id: description: Sha256 hashes of the unique id from the advertiser that identifies a user in their space, e.g. user id, loyalty id, etc. We highly recommend this on all events. It may improve reporting performance such as ROAS/CPA. type: array items: type: string example: - 6a7a73766627eb611720883d5a11cc62b5bfee237b00a6658d78c50032ec4aee click_id: description: The unique identifier stored in _epik cookie on your domain or &epik= query parameter in the URL. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. type: string example: dj0yJnU9b2JDcFFHekV4SHJNcmVrbFBkUEdqakh0akdUT1VjVVUmcD0yJm49cnNBQ3F2Q2dOVDBXWWhkWklrUGxBUSZ0PUFBQUFBR1BaY3Bv nullable: true partner_id: description: A unique identifier of visitors' information defined by third party partners. e.g RampID type: string example: BUJrTlRRzGJmWhRXFZdkioV6wKPBve7Lom__GU9J74hq2NIQj4O3nOZJrp3mcUr5MptkXsI14juMOIM9mNZnM4zEUFT2JLVaFhcOfuuWz3IWEDtBf6I0DPc nullable: true SSIOInsertionOrderStatus: type: object properties: pin_order_id: description: Salesforce order id example: 0Q01N0000015hekSAB type: string status: description: Salesforce insertion order status example: Approved type: string creation_time: description: Salesforce insertion order creation time example: '2017-06-21T23:11:11.000Z' type: string nullable: true ConversionTagCommon: type: object properties: ad_account_id: description: Ad account ID. example: '549755885175' title: ad_account_id type: string code_snippet: description: Tag code snippet. example: