Pinterest Targeting API
The Targeting API from Pinterest — 1 operation(s) for targeting.
OpenAPI Specification
openapi: 3.0.3
info:
version: 5.13.0
title: Pinterest Targeting 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: Targeting
paths:
/resources/targeting/{targeting_type}:
get:
summary: Get targeting options
description: '<p>You can use targeting values in ads placement to define your intended audience. </p> <p>Targeting metrics are organized around targeting specifications.</p> <p>For more information on ads targeting, see <a class="reference external" href="https://help.pinterest.com/en/business/article/audience-targeting" target="_blank">Audience targeting</a>.</p>
<p><b>Sample return:</b></p> <pre class="literal-block"> [{"36313": "Australia: Moreton Bay - North", "124735": "Canada: North Battleford", "36109": "Australia: Murray", "36108": "Australia: Mid North Coast", "36101": "Australia: Capital Region", "811": "U.S.: Reno", "36103": "Australia: Central West", "36102": "Australia: Central Coast", "36105": "Australia: Far West and Orana", "36104": "Australia: Coffs Harbour - Grafton", "36107": "Australia: Illawarra", "36106": "Australia: Hunter Valley Exc Newcastle", "554017": "New Zealand: Wanganui", "554016": "New Zealand: Marlborough", "554015": "New Zealand: Gisborne", "554014": "New Zealand: Tararua", "554013": "New Zealand: Invercargill", "GR": "Greece", "554011": "New Zealand: Whangarei", "554010": "New Zealand: Far North", "717": "U.S.: Quincy-Hannibal-Keokuk", "716": "U.S.: Baton Rouge",...}] </pre>'
operationId: targeting_options/get
security:
- pinterest_oauth2:
- ads:read
x-ratelimit-category: ads_read
x-sandbox: enabled
parameters:
- $ref: '#/components/parameters/path_targeting_type'
- $ref: '#/components/parameters/query_client_id'
- $ref: '#/components/parameters/query_oauth_signature'
- $ref: '#/components/parameters/query_timestamp'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TargetingOptionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
tags:
- Targeting
components:
schemas:
TargetingOptionResponse:
title: TargetingOptionResponse
type: array
nullable: true
items:
type: object
example:
'36313': 'Australia: Moreton Bay - North'
'124735': 'Canada: North Battleford'
Error:
title: Error
type: object
properties:
code:
type: integer
message:
type: string
required:
- code
- message
parameters:
query_timestamp:
name: timestamp
description: Timestamp
in: query
required: false
schema:
type: string
example: '1618338184277'
pattern: \d+
style: form
query_client_id:
name: client_id
description: Client ID.
in: query
required: false
schema:
type: string
pattern: ^\d+$
maxLength: 18
example: '1094834'
style: form
query_oauth_signature:
name: oauth_signature
description: Oauth signature
in: query
required: false
schema:
type: string
example: 8209f
style: form
path_targeting_type:
name: targeting_type
description: Public targeting type.
in: path
required: true
style: simple
schema:
title: PublicTargetingType
description: Public ad targeting type with external names
type: string
example: APPTYPE
enum:
- APPTYPE
- GENDER
- LOCALE
- AGE_BUCKET
- LOCATION
- GEO
- INTEREST
- KEYWORD
- AUDIENCE_INCLUDE
- AUDIENCE_EXCLUDE
securitySchemes:
pinterest_oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://www.pinterest.com/oauth/
tokenUrl: https://api.pinterest.com/v5/oauth/token
scopes:
ads:read: See all of your advertising data, including ads, ad groups, campaigns etc.
ads:write: Create, update, or delete ads, ad groups, campaigns etc.
billing:read: See all of your billing data, billing profile, etc.
billing:write: Create, update, or delete billing data, billing profiles, etc.
biz_access:read: See business access data
biz_access:write: Create, update, or delete business access data
boards:read: See your public boards, including group boards you join
boards:read_secret: See your secret boards
boards:write: Create, update, or delete your public boards
boards:write_secret: Create, update, or delete your secret boards
catalogs:read: See all of your catalogs data
catalogs:write: Create, update, or delete your catalogs data
pins:read: See your public Pins
pins:read_secret: See your secret Pins
pins:write: Create, update, or delete your public Pins
pins:write_secret: Create, update, or delete your secret Pins
user_accounts:read: See your user accounts and followers
user_accounts:write: Update your user accounts and followers
conversion_token:
type: http
scheme: bearer
description: This security scheme only applies to the conversion events endpoint (POST /ad_accounts/{ad_account_id}/events). This endpoint requires a bearer token generated via Ads Manager (ads.pinterest.com).
basic:
type: http
scheme: basic
x-tagGroups:
- name: Pin and Boards
tags:
- pins
- boards
- media
- aggregated_comments
- aggregated_pin_data
- user_account
- name: Campaign Management
tags:
- ad_accounts
- campaigns
- ad_groups
- ads
- product_group_promotions
- bulk
- name: Targeting
tags:
- audiences
- customer_lists
- keywords
- targeting_template
- audience_insights
- audience_sharing
- name: Ad Formats
tags:
- lead_forms
- lead_ads
- leads_export
- name: Billing
tags:
- billing
- order_lines
- terms_of_service
- name: Business Access
tags:
- business_access_assets
- business_access_invite
- business_access_relationships
- name: Conversions
tags:
- conversion_events
- conversion_tags
- name: Others
tags:
- integrations
- oauth
- resources
- search
- terms
- name: Shopping
tags:
- catalogs
- name: Deprecated
tags:
- product_groups