diff --git a/.github/scripts/backup-collection.js b/.github/scripts/backup-collection.js new file mode 100644 index 0000000..bde33fa --- /dev/null +++ b/.github/scripts/backup-collection.js @@ -0,0 +1,56 @@ +const axios = require('axios'); +const fs = require('fs'); + +async function backupCollection() { + try { + // First, try to find "latest" collection by name (preferred) + // Fall back to COLLECTION_UID if "latest" doesn't exist yet + let collectionUid = process.env.COLLECTION_UID; + let collectionName = 'unknown'; + + if (process.env.POSTMAN_API_KEY) { + try { + const collectionsResponse = await axios({ + method: 'get', + url: 'https://api.getpostman.com/collections', + headers: { 'X-Api-Key': process.env.POSTMAN_API_KEY } + }); + + const latestCollection = collectionsResponse.data.collections.find(c => c.name === 'latest'); + if (latestCollection) { + collectionUid = latestCollection.uid; + collectionName = 'latest'; + console.log('Found "latest" collection, using UID:', collectionUid); + } else { + console.log('No "latest" collection found, using COLLECTION_UID:', collectionUid); + } + } catch (error) { + console.log('Could not fetch collections list, using COLLECTION_UID:', collectionUid); + } + } + + const url = 'https://api.getpostman.com/collections/' + collectionUid; + console.log('Backup URL:', url); + + console.log('Making backup request...'); + const config = { + method: 'get', + url, + headers: { + 'X-Api-Key': process.env.POSTMAN_API_KEY + } + }; + + const response = await axios(config); + + const backupPath = './postman/backup/collection_' + process.env.TIMESTAMP + '.json'; + fs.writeFileSync(backupPath, JSON.stringify(response.data, null, 2)); + console.log('Backup created successfully at:', backupPath); + console.log('Backed up collection:', collectionName, '(UID:', collectionUid + ')'); + } catch (error) { + console.error('Backup failed:', error.response?.data || error.message); + process.exit(1); + } +} + +backupCollection(); \ No newline at end of file diff --git a/.github/scripts/update-collection.js b/.github/scripts/update-collection.js new file mode 100644 index 0000000..05dbacc --- /dev/null +++ b/.github/scripts/update-collection.js @@ -0,0 +1,93 @@ +const axios = require('axios'); +const fs = require('fs'); + +async function versionCollection() { + try { + console.log('Starting collection versioning process...'); + + // Get all collections + const collectionsResponse = await axios({ + method: 'get', + url: 'https://api.getpostman.com/collections', + headers: { 'X-Api-Key': process.env.POSTMAN_API_KEY } + }); + + const collections = collectionsResponse.data.collections; + console.log('Found collections:', collections.map(c => c.name)); + + // Always find the "latest" collection by name, not by UID + // This ensures we always work with the current "latest" regardless of UID changes + let currentCollection = collections.find(c => c.name === 'Pinterest REST API latest'); + + // Fallback: if no "latest" exists, use COLLECTION_UID (for first-time setup) + if (!currentCollection && process.env.COLLECTION_UID) { + currentCollection = collections.find(c => c.uid === process.env.COLLECTION_UID); + console.log('No "Pinterest REST API latest" collection found, using COLLECTION_UID as starting point'); + } + + if (!currentCollection) { + throw new Error('Could not find "Pinterest REST API latest" collection or collection with COLLECTION_UID'); + } + console.log('Current collection:', currentCollection.name, '(UID:', currentCollection.uid + ')'); + + // Find highest version number from existing Pinterest REST API collections + let highestVersion = { major: 5, minor: 14, patch: 0 }; // Start from 5.14.0 as example + collections.forEach(collection => { + // Look for "Pinterest REST API X.Y.Z" pattern + const match = collection.name.match(/^Pinterest REST API (\d+)\.(\d+)\.(\d+)$/); + if (match) { + const version = { + major: parseInt(match[1]), + minor: parseInt(match[2]), + patch: parseInt(match[3]) + }; + if (version.major > highestVersion.major || + (version.major === highestVersion.major && version.minor > highestVersion.minor)) { + highestVersion = version; + } + } + }); + + // Calculate next version (increment minor) + const nextVersion = `${highestVersion.major}.${highestVersion.minor + 1}.${highestVersion.patch}`; + const nextVersionName = `Pinterest REST API ${nextVersion}`; + console.log('Next version:', nextVersionName); + + // Rename current collection to version number + await axios({ + method: 'put', + url: `https://api.getpostman.com/collections/${currentCollection.uid}`, + headers: { + 'X-Api-Key': process.env.POSTMAN_API_KEY, + 'Content-Type': 'application/json' + }, + data: { collection: { info: { name: nextVersionName } } } + }); + console.log('Renamed current collection to:', nextVersionName); + + // Create new "Pinterest REST API latest" collection + const newCollectionData = JSON.parse(fs.readFileSync('./postman/collection.json')); + newCollectionData.info.name = 'Pinterest REST API latest'; + + const createResponse = await axios({ + method: 'post', + url: 'https://api.getpostman.com/collections', + headers: { + 'X-Api-Key': process.env.POSTMAN_API_KEY, + 'Content-Type': 'application/json' + }, + data: { collection: newCollectionData } + }); + + console.log('Created new "Pinterest REST API latest" collection'); + console.log('New collection UID:', createResponse.data.collection.uid); + console.log('✅ Process complete! The "Pinterest REST API latest" collection is now ready for future updates.'); + console.log('Note: COLLECTION_UID secret can remain unchanged - script will always find "Pinterest REST API latest" by name.'); + + } catch (error) { + console.error('Error:', error.response?.data || error.message); + process.exit(1); + } +} + +versionCollection(); \ No newline at end of file diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..431140d --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,54 @@ +name: Transform OpenAPI to Postman Collection + +on: + push: + branches: [ main ] + paths: + - 'v5/openapi.yaml' + - 'v5/openapi.json' + +jobs: + sync-to-postman: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + + - name: Install Dependencies + run: | + npm install -g openapi-to-postmanv2 + npm install axios + + - name: Backup Current Postman Collection + env: + POSTMAN_API_KEY: ${{ secrets.POSTMAN_API_KEY }} + COLLECTION_UID: ${{ secrets.POSTMAN_COLLECTION_UID }} + TIMESTAMP: $(date +%Y%m%d_%H%M%S) + run: | + mkdir -p ./postman/backup + node .github/scripts/backup-collection.js + + - name: Upload Backup as Artifact + uses: actions/upload-artifact@v4 + with: + name: postman-collection-backup + path: ./postman/backup/collection_*.json + retention-days: 90 + + - name: Convert OpenAPI to Postman Collection + run: | + openapi2postmanv2 \ + -s ./v5/openapi.yaml \ + -o ./postman/collection.json \ + -p \ + --pretty + + - name: Version and Create New Postman Collection + env: + POSTMAN_API_KEY: ${{ secrets.POSTMAN_API_KEY }} + COLLECTION_UID: ${{ secrets.POSTMAN_COLLECTION_UID }} + run: node .github/scripts/update-collection.js diff --git a/v5/openapi.json b/v5/openapi.json index a38d2bf..f26d2de 100644 --- a/v5/openapi.json +++ b/v5/openapi.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "5.14.0", + "version": "5.15.0", "title": "Pinterest REST API", "description": "Pinterest's REST API", "contact": { @@ -42,7 +42,7 @@ }, { "name": "audience_sharing", - "description": "View, share, or revoke shared audiences.
\nAudience Sharing endpoints are not available to all apps,\nif you are interested in using them, reach out to us on our help center page.\nLearn more." + "description": "View, share, or revoke shared audiences.
\nAudience Sharing endpoints are not available to all apps,\nif you are interested in using them, reach out to us on our help center page.\nLearn more." }, { "name": "audiences", @@ -64,6 +64,31 @@ "name": "campaigns", "description": "View, create or update campaigns." }, + { + "name": "catalog_feeds", + "description": "View and manage catalog feeds.", + "x-display-name": "feeds" + }, + { + "name": "catalog_items", + "description": "View and manage catalog items directly without a feed.", + "x-display-name": "items" + }, + { + "name": "catalog_product_groups", + "description": "View and manage catalog product groups using filters.", + "x-display-name": "product_groups" + }, + { + "name": "catalog_regions", + "description": "View and manage catalog regions defined by sets of postal codes.", + "x-display-name": "regions" + }, + { + "name": "catalog_reports", + "description": "View and manage reports about catalogs.", + "x-display-name": "reports" + }, { "name": "catalogs", "description": "Manage information about shopping product catalogs and items." @@ -104,6 +129,10 @@ "name": "media", "description": "Register and manage media uploads." }, + { + "name": "msot_events", + "description": "Submit Measurement Source of Truth attributed conversion events via the Pinterest API." + }, { "name": "oauth", "description": "Generate and refresh OAuth access tokens." @@ -120,6 +149,10 @@ "name": "product_group_promotions", "description": "View, create, update, or delete information about promoted product groups." }, + { + "name": "promotions", + "description": "View, create, update, or delete promotions." + }, { "name": "resources", "description": "View metadata about available metrics and targeting options in the Pinterest API." @@ -154,7 +187,8 @@ "media", "aggregated_comments", "aggregated_pin_data", - "user_account" + "user_account", + "entity_history" ] }, { @@ -184,7 +218,8 @@ "tags": [ "lead_forms", "lead_ads", - "leads_export" + "leads_export", + "promotions" ] }, { @@ -207,7 +242,8 @@ "name": "Conversions", "tags": [ "conversion_events", - "conversion_tags" + "conversion_tags", + "msot_events" ] }, { @@ -224,7 +260,12 @@ { "name": "Shopping", "tags": [ - "catalogs" + "catalogs", + "catalog_feeds", + "catalog_product_groups", + "catalog_reports", + "catalog_items", + "catalog_regions" ] } ], @@ -242,6 +283,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -356,6 +402,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -402,6 +453,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -489,7 +545,7 @@ }, "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 advertiser’s 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\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.", + "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.\nNotes:\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 advertiser’s 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\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- Certain organizations with closed beta access can set `start_time` and `end_time` at the ad group level for campaigns with Campaign Budget Optimization (CBO) objectives: `TRAFFIC`, `AWARENESS`, `WEB_CONVERSIONS`, and `CATALOG_SALES`. All other organizations can set these scheduling parameters for non-CBO campaigns only.\n- If the parent ad campaign has start and end times set, ad group start and end times must occur within the parent campaign schedule. ", "operationId": "ad_groups/create", "security": [ { @@ -611,13 +667,18 @@ "/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.\n- 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.\n- 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.\n- 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.", + "description": "Get analytics for the specified ad groups in the specified ad_account_id, filtered by the specified options.\n- 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.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "ad_groups/analytics", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -652,6 +713,9 @@ }, { "$ref": "#/components/parameters/query_conversion_attribution_conversion_report_time" + }, + { + "$ref": "#/components/parameters/aggregate_report_rows" } ], "responses": { @@ -698,13 +762,18 @@ "/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.\nFor the requested ad group(s) and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.", + "description": "Get targeting analytics for one or more ad groups.\nFor the requested ad group(s) and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "ad_groups_targeting_analytics/get", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -784,6 +853,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -860,13 +934,18 @@ "/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\ncontain additional information from the Ad Review process.\nFor more information about our policies and rejection reasons see the Pinterest advertising standards.", + "description": "Get a specific ad group given the ad group ID.", "operationId": "ad_groups/get", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -991,6 +1070,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -1200,13 +1284,18 @@ "/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.\n- 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.\n- The request must contain either ad_ids or both campaign_ids and pin_ids.\n- 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.\n- 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.", + "description": "Get analytics for the specified ads in the specified ad_account_id, filtered by the specified options.\n- 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.\n- The request must contain either ad_ids or both campaign_ids and pin_ids.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "ads/analytics", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -1305,7 +1394,7 @@ "/ad_accounts/{ad_account_id}/ads_credit/discounts": { "get": { "summary": "Get ads credit discounts", - "description": "Returns the list of discounts applied to the account.\n\nThis endpoint might not be available to all apps. Learn more.", + "description": "Returns the list of discounts applied to the account.\n\nThis endpoint might not be available to all apps. Learn more.", "operationId": "ads_credits_discounts/get", "security": [ { @@ -1373,7 +1462,7 @@ "/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.\n\nThis endpoint might not be available to all apps. Learn more.", + "description": "Redeem ads credit on behalf of the ad account id and apply it towards billing.\n\nThis endpoint might not be available to all apps. Learn more.", "tags": [ "billing" ], @@ -1449,13 +1538,18 @@ "/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,\nthe response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type\n(e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.", + "description": "Get targeting analytics for one or more ads. For the requested ad(s) and metrics,\nthe response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type\n(e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "ad_targeting_analytics/get", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -1535,6 +1629,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -1577,13 +1676,18 @@ "/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.\n- 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.\n- 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.\n- If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time.", + "description": "Get analytics for the specified ad_account_id, filtered by the specified options.\n- 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.\n- 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.\n- If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "ad_account/analytics", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -1668,6 +1772,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -1717,6 +1826,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -1882,6 +1996,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -2055,6 +2174,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -2145,7 +2269,7 @@ "/ad_accounts/{ad_account_id}/audiences/ad_accounts/shared": { "patch": { "summary": "Update audience sharing between ad accounts", - "description": "From an ad account, share a specific audience with another ad account, or revoke access to a previously shared audience. Only the audience owner account can share the audience. The recipient ad account(s) must be in the same Pinterest Business Hierarchy as the business owner of the ad account.
This endpoint is not available to all apps.Learn more.", + "description": "From an ad account, share a specific audience with another ad account, or revoke access to a previously shared audience. Only the audience owner account can share the audience. The recipient ad account(s) must be in the same Pinterest Business Hierarchy as the business owner of the ad account.
This endpoint is not available to all apps.Learn more.", "operationId": "update_ad_account_to_ad_account_shared_audience", "security": [ { @@ -2215,7 +2339,7 @@ "/ad_accounts/{ad_account_id}/audiences/businesses/shared": { "patch": { "summary": "Update audience sharing from an ad account to businesses", - "description": "From an ad account, share a specific audience with a business account, or revoke access to a previously shared audience. Only the audience owner account can share the audience. The recipient business account must be in the same business hierarchy as the business owner of the ad account.
This endpoint is not available to all apps.Learn more.", + "description": "From an ad account, share a specific audience with a business account, or revoke access to a previously shared audience. Only the audience owner account can share the audience. The recipient business account must be in the same business hierarchy as the business owner of the ad account.
This endpoint is not available to all apps.Learn more.", "operationId": "update_ad_account_to_business_shared_audience", "security": [ { @@ -2291,6 +2415,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -2342,7 +2471,7 @@ "/ad_accounts/{ad_account_id}/billing_profiles": { "get": { "summary": "Get billing profiles", - "description": "Get billing profiles in the advertiser account.\n\nThis endpoint might not be available to all apps. Learn more.", + "description": "Get billing profiles in the advertiser account.\n\nThis endpoint might not be available to all apps. Learn more.", "operationId": "billing_profiles/get", "security": [ { @@ -2416,6 +2545,170 @@ } } }, + "/ad_accounts/{ad_account_id}/billing_invoices": { + "get": { + "summary": "Get billing invoices", + "description": "Get billing invoices in the advertiser account.", + "operationId": "billing_invoices/get", + "security": [ + { + "pinterest_oauth2": [ + "ads:read", + "billing:read" + ] + } + ], + "x-ratelimit-category": "ads_read", + "x-sandbox": "disabled", + "parameters": [ + { + "$ref": "#/components/parameters/path_ad_account_id" + }, + { + "$ref": "#/components/parameters/query_bookmark" + }, + { + "$ref": "#/components/parameters/query_page_size" + }, + { + "$ref": "#/components/parameters/query_sort_billing_invoice" + }, + { + "$ref": "#/components/parameters/query_order" + }, + { + "$ref": "#/components/parameters/query_billing_invoice_status" + }, + { + "$ref": "#/components/parameters/query_billing_document_type" + }, + { + "$ref": "#/components/parameters/query_billing_start_due_date" + }, + { + "$ref": "#/components/parameters/query_billing_end_due_date" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Paginated" + }, + { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BillingInvoiceResponse" + } + } + } + } + ] + } + } + } + }, + "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": [ + "billing" + ] + } + }, + "/ad_accounts/{ad_account_id}/billing_invoice/{billing_invoice_id}/download": { + "get": { + "summary": "Get download url for a billing invoice", + "description": "Get download url for a billing invoice.", + "operationId": "billing_invoice_download/get", + "security": [ + { + "pinterest_oauth2": [ + "ads:read", + "billing:read" + ] + } + ], + "x-ratelimit-category": "ads_read", + "x-sandbox": "disabled", + "parameters": [ + { + "$ref": "#/components/parameters/path_ad_account_id" + }, + { + "$ref": "#/components/parameters/path_billing_invoice_id" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BillingInvoiceDownloadResponse" + } + } + }, + "description": "Successfully fetched Billing invoice information for a given ad account" + }, + "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": [ + "billing" + ] + } + }, "/ad_accounts/{ad_account_id}/bulk/download": { "post": { "summary": "Get advertiser entities in bulk", @@ -2539,6 +2832,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -2592,6 +2890,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -2795,13 +3098,18 @@ "/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.\n- 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.\n- 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.\n- 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.", + "description": "Get analytics for the specified campaigns in the specified ad_account_id, filtered by the specified options.\n- 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.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "campaigns/analytics", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -2836,6 +3144,9 @@ }, { "$ref": "#/components/parameters/query_conversion_attribution_conversion_report_time" + }, + { + "$ref": "#/components/parameters/aggregate_report_rows" } ], "responses": { @@ -2882,13 +3193,18 @@ "/ad_accounts/{ad_account_id}/campaigns/targeting_analytics": { "get": { "summary": "Get targeting analytics for campaigns", - "description": "Get targeting analytics for one or more campaigns.\nFor the requested account and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.", + "description": "Get targeting analytics for one or more campaigns.\nFor the requested account and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "campaign_targeting_analytics/get", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -2968,6 +3284,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3017,6 +3338,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3120,6 +3446,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3167,6 +3498,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3238,6 +3574,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3411,6 +3752,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3664,6 +4010,112 @@ } } }, + "/ad_accounts/{ad_account_id}/msot/events": { + "post": { + "summary": "Send Measurement Source Of Truth (MSOT) attributed conversion events", + "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.\n
\n

Advertisers or their measurement partners can send attributed MSOT conversion events to Pinterest based on their ad_account_id. The request body should be a JSON object.

\n- These events will NOT be used in Reporting.", + "operationId": "msot_events/create", + "security": [ + { + "pinterest_oauth2": [ + "msot:write" + ] + } + ], + "x-ratelimit-category": "msot_write", + "x-sandbox": "disabled", + "parameters": [ + { + "$ref": "#/components/parameters/path_ad_account_id" + } + ], + "requestBody": { + "description": "Attributed MSOT conversion events", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversionMSOTEvents" + } + } + } + }, + "responses": { + "200": { + "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 MSOT conversion events", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + }, + "example": { + "code": 3, + "message": "Your token does not have sufficient permissions to perform this operation. Please ensure your token is authorized with the correct set of scopes." + } + } + } + }, + "403": { + "description": "Unauthorized access", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + }, + "example": { + "code": 29, + "message": "You are not permitted to access the resource" + } + } + } + }, + "429": { + "description": "This request exceeded a rate limit. This can happen if the client exceeds one\nof 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\nof the published rate limits within a short time window." + } + } + } + }, + "default": { + "description": "Unexpected errors", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + }, + "tags": [ + "msot_events" + ] + } + }, "/ad_accounts/{ad_account_id}/insights/audiences": { "get": { "summary": "Get audience insights scope and type", @@ -3674,6 +4126,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3720,6 +4177,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -3904,6 +4366,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -4258,7 +4725,7 @@ "/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.\n- List of answers should follow the questions creation order.\n\nThis endpoint is currently in beta and not available to all apps. Learn more.", + "description": "Create lead form test data based on the list of answers provided as part of the body.\n- List of answers should follow the questions creation order.", "operationId": "lead_form_test/create", "security": [ { @@ -4344,9 +4811,84 @@ } }, "/ad_accounts/{ad_account_id}/leads/subscriptions": { + "get": { + "operationId": "ad_accounts_subscriptions/get_list", + "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.", + "parameters": [ + { + "$ref": "#/components/parameters/AdAccountId" + }, + { + "$ref": "#/components/parameters/Resource.BookmarkParams.bookmark" + }, + { + "$ref": "#/components/parameters/Resource.BookmarkParams.page_size" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "items" + ], + "properties": { + "bookmark": { + "type": "string", + "nullable": true + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LeadSubscription" + } + } + } + } + } + } + }, + "403": { + "description": "Can't access this subscription.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "tags": [ + "lead_ads" + ], + "x-ratelimit-category": "ads_read", + "x-sandbox": "disabled", + "security": [ + { + "pinterest_oauth2": [ + "ads:read" + ] + } + ] + }, "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.", + "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.", "tags": [ "lead_ads" ], @@ -4430,101 +4972,23 @@ } } } - }, - "get": { - "summary": "Get lead ads subscriptions", - "description": "Get the advertiser's list of lead ads subscriptions.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n\nThis 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": [ - "lead_ads" - ] } }, "/ad_accounts/{ad_account_id}/leads/subscriptions/{subscription_id}": { "get": { "summary": "Get lead ads subscription", - "description": "Get a specific lead ads subscription record.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n\nThis endpoint is currently in beta and not available to all apps. Learn more.", + "description": "Get a specific lead ads subscription record.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.", "operationId": "ad_accounts_subscriptions/get_by_id", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -4615,7 +5079,7 @@ }, "delete": { "summary": "Delete lead ads subscription", - "description": "Delete an existing lead ads webhook subscription by ID.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.\n\nThis endpoint is currently in beta and not available to all apps. Learn more.", + "description": "Delete an existing lead ads webhook subscription by ID.\n- Only requests for the OWNER or ADMIN of the ad_account will be allowed.", "operationId": "ad_accounts_subscriptions/del_by_id", "security": [ { @@ -5270,7 +5734,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductGroupPromotionResponseItem" + "$ref": "#/components/schemas/ProductGroupPromotion" } } } @@ -5324,7 +5788,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductGroupPromotionResponse" + "$ref": "#/components/schemas/ProductGroupPromotion" } } }, @@ -5350,13 +5814,18 @@ "/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.\n- 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.\n- 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.\n- 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.", + "description": "Get analytics for the specified product groups in the specified ad_account_id, filtered by the specified options.\n- 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.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "product_groups/analytics", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -5434,11 +5903,11 @@ ] } }, - "/ad_accounts/{ad_account_id}/reports": { + "/ad_accounts/{ad_account_id}/promotions": { "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.\n- 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", + "summary": "Get promotions", + "description": "Gets all promotions associated with an ad account ID that can be applied to an ad group. Can be either internally-saved promotions or external promotions imported from a commerce integration.", + "operationId": "promotions/list", "security": [ { "pinterest_oauth2": [ @@ -5446,29 +5915,49 @@ ] } ], - "x-ratelimit-category": "ads_analytics", + "x-ratelimit-category": "ads_read", "x-sandbox": "disabled", "parameters": [ { "$ref": "#/components/parameters/path_ad_account_id" }, { - "$ref": "#/components/parameters/query_token_required" + "$ref": "#/components/parameters/query_page_size" + }, + { + "$ref": "#/components/parameters/query_order" + }, + { + "$ref": "#/components/parameters/query_bookmark" } ], "responses": { "200": { + "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AdsAnalyticsGetAsyncResponse" + "allOf": [ + { + "$ref": "#/components/schemas/Paginated" + }, + { + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionResponse" + } + } + } + } + ] } } - }, - "description": "Success" + } }, "400": { - "description": "Invalid ad account ads analytics parameters.", + "description": "Invalid ad account promotions parameters.", "content": { "application/json": { "schema": { @@ -5476,7 +5965,7 @@ }, "example": { "code": 400, - "message": "Invalid ad account ads analytics parameters." + "message": "Invalid ad account promotions parameters." } } } @@ -5493,21 +5982,20 @@ } }, "tags": [ - "ad_accounts" + "promotions" ] }, "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.\n- 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.\n- 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.\n- 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.\n- 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.\n- 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", + "description": "Create multiple new promotions.", + "operationId": "promotions/create", "security": [ { "pinterest_oauth2": [ - "ads:read" + "ads:write" ] } ], - "x-ratelimit-category": "ads_analytics", + "x-ratelimit-category": "ads_write", "x-sandbox": "disabled", "parameters": [ { @@ -5515,28 +6003,35 @@ } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AdsAnalyticsCreateAsyncRequest" + "type": "array", + "description": "List of promotions to create.", + "items": { + "$ref": "#/components/schemas/PromotionCreateRequest" + }, + "maxItems": 30, + "minItems": 1 } } - } + }, + "description": "List of promotions to create, size limit [1, 30].", + "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AdsAnalyticsCreateAsyncResponse" + "$ref": "#/components/schemas/PromotionsResponse" } } }, "description": "Success" }, "400": { - "description": "Invalid ad account ads analytics parameters.", + "description": "Invalid create promotions request parameters.", "content": { "application/json": { "schema": { @@ -5544,32 +6039,30 @@ }, "example": { "code": 400, - "message": "Invalid ad account ads analytics parameters." + "message": "Platform type not supported for promotions." } } } }, "default": { - "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } + }, + "description": "Unexpected error" } }, + "summary": "Create promotions", "tags": [ - "ad_accounts" + "promotions" ] - } - }, - "/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 /docs/developer-tools/sandbox/ for more information.", - "operationId": "sandbox/delete", + }, + "patch": { + "description": "Update multiple promotions.", + "operationId": "promotions/update", "security": [ { "pinterest_oauth2": [ @@ -5578,26 +6071,42 @@ } ], "x-ratelimit-category": "ads_write", - "x-sandbox": "enabled", + "x-sandbox": "disabled", "parameters": [ { "$ref": "#/components/parameters/path_ad_account_id" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of promotion data updates keyed on promotion id.", + "items": { + "$ref": "#/components/schemas/PromotionUpdateRequest" + }, + "maxItems": 30, + "minItems": 1 + } + } + }, + "description": "List of promotions to create, size limit [1, 30].", + "required": true + }, "responses": { "200": { - "description": "OK", "content": { "application/json": { "schema": { - "type": "string", - "example": "Delete Success" + "$ref": "#/components/schemas/PromotionsResponse" } } - } + }, + "description": "Success" }, "400": { - "description": "Invalid ad account id.", + "description": "Invalid create promotions request parameters.", "content": { "application/json": { "schema": { @@ -5605,32 +6114,33 @@ }, "example": { "code": 400, - "message": "Invalid ad account id" + "message": "Platform type not supported for promotions." } } } }, "default": { - "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } - } + }, + "description": "Unexpected error" } }, + "summary": "Update promotions", "tags": [ - "ad_accounts" + "promotions" ] } }, - "/ad_accounts/{ad_account_id}/ssio/accounts": { + "/ad_accounts/{ad_account_id}/promotions/{promotion_id}": { "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.\n- 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", + "summary": "Get promotion by id", + "description": "Get a promotion by its Pinterest-specific id. It must be associated with the provided ad account id.", + "operationId": "promotions/get", "security": [ { "pinterest_oauth2": [ @@ -5639,33 +6149,36 @@ } ], "x-ratelimit-category": "ads_read", - "x-sandbox": "enabled", + "x-sandbox": "disabled", "parameters": [ { "$ref": "#/components/parameters/path_ad_account_id" + }, + { + "$ref": "#/components/parameters/path_promotion_id" } ], "responses": { "200": { + "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SSIOAccountResponse" + "$ref": "#/components/schemas/PromotionResponse" } } - }, - "description": "Success" + } }, - "400": { - "description": "Invalid request parameter.", + "404": { + "description": "The promotion ID for the given ad account ID was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { - "code": 400, - "message": "Invalid request parameter." + "code": 4997, + "message": "Promotion for that ID was not found" } } } @@ -5682,15 +6195,13 @@ } }, "tags": [ - "billing" + "promotions" ] - } - }, - "/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.\n- 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", + }, + "delete": { + "summary": "Delete promotion by id", + "description": "Delete a promotion within Pinterest.", + "operationId": "promotions/delete", "security": [ { "pinterest_oauth2": [ @@ -5699,36 +6210,70 @@ } ], "x-ratelimit-category": "ads_write", - "x-sandbox": "enabled", + "x-sandbox": "disabled", "parameters": [ { "$ref": "#/components/parameters/path_ad_account_id" + }, + { + "$ref": "#/components/parameters/path_promotion_id" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SSIOCreateInsertionOrderRequest" + "responses": { + "204": { + "description": "Promotion deleted successfully" + }, + "default": { + "description": "Unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } } } - }, - "description": "Order line to create.", - "required": true + } }, + "tags": [ + "promotions" + ] + } + }, + "/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.\n- 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/SSIOCreateInsertionOrderResponse" + "$ref": "#/components/schemas/AdsAnalyticsGetAsyncResponse" } } }, "description": "Success" }, "400": { - "description": "Invalid request.", + "description": "Invalid ad account ads analytics parameters.", "content": { "application/json": { "schema": { @@ -5736,7 +6281,7 @@ }, "example": { "code": 400, - "message": "Invalid request." + "message": "Invalid ad account ads analytics parameters." } } } @@ -5753,51 +6298,50 @@ } }, "tags": [ - "billing" + "ad_accounts" ] }, - "patch": { - "summary": "Edit insertion order through SSIO.", - "description": "Edit insertion order through SSIO for ad_account_id.\n- 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", + "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.\n- 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.\n- 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.\n- 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.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", + "operationId": "analytics/create_report", "security": [ { "pinterest_oauth2": [ - "ads:write" + "ads:read" ] } ], - "x-ratelimit-category": "ads_write", - "x-sandbox": "enabled", + "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/SSIOEditInsertionOrderRequest" + "$ref": "#/components/schemas/AdsAnalyticsCreateAsyncRequest" } } - }, - "description": "Order line to create.", - "required": true + } }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SSIOEditInsertionOrderResponse" + "$ref": "#/components/schemas/AdsAnalyticsCreateAsyncResponse" } } }, "description": "Success" }, "400": { - "description": "Invalid request.", + "description": "Invalid ad account ads analytics parameters.", "content": { "application/json": { "schema": { @@ -5805,7 +6349,7 @@ }, "example": { "code": 400, - "message": "Invalid request." + "message": "Invalid ad account ads analytics parameters." } } } @@ -5822,63 +6366,43 @@ } }, "tags": [ - "billing" + "ad_accounts" ] } }, - "/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.\n- 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", + "/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 /docs/developer-tools/sandbox/ for more information.", + "operationId": "sandbox/delete", "security": [ { "pinterest_oauth2": [ - "ads:read" + "ads:write" ] } ], - "x-ratelimit-category": "ads_read", + "x-ratelimit-category": "ads_write", "x-sandbox": "enabled", "parameters": [ { "$ref": "#/components/parameters/path_ad_account_id" - }, - { - "$ref": "#/components/parameters/query_bookmark" - }, - { - "$ref": "#/components/parameters/query_page_size" } ], "responses": { "200": { + "description": "OK", "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" - } - } - } - } - ] + "type": "string", + "example": "Delete Success" } } - }, - "description": "Success" + } }, "400": { - "description": "Invalid request parameter.", + "description": "Invalid ad account id.", "content": { "application/json": { "schema": { @@ -5886,7 +6410,7 @@ }, "example": { "code": 400, - "message": "Invalid request parameter." + "message": "Invalid ad account id" } } } @@ -5903,15 +6427,15 @@ } }, "tags": [ - "billing" + "ad_accounts" ] } }, - "/ad_accounts/{ad_account_id}/ssio/insertion_orders/{pin_order_id}/status": { + "/ad_accounts/{ad_account_id}/ssio/accounts": { "get": { - "summary": "Get insertion order status by pin order id.", - "description": "Get insertion order status for pin order id pin_order_id.\n- 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", + "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.\n- 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": [ @@ -5924,9 +6448,6 @@ "parameters": [ { "$ref": "#/components/parameters/path_ad_account_id" - }, - { - "$ref": "#/components/parameters/path_pin_order_id" } ], "responses": { @@ -5934,7 +6455,291 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SSIOInsertionOrderStatusResponse" + "$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": [ + "billing" + ] + } + }, + "/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.\n- 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": [ + "billing" + ] + }, + "patch": { + "summary": "Edit insertion order through SSIO.", + "description": "Edit insertion order through SSIO for ad_account_id.\n- 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": [ + "billing" + ] + } + }, + "/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.\n- 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": [ + "billing" + ] + } + }, + "/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.\n- 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" } } }, @@ -6057,13 +6862,18 @@ "/ad_accounts/{ad_account_id}/targeting_analytics": { "get": { "summary": "Get targeting analytics for an ad account", - "description": "Get targeting analytics for an ad account.\nFor the requested account and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.", + "description": "Get targeting analytics for an ad account.\nFor the requested account and metrics, the response will include the requested metric information\n(e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").

\n- The token's user_account must either be the Owner of the specified ad account, or have one\nof the necessary roles granted to them via\nBusiness Access: Admin, Analyst, Campaign Manager.\n- 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.\n- 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.\n\nDeprecation notice\nAs of March 31, 2025, requests to this endpoint have changed for the following parameters:\n- engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date.\n- granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual.", "operationId": "ad_account_targeting_analytics/get", "security": [ { "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_analytics", @@ -6140,6 +6950,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -6193,7 +7008,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/TargetingTemplateResponseData" + "$ref": "#/components/schemas/TargetingTemplateGetResponseData" } } } @@ -6913,6 +7728,12 @@ "boards:read", "boards:write" ] + }, + { + "client_credentials": [ + "boards:read", + "boards:write" + ] } ], "x-ratelimit-category": "org_write", @@ -7085,6 +7906,12 @@ "boards:read", "boards:write" ] + }, + { + "client_credentials": [ + "boards:read", + "boards:write" + ] } ], "x-ratelimit-category": "org_write", @@ -8044,6 +8871,9 @@ { "$ref": "#/components/parameters/path_asset_id" }, + { + "$ref": "#/components/parameters/fetch_system_users" + }, { "$ref": "#/components/parameters/query_bookmark" }, @@ -8304,6 +9134,9 @@ { "$ref": "#/components/parameters/path_business_user" }, + { + "$ref": "#/components/parameters/fetch_system_users" + }, { "$ref": "#/components/parameters/query_assets_summary" }, @@ -9562,7 +10395,7 @@ "/businesses/{business_id}/audiences/ad_accounts/shared": { "patch": { "summary": "Update audience sharing from a business to ad accounts", - "description": "From a business, share a specific audience with other ad account(s), or revoke access to a previously shared audience.

This endpoint is not available to all apps.Learn more.", + "description": "From a business, share a specific audience with other ad account(s), or revoke access to a previously shared audience. This endpoint is not available to all apps.Learn more.", "operationId": "update_business_to_ad_account_shared_audience", "security": [ { @@ -9632,7 +10465,7 @@ "/businesses/{business_id}/audiences/businesses/shared": { "patch": { "summary": "Update audience sharing between businesses", - "description": "From a business, share a specific audience with another business account, or revoke access to a previously shared audience. Only the audience owner can share the audience with other businesses, and the recipient business must be within the same business hierarchy.
This endpoint is not available to all apps.Learn more.", + "description": "From a business, share a specific audience with another business account, or revoke access to a previously shared audience. Only the audience owner can share the audience with other businesses, and the recipient business must be within the same business hierarchy.
This endpoint is not available to all apps.Learn more.", "operationId": "update_business_to_business_shared_audience", "security": [ { @@ -10209,7 +11042,7 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] }, "post": { @@ -10398,7 +11231,7 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] } }, @@ -10506,7 +11339,7 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] }, "patch": { @@ -10638,7 +11471,7 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] }, "delete": { @@ -10763,7 +11596,7 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] } }, @@ -10872,7 +11705,7 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] } }, @@ -10996,7 +11829,7 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] } }, @@ -11126,114 +11959,11 @@ } }, "tags": [ - "catalogs" + "catalog_feeds" ] } }, "/catalogs/items": { - "get": { - "deprecated": true, - "summary": "Get catalogs items", - "description": "Get the items of the catalog owned by the \"operation user_account\". See detailed documentation here.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.\n\nNote: this endpoint is deprecated and will be deleted soon. Please use Get catalogs items (POST) instead.", - "operationId": "items/get", - "security": [ - { - "pinterest_oauth2": [ - "catalogs:read" - ] - } - ], - "x-ratelimit-category": "catalogs_read", - "x-sandbox": "enabled", - "parameters": [ - { - "$ref": "#/components/parameters/query_ad_account_id" - }, - { - "$ref": "#/components/parameters/query_catalogs_items_country" - }, - { - "$ref": "#/components/parameters/query_catalogs_items_language" - }, - { - "$ref": "#/components/parameters/query_catalogs_items" - }, - { - "$ref": "#/components/parameters/query_catalogs_items_filters" - } - ], - "responses": { - "200": { - "description": "Response containing the requested catalogs items", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CatalogsItems" - } - } - } - }, - "400": { - "description": "Invalid request parameters.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - }, - "examples": { - "InvalidRequest": { - "value": { - "code": 1, - "message": "Parameter 'item_ids' is required." - } - } - } - } - } - }, - "401": { - "description": "Not authorized to access catalogs items", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - }, - "examples": { - "UnauthorizedAccess": { - "value": { - "code": 2, - "message": "Authentication failed." - } - } - } - } - } - }, - "403": { - "description": "Not authorized to access catalogs items", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - }, - "default": { - "description": "Unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "tags": [ - "catalogs" - ] - }, "post": { "summary": "Get catalogs items (POST)", "description": "Get the items of the catalog owned by the \"operation user_account\". See detailed documentation here.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.\n\nNote: Access to the Creative Assets catalog type is restricted to a specific group of users.\nIf you require access, please reach out to your partner manager.", @@ -11332,7 +12062,7 @@ } }, "tags": [ - "catalogs" + "catalog_items" ] } }, @@ -11449,7 +12179,7 @@ } }, "tags": [ - "catalogs" + "catalog_items" ] } }, @@ -11570,7 +12300,7 @@ } }, "tags": [ - "catalogs" + "catalog_items" ] } }, @@ -11702,7 +12432,7 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] }, "post": { @@ -12127,7 +12857,7 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] } }, @@ -12299,13 +13029,13 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] }, "post": { "x-ratelimit-category": "catalogs_write", "summary": "Create product group", - "description": "Create product group to use in Catalogs owned by the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.\n\nLearn more\n\nNote: Access to the Creative Assets catalog type is restricted to a specific group of users.\nIf you require access, please reach out to your partner manager.", + "description": "Create product group to use in Catalogs owned by the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.\n\"Catalog-based product groups\" can include items from all data sources (feeds and API) and are available to both non-retail catalogs with any data sources and retail catalogs with API-created items. If your catalog only contains retail items created via feeds, you should use the \"retail feed-based\" option.\nLearn more\n\nNote: Access to the Creative Assets catalog type is restricted to a specific group of users.\nIf you require access, please reach out to your partner manager.", "operationId": "catalogs_product_groups/create", "security": [ { @@ -12706,7 +13436,7 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] } }, @@ -12851,7 +13581,7 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] }, "delete": { @@ -12999,13 +13729,13 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] }, "patch": { "x-ratelimit-category": "catalogs_write", "summary": "Update single product group", - "description": "Update product group owned by the \"operation user_account\" to use in Catalogs.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.\n\nLearn more\n\nNote: Access to the Creative Assets catalog type is restricted to a specific group of users.\nIf you require access, please reach out to your partner manager.", + "description": "Update product group owned by the \"operation user_account\" to use in Catalogs.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.\n\"Catalog-based product groups\" can include items from all data sources (feeds and API) and are available to both non-retail catalogs with any data sources and retail catalogs with API-created items. If your catalog only contains retail items created via feeds, you should use the \"retail feed-based\" option.\nLearn more\n\nNote: Access to the Creative Assets catalog type is restricted to a specific group of users.\nIf you require access, please reach out to your partner manager.", "operationId": "catalogs_product_groups/update", "x-sandbox": "enabled", "parameters": [ @@ -13184,7 +13914,7 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] } }, @@ -13269,7 +13999,7 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] } }, @@ -13398,7 +14128,7 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] } }, @@ -13523,14 +14253,14 @@ } }, "tags": [ - "catalogs" + "catalog_product_groups" ] } }, "/catalogs/reports": { "post": { "summary": "Build catalogs report", - "description": "Async request to create a report of the catalog owned by the \"operation user_account\". This endpoint generates a report upon receiving the first approved request of the day. Any following requests with identical parameters will yield the same report even if data has changed.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.", + "description": "Async request to create a report of the catalog owned by the \"operation user_account\". This endpoint generates a report upon receiving the first approved request of the day. Any following requests with identical parameters will yield the same report even if data has changed.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.\n\nNote: Access to the All Items report type is restricted to a specific group of users.\nIf you require access, please reach out to your partner manager.", "operationId": "reports/create", "security": [ { @@ -13628,7 +14358,7 @@ } }, "tags": [ - "catalogs" + "catalog_reports" ] }, "get": { @@ -13711,7 +14441,7 @@ } }, "tags": [ - "catalogs" + "catalog_reports" ] } }, @@ -13799,7 +14529,7 @@ } }, "tags": [ - "catalogs" + "catalog_reports" ] } }, @@ -14143,7 +14873,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DetailedError" + "anyOf": [ + { + "$ref": "#/components/schemas/Error" + }, + { + "$ref": "#/components/schemas/DetailedError" + } + ] } } } @@ -14473,7 +15210,7 @@ "/oauth/token": { "post": { "summary": "Generate OAuth access token", - "description": "Generate an OAuth access token by using an authorization code or a refresh token.\n\nIMPORTANT: You need to start the OAuth flow via www.pinterest.com/oauth before calling this endpoint (or have an existing refresh token).\n\nSee Authentication for more.\n\nParameter refresh_on and its corresponding response type everlasting_refresh are now available to all apps! Later this year, continuous refresh will become the default behavior (ie you will no longer need to send this parameter). Learn more.\n\nGrant type client_credentials and its corresponding response type are not fully available. You will likely get a default error if you attempt to use this grant_type.", + "description": "Generate an OAuth access token by using an authorization code or a refresh token.\n\nIMPORTANT: You need to start the OAuth flow via www.pinterest.com/oauth before calling this endpoint (or have an existing refresh token).\n\nSee Authentication for more.\n\nParameter refresh_on and its corresponding response type everlasting_refresh are now available to all apps! Later this year, continuous refresh will become the default behavior (ie you will no longer need to send this parameter). Learn more.\n\nUse Token Debugger to validate and inspect your access token.", "tags": [ "oauth" ], @@ -14649,6 +15386,14 @@ "pins:read", "pins:write" ] + }, + { + "client_credentials": [ + "boards:read", + "boards:write", + "pins:read", + "pins:write" + ] } ], "x-ratelimit-category": "org_write", @@ -14908,6 +15653,14 @@ "pins:read", "pins:write" ] + }, + { + "client_credentials": [ + "boards:read", + "boards:write", + "pins:read", + "pins:write" + ] } ], "x-ratelimit-category": "org_write", @@ -14983,7 +15736,7 @@ }, "patch": { "summary": "Update Pin", - "description": "Update a pin owned by the \"operating user_account\".\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account:\n\n- For Pins on public or protected boards: Owner, Admin, Analyst, Campaign Manager.\n- For Pins on secret boards: Owner, Admin.\n\nThis endpoint is currently in beta and not available to all apps. Learn more.", + "description": "Update a pin owned by the \"operating user_account\".\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account:\n\n- For Pins on public or protected boards: Owner, Admin, Analyst, Campaign Manager.\n- For Pins on secret boards: Owner, Admin.\n\nThis endpoint is currently in beta and not available to all apps. Learn more.", "tags": [ "pins" ], @@ -14996,6 +15749,14 @@ "pins:read", "pins:write" ] + }, + { + "client_credentials": [ + "boards:read", + "boards:write", + "pins:read", + "pins:write" + ] } ], "x-ratelimit-category": "org_write", @@ -15212,7 +15973,7 @@ "/pins/analytics": { "get": { "summary": "Get multiple Pin analytics", - "description": "This endpoint is currently in beta and not available to all apps. Learn more.\n\nGet analytics for multiple pins owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- The maximum number of pins supported in a single request is 100.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account:\n\n- For Pins on public or protected boards: Admin, Analyst.\n- For Pins on secret boards: Admin.\n\nIf Pin was created before 2023-03-20 lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then.", + "description": "This endpoint is currently in beta and not available to all apps. Learn more.\n\nGet analytics for multiple pins owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- The maximum number of pins supported in a single request is 100.\n- By default, the \"operation user_account\" is the token user_account.\n\nOptional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the \"operation user_account\". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account:\n\n- For Pins on public or protected boards: Admin, Analyst.\n- For Pins on secret boards: Admin.\n\nIf Pin was created before 2023-03-20 lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then.", "tags": [ "pins" ], @@ -15527,6 +16288,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -15570,6 +16336,13 @@ "pins:read", "user_accounts:read" ] + }, + { + "client_credentials": [ + "ads:read", + "pins:read", + "user_accounts:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -15609,7 +16382,7 @@ "/resources/lead_form_questions": { "get": { "summary": "Get lead form questions", - "description": "Get a list of all lead form question type names. Some questions might not be used.\n\nThis endpoint is currently in beta and not available to all apps. Learn more.", + "description": "Get a list of all lead form question type names. Some questions might not be used.\n\nThis endpoint is currently in beta and not available to all apps. Learn more.", "operationId": "lead_form_questions/get", "security": [ { @@ -15705,6 +16478,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -15751,6 +16529,11 @@ "pinterest_oauth2": [ "ads:read" ] + }, + { + "client_credentials": [ + "ads:read" + ] } ], "x-ratelimit-category": "ads_read", @@ -15967,7 +16750,7 @@ "/search/partner/pins": { "get": { "summary": "Search pins by a given search term", - "description": "This endpoint is currently in beta and not available to all apps. Learn more.\n\nGet the top 10 Pins by a given search term.", + "description": "This endpoint is currently in beta and not available to all apps. Learn more.\n\nGet the top 10 Pins by a given search term.", "operationId": "search_partner_pins", "security": [ { @@ -16953,7 +17736,7 @@ "/user_account/following/{username}": { "post": { "summary": "Follow user", - "description": "This endpoint is currently in beta and not available to all apps. Learn more.\n\nUse this request, as a signed-in user, to follow another user.", + "description": "This endpoint is currently in beta and not available to all apps. Learn more.\n\nUse this request, as a signed-in user, to follow another user.", "tags": [ "user_account" ], @@ -17398,6 +18181,7 @@ "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", + "msot:write": "Create measurement source of truth events", "pins:read": "See your public Pins", "pins:read_secret": "See your secret Pins", "pins:write": "Create, update, or delete your public Pins", @@ -17433,6 +18217,7 @@ "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", + "msot:write": "Create measurement source of truth events", "pins:read": "See your public Pins", "pins:read_secret": "See your secret Pins", "pins:write": "Create, update, or delete your public Pins", @@ -17616,6 +18401,7 @@ "type": "object", "example": { "country": "US", + "currency": "USD", "owner_user_id": "383791336903426391", "name": "ACME Tools" }, @@ -17623,6 +18409,9 @@ "country": { "$ref": "#/components/schemas/Country" }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, "name": { "description": "Ad Account name.", "example": "ACME Tools", @@ -17773,7 +18562,7 @@ "nullable": true }, "created_time": { - "description": "Lead form creation time. Unix timestamp in milliseconds.", + "description": "Lead subscription creation time. Unix timestamp in milliseconds.", "example": 1699209842000, "type": "integer" } @@ -17961,6 +18750,17 @@ "ADD_TO_CART", "WATCH_NOW", "READ_MORE", + "BUY_TICKETS", + "DONATE_NOW", + "DOWNLOAD", + "EXPLORE_MORE", + "FIND_A_LOCATION", + "GET_DEAL", + "GET_RECIPE", + "GET_SHOWTIMES", + "ON_SALE", + "PLAY_GAME", + "TRY_IT", null ] }, @@ -18684,13 +19484,13 @@ ] }, "start_time": { - "description": "Ad group start time. Unix timestamp in seconds. Defaults to current time.", + "description": "Timestamp in Unix format for scheduling when ads in the ad group start to appear. If not specified, ads appear during parent campaign's `start_time`. Cannot precede `start_time` for parent campaign (if specified). Learn about scheduling ads.\nFor certain organizations (Closed beta): Supported for campaigns with Campaign Budget Optimization (CBO).\nFor all organizations: Supported for campaigns without CBO.", "type": "integer", "example": 5686848000, "nullable": true }, "end_time": { - "description": "Ad group end time. Unix timestamp in seconds.", + "description": "Timestamp in Unix format for scheduling when ads in the ad group stop appearing. If not specified, ads run indefinitely unless you update the ad group by changing their status to `paused`. Cannot occur after `end_time` for parent campaign (if specified). Learn about scheduling ads.\nFor certain organizations (Closed beta): Supported for campaigns with Campaign Budget Optimization (CBO).\nFor all organizations: Supported for campaigns without CBO.", "type": "integer", "example": 5705424000, "nullable": true @@ -18715,7 +19515,7 @@ }, "auto_targeting_enabled": { "type": "boolean", - "description": "Enable auto-targeting for ad group. Also known as \"expanded targeting\".", + "description": "Enable auto-targeting for ad group. Default value is True. Also known as \"Performance+ targeting\".", "example": true, "nullable": true }, @@ -18747,7 +19547,7 @@ }, "bid_strategy_type": { "nullable": true, - "description": "Bid strategy type. For Campaigns with Video Completion objectives, the only supported bid strategy type is AUTOMATIC_BID.", + "description": "Bid strategy type. For Campaigns with Video Completion objectives, the only supported bid strategy type is AUTOMATIC_BID, also known as \"Performance+ bidding\".", "enum": [ "AUTOMATIC_BID", "MAX_BID", @@ -18769,6 +19569,20 @@ }, "maxItems": 1, "nullable": true + }, + "is_creative_optimization": { + "type": "boolean", + "description": "Enable creative optimization for the ad group, default value is FALSE. When enabled, you allow Pinterest to automatically turn your product Pins into ads in different formats (collections and shopping) and deliver those ads to users at scale.", + "example": true, + "nullable": true + }, + "promotion_id": { + "type": "string", + "description": "Promotion ID. To clear this field, set to null.", + "pattern": "^\\d+$", + "example": "7834020347906", + "nullable": true, + "default": "0" } } }, @@ -18795,7 +19609,7 @@ "allOf": [ { "type": "boolean", - "description": "Enable auto-targeting for ad group.Default value is True. Also known as \"expanded targeting\".", + "description": "Enable auto-targeting for ad group. Default value is True. Also known as \"Performance+ targeting\".", "example": true } ] @@ -18808,6 +19622,13 @@ } ], "default": "DAILY" + }, + "bid_multiplier": { + "description": "Open beta\nBid multiplier for ad group. This value is a double between 0.1\nand 10.0. Enter 0 to remove the bid multiplier.\n- Make sure the `bid_strategy` type for your ad group is set to `AUTOMATIC_BID`.\n- Not currently supported for Performance+ campaigns.", + "type": "number", + "example": 1, + "minimum": 0, + "maximum": 10 } }, "required": [ @@ -18881,6 +19702,14 @@ }, "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." + }, + "bid_multiplier": { + "description": "Open beta\nBid multiplier for ad group. This value is a double between 0.1\nand 10.0. Enter 0 to remove the bid multiplier.\n- Not currently supported for Performance+ campaigns.", + "type": "number", + "example": 1, + "minimum": 0, + "maximum": 10, + "nullable": true } } } @@ -18915,6 +19744,13 @@ "type": "string", "pattern": "^\\d+$", "example": "2680060704746" + }, + "bid_multiplier": { + "description": "Open beta\nBid multiplier for ad group. This value is a double between 0.1\nand 10.0. Enter 0 to remove the bid multiplier.\n- Make sure the `bid_strategy` type for your ad group is set to `AUTOMATIC_BID`.\n- Not currently supported for Performance+ campaigns.", + "type": "number", + "example": 1, + "minimum": 0, + "maximum": 10 } }, "required": [ @@ -18929,7 +19765,7 @@ "type": "object", "properties": { "AD_GROUP_ID": { - "description": "The ID of the ad group that this metrics belongs to.", + "description": "The ID of the ad group that this metrics belongs to. Returned as long as aggregate_report_rows is not true.", "type": "string", "pattern": "^\\d+$" }, @@ -18939,9 +19775,6 @@ "format": "date" } }, - "required": [ - "AD_GROUP_ID" - ], "additionalProperties": true, "example": { "DATE": "2021-04-01", @@ -18956,7 +19789,7 @@ "properties": { "auto_targeting_enabled": { "type": "boolean", - "description": "Enable auto-targeting for ad group. Also known as \"expanded targeting\".", + "description": "Enable auto-targeting for ad group. Default value is True. Also known as \"Performance+ targeting\".", "example": true, "default": true }, @@ -19668,6 +20501,12 @@ "type": "integer", "minimum": 0, "maximum": 23 + }, + "combine_targeting_types": { + "type": "boolean", + "description": "Determines if the targeting types included in the request should be consolidated into a single breakdown. For example, when combine_targeting_types is set to true, if GENDER and COUNTRY are targeting types in the request, the response will have a targeting type of GENDER_AND_COUNTRY and targeting values such as female&US. This feature is currently in BETA and is not available to all users.", + "example": false, + "default": false } } } @@ -20046,7 +20885,7 @@ } }, "AssetTypeResponse": { - "description": "Type of asset. Currently we only support AD_ACCOUNT and PROFILE, and ASSET_GROUP.", + "description": "Type of asset. Currently we only support AD_ACCOUNT, PROFILE, ASSET_GROUP and CATALOG.", "example": "AD_ACCOUNT", "type": "string" }, @@ -20118,6 +20957,13 @@ "nullable": true, "title": "updated_time", "type": "integer" + }, + "created_by_company_name": { + "description": "The company that created this audience.", + "example": "Pinterest", + "nullable": true, + "title": "created_by_company_name", + "type": "string" } }, "title": "Audience", @@ -20270,13 +21116,11 @@ }, "audience_type": { "type": "string", + "title": "audience_type", + "description": "Audience types: ACTALIKE, ENGAGEMENT, CUSTOMER_LIST and VISITOR. Values are case-sensitive.", "allOf": [ { "$ref": "#/components/schemas/AudienceType" - }, - { - "title": "audience_type", - "description": "Audience types: ACTALIKE, ENGAGEMENT, CUSTOMER_LIST and VISITOR. Values are case-sensitive." } ] } @@ -20305,16 +21149,15 @@ "example": "2022-10-09" }, "type": { - "$ref": "#/components/schemas/AudienceDefinitionType" + "title": "AudienceDefinitionType", + "type": "string", + "example": "IMPRESSION_PLUS_ENGAGEMENT" }, "scope": { - "$ref": "#/components/schemas/AudienceDefinitionScope" + "title": "AudienceDefinitionScope", + "type": "string", + "example": "PARTNER" } - }, - "example": { - "date": "2022-10-09", - "scope": "PARTNER", - "type": "IMPRESSION_PLUS_ENGAGEMENT" } }, "AudienceDefinitionResponse": { @@ -20329,10 +21172,11 @@ } }, "AudienceDefinitionScope": { + "type": "object", "description": "Generated audience scope to request.", - "type": "string", "properties": { "scope": { + "type": "string", "enum": [ "PARTNER", "PINTEREST" @@ -20341,10 +21185,11 @@ } }, "AudienceDefinitionType": { + "type": "object", "description": "Generated audience type to request.", - "type": "string", "properties": { "scope": { + "type": "string", "enum": [ "IMPRESSION_PLUS_ENGAGEMENT", "ENGAGEMENT" @@ -20927,6 +21772,7 @@ }, "AvailabilityFilter": { "type": "object", + "title": "AVAILABILITY", "additionalProperties": false, "properties": { "AVAILABILITY": { @@ -21297,6 +22143,117 @@ "CARTE_BANCAIRE" ], "example": "VISA" + }, + "billing_type": { + "description": "Billing type of the advertiser", + "type": "string", + "enum": [ + "CREDIT_CARD", + "INVOICE", + "INTERNAL", + "RECURRING", + "PREPAID" + ], + "example": "CREDIT_CARD" + } + } + }, + "BillingInvoiceResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the billing invoice", + "pattern": "^\\d+$" + }, + "ad_account_id": { + "type": "string", + "description": "The ID of the ad account this invoice belongs to", + "pattern": "^\\d+$" + }, + "ad_account_name": { + "type": "string", + "description": "The name of the ad account this invoice belongs to" + }, + "document_type": { + "type": "string", + "description": "The type of the document", + "enum": [ + "INVOICE", + "CREDIT_MEMO" + ] + }, + "amount_billed_micro_currency": { + "type": "integer", + "description": "The amount billed in this invoice. Denoted in micro currency" + }, + "amount_tax_micro_currency": { + "type": "integer", + "description": "The tax in this invoice. Denoted in micro currency", + "nullable": true + }, + "amount_net_micro_currency": { + "type": "integer", + "description": "The net amount in this invoice. Denoted in micro currency", + "nullable": true + }, + "amount_discount_micro_currency": { + "type": "integer", + "description": "The discount in this invoice. Denoted in micro currency", + "nullable": true + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "billing_period_start_date": { + "type": "string", + "format": "date", + "description": "The start date of the billing period. Format: YYYY-MM-DD", + "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$" + }, + "billing_period_end_date": { + "type": "string", + "format": "date", + "description": "The end date of the billing period. Format: YYYY-MM-DD", + "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$" + }, + "invoice_due_date": { + "type": "string", + "format": "date", + "description": "The date the invoice is due. Format: YYYY-MM-DD", + "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$" + }, + "status": { + "type": "string", + "description": "The status of the invoice", + "example": "OPEN", + "enum": [ + "OPEN", + "CLOSED" + ] + }, + "payment_terms": { + "type": "string", + "description": "The payment terms of the invoice", + "example": "NET 30" + }, + "bill_to_country": { + "type": "string", + "description": "The country of the bill to address" + } + } + }, + "BillingInvoiceDownloadResponse": { + "title": "BillingInvoiceDownloadResponse", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The billing invoice id" + }, + "download_url": { + "type": "string", + "description": "The download url for the billing invoice" } } }, @@ -21479,6 +22436,7 @@ }, "BrandFilter": { "type": "object", + "title": "BRAND", "additionalProperties": false, "properties": { "BRAND": { @@ -22177,18 +23135,21 @@ }, "start_time": { "type": "integer", - "description": "Campaign start time. Unix timestamp in seconds. Only used for Campaign Budget Optimization (CBO) campaigns.", + "description": "Timestamp in Unix format for scheduling when ads in the campaign start to appear. Must precede any start times set for child ad groups. Defaults to current time if no time is specified. Learn about scheduling campaigns.\nDifferent start times can be set for the campaign's child ad groups, but they cannot occur before a `start_time` specified for the campaign.\n- If your campaign has a child ad group with a start time specified, and if you update that campaign with a `start_time` that is later than that of the ad group, the campaign `start_time` will supersede the ad group `start_time`, and the request will not return an error.\n- In this scenario, if you call List campaigns or List ad groups, the returned campaigns or ad groups are listed with the start and end times that you assigned them, regardless of supersedence.", "example": 1580865126, "nullable": true }, "end_time": { "type": "integer", - "description": "Campaign end time. Unix timestamp in seconds. Only used for Campaign Budget Optimization (CBO) campaigns.", + "description": "Timestamp in Unix format for scheduling when ads in the campaign stop appearing. Must occur after any end times for child ad groups. If `end_time` is not specified for the campaign, ads run indefinitely unless you update the campaign, changing their status to `paused`. Learn about scheduling campaigns.\nDifferent end times can be set for the campaign's child ad groups, but they cannot occur after an `end_time` specified for the campaign.\n- If your campaign has a child ad group with an end time specified, and if you update that campaign with an `end_time` that is earlier than that of the ad group, the campaign `end_time` will supersede the ad group `end_time`, and the request will not return an error.\n- In this scenario, if you call List campaigns or List ad groups, the returned campaigns or ad groups are listed with the start and end times that you assigned them, regardless of supersedence.", "example": 1644023526, "nullable": true }, "is_flexible_daily_budgets": { "$ref": "#/components/schemas/CampaignIsFlexibleDailyBudgets" + }, + "is_automated_campaign": { + "$ref": "#/components/schemas/CampaignIsAutomatedCampaign" } } }, @@ -22206,9 +23167,6 @@ "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": { - "$ref": "#/components/schemas/CampaignIsAutomatedCampaign" } } } @@ -22226,6 +23184,7 @@ "is_flexible_daily_budgets": { "type": "boolean", "default": false, + "nullable": false, "allOf": [ { "$ref": "#/components/schemas/CampaignIsFlexibleDailyBudgets" @@ -22235,6 +23194,7 @@ "is_automated_campaign": { "type": "boolean", "default": false, + "nullable": false, "allOf": [ { "$ref": "#/components/schemas/CampaignIsAutomatedCampaign" @@ -22252,6 +23212,12 @@ }, "objective_type": { "$ref": "#/components/schemas/ObjectiveType" + }, + "is_performance_plus": { + "description": "Enable Performance+ for your campaign. To learn more, see Performance+ Setup.", + "type": "boolean", + "example": true, + "default": false } }, "required": [ @@ -22331,7 +23297,7 @@ }, "CampaignIsFlexibleDailyBudgets": { "type": "boolean", - "description": "Determine if a campaign has flexible daily budgets setup.", + "description": "Determine if a campaign has setup for flexible daily budgets, also known as \"Performance+ budgets\".", "example": true, "nullable": true }, @@ -22370,6 +23336,11 @@ }, "summary_status": { "$ref": "#/components/schemas/CampaignSummaryStatus" + }, + "is_performance_plus": { + "description": "Enable Performance+ for your campaign. To learn more, see Performance+ Setup.", + "type": "boolean", + "example": true } } } @@ -22413,6 +23384,11 @@ "$ref": "#/components/schemas/ObjectiveType" } ] + }, + "is_performance_plus": { + "description": "Enable Performance+ for your campaign. To learn more, see Performance+ Setup. This field is immutable, except only for campaigns in draft status which may update this field.", + "type": "boolean", + "example": true } }, "required": [ @@ -22436,7 +23412,7 @@ "type": "object", "properties": { "CAMPAIGN_ID": { - "description": "The ID of the campaing that this metrics belongs to.", + "description": "The ID of the campaing that this metrics belongs to. Returned as long as aggregate_report_rows is not true.", "type": "string", "pattern": "^\\d+$" }, @@ -22446,9 +23422,6 @@ "format": "date" } }, - "required": [ - "CAMPAIGN_ID" - ], "additionalProperties": true, "example": { "DATE": "2021-04-01", @@ -22740,6 +23713,54 @@ } }, "CatalogsHotelReportParameters": { + "type": "object", + "description": "Parameters for hotel report", + "properties": { + "catalog_type": { + "type": "string", + "enum": [ + "HOTEL" + ] + }, + "report": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/CatalogsReportFeedIngestionFilter" + }, + { + "$ref": "#/components/schemas/CatalogsReportDistributionIssueFilter" + }, + { + "$ref": "#/components/schemas/CatalogsReportAllItemsFilter" + } + ], + "discriminator": { + "propertyName": "report_type", + "mapping": { + "FEED_INGESTION_ISSUES": "#/components/schemas/CatalogsReportFeedIngestionFilter", + "DISTRIBUTION_ISSUES": "#/components/schemas/CatalogsReportDistributionIssueFilter", + "ALL_ITEMS": "#/components/schemas/CatalogsReportAllItemsFilter" + } + }, + "properties": { + "report_type": { + "type": "string", + "enum": [ + "FEED_INGESTION_ISSUES", + "DISTRIBUTION_ISSUES", + "ALL_ITEMS" + ] + } + } + } + }, + "required": [ + "catalog_type", + "report" + ] + }, + "CatalogsHotelReportStatsParameters": { "type": "object", "description": "Parameters for hotel report", "properties": { @@ -22783,6 +23804,54 @@ ] }, "CatalogsRetailReportParameters": { + "type": "object", + "description": "Parameters for retail report", + "properties": { + "catalog_type": { + "type": "string", + "enum": [ + "RETAIL" + ] + }, + "report": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/CatalogsReportFeedIngestionFilter" + }, + { + "$ref": "#/components/schemas/CatalogsReportDistributionIssueFilter" + }, + { + "$ref": "#/components/schemas/CatalogsReportAllItemsFilter" + } + ], + "discriminator": { + "propertyName": "report_type", + "mapping": { + "FEED_INGESTION_ISSUES": "#/components/schemas/CatalogsReportFeedIngestionFilter", + "DISTRIBUTION_ISSUES": "#/components/schemas/CatalogsReportDistributionIssueFilter", + "ALL_ITEMS": "#/components/schemas/CatalogsReportAllItemsFilter" + } + }, + "properties": { + "report_type": { + "type": "string", + "enum": [ + "FEED_INGESTION_ISSUES", + "DISTRIBUTION_ISSUES", + "ALL_ITEMS" + ] + } + } + } + }, + "required": [ + "catalog_type", + "report" + ] + }, + "CatalogsRetailReportStatsParameters": { "type": "object", "description": "Parameters for retail report", "properties": { @@ -22871,6 +23940,26 @@ "report_type" ] }, + "CatalogsReportAllItemsFilter": { + "type": "object", + "additionalProperties": false, + "properties": { + "report_type": { + "type": "string", + "enum": [ + "ALL_ITEMS" + ] + }, + "catalog_id": { + "type": "string", + "description": "Unique identifier of a catalog. If not given, oldest catalog will be used", + "pattern": "^\\d+$" + } + }, + "required": [ + "report_type" + ] + }, "CatalogsHotelBatchItem": { "description": "Hotel batch item", "type": "object", @@ -23201,6 +24290,10 @@ "IMAGE_INVALID_FILE": { "type": "integer", "description": "Image files are unreadable. Please upload new files to continue." + }, + "FETCH_GOOGLE_SHEET_NOT_SHARED": { + "type": "integer", + "description": "Update your Google Sheets sharing settings to 'Anyone with link' as a Viewer so that Pinterest can access your file." } } }, @@ -23274,6 +24367,10 @@ "HOTEL_PRICE_HEADER_IS_PRESENT": { "type": "integer", "description": "price is not a supported column. Use base_price and sale_price instead." + }, + "FETCH_GOOGLE_SHEET_PUBLIC_CAN_EDIT": { + "type": "integer", + "description": "Update your Google Sheets sharing settings from 'Editor' to 'Viewer'." } } }, @@ -23900,6 +24997,406 @@ "CatalogsFeedValidationWarnings": { "type": "object", "properties": { + "AD_IMAGE_0_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 0 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_1_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 1 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_2_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 2 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_3_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 3 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_4_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 4 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_5_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 5 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_6_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 6 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_7_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 7 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_8_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 8 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_9_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 9 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_10_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 10 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_11_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 11 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_12_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 12 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_13_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 13 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_14_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 14 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_15_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 15 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_16_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 16 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_17_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 17 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_18_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 18 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_19_LINK_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image link 19 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_0_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 0 format is unsupported." + }, + "AD_IMAGE_1_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 1 format is unsupported." + }, + "AD_IMAGE_2_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 2 format is unsupported." + }, + "AD_IMAGE_3_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 3 format is unsupported." + }, + "AD_IMAGE_4_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 4 format is unsupported." + }, + "AD_IMAGE_5_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 5 format is unsupported." + }, + "AD_IMAGE_6_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 6 format is unsupported." + }, + "AD_IMAGE_7_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 7 format is unsupported." + }, + "AD_IMAGE_8_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 8 format is unsupported." + }, + "AD_IMAGE_9_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 9 format is unsupported." + }, + "AD_IMAGE_10_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 10 format is unsupported." + }, + "AD_IMAGE_11_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 11 format is unsupported." + }, + "AD_IMAGE_12_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 12 format is unsupported." + }, + "AD_IMAGE_13_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 13 format is unsupported." + }, + "AD_IMAGE_14_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 14 format is unsupported." + }, + "AD_IMAGE_15_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 15 format is unsupported." + }, + "AD_IMAGE_16_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 16 format is unsupported." + }, + "AD_IMAGE_17_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 17 format is unsupported." + }, + "AD_IMAGE_18_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 18 format is unsupported." + }, + "AD_IMAGE_19_LINK_WARNING": { + "type": "integer", + "description": "Ad image link 19 format is unsupported." + }, + "AD_IMAGE_0_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 0 is required because an image tag was provided." + }, + "AD_IMAGE_1_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 1 is required because an image tag was provided." + }, + "AD_IMAGE_2_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 2 is required because an image tag was provided." + }, + "AD_IMAGE_3_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 3 is required because an image tag was provided." + }, + "AD_IMAGE_4_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 4 is required because an image tag was provided." + }, + "AD_IMAGE_5_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 5 is required because an image tag was provided." + }, + "AD_IMAGE_6_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 6 is required because an image tag was provided." + }, + "AD_IMAGE_7_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 7 is required because an image tag was provided." + }, + "AD_IMAGE_8_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 8 is required because an image tag was provided." + }, + "AD_IMAGE_9_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 9 is required because an image tag was provided." + }, + "AD_IMAGE_10_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 10 is required because an image tag was provided." + }, + "AD_IMAGE_11_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 11 is required because an image tag was provided." + }, + "AD_IMAGE_12_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 12 is required because an image tag was provided." + }, + "AD_IMAGE_13_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 13 is required because an image tag was provided." + }, + "AD_IMAGE_14_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 14 is required because an image tag was provided." + }, + "AD_IMAGE_15_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 15 is required because an image tag was provided." + }, + "AD_IMAGE_16_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 16 is required because an image tag was provided." + }, + "AD_IMAGE_17_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 17 is required because an image tag was provided." + }, + "AD_IMAGE_18_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 18 is required because an image tag was provided." + }, + "AD_IMAGE_19_LINK_REQUIRED": { + "type": "integer", + "description": "Ad image link 19 is required because an image tag was provided." + }, + "AD_IMAGE_0_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 0 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_1_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 1 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_2_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 2 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_3_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 3 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_4_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 4 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_5_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 5 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_6_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 6 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_7_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 7 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_8_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 8 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_9_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 9 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_10_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 10 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_11_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 11 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_12_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 12 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_13_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 13 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_14_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 14 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_15_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 15 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_16_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 16 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_17_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 17 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_18_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 18 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_19_TAG_LENGTH_TOO_LONG": { + "type": "integer", + "description": "Ad image tag 19 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_0_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 0 is required because an image link was provided." + }, + "AD_IMAGE_1_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 1 is required because an image link was provided." + }, + "AD_IMAGE_2_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 2 is required because an image link was provided." + }, + "AD_IMAGE_3_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 3 is required because an image link was provided." + }, + "AD_IMAGE_4_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 4 is required because an image link was provided." + }, + "AD_IMAGE_5_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 5 is required because an image link was provided." + }, + "AD_IMAGE_6_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 6 is required because an image link was provided." + }, + "AD_IMAGE_7_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 7 is required because an image link was provided." + }, + "AD_IMAGE_8_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 8 is required because an image link was provided." + }, + "AD_IMAGE_9_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 9 is required because an image link was provided." + }, + "AD_IMAGE_10_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 10 is required because an image link was provided." + }, + "AD_IMAGE_11_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 11 is required because an image link was provided." + }, + "AD_IMAGE_12_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 12 is required because an image link was provided." + }, + "AD_IMAGE_13_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 13 is required because an image link was provided." + }, + "AD_IMAGE_14_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 14 is required because an image link was provided." + }, + "AD_IMAGE_15_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 15 is required because an image link was provided." + }, + "AD_IMAGE_16_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 16 is required because an image link was provided." + }, + "AD_IMAGE_17_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 17 is required because an image link was provided." + }, + "AD_IMAGE_18_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 18 is required because an image link was provided." + }, + "AD_IMAGE_19_TAG_REQUIRED": { + "type": "integer", + "description": "Ad image tag 19 is required because an image link was provided." + }, "AD_LINK_FORMAT_WARNING": { "type": "integer", "description": "Some items have ad links that are formatted incorrectly." @@ -24923,6 +26420,106 @@ "CatalogsItemValidationIssue": { "type": "string", "enum": [ + "AD_IMAGE_0_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_1_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_2_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_3_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_4_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_5_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_6_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_7_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_8_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_9_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_10_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_11_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_12_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_13_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_14_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_15_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_16_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_17_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_18_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_19_LINK_LENGTH_TOO_LONG", + "AD_IMAGE_0_LINK_WARNING", + "AD_IMAGE_1_LINK_WARNING", + "AD_IMAGE_2_LINK_WARNING", + "AD_IMAGE_3_LINK_WARNING", + "AD_IMAGE_4_LINK_WARNING", + "AD_IMAGE_5_LINK_WARNING", + "AD_IMAGE_6_LINK_WARNING", + "AD_IMAGE_7_LINK_WARNING", + "AD_IMAGE_8_LINK_WARNING", + "AD_IMAGE_9_LINK_WARNING", + "AD_IMAGE_10_LINK_WARNING", + "AD_IMAGE_11_LINK_WARNING", + "AD_IMAGE_12_LINK_WARNING", + "AD_IMAGE_13_LINK_WARNING", + "AD_IMAGE_14_LINK_WARNING", + "AD_IMAGE_15_LINK_WARNING", + "AD_IMAGE_16_LINK_WARNING", + "AD_IMAGE_17_LINK_WARNING", + "AD_IMAGE_18_LINK_WARNING", + "AD_IMAGE_19_LINK_WARNING", + "AD_IMAGE_0_LINK_REQUIRED", + "AD_IMAGE_1_LINK_REQUIRED", + "AD_IMAGE_2_LINK_REQUIRED", + "AD_IMAGE_3_LINK_REQUIRED", + "AD_IMAGE_4_LINK_REQUIRED", + "AD_IMAGE_5_LINK_REQUIRED", + "AD_IMAGE_6_LINK_REQUIRED", + "AD_IMAGE_7_LINK_REQUIRED", + "AD_IMAGE_8_LINK_REQUIRED", + "AD_IMAGE_9_LINK_REQUIRED", + "AD_IMAGE_10_LINK_REQUIRED", + "AD_IMAGE_11_LINK_REQUIRED", + "AD_IMAGE_12_LINK_REQUIRED", + "AD_IMAGE_13_LINK_REQUIRED", + "AD_IMAGE_14_LINK_REQUIRED", + "AD_IMAGE_15_LINK_REQUIRED", + "AD_IMAGE_16_LINK_REQUIRED", + "AD_IMAGE_17_LINK_REQUIRED", + "AD_IMAGE_18_LINK_REQUIRED", + "AD_IMAGE_19_LINK_REQUIRED", + "AD_IMAGE_0_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_1_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_2_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_3_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_4_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_5_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_6_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_7_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_8_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_9_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_10_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_11_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_12_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_13_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_14_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_15_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_16_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_17_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_18_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_19_TAG_LENGTH_TOO_LONG", + "AD_IMAGE_0_TAG_REQUIRED", + "AD_IMAGE_1_TAG_REQUIRED", + "AD_IMAGE_2_TAG_REQUIRED", + "AD_IMAGE_3_TAG_REQUIRED", + "AD_IMAGE_4_TAG_REQUIRED", + "AD_IMAGE_5_TAG_REQUIRED", + "AD_IMAGE_6_TAG_REQUIRED", + "AD_IMAGE_7_TAG_REQUIRED", + "AD_IMAGE_8_TAG_REQUIRED", + "AD_IMAGE_9_TAG_REQUIRED", + "AD_IMAGE_10_TAG_REQUIRED", + "AD_IMAGE_11_TAG_REQUIRED", + "AD_IMAGE_12_TAG_REQUIRED", + "AD_IMAGE_13_TAG_REQUIRED", + "AD_IMAGE_14_TAG_REQUIRED", + "AD_IMAGE_15_TAG_REQUIRED", + "AD_IMAGE_16_TAG_REQUIRED", + "AD_IMAGE_17_TAG_REQUIRED", + "AD_IMAGE_18_TAG_REQUIRED", + "AD_IMAGE_19_TAG_REQUIRED", "AD_LINK_FORMAT_WARNING", "AD_LINK_SAME_AS_LINK", "ADDITIONAL_IMAGE_LINK_LENGTH_TOO_LONG", @@ -25023,6 +26620,406 @@ "CatalogsItemValidationWarnings": { "type": "object", "properties": { + "AD_IMAGE_0_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 0 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_1_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 1 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_2_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 2 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_3_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 3 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_4_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 4 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_5_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 5 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_6_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 6 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_7_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 7 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_8_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 8 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_9_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 9 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_10_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 10 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_11_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 11 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_12_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 12 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_13_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 13 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_14_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 14 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_15_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 15 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_16_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 16 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_17_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 17 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_18_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 18 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_19_LINK_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 19 length is too long. The maximum length is 2047 characters." + }, + "AD_IMAGE_0_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 0 format is unsupported." + }, + "AD_IMAGE_1_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 1 format is unsupported." + }, + "AD_IMAGE_2_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 2 format is unsupported." + }, + "AD_IMAGE_3_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 3 format is unsupported." + }, + "AD_IMAGE_4_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 4 format is unsupported." + }, + "AD_IMAGE_5_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 5 format is unsupported." + }, + "AD_IMAGE_6_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 6 format is unsupported." + }, + "AD_IMAGE_7_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 7 format is unsupported." + }, + "AD_IMAGE_8_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 8 format is unsupported." + }, + "AD_IMAGE_9_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 9 format is unsupported." + }, + "AD_IMAGE_10_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 10 format is unsupported." + }, + "AD_IMAGE_11_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 11 format is unsupported." + }, + "AD_IMAGE_12_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 12 format is unsupported." + }, + "AD_IMAGE_13_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 13 format is unsupported." + }, + "AD_IMAGE_14_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 14 format is unsupported." + }, + "AD_IMAGE_15_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 15 format is unsupported." + }, + "AD_IMAGE_16_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 16 format is unsupported." + }, + "AD_IMAGE_17_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 17 format is unsupported." + }, + "AD_IMAGE_18_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 18 format is unsupported." + }, + "AD_IMAGE_19_LINK_WARNING": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 19 format is unsupported." + }, + "AD_IMAGE_0_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 0 is required because an image tag was provided." + }, + "AD_IMAGE_1_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 1 is required because an image tag was provided." + }, + "AD_IMAGE_2_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 2 is required because an image tag was provided." + }, + "AD_IMAGE_3_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 3 is required because an image tag was provided." + }, + "AD_IMAGE_4_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 4 is required because an image tag was provided." + }, + "AD_IMAGE_5_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 5 is required because an image tag was provided." + }, + "AD_IMAGE_6_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 6 is required because an image tag was provided." + }, + "AD_IMAGE_7_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 7 is required because an image tag was provided." + }, + "AD_IMAGE_8_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 8 is required because an image tag was provided." + }, + "AD_IMAGE_9_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 9 is required because an image tag was provided." + }, + "AD_IMAGE_10_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 10 is required because an image tag was provided." + }, + "AD_IMAGE_11_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 11 is required because an image tag was provided." + }, + "AD_IMAGE_12_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 12 is required because an image tag was provided." + }, + "AD_IMAGE_13_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 13 is required because an image tag was provided." + }, + "AD_IMAGE_14_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 14 is required because an image tag was provided." + }, + "AD_IMAGE_15_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 15 is required because an image tag was provided." + }, + "AD_IMAGE_16_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 16 is required because an image tag was provided." + }, + "AD_IMAGE_17_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 17 is required because an image tag was provided." + }, + "AD_IMAGE_18_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 18 is required because an image tag was provided." + }, + "AD_IMAGE_19_LINK_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image link 19 is required because an image tag was provided." + }, + "AD_IMAGE_0_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 0 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_1_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 1 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_2_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 2 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_3_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 3 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_4_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 4 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_5_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 5 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_6_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 6 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_7_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 7 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_8_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 8 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_9_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 9 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_10_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 10 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_11_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 11 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_12_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 12 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_13_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 13 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_14_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 14 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_15_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 15 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_16_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 16 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_17_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 17 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_18_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 18 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_19_TAG_LENGTH_TOO_LONG": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 19 length is too long. The maximum length is 511 characters." + }, + "AD_IMAGE_0_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 0 is required because an image link was provided." + }, + "AD_IMAGE_1_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 1 is required because an image link was provided." + }, + "AD_IMAGE_2_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 2 is required because an image link was provided." + }, + "AD_IMAGE_3_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 3 is required because an image link was provided." + }, + "AD_IMAGE_4_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 4 is required because an image link was provided." + }, + "AD_IMAGE_5_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 5 is required because an image link was provided." + }, + "AD_IMAGE_6_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 6 is required because an image link was provided." + }, + "AD_IMAGE_7_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 7 is required because an image link was provided." + }, + "AD_IMAGE_8_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 8 is required because an image link was provided." + }, + "AD_IMAGE_9_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 9 is required because an image link was provided." + }, + "AD_IMAGE_10_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 10 is required because an image link was provided." + }, + "AD_IMAGE_11_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 11 is required because an image link was provided." + }, + "AD_IMAGE_12_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 12 is required because an image link was provided." + }, + "AD_IMAGE_13_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 13 is required because an image link was provided." + }, + "AD_IMAGE_14_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 14 is required because an image link was provided." + }, + "AD_IMAGE_15_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 15 is required because an image link was provided." + }, + "AD_IMAGE_16_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 16 is required because an image link was provided." + }, + "AD_IMAGE_17_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 17 is required because an image link was provided." + }, + "AD_IMAGE_18_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 18 is required because an image link was provided." + }, + "AD_IMAGE_19_TAG_REQUIRED": { + "$ref": "#/components/schemas/CatalogsItemValidationDetails", + "description": "Ad image tag 19 is required because an image link was provided." + }, "AD_LINK_FORMAT_WARNING": { "$ref": "#/components/schemas/CatalogsItemValidationDetails", "description": "Item has an ad link that is formatted incorrectly." @@ -26003,6 +28000,7 @@ }, "CatalogsCreativeAssetsProductGroupFiltersAllOf": { "type": "object", + "title": "all_of", "additionalProperties": false, "properties": { "all_of": { @@ -26019,6 +28017,7 @@ }, "CatalogsCreativeAssetsProductGroupFiltersAnyOf": { "type": "object", + "title": "any_of", "additionalProperties": false, "properties": { "any_of": { @@ -26077,6 +28076,9 @@ }, { "$ref": "#/components/schemas/MediaTypeFilter" + }, + { + "$ref": "#/components/schemas/TitleKeywordsFilter" } ] }, @@ -26168,6 +28170,9 @@ "filters": { "$ref": "#/components/schemas/CatalogsHotelProductGroupFilters" }, + "type": { + "$ref": "#/components/schemas/CatalogsHotelProductGroupType" + }, "created_at": { "description": "Unix timestamp in seconds of when catalog product group was created.", "example": 1621350033000, @@ -26188,7 +28193,8 @@ "id", "filters", "catalog_type", - "catalog_id" + "catalog_id", + "type" ] }, "CatalogsHotelProductGroupFilterKeys": { @@ -26220,6 +28226,9 @@ }, { "$ref": "#/components/schemas/CountryFilter" + }, + { + "$ref": "#/components/schemas/TitleKeywordsFilter" } ] }, @@ -26238,6 +28247,7 @@ }, "CatalogsHotelProductGroupFiltersAllOf": { "type": "object", + "title": "all_of", "additionalProperties": false, "properties": { "all_of": { @@ -26254,6 +28264,7 @@ }, "CatalogsHotelProductGroupFiltersAnyOf": { "type": "object", + "title": "any_of", "additionalProperties": false, "properties": { "any_of": { @@ -26343,7 +28354,8 @@ "id", "catalog_id", "feed_id", - "catalog_type" + "catalog_type", + "type" ] }, "CatalogsHotelProductGroupCreateRequest": { @@ -26623,6 +28635,24 @@ }, { "$ref": "#/components/schemas/ProductGroupReferenceFilter" + }, + { + "$ref": "#/components/schemas/CustomNumber0Filter" + }, + { + "$ref": "#/components/schemas/CustomNumber1Filter" + }, + { + "$ref": "#/components/schemas/CustomNumber2Filter" + }, + { + "$ref": "#/components/schemas/CustomNumber3Filter" + }, + { + "$ref": "#/components/schemas/CustomNumber4Filter" + }, + { + "$ref": "#/components/schemas/TitleKeywordsFilter" } ] }, @@ -26641,6 +28671,7 @@ }, "CatalogsProductGroupFiltersAllOf": { "type": "object", + "title": "all_of", "additionalProperties": false, "properties": { "all_of": { @@ -26662,6 +28693,7 @@ "anyOf": [ { "type": "object", + "title": "any_of", "additionalProperties": false, "properties": { "any_of": { @@ -26679,6 +28711,7 @@ }, { "type": "object", + "title": "all_of", "additionalProperties": false, "properties": { "all_of": { @@ -26698,6 +28731,7 @@ }, "CatalogsProductGroupFiltersAnyOf": { "type": "object", + "title": "any_of", "additionalProperties": false, "properties": { "any_of": { @@ -26792,6 +28826,34 @@ "values" ] }, + "CatalogsProductGroupFilterOperatorTypeCriteria": { + "title": "catalogs_product_group_filter_operator_type_criteria", + "type": "object", + "additionalProperties": false, + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + } + }, + "negated": { + "type": "boolean", + "default": false + }, + "filter_operator_type": { + "default": "IS", + "type": "string", + "enum": [ + "IS", + "CONTAINS" + ] + } + }, + "required": [ + "values" + ] + }, "CatalogsProductGroupMultipleStringListCriteria": { "title": "catalogs_product_group_multiple_string_list_criteria", "type": "object", @@ -26837,6 +28899,35 @@ "values" ] }, + "CatalogsProductGroupUint32Criteria": { + "title": "catalogs_product_group_uint32_criteria", + "type": "object", + "additionalProperties": false, + "properties": { + "operator": { + "type": "string", + "enum": [ + "GREATER_THAN", + "GREATER_THAN_OR_EQUALS", + "LESS_THAN", + "LESS_THAN_OR_EQUALS" + ] + }, + "value": { + "type": "integer", + "minimum": 0, + "maximum": 4294967295 + }, + "negated": { + "type": "boolean", + "default": false + } + }, + "required": [ + "operator", + "value" + ] + }, "CatalogsProductGroupProductCountsVertical": { "type": "object", "description": "Product counts for a CatalogsProductGroup", @@ -26979,6 +29070,16 @@ ], "example": "TOP_SELLERS" }, + "CatalogsHotelProductGroupType": { + "type": "string", + "title": "hotel_product_group_type", + "description": "

Catalog hotel product group type

\n

MERCHANT_CREATED: Product groups created by merchants.\n
ALL_LISTINGS: Includes every hotel item in your catalog.", + "enum": [ + "MERCHANT_CREATED", + "ALL_LISTINGS" + ], + "example": "MERCHANT_CREATED" + }, "CatalogsProductGroupUpdateRequest": { "type": "object", "title": "retail feed based", @@ -28181,6 +30282,7 @@ }, "ConditionFilter": { "type": "object", + "title": "CONDITION", "additionalProperties": false, "properties": { "CONDITION": { @@ -28361,8 +30463,8 @@ "type": "string" }, "example": [ - "red-pinterest-shirt-logo-1", - "purple-pinterest-shirt-logo-3" + "product-id-001", + "product-id-002" ] }, "content_name": { @@ -28392,43 +30494,55 @@ "properties": { "id": { "description": "The id of a product. We recommend using this if you are a merchant for AddToCart and Checkouts. For detail, please check here (Install the Pinterest tag section).", - "example": "red-pinterest-shirt-logo-1", "type": "string" }, "item_price": { "description": "The price of a product. Accepted as a string in the request; it will be parsed into a double. This is the original item value before any discount. We recommend using this if you are a merchant for PageVisit, AddToCart and Checkouts. For detail, please check here (Install the Pinterest tag section).", - "example": "1325.12", "type": "string" }, "quantity": { "description": "The amount of a product. We recommend using this if you are a merchant for AddToCart and Checkouts. For detail, please check here (Install the Pinterest tag section).", "type": "integer", - "format": "int64", - "example": 5 + "format": "int64" }, "item_name": { "description": "The name of a product.", - "example": "pinterest-clothing-shirt", "type": "string" }, "item_category": { "description": "The category of a product.", - "example": "pinterest-entertainment", "type": "string" }, "item_brand": { "description": "The brand of a product.", - "example": "pinterest", "type": "string" } } - } + }, + "example": [ + { + "id": "product-id-001", + "item_price": "14.99", + "quantity": 3, + "item_name": "pinterest-shirt-girl", + "item_category": "pinterest-clothing-shirts", + "item_brand": "pinterest" + }, + { + "id": "product-id-002", + "item_price": "13.71", + "quantity": 2, + "item_name": "pinterest-shirt-men", + "item_category": "pinterest-clothing-shirts", + "item_brand": "pinterest" + } + ] }, "num_items": { "description": "Total number of products of the event. For example, the total number of items purchased in a checkout event. We recommend using this if you are a merchant for AddToCart and Checkouts. For detail, please check here (Install the Pinterest tag section).", "type": "integer", "format": "int64", - "example": 2 + "example": 5 }, "order_id": { "description": "The order ID. We recommend sending order_id to help us deduplicate events when necessary. This also helps to run other measurement products at Pinterest.", @@ -28436,6 +30550,18 @@ "nullable": true, "example": "my_order_id" }, + "external_measurement_vendor_id": { + "description": "Only use when instructed.", + "type": "integer", + "nullable": true, + "example": 1 + }, + "external_measurement_id": { + "description": "Only use when instructed.", + "type": "string", + "nullable": true, + "example": "rbos-cb7a9e56-4988-4ca0-801b-05c79b29785f" + }, "search_string": { "description": "The search string related to the user conversion event.", "type": "string", @@ -28535,125 +30661,63 @@ "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. The string should be in the UTF-8 format.", - "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. The string should be in the UTF-8 format.", - "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" - } - }, + "$ref": "#/components/schemas/ConversionEventsUserDataProperties", "required": [ "em" - ] + ], + "title": "EMConversionEventsUserDataPropertyRequired" }, { - "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. The string should be in the UTF-8 format.", - "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. The string should be in the UTF-8 format.", - "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" - } - }, + "$ref": "#/components/schemas/ConversionEventsUserDataProperties", "required": [ "hashed_maids" - ] + ], + "title": "HashedMaidsConversionEventsUserDataPropertyRequired" }, { - "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. The string should be in the UTF-8 format.", - "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. The string should be in the UTF-8 format.", - "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" - } - }, + "$ref": "#/components/schemas/ConversionEventsUserDataProperties", "required": [ "client_ip_address", "client_user_agent" - ] + ], + "title": "ClientIPAddressConversionEventsUserDataPropertyRequired" } - ], + ] + }, + "ConversionEventsUserDataProperties": { + "type": "object", "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. The string should be in the UTF-8 format.", + "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. The string should be in the UTF-8 format.", + "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" + }, "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. The string should be in the UTF-8 format.", "type": "array", @@ -28768,6 +30832,125 @@ } } }, + "ConversionMSOTEvents": { + "title": "Conversion MSOT Events", + "description": "Object containing the MSOT conversion events.", + "type": "object", + "additionalProperties": false, + "properties": { + "event_id": { + "description": "A unique id string that identifies this event. If you are already sending us events through Conversions API, then this id should match the event_id sent through Conversions API.", + "type": "string", + "maxLength": 256, + "example": "eventId0001" + }, + "event_name": { + "description": "Type of user event.", + "type": "string", + "enum": [ + "add_to_cart", + "checkout", + "lead", + "signup" + ], + "example": "add_to_cart" + }, + "event_timestamp": { + "description": "The time when the event occurred. Unix timestamp in seconds.", + "type": "integer", + "format": "int64", + "example": 1451431341 + }, + "ad_group_id": { + "description": "The ID of the ad group that was attributed to the conversion event.", + "type": "string", + "pattern": "^\\d+$", + "example": "2680060704746" + }, + "attribution_scope": { + "description": "Ad event type.", + "type": "string", + "enum": [ + "view", + "engagement", + "click" + ], + "example": "click" + }, + "value": { + "description": "Order value of the conversion event. Required if event_name is 'add_to_cart' or 'checkout'.", + "type": "number", + "format": "double", + "example": 123.45 + }, + "currency": { + "allOf": [ + { + "$ref": "#/components/schemas/Currency" + }, + { + "type": "string", + "description": "Currency code for the value field, required if value is present. Currency Codes should be in ISO 4217 standard." + } + ] + }, + "campaign_id": { + "description": "The ID of the campaign that was attributed to the conversion event.", + "type": "string", + "pattern": "^\\d+$", + "example": "626736533506" + }, + "action_timestamps": { + "description": "Timestamp(s) when the ad action(s) happened. Unix timestamp in seconds.", + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "example": [ + 1451410040 + ] + }, + "attribution_model": { + "description": "The attribution model used to attribute the conversion event.", + "type": "string", + "enum": [ + "first_touch", + "last_touch", + "multi_touch" + ], + "example": "multi_touch" + }, + "attribution_score": { + "description": "Credit given to the attributed ad actions. Allowed values are > 0 and <= 1.", + "type": "number", + "format": "double", + "minimum": 0, + "exclusiveMinimum": true, + "maximum": 1, + "example": 0.5 + }, + "total_events": { + "description": "Total number of conversion events that are reported in one API call.\n

If you are sending one API request for one attributed conversion event then this value should be 1.

\n

If you are sending multiple attributed conversion events in one API request then this value should be the total number of attributed conversion events in the request.

", + "type": "integer", + "minimum": 1, + "example": 2 + }, + "total_event_touchpoints": { + "description": "Total number of ad events including other non-Pinterest ad platforms.", + "type": "integer", + "minimum": 1, + "example": 2 + } + }, + "required": [ + "event_id", + "event_name", + "event_timestamp", + "ad_group_id", + "attribution_scope" + ] + }, "ConversionReportAttributionType": { "type": "string", "description": "Attribution type. Refers to the Pinterest Tag endpoints", @@ -28896,6 +31079,14 @@ "type": "boolean", "default": false, "nullable": true + }, + "aem_external_id_enabled": { + "description": "Whether Automatic Enhanced Match location is enabled. See Enhanced match for more information.", + "example": true, + "title": "aem_external_id_enabled", + "type": "boolean", + "default": false, + "nullable": true } }, "title": "ConversionTagConfigs" @@ -29248,6 +31439,7 @@ }, "CountryFilter": { "type": "object", + "title": "COUNTRY", "additionalProperties": false, "properties": { "COUNTRY": { @@ -29627,6 +31819,7 @@ }, "CurrencyFilter": { "type": "object", + "title": "CURRENCY", "additionalProperties": false, "properties": { "CURRENCY": { @@ -29645,11 +31838,12 @@ }, "CustomLabel0Filter": { "type": "object", + "title": "CUSTOM_LABEL_0", "additionalProperties": false, "properties": { "CUSTOM_LABEL_0": { "type": "object", - "$ref": "#/components/schemas/CatalogsProductGroupMultipleStringCriteria" + "$ref": "#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria" } }, "required": [ @@ -29658,11 +31852,12 @@ }, "CustomLabel1Filter": { "type": "object", + "title": "CUSTOM_LABEL_1", "additionalProperties": false, "properties": { "CUSTOM_LABEL_1": { "type": "object", - "$ref": "#/components/schemas/CatalogsProductGroupMultipleStringCriteria" + "$ref": "#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria" } }, "required": [ @@ -29671,11 +31866,12 @@ }, "CustomLabel2Filter": { "type": "object", + "title": "CUSTOM_LABEL_2", "additionalProperties": false, "properties": { "CUSTOM_LABEL_2": { "type": "object", - "$ref": "#/components/schemas/CatalogsProductGroupMultipleStringCriteria" + "$ref": "#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria" } }, "required": [ @@ -29684,11 +31880,12 @@ }, "CustomLabel3Filter": { "type": "object", + "title": "CUSTOM_LABEL_3", "additionalProperties": false, "properties": { "CUSTOM_LABEL_3": { "type": "object", - "$ref": "#/components/schemas/CatalogsProductGroupMultipleStringCriteria" + "$ref": "#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria" } }, "required": [ @@ -29697,17 +31894,88 @@ }, "CustomLabel4Filter": { "type": "object", + "title": "CUSTOM_LABEL_4", "additionalProperties": false, "properties": { "CUSTOM_LABEL_4": { "type": "object", - "$ref": "#/components/schemas/CatalogsProductGroupMultipleStringCriteria" + "$ref": "#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria" } }, "required": [ "CUSTOM_LABEL_4" ] }, + "CustomNumber0Filter": { + "type": "object", + "title": "CUSTOM_NUMBER_0", + "additionalProperties": false, + "properties": { + "CUSTOM_NUMBER_0": { + "type": "object", + "$ref": "#/components/schemas/CatalogsProductGroupUint32Criteria" + } + }, + "required": [ + "CUSTOM_NUMBER_0" + ] + }, + "CustomNumber1Filter": { + "type": "object", + "title": "CUSTOM_NUMBER_1", + "additionalProperties": false, + "properties": { + "CUSTOM_NUMBER_1": { + "type": "object", + "$ref": "#/components/schemas/CatalogsProductGroupUint32Criteria" + } + }, + "required": [ + "CUSTOM_NUMBER_1" + ] + }, + "CustomNumber2Filter": { + "type": "object", + "title": "CUSTOM_NUMBER_2", + "additionalProperties": false, + "properties": { + "CUSTOM_NUMBER_2": { + "type": "object", + "$ref": "#/components/schemas/CatalogsProductGroupUint32Criteria" + } + }, + "required": [ + "CUSTOM_NUMBER_2" + ] + }, + "CustomNumber3Filter": { + "type": "object", + "title": "CUSTOM_NUMBER_3", + "additionalProperties": false, + "properties": { + "CUSTOM_NUMBER_3": { + "type": "object", + "$ref": "#/components/schemas/CatalogsProductGroupUint32Criteria" + } + }, + "required": [ + "CUSTOM_NUMBER_3" + ] + }, + "CustomNumber4Filter": { + "type": "object", + "title": "CUSTOM_NUMBER_4", + "additionalProperties": false, + "properties": { + "CUSTOM_NUMBER_4": { + "type": "object", + "$ref": "#/components/schemas/CatalogsProductGroupUint32Criteria" + } + }, + "required": [ + "CUSTOM_NUMBER_4" + ] + }, "CustomerList": { "properties": { "ad_account_id": { @@ -29808,11 +32076,6 @@ "default": "EMAIL", "title": "list_type", "type": "string" - }, - "exceptions": { - "description": "Customer list errors.", - "title": "exceptions", - "type": "object" } }, "required": [ @@ -29838,10 +32101,6 @@ ], "title": "operation_type", "type": "string" - }, - "exceptions": { - "$ref": "#/components/schemas/Exception", - "type": "object" } }, "required": [ @@ -30082,6 +32341,9 @@ "description": { "type": "string", "nullable": true + }, + "id": { + "type": "string" } } }, @@ -30166,6 +32428,7 @@ }, "GenderFilter": { "type": "object", + "title": "GENDER", "additionalProperties": false, "properties": { "GENDER": { @@ -30186,6 +32449,7 @@ }, "MediaTypeFilter": { "type": "object", + "title": "MEDIA_TYPE", "additionalProperties": false, "properties": { "MEDIA_TYPE": { @@ -30246,6 +32510,29 @@ "nullable": true, "description": "An object containing all the information specific to the provided asset group. This field will be populated only if asset_type equals 'ASSET_GROUP'.", "$ref": "#/components/schemas/AssetGroupBinding" + }, + "catalog_info": { + "nullable": true, + "description": "An object containing all the information specific to the provided catalog. This field will be populated only if asset_type equals 'CATALOG'.", + "type": "object", + "properties": { + "id": { + "description": "Catalog ID.", + "example": "4836859046874", + "type": "string", + "pattern": "^\\d+$" + }, + "name": { + "type": "string", + "description": "Catalog name", + "example": "Canada Catalog" + }, + "catalog_type": { + "type": "string", + "description": "Catalog type", + "example": "PRODUCT" + } + } } } }, @@ -30255,7 +32542,8 @@ "AD_ACCOUNT", "PROFILE", "ASSET_GROUP", - "CONVERSION_TAG" + "CONVERSION_TAG", + "CATALOG" ], "example": "AD_ACCOUNT", "type": "string" @@ -30340,6 +32628,7 @@ }, "GoogleProductCategory0Filter": { "type": "object", + "title": "GOOGLE_PRODUCT_CATEGORY_0", "additionalProperties": false, "properties": { "GOOGLE_PRODUCT_CATEGORY_0": { @@ -30353,6 +32642,7 @@ }, "GoogleProductCategory1Filter": { "type": "object", + "title": "GOOGLE_PRODUCT_CATEGORY_1", "additionalProperties": false, "properties": { "GOOGLE_PRODUCT_CATEGORY_1": { @@ -30366,6 +32656,7 @@ }, "GoogleProductCategory2Filter": { "type": "object", + "title": "GOOGLE_PRODUCT_CATEGORY_2", "additionalProperties": false, "properties": { "GOOGLE_PRODUCT_CATEGORY_2": { @@ -30379,6 +32670,7 @@ }, "GoogleProductCategory3Filter": { "type": "object", + "title": "GOOGLE_PRODUCT_CATEGORY_3", "additionalProperties": false, "properties": { "GOOGLE_PRODUCT_CATEGORY_3": { @@ -30392,6 +32684,7 @@ }, "GoogleProductCategory4Filter": { "type": "object", + "title": "GOOGLE_PRODUCT_CATEGORY_4", "additionalProperties": false, "properties": { "GOOGLE_PRODUCT_CATEGORY_4": { @@ -30405,6 +32698,7 @@ }, "GoogleProductCategory5Filter": { "type": "object", + "title": "GOOGLE_PRODUCT_CATEGORY_5", "additionalProperties": false, "properties": { "GOOGLE_PRODUCT_CATEGORY_5": { @@ -30418,6 +32712,7 @@ }, "GoogleProductCategory6Filter": { "type": "object", + "title": "GOOGLE_PRODUCT_CATEGORY_6", "additionalProperties": false, "properties": { "GOOGLE_PRODUCT_CATEGORY_6": { @@ -30431,6 +32726,7 @@ }, "ProductGroupReferenceFilter": { "type": "object", + "title": "PRODUCT_GROUP", "additionalProperties": false, "properties": { "PRODUCT_GROUP": { @@ -30465,6 +32761,7 @@ }, "HotelIdFilter": { "type": "object", + "title": "HOTEL_ID", "additionalProperties": false, "properties": { "HOTEL_ID": { @@ -30478,6 +32775,7 @@ }, "CreativeAssetsIdFilter": { "type": "object", + "title": "CREATIVE_ASSETS_ID", "additionalProperties": false, "properties": { "CREATIVE_ASSETS_ID": { @@ -30646,7 +32944,7 @@ "message": { "type": "string", "description": "Explanation of the event that occured.", - "maxLength": 2048 + "maxLength": 8192 }, "app_version_number": { "type": "string", @@ -30692,7 +32990,7 @@ "message": { "type": "string", "description": "Human-readable description of the error.", - "maxLength": 512 + "maxLength": 8192 }, "message_detail": { "type": "string", @@ -30901,7 +33199,6 @@ "properties": { "external_business_id": { "type": "string", - "nullable": true, "description": "External business ID for the integration." }, "connected_merchant_id": { @@ -31341,6 +33638,20 @@ "pattern": "^\\d+$" } }, + "catalogs_ids": { + "description": "A list of catalog IDs under asset group", + "example": [ + "4836859046874" + ], + "type": "array", + "nullable": true, + "items": { + "description": "The ID of a catalog in an asset group.", + "example": "4836859046874", + "type": "string", + "pattern": "^\\d+$" + } + }, "created_time": { "description": "The creation time of the asset group", "example": 1646767577816, @@ -31438,6 +33749,9 @@ }, { "$ref": "#/components/schemas/UpdatableItemAttributes" + }, + { + "type": "object" } ] }, @@ -31490,6 +33804,9 @@ }, { "$ref": "#/components/schemas/UpdatableItemAttributes" + }, + { + "type": "object" } ] }, @@ -31552,6 +33869,7 @@ }, "ItemGroupIdFilter": { "type": "object", + "title": "ITEM_GROUP_ID", "additionalProperties": false, "properties": { "ITEM_GROUP_ID": { @@ -31565,6 +33883,7 @@ }, "ItemIdFilter": { "type": "object", + "title": "ITEM_ID", "additionalProperties": false, "properties": { "ITEM_ID": { @@ -31576,6 +33895,20 @@ "ITEM_ID" ] }, + "TitleKeywordsFilter": { + "type": "object", + "title": "TITLE_KEYWORDS", + "additionalProperties": false, + "properties": { + "TITLE_KEYWORDS": { + "type": "object", + "$ref": "#/components/schemas/CatalogsProductGroupMultipleStringCriteria" + } + }, + "required": [ + "TITLE_KEYWORDS" + ] + }, "ItemProcessingRecord": { "type": "object", "description": "Object describing an item processing record", @@ -31857,12 +34190,6 @@ "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", @@ -32044,7 +34371,7 @@ }, "Language": { "type": "string", - "description": "Language code, which is among the offical ISO 639-1 language list.", + "description": "Language code, which is among the official ISO 639-1 language list.", "example": "EN", "enum": [ "AM", @@ -32535,6 +34862,7 @@ }, "MaxPriceFilter": { "type": "object", + "title": "MAX_PRICE", "additionalProperties": false, "properties": { "MAX_PRICE": { @@ -32942,6 +35270,7 @@ }, "PriceFilter": { "type": "object", + "title": "PRICE", "additionalProperties": false, "properties": { "PRICE": { @@ -32983,6 +35312,7 @@ }, "MinPriceFilter": { "type": "object", + "title": "MIN_PRICE", "additionalProperties": false, "properties": { "MIN_PRICE": { @@ -33276,6 +35606,46 @@ "MIN_AD_PRICE", "SHIPPING_WIDTH", "SHIPPING_HEIGHT", + "AD_IMAGE_0_LINK", + "AD_IMAGE_1_LINK", + "AD_IMAGE_2_LINK", + "AD_IMAGE_3_LINK", + "AD_IMAGE_4_LINK", + "AD_IMAGE_5_LINK", + "AD_IMAGE_6_LINK", + "AD_IMAGE_7_LINK", + "AD_IMAGE_8_LINK", + "AD_IMAGE_9_LINK", + "AD_IMAGE_10_LINK", + "AD_IMAGE_11_LINK", + "AD_IMAGE_12_LINK", + "AD_IMAGE_13_LINK", + "AD_IMAGE_14_LINK", + "AD_IMAGE_15_LINK", + "AD_IMAGE_16_LINK", + "AD_IMAGE_17_LINK", + "AD_IMAGE_18_LINK", + "AD_IMAGE_19_LINK", + "AD_IMAGE_0_TAG", + "AD_IMAGE_1_TAG", + "AD_IMAGE_2_TAG", + "AD_IMAGE_3_TAG", + "AD_IMAGE_4_TAG", + "AD_IMAGE_5_TAG", + "AD_IMAGE_6_TAG", + "AD_IMAGE_7_TAG", + "AD_IMAGE_8_TAG", + "AD_IMAGE_9_TAG", + "AD_IMAGE_10_TAG", + "AD_IMAGE_11_TAG", + "AD_IMAGE_12_TAG", + "AD_IMAGE_13_TAG", + "AD_IMAGE_14_TAG", + "AD_IMAGE_15_TAG", + "AD_IMAGE_16_TAG", + "AD_IMAGE_17_TAG", + "AD_IMAGE_18_TAG", + "AD_IMAGE_19_TAG", null ] }, @@ -33490,6 +35860,10 @@ }, "redirect_uri": { "type": "string" + }, + "continuous_refresh": { + "description": "Setting this value to true will have a continuous refresh token be returned from this endpoint rather than the current legacy, 1-year expiry, refresh token.", + "type": "boolean" } }, "required": [ @@ -33525,10 +35899,6 @@ }, "scope": { "type": "string" - }, - "refresh_on": { - "description": "Setting this field to true will add a new refresh token to your 200 response, as well as the refresh_token_expires_in and refresh_token_expires_at fields. To see the structure of this payload, set the 200 response_type to \"everlasting_refresh\".", - "type": "boolean" } }, "required": [ @@ -33911,7 +36281,7 @@ "pattern": "^[0-9]+$" }, "is_roas_optimized": { - "description": "ROAS optimization is not supported", + "description": "Performance+ ROAS bidding. When enabled, Pinterest will optimize for conversion value instead of conversion volume. Only supported when `conversion_event` is set to `\"CHECKOUT\"` and `bid_strategy_type` is set to `\"AUTOMATIC_BID\"`.
This parameter is not enabled for all advertisers. Learn more.", "nullable": true, "title": "is_roas_optimized", "type": "boolean" @@ -33934,7 +36304,10 @@ "frequency_goal_metadata": { "properties": { "frequency": { - "type": "integer" + "type": "integer", + "description": "Frequency target can only be between 2 and 20", + "minimum": 2, + "maximum": 20 }, "timerange": { "type": "string", @@ -34203,9 +36576,12 @@ "ADMIN", "ANALYST", "FINANCE_MANAGER", + "FINANCE_EDIT", + "FINANCE_VIEW", "AUDIENCE_MANAGER", "CAMPAIGN_MANAGER", "CATALOGS_MANAGER", + "CATALOGS_VIEWER", "PROFILE_PUBLISHER" ] }, @@ -34227,6 +36603,8 @@ "ADMIN", "ANALYST", "FINANCE_MANAGER", + "FINANCE_EDIT", + "FINANCE_VIEW", "AUDIENCE_MANAGER", "CAMPAIGN_MANAGER", "CATALOGS_MANAGER", @@ -34550,29 +36928,47 @@ "description": "Private note for this Pin. Learn more.", "type": "string", "nullable": true + }, + "sponsor_id": { + "description": "The sponsor account id to request paid partnership from. Currently the field is only available to a list of users in a closed beta.", + "type": "string", + "pattern": "^\\d+$", + "nullable": true } } }, - "PinMedia": { - "title": "Pin media", + "PinMediaBase": { "type": "object", - "description": "Pin media objects.", - "discriminator": { - "propertyName": "media_type", - "mapping": { - "image": "#/components/schemas/PinMediaWithImage", - "video": "#/components/schemas/PinMediaWithVideo", - "multiple_images": "#/components/schemas/PinMediaWithImages", - "multiple_videos": "#/components/schemas/PinMediaWithVideos", - "multiple_mixed": "#/components/schemas/PinMediaWithImageAndVideo" - } - }, + "description": "Pin Base objects.", "properties": { "media_type": { "type": "string" } } }, + "PinMedia": { + "title": "Pin media", + "type": "object", + "description": "Pin media objects.", + "allOf": [ + { + "$ref": "#/components/schemas/PinMediaBase" + }, + { + "type": "object", + "discriminator": { + "propertyName": "media_type", + "mapping": { + "image": "#/components/schemas/PinMediaWithImage", + "video": "#/components/schemas/PinMediaWithVideo", + "multiple_images": "#/components/schemas/PinMediaWithImages", + "multiple_videos": "#/components/schemas/PinMediaWithVideos", + "multiple_mixed": "#/components/schemas/PinMediaWithImageAndVideo" + } + } + } + ] + }, "PinMediaMetadata": { "type": "object", "anyOf": [ @@ -34835,6 +37231,11 @@ "type": "string", "description": "Cover image Base64." }, + "cover_image_key_frame_time": { + "type": "integer", + "description": "Keyframe timestamp for cover image (seconds). If entered time exceeds video duration, the last frame is used.", + "minimum": 0 + }, "media_id": { "type": "string", "pattern": "^\\d+$" @@ -34855,6 +37256,9 @@ "title": "image", "description": "Pin with image.", "allOf": [ + { + "$ref": "#/components/schemas/PinMediaBase" + }, { "type": "object", "properties": { @@ -34880,9 +37284,6 @@ } } } - }, - { - "$ref": "#/components/schemas/PinMedia" } ], "example": { @@ -34916,6 +37317,9 @@ "title": "Video and image", "description": "Pin with a mix of images and videos.", "allOf": [ + { + "$ref": "#/components/schemas/PinMediaBase" + }, { "type": "object", "properties": { @@ -34926,9 +37330,6 @@ } } } - }, - { - "$ref": "#/components/schemas/PinMedia" } ] }, @@ -34937,6 +37338,9 @@ "title": "Images", "description": "Pin with multiple images.", "allOf": [ + { + "$ref": "#/components/schemas/PinMediaBase" + }, { "type": "object", "properties": { @@ -34947,9 +37351,6 @@ } } } - }, - { - "$ref": "#/components/schemas/PinMedia" } ] }, @@ -34958,6 +37359,9 @@ "title": "video", "description": "Pin with video.", "allOf": [ + { + "$ref": "#/components/schemas/PinMediaBase" + }, { "type": "object", "properties": { @@ -35003,9 +37407,6 @@ "description": "Width (in pixels)" } } - }, - { - "$ref": "#/components/schemas/PinMedia" } ], "example": { @@ -35038,6 +37439,9 @@ "title": "Videos", "description": "Pin with multiple videos.", "allOf": [ + { + "$ref": "#/components/schemas/PinMediaBase" + }, { "type": "object", "properties": { @@ -35048,9 +37452,6 @@ } } } - }, - { - "$ref": "#/components/schemas/PinMedia" } ] }, @@ -35289,6 +37690,9 @@ "type": "string", "nullable": true }, + "creative_type": { + "$ref": "#/components/schemas/CreativeType" + }, "collections_hero_pin_id": { "description": "Hero Pin ID if this PG is promoted as a Collection", "example": "123123", @@ -35306,6 +37710,45 @@ }, "grid_click_type": { "$ref": "#/components/schemas/GridClickType" + }, + "is_generate_background": { + "type": "boolean", + "description": "Enable generate backgrounds for the product group, default value is FALSE. When enabled, Pinterest will use generative AI to apply backgrounds for your product images that help drive user inspiration and engagement.", + "example": true, + "nullable": true + }, + "customizable_cta_type": { + "type": "string", + "description": "Select a call to action (CTA) to display below your ad. CTA options for catalog sales campaigns are SHOP_NOW, BOOK_NOW, ON_SALE, GET_DEAL", + "example": "SHOP_NOW", + "nullable": true, + "enum": [ + "SHOP_NOW", + "BOOK_NOW", + "ON_SALE", + "GET_DEAL", + null + ] + }, + "collections_header_type": { + "type": "string", + "nullable": true, + "description": "Collections ad header type", + "example": "SHOP_THIS_COLLECTION", + "enum": [ + "SHOP_THIS_COLLECTION", + "EXPLORE_THIS_COLLECTION", + "NO_HEADER", + "ON_SALE", + "GET_DEAL", + null + ] + }, + "selected_image_tag": { + "type": "string", + "description": "The ad image tag selected for the product group promotion.", + "example": "holiday_sale", + "nullable": true } }, "type": "object", @@ -35316,25 +37759,25 @@ "product_group_promotion": [ { "slideshow_collections_description": "Description", + "creative_type": "REGULAR", "collections_hero_pin_id": "123123", "catalog_product_group_name": "catalogProductGroupName", "collections_hero_destination_url": "http://www.pinterest.com", "tracking_url": "https://www.pinterest.com", "slideshow_collections_title": "Title", "is_mdl": true, - "status": "ACTIVE", - "creative_type": "REGULAR" + "status": "ACTIVE" }, { "slideshow_collections_description": "Description", + "creative_type": "REGULAR", "collections_hero_pin_id": "123123", "catalog_product_group_name": "catalogProductGroupName", "collections_hero_destination_url": "http://www.pinterest.com", "tracking_url": "https://www.pinterest.com", "slideshow_collections_title": "Title", "is_mdl": true, - "status": "ACTIVE", - "creative_type": "REGULAR" + "status": "ACTIVE" } ], "ad_group_id": "2680059592705" @@ -35349,7 +37792,7 @@ }, "product_group_promotion": { "items": { - "$ref": "#/components/schemas/ProductGroupPromotionCreateRequestElement" + "$ref": "#/components/schemas/ProductGroupPromotion" }, "title": "product_group_promotion", "type": "array" @@ -35362,23 +37805,6 @@ "title": "ProductGroupPromotionCreateRequest", "type": "object" }, - "ProductGroupPromotionCreateRequestElement": { - "type": "object", - "title": "ProductGroupPromotionCreateRequestElement", - "allOf": [ - { - "$ref": "#/components/schemas/ProductGroupPromotion" - }, - { - "type": "object", - "properties": { - "creative_type": { - "$ref": "#/components/schemas/CreativeType" - } - } - } - ] - }, "ProductGroupPromotionResponse": { "type": "object", "title": "ProductGroupPromotionResponse", @@ -35391,29 +37817,12 @@ } } }, - "ProductGroupPromotionResponseElement": { - "type": "object", - "title": "ProductGroupPromotionResponseElement", - "allOf": [ - { - "$ref": "#/components/schemas/ProductGroupPromotion" - }, - { - "type": "object", - "properties": { - "creative_type": { - "$ref": "#/components/schemas/CreativeType" - } - } - } - ] - }, "ProductGroupPromotionResponseItem": { "type": "object", "title": "ProductGroupPromotionResponseItem", "properties": { "data": { - "$ref": "#/components/schemas/ProductGroupPromotionResponseElement" + "$ref": "#/components/schemas/ProductGroupPromotion" }, "exceptions": { "nullable": true, @@ -35430,6 +37839,7 @@ { "catalog_product_group_id": "1234123", "slideshow_collections_description": "Description", + "creative_type": "REGULAR", "collections_hero_pin_id": "123123", "catalog_product_group_name": "ProductGroupName", "collections_hero_destination_url": "http://www.pinterest.com", @@ -35441,6 +37851,7 @@ { "catalog_product_group_id": "1231231", "slideshow_collections_description": "Other description", + "creative_type": "REGULAR", "collections_hero_pin_id": "123124", "catalog_product_group_name": "ProductGroupName", "collections_hero_destination_url": "http://www.pinterest.com", @@ -35488,6 +37899,7 @@ }, "ProductType0Filter": { "type": "object", + "title": "PRODUCT_TYPE_0", "additionalProperties": false, "properties": { "PRODUCT_TYPE_0": { @@ -35501,6 +37913,7 @@ }, "ProductType1Filter": { "type": "object", + "title": "PRODUCT_TYPE_1", "additionalProperties": false, "properties": { "PRODUCT_TYPE_1": { @@ -35514,6 +37927,7 @@ }, "ProductType2Filter": { "type": "object", + "title": "PRODUCT_TYPE_2", "additionalProperties": false, "properties": { "PRODUCT_TYPE_2": { @@ -35527,6 +37941,7 @@ }, "ProductType3Filter": { "type": "object", + "title": "PRODUCT_TYPE_3", "additionalProperties": false, "properties": { "PRODUCT_TYPE_3": { @@ -35540,6 +37955,7 @@ }, "ProductType4Filter": { "type": "object", + "title": "PRODUCT_TYPE_4", "additionalProperties": false, "properties": { "PRODUCT_TYPE_4": { @@ -35551,6 +37967,210 @@ "PRODUCT_TYPE_4" ] }, + "PromotionArrayElement": { + "title": "PromotionArrayElement", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionResponse" + }, + "exception": { + "$ref": "#/components/schemas/Exception" + } + } + }, + "PromotionCommon": { + "title": "Promotion", + "type": "object", + "properties": { + "external_id": { + "description": "Platform-specific ID for this promotion. Will be null for promotions first created within Pinterest.", + "example": "abc", + "type": "string", + "maxLength": 64 + }, + "platform_type": { + "description": "The source integration platform used when creating the promotion. Currently supported values are 'DEFAULT' and 'SHOPIFY'.", + "example": "DEFAULT", + "type": "string" + }, + "promotion_title": { + "description": "Internal name for the promotion.", + "example": "Black Friday 10% off", + "type": "string" + }, + "promotion_code": { + "description": "Code that can be used to redeem a promotion.", + "example": "blackfriday10", + "type": "string" + }, + "start_time": { + "description": "Promotion start time. Unix timestamp in seconds. Independent of campaign start time.", + "example": 1677003860, + "type": "integer" + }, + "end_time": { + "description": "Promotion end time. Unix timestamp in seconds. Independent of campaign end time.", + "example": 1678003860, + "type": "integer" + }, + "promotion_type": { + "$ref": "#/components/schemas/PromotionType" + }, + "template_values": { + "description": "List of values to be inserted in the promotion type-specific template.", + "type": "array", + "minItems": 0, + "maxItems": 2, + "items": { + "$ref": "#/components/schemas/PromotionTemplateValue" + } + }, + "discount_status": { + "type": "string", + "description": "Discount status based on the current time and start and end time of discount", + "example": "ACTIVE", + "enum": [ + "OTHER", + "ACTIVE", + "PAUSED", + "SCHEDULED", + "EXPIRED" + ] + } + } + }, + "PromotionCreateRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PromotionCommon" + }, + { + "type": "object", + "title": "PromotionCreateRequest", + "required": [ + "promotion_title", + "promotion_type" + ] + } + ] + }, + "PromotionResponse": { + "title": "PromotionResponse", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PromotionCommon" + }, + { + "type": "object", + "properties": { + "id": { + "description": "Promotion ID", + "type": "string", + "pattern": "^\\d+$", + "example": "7834020347906" + }, + "ad_account_id": { + "description": "The Ad Account ID that this promotion belongs to.", + "example": "549755885175", + "type": "string", + "pattern": "^\\d+$" + }, + "status": { + "$ref": "#/components/schemas/EntityStatus" + } + } + } + ] + }, + "PromotionTemplateValue": { + "title": "Promotion template value", + "type": "object", + "properties": { + "amount": { + "description": "Numeric value.", + "example": 100, + "type": "number" + }, + "percent": { + "description": "Percent value.", + "example": 10, + "type": "number" + }, + "currency_code": { + "$ref": "#/components/schemas/Currency" + } + } + }, + "PromotionType": { + "type": "string", + "description": "Determines the displayed promotion text along with what parameters (if any) are needed to complete the template. This list is not finalized, and will be updated as new types are supported.", + "example": "VARIABLE", + "enum": [ + "VARIABLE", + "SITEWIDE", + "CHECKOUT", + "SAVE_X_ON_Y", + "BUY_X_GET_Y", + "SPEND_X_SAVE_Y", + "FREE_SHIPPING", + "FREE_SHIPPING_MINIMUM", + "FREE_SHIPPING_WITH_DISCOUNT", + "SITEWIDE_IN_STORES", + "EXTRA_PERCENT_OFF", + "GIFT_WITH_PURCHASE", + "GIFT_WITH_PURCHASE_MINIMUM", + "FIXED", + "PERCENT_OFF_CLEARANCE", + "X_OFF_Y", + "GIFT_WITH_FIRST_PURCHASE", + "BUY_X_GET_ONE_FREE", + "CASH_BACK", + "POINTS_ON_ALL_PURCHASES", + "BONUS", + "POINTS_WITH_PURCHASE" + ] + }, + "PromotionUpdateRequest": { + "title": "PromotionUpdateRequest", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PromotionCommon" + }, + { + "type": "object", + "properties": { + "id": { + "description": "Promotion ID", + "type": "string", + "pattern": "^\\d+$", + "example": "7834020347906" + }, + "status": { + "$ref": "#/components/schemas/EntityStatus" + } + }, + "required": [ + "id" + ] + } + ] + }, + "PromotionsResponse": { + "title": "PromotionsResponse", + "type": "object", + "properties": { + "promotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionArrayElement" + } + } + } + }, "QuizPinData": { "description": "This field includes all quiz data including questions, options, and results.", "example": { @@ -35784,6 +38404,7 @@ "CTR", "ECTR", "OUTBOUND_CTR", + "OUTBOUND_CTR_1", "COST_PER_OUTBOUND_CLICK", "CAMPAIGN_NAME", "CAMPAIGN_STATUS", @@ -35813,8 +38434,21 @@ "AD_GROUP_NAME", "AD_GROUP_STATUS", "AD_GROUP_ENTITY_STATUS", + "AD_GROUP_BID_MULTIPLIER", "PRODUCT_GROUP_ID", "PRODUCT_GROUP_STATUS", + "PROMO_ID", + "PROMO_NAME", + "PRODUCT_ITEM_NAME", + "PRODUCT_ITEM_IMAGE_URL", + "PRODUCT_ITEM_PRICE", + "PRODUCT_ITEM_PRODUCT_URL", + "PRODUCT_ITEM_PIN_URL", + "PRODUCT_ITEM_BRAND", + "PRODUCT_ITEM_DESCRIPTION", + "PRODUCT_ITEM_SALE_PRICE", + "PRODUCT_ITEM_PRODUCT_TYPE", + "PRODUCT_ITEM_PRODUCT_CATEGORY", "ORDER_LINE_ID", "ORDER_LINE_NAME", "CLICKTHROUGH_1", @@ -35832,6 +38466,7 @@ "TOTAL_IMPRESSION_USER", "TOTAL_IMPRESSION_FREQUENCY", "COST_PER_OUTBOUND_CLICK_IN_DOLLAR", + "COST_PER_OUTBOUND_CLICK_IN_DOLLAR_1", "TOTAL_ENGAGEMENT_PAGE_VISIT", "TOTAL_ENGAGEMENT_SIGNUP", "TOTAL_ENGAGEMENT_CHECKOUT", @@ -35938,7 +38573,9 @@ "PIN_PROMOTION_NAME", "AD_NAME", "CAMPAIGN_LIFETIME_SPEND_CAP", + "AD_GROUP_OPTIMIZATION", "CAMPAIGN_DAILY_SPEND_CAP", + "IS_PREMIERE_CAMPAIGN", "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION", "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION", "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION", @@ -36063,6 +38700,7 @@ "PAGE_VISIT_ROAS", "CHECKOUT_ROAS", "CUSTOM_ROAS", + "PRODUCT_GROUP_AD_IMAGE_TAG", "VIDEO_3SEC_VIEWS_1", "VIDEO_P100_COMPLETE_1", "VIDEO_P0_COMBINED_1", @@ -36081,6 +38719,7 @@ "VIDEO_MRC_VIEWS_2", "PAID_VIDEO_VIEWABLE_RATE", "VIDEO_LENGTH", + "VIDEO_SPEND_IN_DOLLAR", "CPV_IN_MICRO_DOLLAR", "ECPV_IN_DOLLAR", "CPCV_IN_MICRO_DOLLAR", @@ -36314,6 +38953,12 @@ "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_PAGE_FORWARD_1", + "IDEA_PIN_PAGE_FORWARD_2", + "IDEA_PIN_PAGE_BACKWARD_1", + "IDEA_PIN_PAGE_BACKWARD_2", + "TOTAL_IDEA_PIN_PAGE_FORWARD", + "TOTAL_IDEA_PIN_PAGE_BACKWARD", "IDEA_PIN_PRODUCT_TAG_VISIT_1", "IDEA_PIN_PRODUCT_TAG_VISIT_2", "TOTAL_IDEA_PIN_PRODUCT_TAG_VISIT", @@ -36386,9 +39031,12 @@ "ANALYST", "SOS_READER", "FINANCE_MANAGER", + "FINANCE_EDIT", + "FINANCE_VIEW", "AUDIENCE_MANAGER", "CAMPAIGN_MANAGER", "CATALOGS_MANAGER", + "CATALOGS_VIEWER", "RESTRICTED_OWNER", "PROFILE_MANAGER", "PROFILE_PUBLISHER", @@ -37009,6 +39657,8 @@ "type": "string", "enum": [ "18-24", + "19+", + "20+", "21+", "25-34", "35-44", @@ -37371,9 +40021,27 @@ "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.", + "description": "List of targeting types. Requires `level` to be a value ending in `_TARGETING`.[\"MEDIA_TYPE\"] is only available in PRODUCT_ITEM_TARGETING level. [\"AGE_BUCKET_AND_GENDER\"] is in BETA and not yet available to all users.", "items": { - "$ref": "#/components/schemas/AdsAnalyticsTargetingType" + "type": "string", + "description": "Reporting targeting type", + "example": "APPTYPE", + "enum": [ + "KEYWORD", + "APPTYPE", + "GENDER", + "LOCATION", + "PLACEMENT", + "COUNTRY", + "TARGETED_INTEREST", + "PINNER_INTEREST", + "AUDIENCE_INCLUDE", + "GEO", + "AGE_BUCKET", + "REGION", + "MEDIA_TYPE", + "AGE_BUCKET_AND_GENDER" + ] }, "maxItems": 5, "minItems": 1 @@ -37542,6 +40210,7 @@ "CTR", "ECTR", "OUTBOUND_CTR", + "OUTBOUND_CTR_1", "CPC_IN_MICRO_CURRENCY", "CPW_IN_MICRO_DOLLAR", "CPW_IN_DOLLAR", @@ -37570,7 +40239,6 @@ "CROSS_DEVICE_TYPE", "INGESTION_SOURCE", "SOURCE_PLATFORM", - "PIN_PROMOTION_IS_RUNNING", "TOTAL_ENGAGEMENT", "ENGAGEMENT_1", "ENGAGEMENT_2", @@ -37580,8 +40248,6 @@ "ECPE_IN_DOLLAR", "ENGAGEMENT_RATE", "EENGAGEMENT_RATE", - "INTERNAL_ECPE_IN_MICRO_DOLLAR", - "INTERNAL_ECPE_IN_DOLLAR", "ECPM_IN_MICRO_DOLLAR", "ECPM_IN_DOLLAR", "REPIN_RATE", @@ -37612,8 +40278,6 @@ "AD_GROUP_END_DATE", "AD_GROUP_BUDGET_TYPE", "AD_GROUP_BUDGET_IN_LOCAL_CURRENCY", - "AD_GROUP_SUGGESTED_BUDGET_IN_LOCAL_CURRENCY", - "AD_GROUP_SUGGESTED_BONUS_BUDGET_IN_LOCAL_CURRENCY", "AD_GROUP_ENTITY_STATUS", "AD_GROUP_ACTION_TYPE", "AD_GROUP_CONVERSION_LEARNING_MODE_TYPE", @@ -37621,6 +40285,7 @@ "AD_GROUP_BID_STRATEGY_TYPE", "AD_GROUP_EXPERIMENT_NAME", "AD_GROUP_EXPERIMENT_CELL", + "AD_GROUP_BID_MULTIPLIER", "CAMPAIGN_WEB_CLOSEUP_WHITELISTED", "PRODUCT_GROUP_ID", "PRODUCT_GROUP_DEFINITION", @@ -37631,6 +40296,8 @@ "PRODUCT_GROUP_ENTITY_STATUS", "PRODUCT_GROUP_INCLUSION", "PRODUCT_GROUP_CREATIVE_TYPE", + "PROMO_ID", + "PROMO_NAME", "ITEM_ID", "PRODUCT_ITEM_ID", "INTERNAL_PRODUCT_ITEM_ID", @@ -37638,6 +40305,15 @@ "PRODUCT_ITEM_NAME", "PRODUCT_ITEM_IMAGE_URL", "PRODUCT_ITEM_PRICE", + "PRODUCT_ITEM_PRODUCT_URL", + "PRODUCT_ITEM_PIN_URL", + "PRODUCT_ITEM_BRAND", + "PRODUCT_ITEM_DESCRIPTION", + "PRODUCT_ITEM_SALE_PRICE", + "PRODUCT_ITEM_PRODUCT_TYPE", + "PRODUCT_ITEM_PRODUCT_CATEGORY", + "PRODUCT_ITEM_CAMPAIGN_NAME", + "PRODUCT_ITEM_AD_GROUP_NAME", "ORDER_LINE_ID", "ORDER_LINE_NAME", "ORDER_LINE_PIN_REV_SHARE", @@ -37648,6 +40324,7 @@ "CONVERSION_PRODUCT_NAME", "CONVERSION_PRODUCT_BRAND", "CONVERSION_PRODUCT_CATEGORY", + "CONVERSION_PRODUCT_ID_GROUP", "CLICKTHROUGH_1", "REPIN_1", "IMPRESSION_1", @@ -37692,6 +40369,7 @@ "TOTAL_IMPRESSION_FREQUENCY_HLL", "TOTAL_OUTBOUND_CLICK", "COST_PER_OUTBOUND_CLICK_IN_DOLLAR", + "COST_PER_OUTBOUND_CLICK_IN_DOLLAR_1", "ENGAGEMENT_PAGE_VISIT_1", "ENGAGEMENT_SIGNUP_1", "ENGAGEMENT_CHECKOUT_1", @@ -37703,6 +40381,11 @@ "ENGAGEMENT_VIEW_CATEGORY_1", "ENGAGEMENT_APP_INSTALL_1", "ENGAGEMENT_UNKNOWN_1", + "ENGAGEMENT_ADD_PAYMENT_INFO_1", + "ENGAGEMENT_ADD_TO_WISHLIST_1", + "ENGAGEMENT_INITIATE_CHECKOUT_1", + "ENGAGEMENT_SUBSCRIBE_1", + "ENGAGEMENT_VIEW_CONTENT_1", "CLICK_PAGE_VISIT_1", "CLICK_SIGNUP_1", "CLICK_CHECKOUT_1", @@ -37714,6 +40397,11 @@ "CLICK_VIEW_CATEGORY_1", "CLICK_APP_INSTALL_1", "CLICK_UNKNOWN_1", + "CLICK_ADD_PAYMENT_INFO_1", + "CLICK_ADD_TO_WISHLIST_1", + "CLICK_INITIATE_CHECKOUT_1", + "CLICK_SUBSCRIBE_1", + "CLICK_VIEW_CONTENT_1", "VIEW_PAGE_VISIT_1", "VIEW_SIGNUP_1", "VIEW_CHECKOUT_1", @@ -37725,6 +40413,11 @@ "VIEW_VIEW_CATEGORY_1", "VIEW_APP_INSTALL_1", "VIEW_UNKNOWN_1", + "VIEW_ADD_PAYMENT_INFO_1", + "VIEW_ADD_TO_WISHLIST_1", + "VIEW_INITIATE_CHECKOUT_1", + "VIEW_SUBSCRIBE_1", + "VIEW_VIEW_CONTENT_1", "CONVERSIONS_1", "ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_1", "ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR_1", @@ -37737,6 +40430,11 @@ "ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_1", "ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_1", "ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR_1", + "ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_1", + "ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_1", + "ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1", + "ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_1", + "ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_1", "CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_1", "CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR_1", "CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1", @@ -37748,6 +40446,11 @@ "CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_1", "CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_1", "CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR_1", + "CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_1", + "CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_1", + "CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1", + "CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_1", + "CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_1", "VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_1", "VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR_1", "VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1", @@ -37759,6 +40462,11 @@ "VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_1", "VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_1", "VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR_1", + "VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_1", + "VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_1", + "VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1", + "VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_1", + "VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_1", "CONVERSIONS_VALUE_IN_MICRO_DOLLAR_1", "ENGAGEMENT_PAGE_VISIT_QUANTITY_1", "ENGAGEMENT_SIGNUP_QUANTITY_1", @@ -37771,6 +40479,11 @@ "ENGAGEMENT_VIEW_CATEGORY_QUANTITY_1", "ENGAGEMENT_APP_INSTALL_QUANTITY_1", "ENGAGEMENT_UNKNOWN_QUANTITY_1", + "ENGAGEMENT_ADD_PAYMENT_INFO_QUANTITY_1", + "ENGAGEMENT_ADD_TO_WISHLIST_QUANTITY_1", + "ENGAGEMENT_INITIATE_CHECKOUT_QUANTITY_1", + "ENGAGEMENT_SUBSCRIBE_QUANTITY_1", + "ENGAGEMENT_VIEW_CONTENT_QUANTITY_1", "CLICK_PAGE_VISIT_QUANTITY_1", "CLICK_SIGNUP_QUANTITY_1", "CLICK_CHECKOUT_QUANTITY_1", @@ -37782,6 +40495,11 @@ "CLICK_VIEW_CATEGORY_QUANTITY_1", "CLICK_APP_INSTALL_QUANTITY_1", "CLICK_UNKNOWN_QUANTITY_1", + "CLICK_ADD_PAYMENT_INFO_QUANTITY_1", + "CLICK_ADD_TO_WISHLIST_QUANTITY_1", + "CLICK_INITIATE_CHECKOUT_QUANTITY_1", + "CLICK_SUBSCRIBE_QUANTITY_1", + "CLICK_VIEW_CONTENT_QUANTITY_1", "VIEW_PAGE_VISIT_QUANTITY_1", "VIEW_SIGNUP_QUANTITY_1", "VIEW_CHECKOUT_QUANTITY_1", @@ -37793,6 +40511,11 @@ "VIEW_VIEW_CATEGORY_QUANTITY_1", "VIEW_APP_INSTALL_QUANTITY_1", "VIEW_UNKNOWN_QUANTITY_1", + "VIEW_ADD_PAYMENT_INFO_QUANTITY_1", + "VIEW_ADD_TO_WISHLIST_QUANTITY_1", + "VIEW_INITIATE_CHECKOUT_QUANTITY_1", + "VIEW_SUBSCRIBE_QUANTITY_1", + "VIEW_VIEW_CONTENT_QUANTITY_1", "CONVERSIONS_QUANTITY_1", "ENGAGEMENT_PAGE_VISIT_2", "ENGAGEMENT_SIGNUP_2", @@ -37805,6 +40528,11 @@ "ENGAGEMENT_VIEW_CATEGORY_2", "ENGAGEMENT_APP_INSTALL_2", "ENGAGEMENT_UNKNOWN_2", + "ENGAGEMENT_ADD_PAYMENT_INFO_2", + "ENGAGEMENT_ADD_TO_WISHLIST_2", + "ENGAGEMENT_INITIATE_CHECKOUT_2", + "ENGAGEMENT_SUBSCRIBE_2", + "ENGAGEMENT_VIEW_CONTENT_2", "CLICK_PAGE_VISIT_2", "CLICK_SIGNUP_2", "CLICK_CHECKOUT_2", @@ -37816,6 +40544,11 @@ "CLICK_VIEW_CATEGORY_2", "CLICK_APP_INSTALL_2", "CLICK_UNKNOWN_2", + "CLICK_ADD_PAYMENT_INFO_2", + "CLICK_ADD_TO_WISHLIST_2", + "CLICK_INITIATE_CHECKOUT_2", + "CLICK_SUBSCRIBE_2", + "CLICK_VIEW_CONTENT_2", "VIEW_PAGE_VISIT_2", "VIEW_SIGNUP_2", "VIEW_CHECKOUT_2", @@ -37827,6 +40560,11 @@ "VIEW_VIEW_CATEGORY_2", "VIEW_APP_INSTALL_2", "VIEW_UNKNOWN_2", + "VIEW_ADD_PAYMENT_INFO_2", + "VIEW_ADD_TO_WISHLIST_2", + "VIEW_INITIATE_CHECKOUT_2", + "VIEW_SUBSCRIBE_2", + "VIEW_VIEW_CONTENT_2", "CONVERSIONS_2", "ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_2", "ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR_2", @@ -37839,6 +40577,11 @@ "ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_2", "ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_2", "ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR_2", + "ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_2", + "ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_2", + "ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2", + "ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_2", + "ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_2", "CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_2", "CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR_2", "CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2", @@ -37850,6 +40593,11 @@ "CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_2", "CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_2", "CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR_2", + "CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_2", + "CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_2", + "CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2", + "CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_2", + "CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_2", "VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_2", "VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR_2", "VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2", @@ -37861,6 +40609,11 @@ "VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_2", "VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_2", "VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR_2", + "VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_2", + "VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_2", + "VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2", + "VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_2", + "VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_2", "CONVERSIONS_VALUE_IN_MICRO_DOLLAR_2", "ENGAGEMENT_PAGE_VISIT_QUANTITY_2", "ENGAGEMENT_SIGNUP_QUANTITY_2", @@ -37873,6 +40626,11 @@ "ENGAGEMENT_VIEW_CATEGORY_QUANTITY_2", "ENGAGEMENT_APP_INSTALL_QUANTITY_2", "ENGAGEMENT_UNKNOWN_QUANTITY_2", + "ENGAGEMENT_ADD_PAYMENT_INFO_QUANTITY_2", + "ENGAGEMENT_ADD_TO_WISHLIST_QUANTITY_2", + "ENGAGEMENT_INITIATE_CHECKOUT_QUANTITY_2", + "ENGAGEMENT_SUBSCRIBE_QUANTITY_2", + "ENGAGEMENT_VIEW_CONTENT_QUANTITY_2", "CLICK_PAGE_VISIT_QUANTITY_2", "CLICK_SIGNUP_QUANTITY_2", "CLICK_CHECKOUT_QUANTITY_2", @@ -37884,6 +40642,11 @@ "CLICK_VIEW_CATEGORY_QUANTITY_2", "CLICK_APP_INSTALL_QUANTITY_2", "CLICK_UNKNOWN_QUANTITY_2", + "CLICK_ADD_PAYMENT_INFO_QUANTITY_2", + "CLICK_ADD_TO_WISHLIST_QUANTITY_2", + "CLICK_INITIATE_CHECKOUT_QUANTITY_2", + "CLICK_SUBSCRIBE_QUANTITY_2", + "CLICK_VIEW_CONTENT_QUANTITY_2", "VIEW_PAGE_VISIT_QUANTITY_2", "VIEW_SIGNUP_QUANTITY_2", "VIEW_CHECKOUT_QUANTITY_2", @@ -37895,6 +40658,11 @@ "VIEW_VIEW_CATEGORY_QUANTITY_2", "VIEW_APP_INSTALL_QUANTITY_2", "VIEW_UNKNOWN_QUANTITY_2", + "VIEW_ADD_PAYMENT_INFO_QUANTITY_2", + "VIEW_ADD_TO_WISHLIST_QUANTITY_2", + "VIEW_INITIATE_CHECKOUT_QUANTITY_2", + "VIEW_SUBSCRIBE_QUANTITY_2", + "VIEW_VIEW_CONTENT_QUANTITY_2", "CONVERSIONS_QUANTITY_2", "TOTAL_ENGAGEMENT_PAGE_VISIT", "TOTAL_ENGAGEMENT_SIGNUP", @@ -37907,6 +40675,11 @@ "TOTAL_ENGAGEMENT_VIEW_CATEGORY", "TOTAL_ENGAGEMENT_APP_INSTALL", "TOTAL_ENGAGEMENT_UNKNOWN", + "TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO", + "TOTAL_ENGAGEMENT_ADD_TO_WISHLIST", + "TOTAL_ENGAGEMENT_INITIATE_CHECKOUT", + "TOTAL_ENGAGEMENT_SUBSCRIBE", + "TOTAL_ENGAGEMENT_VIEW_CONTENT", "TOTAL_CLICK_PAGE_VISIT", "TOTAL_CLICK_SIGNUP", "TOTAL_CLICK_CHECKOUT", @@ -37918,6 +40691,11 @@ "TOTAL_CLICK_VIEW_CATEGORY", "TOTAL_CLICK_APP_INSTALL", "TOTAL_CLICK_UNKNOWN", + "TOTAL_CLICK_ADD_PAYMENT_INFO", + "TOTAL_CLICK_ADD_TO_WISHLIST", + "TOTAL_CLICK_INITIATE_CHECKOUT", + "TOTAL_CLICK_SUBSCRIBE", + "TOTAL_CLICK_VIEW_CONTENT", "TOTAL_VIEW_PAGE_VISIT", "TOTAL_VIEW_SIGNUP", "TOTAL_VIEW_CHECKOUT", @@ -37929,6 +40707,11 @@ "TOTAL_VIEW_VIEW_CATEGORY", "TOTAL_VIEW_APP_INSTALL", "TOTAL_VIEW_UNKNOWN", + "TOTAL_VIEW_ADD_PAYMENT_INFO", + "TOTAL_VIEW_ADD_TO_WISHLIST", + "TOTAL_VIEW_INITIATE_CHECKOUT", + "TOTAL_VIEW_SUBSCRIBE", + "TOTAL_VIEW_VIEW_CONTENT", "TOTAL_CONVERSIONS", "TOTAL_WEB_CONVERSIONS", "TOTAL_INAPP_CONVERSIONS", @@ -37953,6 +40736,16 @@ "TOTAL_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_DOLLAR", "TOTAL_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR", "TOTAL_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR", "TOTAL_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR", "TOTAL_CLICK_PAGE_VISIT_VALUE_IN_DOLLAR", "TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR", @@ -37973,6 +40766,16 @@ "TOTAL_CLICK_VIEW_CATEGORY_VALUE_IN_DOLLAR", "TOTAL_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR", "TOTAL_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR", + "TOTAL_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR", "TOTAL_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR", "TOTAL_VIEW_PAGE_VISIT_VALUE_IN_DOLLAR", "TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR", @@ -37993,6 +40796,16 @@ "TOTAL_VIEW_VIEW_CATEGORY_VALUE_IN_DOLLAR", "TOTAL_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR", "TOTAL_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR", + "TOTAL_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR", "TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR", "TOTAL_CONVERSIONS_VALUE_IN_DOLLAR", "TOTAL_ENGAGEMENT_PAGE_VISIT_QUANTITY", @@ -38006,6 +40819,11 @@ "TOTAL_ENGAGEMENT_VIEW_CATEGORY_QUANTITY", "TOTAL_ENGAGEMENT_APP_INSTALL_QUANTITY", "TOTAL_ENGAGEMENT_UNKNOWN_QUANTITY", + "TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO_QUANTITY", + "TOTAL_ENGAGEMENT_ADD_TO_WISHLIST_QUANTITY", + "TOTAL_ENGAGEMENT_INITIATE_CHECKOUT_QUANTITY", + "TOTAL_ENGAGEMENT_SUBSCRIBE_QUANTITY", + "TOTAL_ENGAGEMENT_VIEW_CONTENT_QUANTITY", "TOTAL_CLICK_PAGE_VISIT_QUANTITY", "TOTAL_CLICK_SIGNUP_QUANTITY", "TOTAL_CLICK_CHECKOUT_QUANTITY", @@ -38017,6 +40835,11 @@ "TOTAL_CLICK_VIEW_CATEGORY_QUANTITY", "TOTAL_CLICK_APP_INSTALL_QUANTITY", "TOTAL_CLICK_UNKNOWN_QUANTITY", + "TOTAL_CLICK_ADD_PAYMENT_INFO_QUANTITY", + "TOTAL_CLICK_ADD_TO_WISHLIST_QUANTITY", + "TOTAL_CLICK_INITIATE_CHECKOUT_QUANTITY", + "TOTAL_CLICK_SUBSCRIBE_QUANTITY", + "TOTAL_CLICK_VIEW_CONTENT_QUANTITY", "TOTAL_VIEW_PAGE_VISIT_QUANTITY", "TOTAL_VIEW_SIGNUP_QUANTITY", "TOTAL_VIEW_CHECKOUT_QUANTITY", @@ -38028,6 +40851,11 @@ "TOTAL_VIEW_VIEW_CATEGORY_QUANTITY", "TOTAL_VIEW_APP_INSTALL_QUANTITY", "TOTAL_VIEW_UNKNOWN_QUANTITY", + "TOTAL_VIEW_ADD_PAYMENT_INFO_QUANTITY", + "TOTAL_VIEW_ADD_TO_WISHLIST_QUANTITY", + "TOTAL_VIEW_INITIATE_CHECKOUT_QUANTITY", + "TOTAL_VIEW_SUBSCRIBE_QUANTITY", + "TOTAL_VIEW_VIEW_CONTENT_QUANTITY", "TOTAL_CONVERSIONS_QUANTITY", "COST_PER_CONVERSION_IN_DOLLAR", "TOTAL_WEB_SESSIONS", @@ -38051,26 +40879,12 @@ "ECPI_IN_MICRO_DOLLAR", "CPI_IN_DOLLAR", "ECPI_IN_DOLLAR", - "ONSITE_CHECKOUTS_CPA_BILLABLE_1", - "ONSITE_CHECKOUTS_CPA_BILLABLE_2", - "ONSITE_CHECKOUTS_CPA_BILLABLE", - "ONSITE_CHECKOUTS_VALUE_1", - "ONSITE_CHECKOUTS_VALUE_2", - "ONSITE_CHECKOUTS_VALUE", "ONSITE_CHECKOUTS_1", "ONSITE_CHECKOUTS_2", "ONSITE_CHECKOUTS", - "ONSITE_CHECKOUTS_VALUE_IN_MICRO_DOLLAR_1", - "ONSITE_CHECKOUTS_VALUE_IN_MICRO_DOLLAR_2", "CONVERSION_RATE", "AVERAGE_CHECKOUT_VALUE", - "RETURN_ON_ADVERTISER_SPEND", - "BUY_BUTTON_CLICKS_1", - "BUY_BUTTON_CLICKS_2", "TOTAL_BUY_BUTTON_CLICKS", - "ORDER_DROPOFF_RATE", - "ONSITE_CHECKOUTS_VALUE_IN_MICRO_DOLLAR", - "ONSITE_CHECKOUTS_VALUE_IN_DOLLAR", "PIN_PROMOTION_NAME", "AD_NAME", "LIFETIME_IMPRESSION_USER_1", @@ -38099,16 +40913,12 @@ "AD_GROUP_START_DATE", "CAMPAIGN_LIFETIME_SPEND_CAP", "AD_GROUP_BID_IN_MICRO_CURRENCY", - "CAMPAIGN_AD_GROUP_START_DATE", - "CAMPAIGN_AD_GROUP_END_DATE", - "CAMPAIGN_NUMBER_OF_AD_GROUPS", "AD_GROUP_NUMBER_OF_PIN_PROMOTIONS", "TODAY_SPEND_IN_LOCAL_CURRENCY", "TOTAL_LIFETIME_SPEND_IN_LOCAL_CURRENCY", "BUDGET_UTILIZATION", "AD_GROUP_OPTIMIZATION", "INSERTION_ORDER", - "AD_GROUP_BONUS_BUDGET", "FREQUENCY", "CAMPAIGN_DAILY_SPEND_CAP", "CAMPAIGN_CREATIVE_TYPE", @@ -38121,7 +40931,6 @@ "FLEXIBLE_DAILY_BUDGETS", "IS_PERFORMANCE_PLUS_CAMPAIGN", "IS_DCO_FORMAT_ENHANCMENT", - "PERCENT_CROSS_DEVICE_CONVERSIONS", "PAGE_VISIT_PERCENT_CROSS_DEVICE_CONVERSIONS", "SIGNUP_PERCENT_CROSS_DEVICE_CONVERSIONS", "CHECKOUT_PERCENT_CROSS_DEVICE_CONVERSIONS", @@ -38133,15 +40942,6 @@ "VIEW_CATEGORY_PERCENT_CROSS_DEVICE_CONVERSIONS", "APP_INSTALL_PERCENT_CROSS_DEVICE_CONVERSIONS", "UNKNOWN_PERCENT_CROSS_DEVICE_CONVERSIONS", - "TOTAL_DESKTOP_ACTION_TO_DESKTOP_CONVERSION", - "TOTAL_DESKTOP_ACTION_TO_MOBILE_CONVERSION", - "TOTAL_DESKTOP_ACTION_TO_TABLET_CONVERSION", - "TOTAL_MOBILE_ACTION_TO_DESKTOP_CONVERSION", - "TOTAL_MOBILE_ACTION_TO_MOBILE_CONVERSION", - "TOTAL_MOBILE_ACTION_TO_TABLET_CONVERSION", - "TOTAL_TABLET_ACTION_TO_DESKTOP_CONVERSION", - "TOTAL_TABLET_ACTION_TO_MOBILE_CONVERSION", - "TOTAL_TABLET_ACTION_TO_TABLET_CONVERSION", "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION", "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION", "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION", @@ -38252,6 +41052,11 @@ "TOTAL_VIEW_CATEGORY", "TOTAL_APP_INSTALL", "TOTAL_UNKNOWN", + "TOTAL_ADD_PAYMENT_INFO", + "TOTAL_ADD_TO_WISHLIST", + "TOTAL_INITIATE_CHECKOUT", + "TOTAL_SUBSCRIBE", + "TOTAL_VIEW_CONTENT", "TOTAL_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR", "TOTAL_SIGNUP_VALUE_IN_MICRO_DOLLAR", "TOTAL_CHECKOUT_VALUE_IN_MICRO_DOLLAR", @@ -38263,6 +41068,11 @@ "TOTAL_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR", "TOTAL_APP_INSTALL_VALUE_IN_MICRO_DOLLAR", "TOTAL_UNKNOWN_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", "AVERAGE_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR", "AVERAGE_SIGNUP_VALUE_IN_MICRO_DOLLAR", "AVERAGE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", @@ -38273,6 +41083,11 @@ "AVERAGE_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR", "AVERAGE_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR", "AVERAGE_UNKNOWN_VALUE_IN_MICRO_DOLLAR", + "AVERAGE_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "AVERAGE_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "AVERAGE_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "AVERAGE_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "AVERAGE_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", "AVERAGE_PAGE_VISIT_VALUE_IN_MICRO_US_DOLLAR", "AVERAGE_SIGNUP_VALUE_IN_MICRO_US_DOLLAR", "AVERAGE_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR", @@ -38283,6 +41098,11 @@ "AVERAGE_WATCH_VIDEO_VALUE_IN_MICRO_US_DOLLAR", "AVERAGE_VIEW_CATEGORY_VALUE_IN_MICRO_US_DOLLAR", "AVERAGE_UNKNOWN_VALUE_IN_MICRO_US_DOLLAR", + "AVERAGE_ADD_PAYMENT_INFO_VALUE_IN_MICRO_US_DOLLAR", + "AVERAGE_ADD_TO_WISHLIST_VALUE_IN_MICRO_US_DOLLAR", + "AVERAGE_INITIATE_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR", + "AVERAGE_SUBSCRIBE_VALUE_IN_MICRO_US_DOLLAR", + "AVERAGE_VIEW_CONTENT_VALUE_IN_MICRO_US_DOLLAR", "TOTAL_PAGE_VISIT_VALUE_IN_MICRO_US_DOLLAR", "TOTAL_SIGNUP_VALUE_IN_MICRO_US_DOLLAR", "TOTAL_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR", @@ -38293,6 +41113,11 @@ "TOTAL_WATCH_VIDEO_VALUE_IN_MICRO_US_DOLLAR", "TOTAL_VIEW_CATEGORY_VALUE_IN_MICRO_US_DOLLAR", "TOTAL_UNKNOWN_VALUE_IN_MICRO_US_DOLLAR", + "TOTAL_ADD_PAYMENT_INFO_VALUE_IN_MICRO_US_DOLLAR", + "TOTAL_ADD_TO_WISHLIST_VALUE_IN_MICRO_US_DOLLAR", + "TOTAL_INITIATE_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR", + "TOTAL_SUBSCRIBE_VALUE_IN_MICRO_US_DOLLAR", + "TOTAL_VIEW_CONTENT_VALUE_IN_MICRO_US_DOLLAR", "TOTAL_PAGE_VISIT_QUANTITY", "TOTAL_SIGNUP_QUANTITY", "TOTAL_CHECKOUT_QUANTITY", @@ -38304,6 +41129,11 @@ "TOTAL_VIEW_CATEGORY_QUANTITY", "TOTAL_APP_INSTALL_QUANTITY", "TOTAL_UNKNOWN_QUANTITY", + "TOTAL_ADD_PAYMENT_INFO_QUANTITY", + "TOTAL_ADD_TO_WISHLIST_QUANTITY", + "TOTAL_INITIATE_CHECKOUT_QUANTITY", + "TOTAL_SUBSCRIBE_QUANTITY", + "TOTAL_VIEW_CONTENT_QUANTITY", "TOTAL_PAGE_VISIT_VALUE_IN_DOLLAR", "TOTAL_SIGNUP_VALUE_IN_DOLLAR", "TOTAL_CHECKOUT_VALUE_IN_DOLLAR", @@ -38315,6 +41145,11 @@ "TOTAL_VIEW_CATEGORY_VALUE_IN_DOLLAR", "TOTAL_APP_INSTALL_VALUE_IN_DOLLAR", "TOTAL_UNKNOWN_VALUE_IN_DOLLAR", + "TOTAL_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_VIEW_CONTENT_VALUE_IN_DOLLAR", "PAGE_VISIT_COST_PER_ACTION", "SIGNUP_COST_PER_ACTION", "CHECKOUT_COST_PER_ACTION", @@ -38327,6 +41162,11 @@ "APP_INSTALL_COST_PER_ACTION", "UNKNOWN_COST_PER_ACTION", "AD_GROUP_CPA_IN_MICRO_CURRENCY", + "ADD_PAYMENT_INFO_COST_PER_ACTION", + "ADD_TO_WISHLIST_COST_PER_ACTION", + "INITIATE_CHECKOUT_COST_PER_ACTION", + "SUBSCRIBE_COST_PER_ACTION", + "VIEW_CONTENT_COST_PER_ACTION", "PAGE_VISIT_COST_PER_ACTION_IN_US_DOLLAR", "SIGNUP_COST_PER_ACTION_IN_US_DOLLAR", "CHECKOUT_COST_PER_ACTION_IN_US_DOLLAR", @@ -38337,6 +41177,11 @@ "WATCH_VIDEO_COST_PER_ACTION_IN_US_DOLLAR", "VIEW_CATEGORY_COST_PER_ACTION_IN_US_DOLLAR", "UNKNOWN_COST_PER_ACTION_IN_US_DOLLAR", + "ADD_PAYMENT_INFO_COST_PER_ACTION_IN_US_DOLLAR", + "ADD_TO_WISHLIST_COST_PER_ACTION_IN_US_DOLLAR", + "INITIATE_CHECKOUT_COST_PER_ACTION_IN_US_DOLLAR", + "SUBSCRIBE_COST_PER_ACTION_IN_US_DOLLAR", + "VIEW_CONTENT_COST_PER_ACTION_IN_US_DOLLAR", "PAGE_VISIT_ROAS", "SIGNUP_ROAS", "CHECKOUT_ROAS", @@ -38352,6 +41197,11 @@ "CLICK_ROAS", "ENGAGEMENT_ROAS", "VIEW_ROAS", + "ADD_PAYMENT_INFO_ROAS", + "ADD_TO_WISHLIST_ROAS", + "INITIATE_CHECKOUT_ROAS", + "SUBSCRIBE_ROAS", + "VIEW_CONTENT_ROAS", "HOUR", "BOARD_ENGAGEMENT", "BOARD_INSERTION", @@ -38367,6 +41217,7 @@ "PRODUCT_GROUP_AD_GROUP_ID", "PRODUCT_GROUP_AD_GROUP_NAME", "PRODUCT_GROUP_AD_GROUP_STATUS", + "PRODUCT_GROUP_AD_IMAGE_TAG", "PROMOTED_CATALOG_PRODUCT_GROUP_REFERENCE_ID", "PROMOTED_CATALOG_PRODUCT_GROUP_REFERENCE_NAME", "PROMOTED_CATALOG_PRODUCT_GROUP_ID", @@ -38382,6 +41233,7 @@ "PROMOTED_CATALOG_PRODUCT_GROUP_AD_GROUP_NAME", "PROMOTED_CATALOG_PRODUCT_GROUP_AD_GROUP_STATUS", "PROMOTED_CATALOG_PRODUCT_GROUP_TRACKING_TEMPLATE_URL", + "PROMOTED_CATALOG_PRODUCT_GROUP_SELECTED_IMAGE_TAG", "VIDEO_3SEC_VIEWS_1", "VIDEO_P0_COMPLETE_1", "VIDEO_P25_COMPLETE_1", @@ -38397,6 +41249,9 @@ "VIDEO_P95_COMBINED_1", "VIDEO_P97_COMBINED_1", "VIDEO_P100_COMBINED_1", + "VIDEO_STARTS_PAID", + "VIDEO_STARTS_EARNED", + "TOTAL_VIDEO_STARTS", "VIDEO_AVG_WATCHTIME_1", "VIDEO_MRC_VIEWS_1", "VIDEO_VIEW_RATE_1", @@ -38422,6 +41277,8 @@ "PAID_VIDEO_IMPRESSION", "PAID_VIDEO_VIEWABLE_RATE", "VIDEO_LENGTH", + "VIDEO_SPEND_IN_MICRO_DOLLAR", + "VIDEO_SPEND_IN_DOLLAR", "CPV_IN_MICRO_DOLLAR", "CPV_IN_DOLLAR", "CP3SV_IN_MICRO_DOLLAR", @@ -38471,8 +41328,9 @@ "VIDEO_AVG_WATCHTIME_IN_SECOND_1", "VIDEO_AVG_WATCHTIME_IN_SECOND_2", "TOTAL_VIDEO_AVG_WATCHTIME_IN_SECOND", - "DELIVERY_STATUS_NO_FANOUT", - "DELIVERY_STATUS_WITH_FANOUT", + "VIDEO_AVG_WATCHTIME_IN_SECOND_VIDEO_STARTS_PAID", + "VIDEO_AVG_WATCHTIME_IN_SECOND_VIDEO_STARTS_EARNED", + "TOTAL_VIDEO_AVG_WATCHTIME_IN_SECOND_VIDEO_STARTS", "KEYWORD_COMPETITION_BAND", "KEYWORD_QUERY_VOLUME", "KEYWORD_VALUE", @@ -38495,13 +41353,6 @@ "ONE_TAP_V2_WEBSITE_VIEW_1", "ONE_TAP_V2_WEBSITE_VIEW_2", "TOTAL_ONE_TAP_V2_WEBSITE_VIEW", - "ONE_TAP_V2_WEBSITE_VIEW_USER_1", - "ONE_TAP_V2_WEBSITE_VIEW_USER_2", - "TOTAL_LANDING_PAGE_VIEWS", - "LANDING_PAGE_VIEWS_1", - "LANDING_PAGE_VIEWS_2", - "COST_PER_LANDING_PAGE_VIEW", - "LANDING_PAGE_VIEW_RATE", "TOTAL_DESTINATION_VIEWS", "DESTINATION_VIEWS_1", "DESTINATION_VIEWS_2", @@ -38514,23 +41365,15 @@ "CAROUSEL_SLOT_IMPRESSION_1", "CAROUSEL_SLOT_IMPRESSION_2", "TOTAL_CAROUSEL_SLOT_IMPRESSION", - "CAROUSEL_SLOT_IMPRESSION_USER_1", - "CAROUSEL_SLOT_IMPRESSION_USER_2", "CAROUSEL_SLOT_CLICKTHROUGH_1", "CAROUSEL_SLOT_CLICKTHROUGH_2", "TOTAL_CAROUSEL_SLOT_CLICKTHROUGH", - "CAROUSEL_SLOT_CLICKTHROUGH_USER_1", - "CAROUSEL_SLOT_CLICKTHROUGH_USER_2", "CAROUSEL_SLOT_SIDESWIPE_1", "CAROUSEL_SLOT_SIDESWIPE_2", "TOTAL_CAROUSEL_SLOT_SIDESWIPE", - "CAROUSEL_SLOT_SIDESWIPE_USER_1", - "CAROUSEL_SLOT_SIDESWIPE_USER_2", "CAROUSEL_SLOT_VIEW_WEBSITE_1", "CAROUSEL_SLOT_VIEW_WEBSITE_2", "TOTAL_CAROUSEL_SLOT_VIEW_WEBSITE", - "CAROUSEL_SLOT_VIEW_WEBSITE_USER_1", - "CAROUSEL_SLOT_VIEW_WEBSITE_USER_2", "COLLECTION_PIN_ITEM_IMPRESSION_1", "COLLECTION_PIN_ITEM_IMPRESSION_2", "TOTAL_COLLECTION_PIN_ITEM_IMPRESSION", @@ -38547,8 +41390,6 @@ "DATE_RANGE", "DATE_RANGE_START", "DATE_RANGE_END", - "REPORT_DATE_START", - "REPORT_DATE_END", "PINNER_LIST_NAME", "PINNER_LIST_TYPE", "ORDER_VALUE", @@ -38859,6 +41700,216 @@ "TOTAL_INAPP_VIEW_APP_INSTALL", "TOTAL_INAPP_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR", "TOTAL_INAPP_VIEW_APP_INSTALL_VALUE_IN_DOLLAR", + "WEB_ADD_PAYMENT_INFO_COST_PER_ACTION", + "WEB_ADD_PAYMENT_INFO_ROAS", + "TOTAL_WEB_ADD_PAYMENT_INFO", + "TOTAL_WEB_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_WEB_CLICK_ADD_PAYMENT_INFO", + "TOTAL_WEB_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_ADD_PAYMENT_INFO", + "TOTAL_WEB_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_WEB_VIEW_ADD_PAYMENT_INFO", + "TOTAL_WEB_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "INAPP_ADD_PAYMENT_INFO_COST_PER_ACTION", + "INAPP_ADD_PAYMENT_INFO_ROAS", + "TOTAL_INAPP_ADD_PAYMENT_INFO", + "TOTAL_INAPP_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_INAPP_CLICK_ADD_PAYMENT_INFO", + "TOTAL_INAPP_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_ADD_PAYMENT_INFO", + "TOTAL_INAPP_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_INAPP_VIEW_ADD_PAYMENT_INFO", + "TOTAL_INAPP_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "OFFLINE_ADD_PAYMENT_INFO_COST_PER_ACTION", + "OFFLINE_ADD_PAYMENT_INFO_ROAS", + "TOTAL_OFFLINE_ADD_PAYMENT_INFO", + "TOTAL_OFFLINE_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_CLICK_ADD_PAYMENT_INFO", + "TOTAL_OFFLINE_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_ADD_PAYMENT_INFO", + "TOTAL_OFFLINE_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_VIEW_ADD_PAYMENT_INFO", + "TOTAL_OFFLINE_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR", + "WEB_ADD_TO_WISHLIST_COST_PER_ACTION", + "WEB_ADD_TO_WISHLIST_ROAS", + "TOTAL_WEB_ADD_TO_WISHLIST", + "TOTAL_WEB_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_WEB_CLICK_ADD_TO_WISHLIST", + "TOTAL_WEB_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_ADD_TO_WISHLIST", + "TOTAL_WEB_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_WEB_VIEW_ADD_TO_WISHLIST", + "TOTAL_WEB_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "INAPP_ADD_TO_WISHLIST_COST_PER_ACTION", + "INAPP_ADD_TO_WISHLIST_ROAS", + "TOTAL_INAPP_ADD_TO_WISHLIST", + "TOTAL_INAPP_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_INAPP_CLICK_ADD_TO_WISHLIST", + "TOTAL_INAPP_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_ADD_TO_WISHLIST", + "TOTAL_INAPP_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_INAPP_VIEW_ADD_TO_WISHLIST", + "TOTAL_INAPP_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "OFFLINE_ADD_TO_WISHLIST_COST_PER_ACTION", + "OFFLINE_ADD_TO_WISHLIST_ROAS", + "TOTAL_OFFLINE_ADD_TO_WISHLIST", + "TOTAL_OFFLINE_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_CLICK_ADD_TO_WISHLIST", + "TOTAL_OFFLINE_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_ADD_TO_WISHLIST", + "TOTAL_OFFLINE_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_VIEW_ADD_TO_WISHLIST", + "TOTAL_OFFLINE_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR", + "WEB_INITIATE_CHECKOUT_COST_PER_ACTION", + "WEB_INITIATE_CHECKOUT_ROAS", + "TOTAL_WEB_INITIATE_CHECKOUT", + "TOTAL_WEB_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_WEB_CLICK_INITIATE_CHECKOUT", + "TOTAL_WEB_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_INITIATE_CHECKOUT", + "TOTAL_WEB_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_WEB_VIEW_INITIATE_CHECKOUT", + "TOTAL_WEB_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "INAPP_INITIATE_CHECKOUT_COST_PER_ACTION", + "INAPP_INITIATE_CHECKOUT_ROAS", + "TOTAL_INAPP_INITIATE_CHECKOUT", + "TOTAL_INAPP_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_INAPP_CLICK_INITIATE_CHECKOUT", + "TOTAL_INAPP_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_INITIATE_CHECKOUT", + "TOTAL_INAPP_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_INAPP_VIEW_INITIATE_CHECKOUT", + "TOTAL_INAPP_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "OFFLINE_INITIATE_CHECKOUT_COST_PER_ACTION", + "OFFLINE_INITIATE_CHECKOUT_ROAS", + "TOTAL_OFFLINE_INITIATE_CHECKOUT", + "TOTAL_OFFLINE_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_CLICK_INITIATE_CHECKOUT", + "TOTAL_OFFLINE_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_INITIATE_CHECKOUT", + "TOTAL_OFFLINE_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_VIEW_INITIATE_CHECKOUT", + "TOTAL_OFFLINE_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR", + "WEB_SUBSCRIBE_COST_PER_ACTION", + "WEB_SUBSCRIBE_ROAS", + "TOTAL_WEB_SUBSCRIBE", + "TOTAL_WEB_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_WEB_CLICK_SUBSCRIBE", + "TOTAL_WEB_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_SUBSCRIBE", + "TOTAL_WEB_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_WEB_VIEW_SUBSCRIBE", + "TOTAL_WEB_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR", + "INAPP_SUBSCRIBE_COST_PER_ACTION", + "INAPP_SUBSCRIBE_ROAS", + "TOTAL_INAPP_SUBSCRIBE", + "TOTAL_INAPP_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_INAPP_CLICK_SUBSCRIBE", + "TOTAL_INAPP_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_SUBSCRIBE", + "TOTAL_INAPP_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_INAPP_VIEW_SUBSCRIBE", + "TOTAL_INAPP_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR", + "OFFLINE_SUBSCRIBE_COST_PER_ACTION", + "OFFLINE_SUBSCRIBE_ROAS", + "TOTAL_OFFLINE_SUBSCRIBE", + "TOTAL_OFFLINE_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_CLICK_SUBSCRIBE", + "TOTAL_OFFLINE_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_SUBSCRIBE", + "TOTAL_OFFLINE_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_VIEW_SUBSCRIBE", + "TOTAL_OFFLINE_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR", + "WEB_VIEW_CONTENT_COST_PER_ACTION", + "WEB_VIEW_CONTENT_ROAS", + "TOTAL_WEB_VIEW_CONTENT", + "TOTAL_WEB_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_WEB_CLICK_VIEW_CONTENT", + "TOTAL_WEB_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_VIEW_CONTENT", + "TOTAL_WEB_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_WEB_VIEW_VIEW_CONTENT", + "TOTAL_WEB_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_WEB_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR", + "INAPP_VIEW_CONTENT_COST_PER_ACTION", + "INAPP_VIEW_CONTENT_ROAS", + "TOTAL_INAPP_VIEW_CONTENT", + "TOTAL_INAPP_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_INAPP_CLICK_VIEW_CONTENT", + "TOTAL_INAPP_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_VIEW_CONTENT", + "TOTAL_INAPP_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_INAPP_VIEW_VIEW_CONTENT", + "TOTAL_INAPP_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_INAPP_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR", + "OFFLINE_VIEW_CONTENT_COST_PER_ACTION", + "OFFLINE_VIEW_CONTENT_ROAS", + "TOTAL_OFFLINE_VIEW_CONTENT", + "TOTAL_OFFLINE_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_CLICK_VIEW_CONTENT", + "TOTAL_OFFLINE_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_VIEW_CONTENT", + "TOTAL_OFFLINE_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR", + "TOTAL_OFFLINE_VIEW_VIEW_CONTENT", + "TOTAL_OFFLINE_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR", + "TOTAL_OFFLINE_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR", "IDEA_PIN_PAGE_FORWARD_1", "IDEA_PIN_PAGE_FORWARD_2", "IDEA_PIN_PAGE_BACKWARD_1", @@ -38903,6 +41954,11 @@ "TOTAL_WATCH_VIDEO_CONVERSION_RATE", "TOTAL_UNKNOWN_CONVERSION_RATE", "TOTAL_CUSTOM_CONVERSION_RATE", + "TOTAL_ADD_PAYMENT_INFO_CONVERSION_RATE", + "TOTAL_ADD_TO_WISHLIST_CONVERSION_RATE", + "TOTAL_INITIATE_CHECKOUT_CONVERSION_RATE", + "TOTAL_SUBSCRIBE_CONVERSION_RATE", + "TOTAL_VIEW_CONTENT_CONVERSION_RATE", "STANDARD_AD_FEED_ITEM_ID", "IS_STANDARD_FEED_AD", "TARGETING_GENDER", @@ -38912,6 +41968,7 @@ "TARGETING_APPTYPE", "TARGETING_LOCATION_CODE", "TARGETING_MEDIA_TYPE", + "TARGETING_AGE_BUCKET", "TOTAL_CONVERSION_PRODUCT_QUANTITY", "TOTAL_WEB_CONVERSION_PRODUCT_QUANTITY", "TOTAL_INAPP_CONVERSION_PRODUCT_QUANTITY", @@ -39472,6 +42529,7 @@ "description": "The top trending keywords for the specified trend type in the requested region.
\nResults are ordered, with the first element in the array representing the #1 top trend.", "type": "array", "items": { + "title": "TrendingKeyword", "type": "object", "properties": { "keyword": { @@ -39504,6 +42562,7 @@ "2023-10-31": 100 }, "type": "object", + "title": "TimeSeries", "properties": { "date": { "type": "string", @@ -39631,6 +42690,36 @@ "type": "string", "nullable": true }, + "custom_number_0": { + "description": "an attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.", + "example": 10, + "type": "integer", + "nullable": true + }, + "custom_number_1": { + "description": "an attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.", + "example": 0, + "type": "integer", + "nullable": true + }, + "custom_number_2": { + "description": "an attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.", + "example": 1520000000, + "type": "integer", + "nullable": true + }, + "custom_number_3": { + "description": "an attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.", + "example": 4294967295, + "type": "integer", + "nullable": true + }, + "custom_number_4": { + "description": "an attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.", + "example": 50, + "type": "integer", + "nullable": true + }, "description": { "description": "

<= 10000 characters

\n

The description of the product.

", "example": "Casual fit denim shirt made with the finest quality Japanese denim.", @@ -40205,6 +43294,11 @@ "custom_label_2", "custom_label_3", "custom_label_4", + "custom_number_0", + "custom_number_1", + "custom_number_2", + "custom_number_3", + "custom_number_4", "description", "free_shipping_label", "free_shipping_limit", @@ -40625,9 +43719,153 @@ "SHARE", "REVOKE" ] + }, + "ErrorResponse": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "integer" + }, + "message": { + "type": "string" + } + } + }, + "LeadSubscription": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^\\d+$", + "description": "Subscription ID." + }, + "lead_form_id": { + "type": "string", + "nullable": true, + "pattern": "^\\d+$", + "description": "Lead form ID.", + "title": "Lead form ID" + }, + "webhook_url": { + "type": "string", + "description": "Standard HTTPS webhook URL.", + "title": "webhook_url" + }, + "ad_account_id": { + "type": "string", + "pattern": "^\\d+$", + "description": "The Ad Account ID that this lead form belongs to." + }, + "user_account_id": { + "type": "string", + "pattern": "^\\d+$", + "description": "User account used to subscribe lead data." + }, + "api_version": { + "type": "string", + "description": "API version." + }, + "cryptographic_key": { + "type": "string", + "nullable": true, + "description": "Base64 encoded key for client to decrypt lead data." + }, + "cryptographic_algorithm": { + "type": "string", + "nullable": true, + "description": "Lead data encryption algorithm." + }, + "created_time": { + "type": "integer", + "description": "Subscription creation time. Unix timestamp in milliseconds." + } + } + }, + "LeadSubscriptionPostParamsCreate": { + "type": "object", + "properties": { + "partner_access_token": { + "type": "string", + "description": "Partner access token. Only for clients that requires authentication. We recommend to avoid this param." + }, + "partner_refresh_token": { + "type": "string", + "description": "Partner refresh token. Only for clients that requires authentication. We recommend to avoid this param." + }, + "partner_metadata": { + "allOf": [ + { + "type": "object", + "properties": { + "subscriber_key": { + "type": "string", + "description": "Text field value that uniquely identifies a subscriber." + } + } + } + ], + "description": "Partner metadata. Only for clients that requires special handling. We recommend to avoid this param." + } + }, + "allOf": [ + { + "type": "object", + "required": [ + "webhook_url" + ], + "properties": { + "lead_form_id": { + "type": "string", + "pattern": "^\\d+$", + "description": "Lead form ID.", + "title": "Lead form ID" + }, + "webhook_url": { + "type": "string", + "description": "Standard HTTPS webhook URL.", + "title": "webhook_url" + } + } + } + ] + }, + "Resource.Error": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "description": "Default error response", + "title": "Generic Error", + "example": { + "code": 2, + "message": "AdAccount not found." + } } }, "parameters": { + "fetch_system_users": { + "name": "fetch_system_users", + "in": "query", + "description": "Fetches system users if True. Fetches regular user employees if False.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, "result_limit": { "description": "Max search result size", "in": "query", @@ -40757,6 +43995,17 @@ "default": false } }, + "path_billing_invoice_id": { + "name": "billing_invoice_id", + "description": "Unique identifier of a billing invoice.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+$", + "maxLength": 18 + } + }, "path_business_id": { "name": "business_id", "in": "path", @@ -40834,10 +44083,11 @@ "name": "batch_id", "in": "path", "description": "Id of a catalogs items batch to fetch", - "example": "595953100599279259-66753b9bb65c46c49bd8503b27fecf9e", + "example": "66753b9bb65c46c49bd8503b27fecf9e", "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9]+$" } }, "path_catalogs_processing_result_id": { @@ -40982,6 +44232,17 @@ "maxLength": 18 } }, + "path_promotion_id": { + "name": "promotion_id", + "description": "Unique identifier of a promotion", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+$", + "maxLength": 18 + } + }, "path_scope": { "name": "scope", "description": "Generated audience scope to request.", @@ -41284,6 +44545,58 @@ "maxItems": 100 } }, + "query_billing_document_type": { + "name": "document_type", + "in": "query", + "description": "Document type of billing invoices to filter by", + "required": false, + "schema": { + "type": "string", + "example": "INVOICE", + "enum": [ + "INVOICE", + "CREDIT_MEMO" + ] + } + }, + "query_billing_end_due_date": { + "name": "end_due_date", + "in": "query", + "description": "Ending point for due dates when searching for invoices. Format: YYYY-MM-DD", + "required": false, + "schema": { + "type": "string", + "format": "date", + "example": "2024-01-01", + "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$" + } + }, + "query_billing_invoice_status": { + "name": "status", + "in": "query", + "description": "Status of billing invoices to filter by", + "required": false, + "schema": { + "type": "string", + "example": "OPEN", + "enum": [ + "OPEN", + "CLOSED" + ] + } + }, + "query_billing_start_due_date": { + "name": "start_due_date", + "in": "query", + "description": "Starting point for due dates when searching for invoices. Format: YYYY-MM-DD", + "required": false, + "schema": { + "type": "string", + "format": "date", + "example": "2023-01-01", + "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$" + } + }, "query_bookmark": { "name": "bookmark", "description": "Cursor used to fetch the next page of items", @@ -41368,7 +44681,31 @@ "required": true, "style": "deepObject", "schema": { - "$ref": "#/components/schemas/CatalogsReportParameters" + "type": "object", + "description": "Report stats parameters", + "properties": { + "catalog_type": { + "$ref": "#/components/schemas/CatalogsType" + } + }, + "required": [ + "catalog_type" + ], + "oneOf": [ + { + "$ref": "#/components/schemas/CatalogsRetailReportStatsParameters" + }, + { + "$ref": "#/components/schemas/CatalogsHotelReportStatsParameters" + } + ], + "discriminator": { + "propertyName": "catalog_type", + "mapping": { + "RETAIL": "#/components/schemas/CatalogsRetailReportStatsParameters", + "HOTEL": "#/components/schemas/CatalogsHotelReportStatsParameters" + } + } } }, "query_catalogs_feed_id": { @@ -41407,22 +44744,6 @@ "$ref": "#/components/schemas/CatalogsItemValidationIssue" } }, - "query_catalogs_items": { - "deprecated": true, - "name": "item_ids", - "in": "query", - "description": "This parameter is deprecated. Use filters instead.", - "example": [ - "CR123" - ], - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, "query_catalogs_items_country": { "name": "country", "in": "query", @@ -41527,6 +44848,7 @@ "ECPC_IN_DOLLAR", "CTR", "ECTR", + "OUTBOUND_CTR_1", "CAMPAIGN_NAME", "PIN_ID", "TOTAL_ENGAGEMENT", @@ -41548,7 +44870,11 @@ "CAMPAIGN_OBJECTIVE_TYPE", "CPM_IN_MICRO_DOLLAR", "CPM_IN_DOLLAR", + "AD_GROUP_NAME", "AD_GROUP_ENTITY_STATUS", + "AD_GROUP_BID_MULTIPLIER", + "PROMO_ID", + "PROMO_NAME", "ORDER_LINE_ID", "ORDER_LINE_NAME", "CLICKTHROUGH_1", @@ -41566,6 +44892,7 @@ "TOTAL_IMPRESSION_USER", "TOTAL_IMPRESSION_FREQUENCY", "COST_PER_OUTBOUND_CLICK_IN_DOLLAR", + "COST_PER_OUTBOUND_CLICK_IN_DOLLAR_1", "TOTAL_ENGAGEMENT_SIGNUP", "TOTAL_ENGAGEMENT_CHECKOUT", "TOTAL_ENGAGEMENT_LEAD", @@ -41587,8 +44914,11 @@ "TOTAL_WEB_SESSIONS", "WEB_SESSIONS_1", "WEB_SESSIONS_2", + "AD_NAME", "CAMPAIGN_LIFETIME_SPEND_CAP", + "AD_GROUP_OPTIMIZATION", "CAMPAIGN_DAILY_SPEND_CAP", + "IS_PREMIERE_CAMPAIGN", "TOTAL_PAGE_VISIT", "TOTAL_SIGNUP", "TOTAL_CHECKOUT", @@ -41601,6 +44931,7 @@ "PAGE_VISIT_ROAS", "CHECKOUT_ROAS", "CUSTOM_ROAS", + "PRODUCT_GROUP_AD_IMAGE_TAG", "VIDEO_MRC_VIEWS_1", "VIDEO_3SEC_VIEWS_2", "VIDEO_P100_COMPLETE_2", @@ -41612,6 +44943,7 @@ "VIDEO_MRC_VIEWS_2", "PAID_VIDEO_VIEWABLE_RATE", "VIDEO_LENGTH", + "VIDEO_SPEND_IN_DOLLAR", "ECPV_IN_DOLLAR", "ECPCV_IN_DOLLAR", "ECPCV_P95_IN_DOLLAR", @@ -42372,7 +45704,8 @@ "enum": [ "AD_ACCOUNT", "PROFILE", - "ASSET_GROUP" + "ASSET_GROUP", + "CATALOG" ], "default": "AD_ACCOUNT", "example": "AD_ACCOUNT" @@ -42402,6 +45735,24 @@ ] } }, + "query_sort_billing_invoice": { + "name": "sort", + "in": "query", + "description": "Field of which to sort billing invoices", + "required": false, + "schema": { + "type": "string", + "example": "DUE_DATE", + "default": "DUE_DATE", + "enum": [ + "DUE_DATE", + "BILLING_PERIOD", + "DOCUMENT_TYPE", + "TOTAL_AMOUNT", + "INVOICE_NUMBER" + ] + } + }, "query_sort_by": { "description": "Specify sorting order for metrics", "explode": false, @@ -42708,7 +46059,63 @@ "schema": { "$ref": "#/components/schemas/InviteType" } + }, + "aggregate_report_rows": { + "in": "query", + "description": "Determines if report rows should be aggregated across all requested entities. This feature is currently in BETA and is not available to all users.", + "name": "aggregate_report_rows", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "AdAccountId": { + "name": "ad_account_id", + "in": "path", + "required": true, + "description": "Unique identifier of an ad account.", + "schema": { + "type": "string", + "pattern": "^\\d+$", + "maxLength": 18 + } + }, + "Resource.BookmarkParams.order": { + "name": "order", + "in": "query", + "required": false, + "description": "The order in which to sort the items returned: “ASCENDING” or “DESCENDING”\nby ID. Note that higher-value IDs are associated with more-recently added\nitems.", + "schema": { + "type": "string", + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "default": "ASCENDING" + } + }, + "Resource.BookmarkParams.page_size": { + "name": "page_size", + "in": "query", + "required": false, + "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 250, + "default": 25 + } + }, + "Resource.BookmarkParams.bookmark": { + "name": "bookmark", + "in": "query", + "required": false, + "description": "Cursor used to fetch the next page of items", + "schema": { + "type": "string" + } } } } -} \ No newline at end of file +} diff --git a/v5/openapi.yaml b/v5/openapi.yaml index 54b810e..d5c0691 100644 --- a/v5/openapi.yaml +++ b/v5/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 5.14.0 + version: 5.15.0 title: Pinterest REST API description: Pinterest's REST API contact: @@ -37,7 +37,7 @@ tags: View, share, or revoke shared audiences.
Audience Sharing endpoints are not available to all apps, if you are interested in using them, reach out to us on our help center page. - Learn more. + Learn more. - name: audiences description: View, create, or update audiences. - name: billing @@ -48,6 +48,21 @@ tags: description: Create, update, or download ads-related entities in bulk. - name: campaigns description: View, create or update campaigns. +- name: catalog_feeds + description: View and manage catalog feeds. + x-display-name: feeds +- name: catalog_items + description: View and manage catalog items directly without a feed. + x-display-name: items +- name: catalog_product_groups + description: View and manage catalog product groups using filters. + x-display-name: product_groups +- name: catalog_regions + description: View and manage catalog regions defined by sets of postal codes. + x-display-name: regions +- name: catalog_reports + description: View and manage reports about catalogs. + x-display-name: reports - name: catalogs description: Manage information about shopping product catalogs and items. - name: conversion_events @@ -68,6 +83,9 @@ tags: description: Create and export leads information from lead ads. - name: media description: Register and manage media uploads. +- name: msot_events + description: Submit Measurement Source of Truth attributed conversion events via + the Pinterest API. - name: oauth description: Generate and refresh OAuth access tokens. - name: order_lines @@ -77,6 +95,8 @@ tags: - name: product_group_promotions description: View, create, update, or delete information about promoted product groups. +- name: promotions + description: View, create, update, or delete promotions. - name: resources description: View metadata about available metrics and targeting options in the Pinterest API. @@ -99,6 +119,7 @@ x-tagGroups: - aggregated_comments - aggregated_pin_data - user_account + - entity_history - name: Campaign Management tags: - ad_accounts @@ -120,6 +141,7 @@ x-tagGroups: - lead_forms - lead_ads - leads_export + - promotions - name: Billing tags: - billing @@ -134,6 +156,7 @@ x-tagGroups: tags: - conversion_events - conversion_tags + - msot_events - name: Others tags: - advanced_auction @@ -145,6 +168,11 @@ x-tagGroups: - name: Shopping tags: - catalogs + - catalog_feeds + - catalog_product_groups + - catalog_reports + - catalog_items + - catalog_regions paths: /ad_accounts: get: @@ -158,6 +186,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -227,6 +257,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -257,6 +289,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -304,8 +338,8 @@ paths: 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\ + \ target=\"_blank\"> click here.\nNotes:\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\ \ advertiser\u2019s profile.

\n

A microcurrency unit is 10^(-6) of the\ @@ -318,10 +352,14 @@ paths: \ to dollars, divide microdollars by 1,000,000\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." + \ you will get an error message.\n- Certain organizations with closed beta access can set `start_time` and `end_time`\ + \ at the ad group level for campaigns with Campaign Budget Optimization (CBO)\ + \ objectives: `TRAFFIC`, `AWARENESS`, `WEB_CONVERSIONS`, and `CATALOG_SALES`.\ + \ All other organizations can set these scheduling parameters for non-CBO\ + \ campaigns only.\n- If the parent ad campaign has start and end times set,\ + \ ad group start and end times must occur within the parent campaign schedule. " operationId: ad_groups/create security: - pinterest_oauth2: @@ -401,10 +439,17 @@ paths: - 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: ad_groups/analytics security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -418,6 +463,7 @@ paths: - $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/aggregate_report_rows' responses: '200': content: @@ -454,10 +500,17 @@ paths: 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: ad_groups_targeting_analytics/get security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -501,6 +554,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -547,14 +602,13 @@ paths: /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. + description: Get a specific ad group given the ad group ID. operationId: ad_groups/get security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -640,6 +694,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -766,10 +822,17 @@ paths: - The request must contain either ad_ids or both campaign_ids and pin_ids. - 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: ads/analytics security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -825,7 +888,7 @@ paths: description: |- Returns the list of discounts applied to the account. - This endpoint might not be available to all apps. Learn more. + This endpoint might not be available to all apps. Learn more. operationId: ads_credits_discounts/get security: - pinterest_oauth2: @@ -865,7 +928,7 @@ paths: 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. + This endpoint might not be available to all apps. Learn more. tags: - billing operationId: ads_credit/redeem @@ -920,10 +983,17 @@ paths: 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: ad_targeting_analytics/get security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -965,6 +1035,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -993,10 +1065,17 @@ paths: - 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: ad_account/analytics security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -1045,6 +1124,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -1073,6 +1154,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -1179,6 +1262,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -1282,6 +1367,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -1335,7 +1422,7 @@ paths: account can share the audience. The recipient ad account(s) must be in the same Pinterest Business Hierarchy as the business owner of the ad account.
This endpoint - is not available to all apps.Learn + is not available to all apps.Learn more. operationId: update_ad_account_to_ad_account_shared_audience security: @@ -1382,7 +1469,7 @@ paths: or revoke access to a previously shared audience. Only the audience owner account can share the audience. The recipient business account must be in the same business hierarchy as the business owner of the ad account.
This - endpoint is not available to all apps.Learn + endpoint is not available to all apps.Learn more. operationId: update_ad_account_to_business_shared_audience security: @@ -1441,6 +1528,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -1474,7 +1563,7 @@ paths: description: |- Get billing profiles in the advertiser account. - This endpoint might not be available to all apps. Learn more. + This endpoint might not be available to all apps. Learn more. operationId: billing_profiles/get security: - pinterest_oauth2: @@ -1514,6 +1603,97 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + /ad_accounts/{ad_account_id}/billing_invoices: + get: + summary: Get billing invoices + description: Get billing invoices in the advertiser account. + operationId: billing_invoices/get + security: + - pinterest_oauth2: + - ads:read + - billing:read + x-ratelimit-category: ads_read + x-sandbox: disabled + parameters: + - $ref: '#/components/parameters/path_ad_account_id' + - $ref: '#/components/parameters/query_bookmark' + - $ref: '#/components/parameters/query_page_size' + - $ref: '#/components/parameters/query_sort_billing_invoice' + - $ref: '#/components/parameters/query_order' + - $ref: '#/components/parameters/query_billing_invoice_status' + - $ref: '#/components/parameters/query_billing_document_type' + - $ref: '#/components/parameters/query_billing_start_due_date' + - $ref: '#/components/parameters/query_billing_end_due_date' + responses: + '200': + description: Success + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Paginated' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/BillingInvoiceResponse' + '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: + - billing + /ad_accounts/{ad_account_id}/billing_invoice/{billing_invoice_id}/download: + get: + summary: Get download url for a billing invoice + description: Get download url for a billing invoice. + operationId: billing_invoice_download/get + security: + - pinterest_oauth2: + - ads:read + - billing:read + x-ratelimit-category: ads_read + x-sandbox: disabled + parameters: + - $ref: '#/components/parameters/path_ad_account_id' + - $ref: '#/components/parameters/path_billing_invoice_id' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BillingInvoiceDownloadResponse' + description: Successfully fetched Billing invoice information for a given + ad account + '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: + - billing /ad_accounts/{ad_account_id}/bulk/download: post: summary: Get advertiser entities in bulk @@ -1597,6 +1777,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -1629,6 +1811,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -1777,10 +1961,17 @@ paths: - 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: campaigns/analytics security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -1794,6 +1985,7 @@ paths: - $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/aggregate_report_rows' responses: '200': content: @@ -1830,10 +2022,17 @@ paths: 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: campaign_targeting_analytics/get security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -1872,6 +2071,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -1900,6 +2101,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -1969,6 +2172,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read operationId: ocpm_eligible_conversion_tags/get parameters: @@ -1997,6 +2202,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -2035,6 +2242,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -2153,6 +2362,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -2323,6 +2534,82 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + /ad_accounts/{ad_account_id}/msot/events: + post: + summary: Send Measurement Source Of Truth (MSOT) attributed conversion events + 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. +
+

Advertisers or their measurement partners can send attributed MSOT conversion events to Pinterest based on their ad_account_id. The request body should be a JSON object.

+ - These events will NOT be used in Reporting. + operationId: msot_events/create + security: + - pinterest_oauth2: + - msot:write + x-ratelimit-category: msot_write + x-sandbox: disabled + parameters: + - $ref: '#/components/parameters/path_ad_account_id' + requestBody: + description: Attributed MSOT conversion events + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConversionMSOTEvents' + responses: + '200': + 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 MSOT conversion events + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: 3 + message: Your token does not have sufficient permissions to perform + this operation. Please ensure your token is authorized with the + correct set of scopes. + '403': + description: Unauthorized access + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: 29 + message: You are not permitted to access the resource + '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. + default: + description: Unexpected errors + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - msot_events /ad_accounts/{ad_account_id}/insights/audiences: get: summary: Get audience insights scope and type @@ -2338,6 +2625,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -2369,6 +2658,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -2481,6 +2772,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -2713,8 +3006,6 @@ paths: 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: @@ -2765,6 +3056,51 @@ paths: tags: - lead_forms /ad_accounts/{ad_account_id}/leads/subscriptions: + get: + operationId: ad_accounts_subscriptions/get_list + 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. + parameters: + - $ref: '#/components/parameters/AdAccountId' + - $ref: '#/components/parameters/Resource.BookmarkParams.bookmark' + - $ref: '#/components/parameters/Resource.BookmarkParams.page_size' + responses: + '200': + description: The request has succeeded. + content: + application/json: + schema: + type: object + required: + - items + properties: + bookmark: + type: string + nullable: true + items: + type: array + items: + $ref: '#/components/schemas/LeadSubscription' + '403': + description: Can't access this subscription. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + default: + description: An unexpected error response. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + tags: + - lead_ads + x-ratelimit-category: ads_read + x-sandbox: disabled + security: + - pinterest_oauth2: + - ads:read post: summary: Create lead ads subscription description: |- @@ -2773,8 +3109,6 @@ paths: - Only requests for the OWNER or ADMIN of the ad_account will be allowed. - Advertisers can set up multiple integrations using ad_account_id + lead_form_id but only one integration per unique records. - For data security, egress lead data is encrypted with AES-256-GCM. - - This endpoint is currently in beta and not available to all apps. Learn more. tags: - lead_ads operationId: ad_accounts_subscriptions/post @@ -2825,79 +3159,29 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + /ad_accounts/{ad_account_id}/leads/subscriptions/{subscription_id}: get: - summary: Get lead ads subscriptions + summary: Get lead ads subscription description: |- - Get the advertiser's list of lead ads subscriptions. + 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_list + operationId: ad_accounts_subscriptions/get_by_id security: - pinterest_oauth2: - ads:read + - client_credentials: + - 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' + - $ref: '#/components/parameters/path_subscription_id' 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: - - lead_ads - /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' + $ref: '#/components/schemas/AdAccountGetSubscriptionResponse' description: Success '400': description: Invalid input parameters. @@ -2943,8 +3227,6 @@ paths: 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: @@ -3354,7 +3636,7 @@ paths: items: type: array items: - $ref: '#/components/schemas/ProductGroupPromotionResponseItem' + $ref: '#/components/schemas/ProductGroupPromotion' description: Success default: content: @@ -3382,7 +3664,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProductGroupPromotionResponse' + $ref: '#/components/schemas/ProductGroupPromotion' description: Success default: content: @@ -3401,10 +3683,17 @@ paths: - 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: product_groups/analytics security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: disabled parameters: @@ -3442,6 +3731,208 @@ paths: $ref: '#/components/schemas/Error' tags: - product_group_promotions + /ad_accounts/{ad_account_id}/promotions: + get: + summary: Get promotions + description: Gets all promotions associated with an ad account ID that can be + applied to an ad group. Can be either internally-saved promotions or external + promotions imported from a commerce integration. + operationId: 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_page_size' + - $ref: '#/components/parameters/query_order' + - $ref: '#/components/parameters/query_bookmark' + responses: + '200': + description: Success + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/Paginated' + - properties: + items: + type: array + items: + $ref: '#/components/schemas/PromotionResponse' + '400': + description: Invalid ad account promotions parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: 400 + message: Invalid ad account promotions parameters. + default: + description: Unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - promotions + post: + description: Create multiple new promotions. + operationId: 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: + type: array + description: List of promotions to create. + items: + $ref: '#/components/schemas/PromotionCreateRequest' + maxItems: 30 + minItems: 1 + description: List of promotions to create, size limit [1, 30]. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PromotionsResponse' + description: Success + '400': + description: Invalid create promotions request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: 400 + message: Platform type not supported for promotions. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Create promotions + tags: + - promotions + patch: + description: Update multiple promotions. + operationId: 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: + type: array + description: List of promotion data updates keyed on promotion id. + items: + $ref: '#/components/schemas/PromotionUpdateRequest' + maxItems: 30 + minItems: 1 + description: List of promotions to create, size limit [1, 30]. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PromotionsResponse' + description: Success + '400': + description: Invalid create promotions request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: 400 + message: Platform type not supported for promotions. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unexpected error + summary: Update promotions + tags: + - promotions + /ad_accounts/{ad_account_id}/promotions/{promotion_id}: + get: + summary: Get promotion by id + description: Get a promotion by its Pinterest-specific id. It must be associated + with the provided ad account id. + operationId: 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_promotion_id' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PromotionResponse' + '404': + description: The promotion ID for the given ad account ID was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + code: 4997 + message: Promotion for that ID was not found + default: + description: Unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - promotions + delete: + summary: Delete promotion by id + description: Delete a promotion within Pinterest. + operationId: promotions/delete + 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_promotion_id' + responses: + '204': + description: Promotion deleted successfully + default: + description: Unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - promotions /ad_accounts/{ad_account_id}/reports: get: summary: Get the account analytics report created by the async call @@ -3490,6 +3981,11 @@ paths: - 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: analytics/create_report security: - pinterest_oauth2: @@ -3843,10 +4339,17 @@ paths: 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. + + Deprecation notice + As of March 31, 2025, requests to this endpoint have changed for the following parameters: + - engagement_window_days: This parameter no longer returns new data. However, you can still access historic data for up to 25 weeks after the deprecation date. + - granularity: The HOUR enum for this parameter no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums remain available as usual. operationId: ad_account_targeting_analytics/get security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_analytics x-sandbox: enabled parameters: @@ -3884,6 +4387,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: disabled parameters: @@ -3917,7 +4422,7 @@ paths: items: type: array items: - $ref: '#/components/schemas/TargetingTemplateResponseData' + $ref: '#/components/schemas/TargetingTemplateGetResponseData' description: Success '400': description: Invalid ad account id. @@ -4377,6 +4882,9 @@ paths: - pinterest_oauth2: - boards:read - boards:write + - client_credentials: + - boards:read + - boards:write x-ratelimit-category: org_write x-sandbox: enabled x-codeSamples: @@ -4532,6 +5040,9 @@ paths: - pinterest_oauth2: - boards:read - boards:write + - client_credentials: + - boards:read + - boards:write x-ratelimit-category: org_write x-sandbox: enabled x-codeSamples: @@ -5186,6 +5697,7 @@ paths: parameters: - $ref: '#/components/parameters/path_business_user' - $ref: '#/components/parameters/path_asset_id' + - $ref: '#/components/parameters/fetch_system_users' - $ref: '#/components/parameters/query_bookmark' - $ref: '#/components/parameters/query_page_size' - $ref: '#/components/parameters/query_business_access_start_index' @@ -5355,6 +5867,7 @@ paths: x-sandbox: disabled parameters: - $ref: '#/components/parameters/path_business_user' + - $ref: '#/components/parameters/fetch_system_users' - $ref: '#/components/parameters/query_assets_summary' - name: business_roles in: query @@ -6145,7 +6658,7 @@ paths: is the owner of the audience, it can share with any ad account within the same business hierarchy.
  • If the business is the recipient of the audience, it can share with any of its owned ad accounts.
    • This - endpoint is not available to all apps.Learn + endpoint is not available to all apps.Learn more. operationId: update_business_to_ad_account_shared_audience security: @@ -6192,7 +6705,7 @@ paths: account, or revoke access to a previously shared audience. Only the audience owner can share the audience with other businesses, and the recipient business must be within the same business hierarchy.
    This endpoint is not available - to all apps.Learn + to all apps.Learn more. operationId: update_business_to_business_shared_audience security: @@ -6555,7 +7068,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds post: x-ratelimit-category: catalogs_write summary: Create feed @@ -6683,7 +7196,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds /catalogs/feeds/{feed_id}: get: x-ratelimit-category: catalogs_read @@ -6753,7 +7266,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds patch: x-ratelimit-category: catalogs_write summary: Update feed @@ -6842,7 +7355,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds delete: x-ratelimit-category: catalogs_write summary: Delete feed @@ -6927,7 +7440,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds /catalogs/feeds/{feed_id}/ingest: post: x-ratelimit-category: catalogs_write @@ -7003,7 +7516,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds /catalogs/feeds/{feed_id}/processing_results: get: x-ratelimit-category: catalogs_read @@ -7079,7 +7592,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds /catalogs/processing_results/{processing_result_id}/item_issues: get: x-ratelimit-category: catalogs_read @@ -7159,19 +7672,19 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_feeds /catalogs/items: - get: - deprecated: true - summary: Get catalogs items + post: + summary: Get catalogs items (POST) description: |- Get the items of the catalog owned by the "operation user_account". See detailed documentation here. - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. - Note: this endpoint is deprecated and will be deleted soon. Please use Get catalogs items (POST) instead. - operationId: items/get + Note: Access to the Creative Assets catalog type is restricted to a specific group of users. + If you require access, please reach out to your partner manager. + operationId: items/post security: - pinterest_oauth2: - catalogs:read @@ -7179,10 +7692,13 @@ paths: x-sandbox: enabled parameters: - $ref: '#/components/parameters/query_ad_account_id' - - $ref: '#/components/parameters/query_catalogs_items_country' - - $ref: '#/components/parameters/query_catalogs_items_language' - - $ref: '#/components/parameters/query_catalogs_items' - - $ref: '#/components/parameters/query_catalogs_items_filters' + requestBody: + description: Request object used to get catalogs items + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CatalogsItemsRequest' responses: '200': description: Response containing the requested catalogs items @@ -7191,7 +7707,7 @@ paths: schema: $ref: '#/components/schemas/CatalogsItems' '400': - description: Invalid request parameters. + description: Invalid request content: application/json: schema: @@ -7200,7 +7716,9 @@ paths: InvalidRequest: value: code: 1 - message: Parameter 'item_ids' is required. + message: 'Invalid request: {''country'': ''US'', ''language'': + ''EN'', ''filters'': {''catalog_type'': ''RETAIL'', ''item_ids'': + ''test0''}} (''test0'' is not of type array)' '401': description: Not authorized to access catalogs items content: @@ -7225,93 +7743,23 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_items + /catalogs/items/batch: post: - summary: Get catalogs items (POST) + summary: Operate on item batch description: |- - Get the items of the catalog owned by the "operation user_account". See detailed documentation here. + This endpoint supports multiple operations on a set of one or more catalog items owned by the "operation user_account". See detailed documentation here. - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. - Note: Access to the Creative Assets catalog type is restricted to a specific group of users. + Note: + - Access to the Creative Assets catalog type is restricted to a specific group of users. If you require access, please reach out to your partner manager. - operationId: items/post - security: - - pinterest_oauth2: - - catalogs:read - x-ratelimit-category: catalogs_read - x-sandbox: enabled - parameters: - - $ref: '#/components/parameters/query_ad_account_id' - requestBody: - description: Request object used to get catalogs items - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CatalogsItemsRequest' - responses: - '200': - description: Response containing the requested catalogs items - content: - application/json: - schema: - $ref: '#/components/schemas/CatalogsItems' - '400': - description: Invalid request - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - InvalidRequest: - value: - code: 1 - message: 'Invalid request: {''country'': ''US'', ''language'': - ''EN'', ''filters'': {''catalog_type'': ''RETAIL'', ''item_ids'': - ''test0''}} (''test0'' is not of type array)' - '401': - description: Not authorized to access catalogs items - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - UnauthorizedAccess: - value: - code: 2 - message: Authentication failed. - '403': - description: Not authorized to access catalogs items - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - default: - description: Unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - tags: - - catalogs - /catalogs/items/batch: - post: - summary: Operate on item batch - description: |- - This endpoint supports multiple operations on a set of one or more catalog items owned by the "operation user_account". See detailed documentation here. - - By default, the "operation user_account" is the token user_account. - - Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. - - Note: - - Access to the Creative Assets catalog type is restricted to a specific group of users. - If you require access, please reach out to your partner manager. - - The item UPSERT operation is restricted to users without a feed data source. If you plan to migrate item ingestion from feeds to the API, please reach out to your partner manager to get assistance. - operationId: items_batch/post - x-ratelimit-category: catalogs_write - x-sandbox: enabled + - The item UPSERT operation is restricted to users without a feed data source. If you plan to migrate item ingestion from feeds to the API, please reach out to your partner manager to get assistance. + operationId: items_batch/post + x-ratelimit-category: catalogs_write + x-sandbox: enabled security: - pinterest_oauth2: - catalogs:read @@ -7376,7 +7824,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_items /catalogs/items/batch/{batch_id}: get: summary: Get item batch status @@ -7453,7 +7901,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_items /catalogs/product_groups/multiple: delete: x-ratelimit-category: catalogs_write @@ -7544,7 +7992,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups post: x-ratelimit-category: catalogs_write summary: Create product groups @@ -7817,7 +8265,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups /catalogs/product_groups: get: x-ratelimit-category: catalogs_read @@ -7927,7 +8375,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups post: x-ratelimit-category: catalogs_write summary: Create product group @@ -7936,7 +8384,7 @@ paths: - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. - + "Catalog-based product groups" can include items from all data sources (feeds and API) and are available to both non-retail catalogs with any data sources and retail catalogs with API-created items. If your catalog only contains retail items created via feeds, you should use the "retail feed-based" option. Learn more Note: Access to the Creative Assets catalog type is restricted to a specific group of users. @@ -8192,7 +8640,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups /catalogs/product_groups/{product_group_id}: get: x-ratelimit-category: catalogs_read @@ -8291,7 +8739,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups delete: x-ratelimit-category: catalogs_write summary: Delete product group @@ -8393,7 +8841,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups patch: x-ratelimit-category: catalogs_write summary: Update single product group @@ -8402,7 +8850,7 @@ paths: - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. - + "Catalog-based product groups" can include items from all data sources (feeds and API) and are available to both non-retail catalogs with any data sources and retail catalogs with API-created items. If your catalog only contains retail items created via feeds, you should use the "retail feed-based" option. Learn more Note: Access to the Creative Assets catalog type is restricted to a specific group of users. @@ -8522,7 +8970,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups /catalogs/product_groups/{product_group_id}/product_counts: get: x-ratelimit-category: catalogs_read @@ -8578,7 +9026,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups /catalogs/product_groups/{product_group_id}/products: get: x-ratelimit-category: catalogs_read @@ -8658,7 +9106,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups /catalogs/products/get_by_product_group_filters: post: x-ratelimit-category: catalogs_read @@ -8740,7 +9188,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_product_groups /catalogs/reports: post: summary: Build catalogs report @@ -8749,6 +9197,9 @@ paths: - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin, Catalogs Manager. + + Note: Access to the All Items report type is restricted to a specific group of users. + If you require access, please reach out to your partner manager. operationId: reports/create security: - pinterest_oauth2: @@ -8809,7 +9260,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_reports get: summary: Get catalogs report description: |- @@ -8862,7 +9313,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_reports /catalogs/reports/stats: get: summary: List report stats @@ -8914,7 +9365,7 @@ paths: schema: $ref: '#/components/schemas/Error' tags: - - catalogs + - catalog_reports /integrations/commerce: post: summary: Create commerce integration @@ -9134,7 +9585,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DetailedError' + anyOf: + - $ref: '#/components/schemas/Error' + - $ref: '#/components/schemas/DetailedError' default: description: Unexpected error content: @@ -9354,9 +9807,9 @@ paths: See Authentication for more. - Parameter refresh_on and its corresponding response type everlasting_refresh are now available to all apps! Later this year, continuous refresh will become the default behavior (ie you will no longer need to send this parameter). Learn more. + Parameter refresh_on and its corresponding response type everlasting_refresh are now available to all apps! Later this year, continuous refresh will become the default behavior (ie you will no longer need to send this parameter). Learn more. - Grant type client_credentials and its corresponding response type are not fully available. You will likely get a default error if you attempt to use this grant_type. + Use Token Debugger to validate and inspect your access token. tags: - oauth operationId: oauth/token @@ -9477,6 +9930,11 @@ paths: - boards:write - pins:read - pins:write + - client_credentials: + - boards:read + - boards:write + - pins:read + - pins:write x-ratelimit-category: org_write x-sandbox: enabled x-codeSamples: @@ -9727,6 +10185,11 @@ paths: - boards:write - pins:read - pins:write + - client_credentials: + - boards:read + - boards:write + - pins:read + - pins:write x-ratelimit-category: org_write x-sandbox: enabled x-codeSamples: @@ -9802,7 +10265,7 @@ paths: - For Pins on public or protected boards: Owner, Admin, Analyst, Campaign Manager. - For Pins on secret boards: Owner, Admin. - This endpoint is currently in beta and not available to all apps. Learn more. + This endpoint is currently in beta and not available to all apps. Learn more. tags: - pins operationId: pins/update @@ -9812,6 +10275,11 @@ paths: - boards:write - pins:read - pins:write + - client_credentials: + - boards:read + - boards:write + - pins:read + - pins:write x-ratelimit-category: org_write x-sandbox: enabled x-codeSamples: @@ -9971,7 +10439,7 @@ paths: get: summary: Get multiple Pin analytics description: |- - This endpoint is currently in beta and not available to all apps. Learn more. + This endpoint is currently in beta and not available to all apps. Learn more. Get analytics for multiple pins owned by the "operation user_account" - or on a group board that has been shared with this account. - The maximum number of pins supported in a single request is 100. @@ -10234,6 +10702,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled responses: @@ -10264,6 +10734,10 @@ paths: - ads:read - pins:read - user_accounts:read + - client_credentials: + - ads:read + - pins:read + - user_accounts:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -10289,7 +10763,7 @@ paths: description: |- Get a list of all lead form question type names. Some questions might not be used. - This endpoint is currently in beta and not available to all apps. Learn more. + This endpoint is currently in beta and not available to all apps. Learn more. operationId: lead_form_questions/get security: - pinterest_oauth2: @@ -10353,6 +10827,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -10382,6 +10858,8 @@ paths: security: - pinterest_oauth2: - ads:read + - client_credentials: + - ads:read x-ratelimit-category: ads_read x-sandbox: enabled parameters: @@ -10508,7 +10986,7 @@ paths: get: summary: Search pins by a given search term description: |- - This endpoint is currently in beta and not available to all apps. Learn more. + This endpoint is currently in beta and not available to all apps. Learn more. Get the top 10 Pins by a given search term. operationId: search_partner_pins @@ -11081,7 +11559,7 @@ paths: post: summary: Follow user description: |- - This endpoint is currently in beta and not available to all apps. Learn more. + This endpoint is currently in beta and not available to all apps. Learn more. Use this request, as a signed-in user, to follow another user. tags: @@ -11353,6 +11831,7 @@ components: 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 + msot:write: Create measurement source of truth events pins:read: See your public Pins pins:read_secret: See your secret Pins pins:write: Create, update, or delete your public Pins @@ -11386,6 +11865,7 @@ components: 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 + msot:write: Create measurement source of truth events pins:read: See your public Pins pins:read_secret: See your secret Pins pins:write: Create, update, or delete your public Pins @@ -11531,11 +12011,14 @@ components: type: object example: country: US + currency: USD owner_user_id: '383791336903426391' name: ACME Tools properties: country: $ref: '#/components/schemas/Country' + currency: + $ref: '#/components/schemas/Currency' name: description: Ad Account name. example: ACME Tools @@ -11656,7 +12139,7 @@ components: type: string nullable: true created_time: - description: Lead form creation time. Unix timestamp in milliseconds. + description: Lead subscription creation time. Unix timestamp in milliseconds. example: 1699209842000 type: integer AdAccountsCountryResponse: @@ -11802,6 +12285,17 @@ components: - ADD_TO_CART - WATCH_NOW - READ_MORE + - BUY_TICKETS + - DONATE_NOW + - DOWNLOAD + - EXPLORE_MORE + - FIND_A_LOCATION + - GET_DEAL + - GET_RECIPE + - GET_SHOWTIMES + - ON_SALE + - PLAY_GAME + - TRY_IT - null quiz_pin_data: type: object @@ -12403,13 +12897,18 @@ components: allOf: - $ref: '#/components/schemas/BudgetType' start_time: - description: Ad group start time. Unix timestamp in seconds. Defaults to - current time. + description: |- + Timestamp in Unix format for scheduling when ads in the ad group start to appear. If not specified, ads appear during parent campaign's `start_time`. Cannot precede `start_time` for parent campaign (if specified). Learn about scheduling ads. + For certain organizations (Closed beta): Supported for campaigns with Campaign Budget Optimization (CBO). + For all organizations: Supported for campaigns without CBO. type: integer example: 5686848000 nullable: true end_time: - description: Ad group end time. Unix timestamp in seconds. + description: |- + Timestamp in Unix format for scheduling when ads in the ad group stop appearing. If not specified, ads run indefinitely unless you update the ad group by changing their status to `paused`. Cannot occur after `end_time` for parent campaign (if specified). Learn about scheduling ads. + For certain organizations (Closed beta): Supported for campaigns with Campaign Budget Optimization (CBO). + For all organizations: Supported for campaigns without CBO. type: integer example: 5705424000 nullable: true @@ -12439,8 +12938,9 @@ components: nullable: true auto_targeting_enabled: type: boolean - description: Enable auto-targeting for ad group. Also known as "expanded targeting". + description: Enable auto-targeting for ad group. Default value is True. + Also known as "Performance+ targeting". example: true nullable: true placement_group: @@ -12462,7 +12962,8 @@ components: bid_strategy_type: nullable: true description: Bid strategy type. For Campaigns with Video Completion objectives, - the only supported bid strategy type is AUTOMATIC_BID. + the only supported bid strategy type is AUTOMATIC_BID, also known as "Performance+ + bidding". enum: - AUTOMATIC_BID - MAX_BID @@ -12485,6 +12986,21 @@ components: example: '643' maxItems: 1 nullable: true + is_creative_optimization: + type: boolean + description: Enable creative optimization for the ad group, default value + is FALSE. When enabled, you allow Pinterest to automatically turn your + product Pins into ads in different formats (collections and shopping) + and deliver those ads to users at scale. + example: true + nullable: true + promotion_id: + type: string + description: Promotion ID. To clear this field, set to null. + pattern: ^\d+$ + example: '7834020347906' + nullable: true + default: '0' AdGroupCreateRequest: type: object allOf: @@ -12500,15 +13016,26 @@ components: type: boolean allOf: - type: boolean - description: Enable auto-targeting for ad group.Default value is True. - Also known as "expanded targeting". + description: Enable auto-targeting for ad group. Default value is True. + Also known as "Performance+ targeting". example: true budget_type: type: string allOf: - $ref: '#/components/schemas/BudgetType' default: DAILY + bid_multiplier: + description: |- + Performance+ campaigns. + type: number + example: 1 + minimum: 0 + maximum: 10 required: - billable_event - campaign_id @@ -12564,6 +13091,17 @@ components: 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.' + bid_multiplier: + description: |- + Performance+ campaigns. + type: number + example: 1 + minimum: 0 + maximum: 10 + nullable: true AdGroupSummaryStatus: type: string description: Summary status for ad group @@ -12588,6 +13126,17 @@ components: type: string pattern: ^\d+$ example: '2680060704746' + bid_multiplier: + description: |- + Performance+ campaigns. + type: number + example: 1 + minimum: 0 + maximum: 10 required: - id AdGroupsAnalyticsResponse: @@ -12596,7 +13145,8 @@ components: type: object properties: AD_GROUP_ID: - description: The ID of the ad group that this metrics belongs to. + description: The ID of the ad group that this metrics belongs to. Returned + as long as aggregate_report_rows is not true. type: string pattern: ^\d+$ DATE: @@ -12604,8 +13154,6 @@ components: time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`) type: string format: date - required: - - AD_GROUP_ID additionalProperties: true example: DATE: '2021-04-01' @@ -12617,8 +13165,9 @@ components: properties: auto_targeting_enabled: type: boolean - description: Enable auto-targeting for ad group. Also known as "expanded targeting". + description: Enable auto-targeting for ad group. Default value is True. + Also known as "Performance+ targeting". example: true default: true placement_group: @@ -13180,6 +13729,16 @@ components: type: integer minimum: 0 maximum: 23 + combine_targeting_types: + type: boolean + description: Determines if the targeting types included in the request + should be consolidated into a single breakdown. For example, when combine_targeting_types + is set to true, if GENDER and COUNTRY are targeting types in the request, + the response will have a targeting type of GENDER_AND_COUNTRY and targeting + values such as female&US. This feature is currently in BETA and is not + available to all users. + example: false + default: false AdsAnalyticsCreateAsyncResponse: type: object properties: @@ -13473,8 +14032,8 @@ components: '809944451643622187': - PROFILE_PUBLISHER AssetTypeResponse: - description: Type of asset. Currently we only support AD_ACCOUNT and PROFILE, - and ASSET_GROUP. + description: Type of asset. Currently we only support AD_ACCOUNT, PROFILE, ASSET_GROUP + and CATALOG. example: AD_ACCOUNT type: string Audience: @@ -13538,6 +14097,12 @@ components: nullable: true title: updated_time type: integer + created_by_company_name: + description: The company that created this audience. + example: Pinterest + nullable: true + title: created_by_company_name + type: string title: Audience type: object AudienceCategory: @@ -13651,12 +14216,12 @@ components: $ref: '#/components/schemas/AudienceDescription' audience_type: type: string + title: audience_type + description: 'Audience + types: ACTALIKE, ENGAGEMENT, CUSTOMER_LIST and VISITOR. Values are + case-sensitive.' allOf: - $ref: '#/components/schemas/AudienceType' - - title: audience_type - description: 'Audience - types: ACTALIKE, ENGAGEMENT, CUSTOMER_LIST and VISITOR. Values - are case-sensitive.' AudienceDataParty: description: Whether the data is owned by the partner (1p) or by the data provider (3p) @@ -13676,13 +14241,13 @@ components: nullable: true example: '2022-10-09' type: - $ref: '#/components/schemas/AudienceDefinitionType' + title: AudienceDefinitionType + type: string + example: IMPRESSION_PLUS_ENGAGEMENT scope: - $ref: '#/components/schemas/AudienceDefinitionScope' - example: - date: '2022-10-09' - scope: PARTNER - type: IMPRESSION_PLUS_ENGAGEMENT + title: AudienceDefinitionScope + type: string + example: PARTNER AudienceDefinitionResponse: type: object properties: @@ -13691,18 +14256,20 @@ components: items: $ref: '#/components/schemas/AudienceDefinition' AudienceDefinitionScope: + type: object description: Generated audience scope to request. - type: string properties: scope: + type: string enum: - PARTNER - PINTEREST AudienceDefinitionType: + type: object description: Generated audience type to request. - type: string properties: scope: + type: string enum: - IMPRESSION_PLUS_ENGAGEMENT - ENGAGEMENT @@ -14203,6 +14770,7 @@ components: type: object AvailabilityFilter: type: object + title: AVAILABILITY additionalProperties: false properties: AVAILABILITY: @@ -14487,6 +15055,92 @@ components: - ELO - CARTE_BANCAIRE example: VISA + billing_type: + description: Billing type of the advertiser + type: string + enum: + - CREDIT_CARD + - INVOICE + - INTERNAL + - RECURRING + - PREPAID + example: CREDIT_CARD + BillingInvoiceResponse: + type: object + properties: + id: + type: string + description: Unique identifier for the billing invoice + pattern: ^\d+$ + ad_account_id: + type: string + description: The ID of the ad account this invoice belongs to + pattern: ^\d+$ + ad_account_name: + type: string + description: The name of the ad account this invoice belongs to + document_type: + type: string + description: The type of the document + enum: + - INVOICE + - CREDIT_MEMO + amount_billed_micro_currency: + type: integer + description: The amount billed in this invoice. Denoted in micro currency + amount_tax_micro_currency: + type: integer + description: The tax in this invoice. Denoted in micro currency + nullable: true + amount_net_micro_currency: + type: integer + description: The net amount in this invoice. Denoted in micro currency + nullable: true + amount_discount_micro_currency: + type: integer + description: The discount in this invoice. Denoted in micro currency + nullable: true + currency: + $ref: '#/components/schemas/Currency' + billing_period_start_date: + type: string + format: date + description: 'The start date of the billing period. Format: YYYY-MM-DD' + pattern: ^(\d{4})-(\d{2})-(\d{2})$ + billing_period_end_date: + type: string + format: date + description: 'The end date of the billing period. Format: YYYY-MM-DD' + pattern: ^(\d{4})-(\d{2})-(\d{2})$ + invoice_due_date: + type: string + format: date + description: 'The date the invoice is due. Format: YYYY-MM-DD' + pattern: ^(\d{4})-(\d{2})-(\d{2})$ + status: + type: string + description: The status of the invoice + example: OPEN + enum: + - OPEN + - CLOSED + payment_terms: + type: string + description: The payment terms of the invoice + example: NET 30 + bill_to_country: + type: string + description: The country of the bill to address + BillingInvoiceDownloadResponse: + title: BillingInvoiceDownloadResponse + type: object + properties: + id: + type: string + description: The billing invoice id + download_url: + type: string + description: The download url for the billing invoice Board: title: Board description: Board @@ -14627,6 +15281,7 @@ components: example: false BrandFilter: type: object + title: BRAND additionalProperties: false properties: BRAND: @@ -15189,18 +15844,26 @@ components: - $ref: '#/components/schemas/TrackingUrls' start_time: type: integer - description: Campaign start time. Unix timestamp in seconds. Only used for - Campaign Budget Optimization (CBO) campaigns. + description: |- + Timestamp in Unix format for scheduling when ads in the campaign start to appear. Must precede any start times set for child ad groups. Defaults to current time if no time is specified. Learn about scheduling campaigns. + Different start times can be set for the campaign's child ad groups, but they cannot occur before a `start_time` specified for the campaign. + - If your campaign has a child ad group with a start time specified, and if you update that campaign with a `start_time` that is later than that of the ad group, the campaign `start_time` will supersede the ad group `start_time`, and the request will not return an error. + - In this scenario, if you call List campaigns or List ad groups, the returned campaigns or ad groups are listed with the start and end times that you assigned them, regardless of supersedence. example: 1580865126 nullable: true end_time: type: integer - description: Campaign end time. Unix timestamp in seconds. Only used for - Campaign Budget Optimization (CBO) campaigns. + description: |- + Timestamp in Unix format for scheduling when ads in the campaign stop appearing. Must occur after any end times for child ad groups. If `end_time` is not specified for the campaign, ads run indefinitely unless you update the campaign, changing their status to `paused`. Learn about scheduling campaigns. + Different end times can be set for the campaign's child ad groups, but they cannot occur after an `end_time` specified for the campaign. + - If your campaign has a child ad group with an end time specified, and if you update that campaign with an `end_time` that is earlier than that of the ad group, the campaign `end_time` will supersede the ad group `end_time`, and the request will not return an error. + - In this scenario, if you call List campaigns or List ad groups, the returned campaigns or ad groups are listed with the start and end times that you assigned them, regardless of supersedence. example: 1644023526 nullable: true is_flexible_daily_budgets: $ref: '#/components/schemas/CampaignIsFlexibleDailyBudgets' + is_automated_campaign: + $ref: '#/components/schemas/CampaignIsAutomatedCampaign' CampaignCreateCommon: type: object allOf: @@ -15215,8 +15878,6 @@ components: of the associated advertiser account. example: 0 nullable: true - is_automated_campaign: - $ref: '#/components/schemas/CampaignIsAutomatedCampaign' CampaignCreateRequest: type: object allOf: @@ -15226,11 +15887,13 @@ components: is_flexible_daily_budgets: type: boolean default: false + nullable: false allOf: - $ref: '#/components/schemas/CampaignIsFlexibleDailyBudgets' is_automated_campaign: type: boolean default: false + nullable: false allOf: - $ref: '#/components/schemas/CampaignIsAutomatedCampaign' status: @@ -15240,6 +15903,13 @@ components: - $ref: '#/components/schemas/EntityStatus' objective_type: $ref: '#/components/schemas/ObjectiveType' + is_performance_plus: + description: Enable Performance+ for your campaign. To learn more, see + Performance+ + Setup. + type: boolean + example: true + default: false required: - name - objective_type @@ -15292,7 +15962,8 @@ components: nullable: true CampaignIsFlexibleDailyBudgets: type: boolean - description: Determine if a campaign has flexible daily budgets setup. + description: Determine if a campaign has setup for flexible daily budgets, also + known as "Performance+ budgets". example: true nullable: true CampaignResponse: @@ -15320,6 +15991,12 @@ components: $ref: '#/components/schemas/CampaignIsCampaignBudgetOptimization' summary_status: $ref: '#/components/schemas/CampaignSummaryStatus' + is_performance_plus: + description: Enable Performance+ for your campaign. To learn more, see + Performance+ + Setup. + type: boolean + example: true CampaignSummaryStatus: type: string description: Summary status for campaign @@ -15347,6 +16024,13 @@ components: nullable: true allOf: - $ref: '#/components/schemas/ObjectiveType' + is_performance_plus: + description: Enable Performance+ for your campaign. To learn more, see + Performance+ + Setup. This field is immutable, except only for campaigns in draft + status which may update this field. + type: boolean + example: true required: - id - ad_account_id @@ -15360,7 +16044,8 @@ components: type: object properties: CAMPAIGN_ID: - description: The ID of the campaing that this metrics belongs to. + description: The ID of the campaing that this metrics belongs to. Returned + as long as aggregate_report_rows is not true. type: string pattern: ^\d+$ DATE: @@ -15368,8 +16053,6 @@ components: time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`) type: string format: date - required: - - CAMPAIGN_ID additionalProperties: true example: DATE: '2021-04-01' @@ -15576,6 +16259,36 @@ components: RETAIL: '#/components/schemas/CatalogsRetailReportParameters' HOTEL: '#/components/schemas/CatalogsHotelReportParameters' CatalogsHotelReportParameters: + type: object + description: Parameters for hotel report + properties: + catalog_type: + type: string + enum: + - HOTEL + report: + type: object + oneOf: + - $ref: '#/components/schemas/CatalogsReportFeedIngestionFilter' + - $ref: '#/components/schemas/CatalogsReportDistributionIssueFilter' + - $ref: '#/components/schemas/CatalogsReportAllItemsFilter' + discriminator: + propertyName: report_type + mapping: + FEED_INGESTION_ISSUES: '#/components/schemas/CatalogsReportFeedIngestionFilter' + DISTRIBUTION_ISSUES: '#/components/schemas/CatalogsReportDistributionIssueFilter' + ALL_ITEMS: '#/components/schemas/CatalogsReportAllItemsFilter' + properties: + report_type: + type: string + enum: + - FEED_INGESTION_ISSUES + - DISTRIBUTION_ISSUES + - ALL_ITEMS + required: + - catalog_type + - report + CatalogsHotelReportStatsParameters: type: object description: Parameters for hotel report properties: @@ -15603,6 +16316,36 @@ components: - catalog_type - report CatalogsRetailReportParameters: + type: object + description: Parameters for retail report + properties: + catalog_type: + type: string + enum: + - RETAIL + report: + type: object + oneOf: + - $ref: '#/components/schemas/CatalogsReportFeedIngestionFilter' + - $ref: '#/components/schemas/CatalogsReportDistributionIssueFilter' + - $ref: '#/components/schemas/CatalogsReportAllItemsFilter' + discriminator: + propertyName: report_type + mapping: + FEED_INGESTION_ISSUES: '#/components/schemas/CatalogsReportFeedIngestionFilter' + DISTRIBUTION_ISSUES: '#/components/schemas/CatalogsReportDistributionIssueFilter' + ALL_ITEMS: '#/components/schemas/CatalogsReportAllItemsFilter' + properties: + report_type: + type: string + enum: + - FEED_INGESTION_ISSUES + - DISTRIBUTION_ISSUES + - ALL_ITEMS + required: + - catalog_type + - report + CatalogsRetailReportStatsParameters: type: object description: Parameters for retail report properties: @@ -15666,6 +16409,21 @@ components: pattern: ^\d+$ required: - report_type + CatalogsReportAllItemsFilter: + type: object + additionalProperties: false + properties: + report_type: + type: string + enum: + - ALL_ITEMS + catalog_id: + type: string + description: Unique identifier of a catalog. If not given, oldest catalog + will be used + pattern: ^\d+$ + required: + - report_type CatalogsHotelBatchItem: description: Hotel batch item type: object @@ -15917,6 +16675,10 @@ components: IMAGE_INVALID_FILE: type: integer description: Image files are unreadable. Please upload new files to continue. + FETCH_GOOGLE_SHEET_NOT_SHARED: + type: integer + description: Update your Google Sheets sharing settings to 'Anyone with + link' as a Viewer so that Pinterest can access your file. CatalogsFeedIngestionInfo: type: object properties: @@ -15976,6 +16738,10 @@ components: type: integer description: price is not a supported column. Use base_price and sale_price instead. + FETCH_GOOGLE_SHEET_PUBLIC_CAN_EDIT: + type: integer + description: Update your Google Sheets sharing settings from 'Editor' to + 'Viewer'. CatalogsFeedProcessingResult: type: object allOf: @@ -16437,127 +17203,467 @@ components: properties: FETCH_ERROR: type: integer - description: Pinterest couldn't download your feed. - FETCH_INACTIVE_FEED_ERROR: + description: Pinterest couldn't download your feed. + FETCH_INACTIVE_FEED_ERROR: + type: integer + description: "Your feed wasn't ingested because it hasn\u2019t changed in\ + \ the previous 90 days." + ENCODING_ERROR: + type: integer + description: Your feed includes data with an unsupported encoding format. + DELIMITER_ERROR: + type: integer + description: Your feed includes data with formatting errors. + REQUIRED_COLUMNS_MISSING: + type: integer + description: Your feed is missing some required column headers. + DUPLICATE_PRODUCTS: + type: integer + description: Some products are duplicated. + IMAGE_LINK_INVALID: + type: integer + description: Some image links are formatted incorrectly. + ITEMID_MISSING: + type: integer + description: Some items are missing an item id in their product metadata, + those items will not be published. + TITLE_MISSING: + type: integer + description: Some items are missing a title in their product metadata, those + items will not be published. + DESCRIPTION_MISSING: + type: integer + description: Some items are missing a description in their product metadata, + those items will not be published. + PRODUCT_LINK_MISSING: + type: integer + description: Some items are missing a link URL in their product metadata, + those items will not be published. + IMAGE_LINK_MISSING: + type: integer + description: Some items are missing an image link URL in their product metadata, + those items will not be published. + AVAILABILITY_INVALID: + type: integer + description: Some items are missing an availability value in their product + metadata, those items will not be published. + PRODUCT_PRICE_INVALID: + type: integer + description: Some items have price formatting errors in their product metadata, + those items will not be published. + LINK_FORMAT_INVALID: + type: integer + description: Some link values are formatted incorrectly. + PARSE_LINE_ERROR: + type: integer + description: Your feed contains formatting errors for some items. + ADWORDS_FORMAT_INVALID: + type: integer + description: Some adwords links contain too many characters. + INTERNAL_SERVICE_ERROR: + type: integer + description: We experienced a technical difficulty and were unable to ingest + your feed. The next ingestion will happen in 24 hours. + NO_VERIFIED_DOMAIN: + type: integer + description: Your merchant domain needs to be claimed. + ADULT_INVALID: + type: integer + description: Some items have invalid adult values. + IMAGE_LINK_LENGTH_TOO_LONG: + type: integer + description: Some items have image_link URLs that contain too many characters, + so those items will not be published. + INVALID_DOMAIN: + type: integer + description: Some of your product link values don't match the verified domain + associated with this account. + FEED_LENGTH_TOO_LONG: + type: integer + description: Your feed contains too many items, some items will not be published. + LINK_LENGTH_TOO_LONG: + type: integer + description: Some product links contain too many characters, those items + will not be published. + MALFORMED_XML: + type: integer + description: Your feed couldn't be validated because the xml file is formatted + incorrectly. + PRICE_MISSING: + type: integer + description: Some products are missing a price, those items will not be + published. + FEED_TOO_SMALL: + type: integer + description: Your feed couldn't be validated because the file doesn't contain + the minimum number of lines required. + MAX_ITEMS_PER_ITEM_GROUP_EXCEEDED: + type: integer + description: Some items exceed the maximum number of items per item group, + those items will not be published. + ITEM_MAIN_IMAGE_DOWNLOAD_FAILURE: + type: integer + description: Some items' main images can't be found. + PINJOIN_CONTENT_UNSAFE: + type: integer + description: Some items were not published because they don't meet Pinterest's + Merchant Guidelines. + BLOCKLISTED_IMAGE_SIGNATURE: + type: integer + description: Some items were not published because they don't meet Pinterest's + Merchant Guidelines. + LIST_PRICE_INVALID: + type: integer + description: Some items have list price formatting errors in their product + metadata, those items will not be published. + PRICE_CANNOT_BE_DETERMINED: + type: integer + description: Some items were not published because price cannot be determined. + The price, list price, and sale price are all different, so those items + will not be published. + CatalogsFeedValidationWarnings: + type: object + properties: + AD_IMAGE_0_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 0 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_1_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 1 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_2_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 2 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_3_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 3 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_4_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 4 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_5_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 5 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_6_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 6 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_7_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 7 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_8_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 8 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_9_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 9 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_10_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 10 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_11_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 11 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_12_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 12 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_13_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 13 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_14_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 14 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_15_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 15 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_16_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 16 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_17_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 17 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_18_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 18 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_19_LINK_LENGTH_TOO_LONG: + type: integer + description: Ad image link 19 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_0_LINK_WARNING: + type: integer + description: Ad image link 0 format is unsupported. + AD_IMAGE_1_LINK_WARNING: + type: integer + description: Ad image link 1 format is unsupported. + AD_IMAGE_2_LINK_WARNING: + type: integer + description: Ad image link 2 format is unsupported. + AD_IMAGE_3_LINK_WARNING: + type: integer + description: Ad image link 3 format is unsupported. + AD_IMAGE_4_LINK_WARNING: + type: integer + description: Ad image link 4 format is unsupported. + AD_IMAGE_5_LINK_WARNING: + type: integer + description: Ad image link 5 format is unsupported. + AD_IMAGE_6_LINK_WARNING: + type: integer + description: Ad image link 6 format is unsupported. + AD_IMAGE_7_LINK_WARNING: + type: integer + description: Ad image link 7 format is unsupported. + AD_IMAGE_8_LINK_WARNING: + type: integer + description: Ad image link 8 format is unsupported. + AD_IMAGE_9_LINK_WARNING: + type: integer + description: Ad image link 9 format is unsupported. + AD_IMAGE_10_LINK_WARNING: + type: integer + description: Ad image link 10 format is unsupported. + AD_IMAGE_11_LINK_WARNING: + type: integer + description: Ad image link 11 format is unsupported. + AD_IMAGE_12_LINK_WARNING: + type: integer + description: Ad image link 12 format is unsupported. + AD_IMAGE_13_LINK_WARNING: + type: integer + description: Ad image link 13 format is unsupported. + AD_IMAGE_14_LINK_WARNING: + type: integer + description: Ad image link 14 format is unsupported. + AD_IMAGE_15_LINK_WARNING: + type: integer + description: Ad image link 15 format is unsupported. + AD_IMAGE_16_LINK_WARNING: + type: integer + description: Ad image link 16 format is unsupported. + AD_IMAGE_17_LINK_WARNING: + type: integer + description: Ad image link 17 format is unsupported. + AD_IMAGE_18_LINK_WARNING: + type: integer + description: Ad image link 18 format is unsupported. + AD_IMAGE_19_LINK_WARNING: + type: integer + description: Ad image link 19 format is unsupported. + AD_IMAGE_0_LINK_REQUIRED: + type: integer + description: Ad image link 0 is required because an image tag was provided. + AD_IMAGE_1_LINK_REQUIRED: + type: integer + description: Ad image link 1 is required because an image tag was provided. + AD_IMAGE_2_LINK_REQUIRED: + type: integer + description: Ad image link 2 is required because an image tag was provided. + AD_IMAGE_3_LINK_REQUIRED: + type: integer + description: Ad image link 3 is required because an image tag was provided. + AD_IMAGE_4_LINK_REQUIRED: + type: integer + description: Ad image link 4 is required because an image tag was provided. + AD_IMAGE_5_LINK_REQUIRED: + type: integer + description: Ad image link 5 is required because an image tag was provided. + AD_IMAGE_6_LINK_REQUIRED: + type: integer + description: Ad image link 6 is required because an image tag was provided. + AD_IMAGE_7_LINK_REQUIRED: + type: integer + description: Ad image link 7 is required because an image tag was provided. + AD_IMAGE_8_LINK_REQUIRED: + type: integer + description: Ad image link 8 is required because an image tag was provided. + AD_IMAGE_9_LINK_REQUIRED: + type: integer + description: Ad image link 9 is required because an image tag was provided. + AD_IMAGE_10_LINK_REQUIRED: + type: integer + description: Ad image link 10 is required because an image tag was provided. + AD_IMAGE_11_LINK_REQUIRED: + type: integer + description: Ad image link 11 is required because an image tag was provided. + AD_IMAGE_12_LINK_REQUIRED: + type: integer + description: Ad image link 12 is required because an image tag was provided. + AD_IMAGE_13_LINK_REQUIRED: + type: integer + description: Ad image link 13 is required because an image tag was provided. + AD_IMAGE_14_LINK_REQUIRED: + type: integer + description: Ad image link 14 is required because an image tag was provided. + AD_IMAGE_15_LINK_REQUIRED: + type: integer + description: Ad image link 15 is required because an image tag was provided. + AD_IMAGE_16_LINK_REQUIRED: + type: integer + description: Ad image link 16 is required because an image tag was provided. + AD_IMAGE_17_LINK_REQUIRED: + type: integer + description: Ad image link 17 is required because an image tag was provided. + AD_IMAGE_18_LINK_REQUIRED: + type: integer + description: Ad image link 18 is required because an image tag was provided. + AD_IMAGE_19_LINK_REQUIRED: + type: integer + description: Ad image link 19 is required because an image tag was provided. + AD_IMAGE_0_TAG_LENGTH_TOO_LONG: + type: integer + description: Ad image tag 0 length is too long. The maximum length is 511 + characters. + AD_IMAGE_1_TAG_LENGTH_TOO_LONG: + type: integer + description: Ad image tag 1 length is too long. The maximum length is 511 + characters. + AD_IMAGE_2_TAG_LENGTH_TOO_LONG: + type: integer + description: Ad image tag 2 length is too long. The maximum length is 511 + characters. + AD_IMAGE_3_TAG_LENGTH_TOO_LONG: type: integer - description: "Your feed wasn't ingested because it hasn\u2019t changed in\ - \ the previous 90 days." - ENCODING_ERROR: + description: Ad image tag 3 length is too long. The maximum length is 511 + characters. + AD_IMAGE_4_TAG_LENGTH_TOO_LONG: type: integer - description: Your feed includes data with an unsupported encoding format. - DELIMITER_ERROR: + description: Ad image tag 4 length is too long. The maximum length is 511 + characters. + AD_IMAGE_5_TAG_LENGTH_TOO_LONG: type: integer - description: Your feed includes data with formatting errors. - REQUIRED_COLUMNS_MISSING: + description: Ad image tag 5 length is too long. The maximum length is 511 + characters. + AD_IMAGE_6_TAG_LENGTH_TOO_LONG: type: integer - description: Your feed is missing some required column headers. - DUPLICATE_PRODUCTS: + description: Ad image tag 6 length is too long. The maximum length is 511 + characters. + AD_IMAGE_7_TAG_LENGTH_TOO_LONG: type: integer - description: Some products are duplicated. - IMAGE_LINK_INVALID: + description: Ad image tag 7 length is too long. The maximum length is 511 + characters. + AD_IMAGE_8_TAG_LENGTH_TOO_LONG: type: integer - description: Some image links are formatted incorrectly. - ITEMID_MISSING: + description: Ad image tag 8 length is too long. The maximum length is 511 + characters. + AD_IMAGE_9_TAG_LENGTH_TOO_LONG: type: integer - description: Some items are missing an item id in their product metadata, - those items will not be published. - TITLE_MISSING: + description: Ad image tag 9 length is too long. The maximum length is 511 + characters. + AD_IMAGE_10_TAG_LENGTH_TOO_LONG: type: integer - description: Some items are missing a title in their product metadata, those - items will not be published. - DESCRIPTION_MISSING: + description: Ad image tag 10 length is too long. The maximum length is 511 + characters. + AD_IMAGE_11_TAG_LENGTH_TOO_LONG: type: integer - description: Some items are missing a description in their product metadata, - those items will not be published. - PRODUCT_LINK_MISSING: + description: Ad image tag 11 length is too long. The maximum length is 511 + characters. + AD_IMAGE_12_TAG_LENGTH_TOO_LONG: type: integer - description: Some items are missing a link URL in their product metadata, - those items will not be published. - IMAGE_LINK_MISSING: + description: Ad image tag 12 length is too long. The maximum length is 511 + characters. + AD_IMAGE_13_TAG_LENGTH_TOO_LONG: type: integer - description: Some items are missing an image link URL in their product metadata, - those items will not be published. - AVAILABILITY_INVALID: + description: Ad image tag 13 length is too long. The maximum length is 511 + characters. + AD_IMAGE_14_TAG_LENGTH_TOO_LONG: type: integer - description: Some items are missing an availability value in their product - metadata, those items will not be published. - PRODUCT_PRICE_INVALID: + description: Ad image tag 14 length is too long. The maximum length is 511 + characters. + AD_IMAGE_15_TAG_LENGTH_TOO_LONG: type: integer - description: Some items have price formatting errors in their product metadata, - those items will not be published. - LINK_FORMAT_INVALID: + description: Ad image tag 15 length is too long. The maximum length is 511 + characters. + AD_IMAGE_16_TAG_LENGTH_TOO_LONG: type: integer - description: Some link values are formatted incorrectly. - PARSE_LINE_ERROR: + description: Ad image tag 16 length is too long. The maximum length is 511 + characters. + AD_IMAGE_17_TAG_LENGTH_TOO_LONG: type: integer - description: Your feed contains formatting errors for some items. - ADWORDS_FORMAT_INVALID: + description: Ad image tag 17 length is too long. The maximum length is 511 + characters. + AD_IMAGE_18_TAG_LENGTH_TOO_LONG: type: integer - description: Some adwords links contain too many characters. - INTERNAL_SERVICE_ERROR: + description: Ad image tag 18 length is too long. The maximum length is 511 + characters. + AD_IMAGE_19_TAG_LENGTH_TOO_LONG: type: integer - description: We experienced a technical difficulty and were unable to ingest - your feed. The next ingestion will happen in 24 hours. - NO_VERIFIED_DOMAIN: + description: Ad image tag 19 length is too long. The maximum length is 511 + characters. + AD_IMAGE_0_TAG_REQUIRED: type: integer - description: Your merchant domain needs to be claimed. - ADULT_INVALID: + description: Ad image tag 0 is required because an image link was provided. + AD_IMAGE_1_TAG_REQUIRED: type: integer - description: Some items have invalid adult values. - IMAGE_LINK_LENGTH_TOO_LONG: + description: Ad image tag 1 is required because an image link was provided. + AD_IMAGE_2_TAG_REQUIRED: type: integer - description: Some items have image_link URLs that contain too many characters, - so those items will not be published. - INVALID_DOMAIN: + description: Ad image tag 2 is required because an image link was provided. + AD_IMAGE_3_TAG_REQUIRED: type: integer - description: Some of your product link values don't match the verified domain - associated with this account. - FEED_LENGTH_TOO_LONG: + description: Ad image tag 3 is required because an image link was provided. + AD_IMAGE_4_TAG_REQUIRED: type: integer - description: Your feed contains too many items, some items will not be published. - LINK_LENGTH_TOO_LONG: + description: Ad image tag 4 is required because an image link was provided. + AD_IMAGE_5_TAG_REQUIRED: type: integer - description: Some product links contain too many characters, those items - will not be published. - MALFORMED_XML: + description: Ad image tag 5 is required because an image link was provided. + AD_IMAGE_6_TAG_REQUIRED: type: integer - description: Your feed couldn't be validated because the xml file is formatted - incorrectly. - PRICE_MISSING: + description: Ad image tag 6 is required because an image link was provided. + AD_IMAGE_7_TAG_REQUIRED: type: integer - description: Some products are missing a price, those items will not be - published. - FEED_TOO_SMALL: + description: Ad image tag 7 is required because an image link was provided. + AD_IMAGE_8_TAG_REQUIRED: type: integer - description: Your feed couldn't be validated because the file doesn't contain - the minimum number of lines required. - MAX_ITEMS_PER_ITEM_GROUP_EXCEEDED: + description: Ad image tag 8 is required because an image link was provided. + AD_IMAGE_9_TAG_REQUIRED: type: integer - description: Some items exceed the maximum number of items per item group, - those items will not be published. - ITEM_MAIN_IMAGE_DOWNLOAD_FAILURE: + description: Ad image tag 9 is required because an image link was provided. + AD_IMAGE_10_TAG_REQUIRED: type: integer - description: Some items' main images can't be found. - PINJOIN_CONTENT_UNSAFE: + description: Ad image tag 10 is required because an image link was provided. + AD_IMAGE_11_TAG_REQUIRED: type: integer - description: Some items were not published because they don't meet Pinterest's - Merchant Guidelines. - BLOCKLISTED_IMAGE_SIGNATURE: + description: Ad image tag 11 is required because an image link was provided. + AD_IMAGE_12_TAG_REQUIRED: type: integer - description: Some items were not published because they don't meet Pinterest's - Merchant Guidelines. - LIST_PRICE_INVALID: + description: Ad image tag 12 is required because an image link was provided. + AD_IMAGE_13_TAG_REQUIRED: type: integer - description: Some items have list price formatting errors in their product - metadata, those items will not be published. - PRICE_CANNOT_BE_DETERMINED: + description: Ad image tag 13 is required because an image link was provided. + AD_IMAGE_14_TAG_REQUIRED: type: integer - description: Some items were not published because price cannot be determined. - The price, list price, and sale price are all different, so those items - will not be published. - CatalogsFeedValidationWarnings: - type: object - properties: + description: Ad image tag 14 is required because an image link was provided. + AD_IMAGE_15_TAG_REQUIRED: + type: integer + description: Ad image tag 15 is required because an image link was provided. + AD_IMAGE_16_TAG_REQUIRED: + type: integer + description: Ad image tag 16 is required because an image link was provided. + AD_IMAGE_17_TAG_REQUIRED: + type: integer + description: Ad image tag 17 is required because an image link was provided. + AD_IMAGE_18_TAG_REQUIRED: + type: integer + description: Ad image tag 18 is required because an image link was provided. + AD_IMAGE_19_TAG_REQUIRED: + type: integer + description: Ad image tag 19 is required because an image link was provided. AD_LINK_FORMAT_WARNING: type: integer description: Some items have ad links that are formatted incorrectly. @@ -17372,6 +18478,106 @@ components: CatalogsItemValidationIssue: type: string enum: + - AD_IMAGE_0_LINK_LENGTH_TOO_LONG + - AD_IMAGE_1_LINK_LENGTH_TOO_LONG + - AD_IMAGE_2_LINK_LENGTH_TOO_LONG + - AD_IMAGE_3_LINK_LENGTH_TOO_LONG + - AD_IMAGE_4_LINK_LENGTH_TOO_LONG + - AD_IMAGE_5_LINK_LENGTH_TOO_LONG + - AD_IMAGE_6_LINK_LENGTH_TOO_LONG + - AD_IMAGE_7_LINK_LENGTH_TOO_LONG + - AD_IMAGE_8_LINK_LENGTH_TOO_LONG + - AD_IMAGE_9_LINK_LENGTH_TOO_LONG + - AD_IMAGE_10_LINK_LENGTH_TOO_LONG + - AD_IMAGE_11_LINK_LENGTH_TOO_LONG + - AD_IMAGE_12_LINK_LENGTH_TOO_LONG + - AD_IMAGE_13_LINK_LENGTH_TOO_LONG + - AD_IMAGE_14_LINK_LENGTH_TOO_LONG + - AD_IMAGE_15_LINK_LENGTH_TOO_LONG + - AD_IMAGE_16_LINK_LENGTH_TOO_LONG + - AD_IMAGE_17_LINK_LENGTH_TOO_LONG + - AD_IMAGE_18_LINK_LENGTH_TOO_LONG + - AD_IMAGE_19_LINK_LENGTH_TOO_LONG + - AD_IMAGE_0_LINK_WARNING + - AD_IMAGE_1_LINK_WARNING + - AD_IMAGE_2_LINK_WARNING + - AD_IMAGE_3_LINK_WARNING + - AD_IMAGE_4_LINK_WARNING + - AD_IMAGE_5_LINK_WARNING + - AD_IMAGE_6_LINK_WARNING + - AD_IMAGE_7_LINK_WARNING + - AD_IMAGE_8_LINK_WARNING + - AD_IMAGE_9_LINK_WARNING + - AD_IMAGE_10_LINK_WARNING + - AD_IMAGE_11_LINK_WARNING + - AD_IMAGE_12_LINK_WARNING + - AD_IMAGE_13_LINK_WARNING + - AD_IMAGE_14_LINK_WARNING + - AD_IMAGE_15_LINK_WARNING + - AD_IMAGE_16_LINK_WARNING + - AD_IMAGE_17_LINK_WARNING + - AD_IMAGE_18_LINK_WARNING + - AD_IMAGE_19_LINK_WARNING + - AD_IMAGE_0_LINK_REQUIRED + - AD_IMAGE_1_LINK_REQUIRED + - AD_IMAGE_2_LINK_REQUIRED + - AD_IMAGE_3_LINK_REQUIRED + - AD_IMAGE_4_LINK_REQUIRED + - AD_IMAGE_5_LINK_REQUIRED + - AD_IMAGE_6_LINK_REQUIRED + - AD_IMAGE_7_LINK_REQUIRED + - AD_IMAGE_8_LINK_REQUIRED + - AD_IMAGE_9_LINK_REQUIRED + - AD_IMAGE_10_LINK_REQUIRED + - AD_IMAGE_11_LINK_REQUIRED + - AD_IMAGE_12_LINK_REQUIRED + - AD_IMAGE_13_LINK_REQUIRED + - AD_IMAGE_14_LINK_REQUIRED + - AD_IMAGE_15_LINK_REQUIRED + - AD_IMAGE_16_LINK_REQUIRED + - AD_IMAGE_17_LINK_REQUIRED + - AD_IMAGE_18_LINK_REQUIRED + - AD_IMAGE_19_LINK_REQUIRED + - AD_IMAGE_0_TAG_LENGTH_TOO_LONG + - AD_IMAGE_1_TAG_LENGTH_TOO_LONG + - AD_IMAGE_2_TAG_LENGTH_TOO_LONG + - AD_IMAGE_3_TAG_LENGTH_TOO_LONG + - AD_IMAGE_4_TAG_LENGTH_TOO_LONG + - AD_IMAGE_5_TAG_LENGTH_TOO_LONG + - AD_IMAGE_6_TAG_LENGTH_TOO_LONG + - AD_IMAGE_7_TAG_LENGTH_TOO_LONG + - AD_IMAGE_8_TAG_LENGTH_TOO_LONG + - AD_IMAGE_9_TAG_LENGTH_TOO_LONG + - AD_IMAGE_10_TAG_LENGTH_TOO_LONG + - AD_IMAGE_11_TAG_LENGTH_TOO_LONG + - AD_IMAGE_12_TAG_LENGTH_TOO_LONG + - AD_IMAGE_13_TAG_LENGTH_TOO_LONG + - AD_IMAGE_14_TAG_LENGTH_TOO_LONG + - AD_IMAGE_15_TAG_LENGTH_TOO_LONG + - AD_IMAGE_16_TAG_LENGTH_TOO_LONG + - AD_IMAGE_17_TAG_LENGTH_TOO_LONG + - AD_IMAGE_18_TAG_LENGTH_TOO_LONG + - AD_IMAGE_19_TAG_LENGTH_TOO_LONG + - AD_IMAGE_0_TAG_REQUIRED + - AD_IMAGE_1_TAG_REQUIRED + - AD_IMAGE_2_TAG_REQUIRED + - AD_IMAGE_3_TAG_REQUIRED + - AD_IMAGE_4_TAG_REQUIRED + - AD_IMAGE_5_TAG_REQUIRED + - AD_IMAGE_6_TAG_REQUIRED + - AD_IMAGE_7_TAG_REQUIRED + - AD_IMAGE_8_TAG_REQUIRED + - AD_IMAGE_9_TAG_REQUIRED + - AD_IMAGE_10_TAG_REQUIRED + - AD_IMAGE_11_TAG_REQUIRED + - AD_IMAGE_12_TAG_REQUIRED + - AD_IMAGE_13_TAG_REQUIRED + - AD_IMAGE_14_TAG_REQUIRED + - AD_IMAGE_15_TAG_REQUIRED + - AD_IMAGE_16_TAG_REQUIRED + - AD_IMAGE_17_TAG_REQUIRED + - AD_IMAGE_18_TAG_REQUIRED + - AD_IMAGE_19_TAG_REQUIRED - AD_LINK_FORMAT_WARNING - AD_LINK_SAME_AS_LINK - ADDITIONAL_IMAGE_LINK_LENGTH_TOO_LONG @@ -17465,6 +18671,346 @@ components: CatalogsItemValidationWarnings: type: object properties: + AD_IMAGE_0_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 0 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_1_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 1 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_2_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 2 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_3_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 3 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_4_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 4 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_5_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 5 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_6_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 6 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_7_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 7 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_8_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 8 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_9_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 9 length is too long. The maximum length is 2047 + characters. + AD_IMAGE_10_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 10 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_11_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 11 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_12_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 12 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_13_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 13 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_14_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 14 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_15_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 15 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_16_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 16 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_17_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 17 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_18_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 18 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_19_LINK_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 19 length is too long. The maximum length is + 2047 characters. + AD_IMAGE_0_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 0 format is unsupported. + AD_IMAGE_1_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 1 format is unsupported. + AD_IMAGE_2_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 2 format is unsupported. + AD_IMAGE_3_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 3 format is unsupported. + AD_IMAGE_4_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 4 format is unsupported. + AD_IMAGE_5_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 5 format is unsupported. + AD_IMAGE_6_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 6 format is unsupported. + AD_IMAGE_7_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 7 format is unsupported. + AD_IMAGE_8_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 8 format is unsupported. + AD_IMAGE_9_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 9 format is unsupported. + AD_IMAGE_10_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 10 format is unsupported. + AD_IMAGE_11_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 11 format is unsupported. + AD_IMAGE_12_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 12 format is unsupported. + AD_IMAGE_13_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 13 format is unsupported. + AD_IMAGE_14_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 14 format is unsupported. + AD_IMAGE_15_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 15 format is unsupported. + AD_IMAGE_16_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 16 format is unsupported. + AD_IMAGE_17_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 17 format is unsupported. + AD_IMAGE_18_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 18 format is unsupported. + AD_IMAGE_19_LINK_WARNING: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 19 format is unsupported. + AD_IMAGE_0_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 0 is required because an image tag was provided. + AD_IMAGE_1_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 1 is required because an image tag was provided. + AD_IMAGE_2_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 2 is required because an image tag was provided. + AD_IMAGE_3_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 3 is required because an image tag was provided. + AD_IMAGE_4_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 4 is required because an image tag was provided. + AD_IMAGE_5_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 5 is required because an image tag was provided. + AD_IMAGE_6_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 6 is required because an image tag was provided. + AD_IMAGE_7_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 7 is required because an image tag was provided. + AD_IMAGE_8_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 8 is required because an image tag was provided. + AD_IMAGE_9_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 9 is required because an image tag was provided. + AD_IMAGE_10_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 10 is required because an image tag was provided. + AD_IMAGE_11_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 11 is required because an image tag was provided. + AD_IMAGE_12_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 12 is required because an image tag was provided. + AD_IMAGE_13_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 13 is required because an image tag was provided. + AD_IMAGE_14_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 14 is required because an image tag was provided. + AD_IMAGE_15_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 15 is required because an image tag was provided. + AD_IMAGE_16_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 16 is required because an image tag was provided. + AD_IMAGE_17_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 17 is required because an image tag was provided. + AD_IMAGE_18_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 18 is required because an image tag was provided. + AD_IMAGE_19_LINK_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image link 19 is required because an image tag was provided. + AD_IMAGE_0_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 0 length is too long. The maximum length is 511 + characters. + AD_IMAGE_1_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 1 length is too long. The maximum length is 511 + characters. + AD_IMAGE_2_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 2 length is too long. The maximum length is 511 + characters. + AD_IMAGE_3_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 3 length is too long. The maximum length is 511 + characters. + AD_IMAGE_4_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 4 length is too long. The maximum length is 511 + characters. + AD_IMAGE_5_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 5 length is too long. The maximum length is 511 + characters. + AD_IMAGE_6_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 6 length is too long. The maximum length is 511 + characters. + AD_IMAGE_7_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 7 length is too long. The maximum length is 511 + characters. + AD_IMAGE_8_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 8 length is too long. The maximum length is 511 + characters. + AD_IMAGE_9_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 9 length is too long. The maximum length is 511 + characters. + AD_IMAGE_10_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 10 length is too long. The maximum length is 511 + characters. + AD_IMAGE_11_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 11 length is too long. The maximum length is 511 + characters. + AD_IMAGE_12_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 12 length is too long. The maximum length is 511 + characters. + AD_IMAGE_13_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 13 length is too long. The maximum length is 511 + characters. + AD_IMAGE_14_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 14 length is too long. The maximum length is 511 + characters. + AD_IMAGE_15_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 15 length is too long. The maximum length is 511 + characters. + AD_IMAGE_16_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 16 length is too long. The maximum length is 511 + characters. + AD_IMAGE_17_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 17 length is too long. The maximum length is 511 + characters. + AD_IMAGE_18_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 18 length is too long. The maximum length is 511 + characters. + AD_IMAGE_19_TAG_LENGTH_TOO_LONG: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 19 length is too long. The maximum length is 511 + characters. + AD_IMAGE_0_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 0 is required because an image link was provided. + AD_IMAGE_1_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 1 is required because an image link was provided. + AD_IMAGE_2_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 2 is required because an image link was provided. + AD_IMAGE_3_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 3 is required because an image link was provided. + AD_IMAGE_4_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 4 is required because an image link was provided. + AD_IMAGE_5_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 5 is required because an image link was provided. + AD_IMAGE_6_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 6 is required because an image link was provided. + AD_IMAGE_7_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 7 is required because an image link was provided. + AD_IMAGE_8_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 8 is required because an image link was provided. + AD_IMAGE_9_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 9 is required because an image link was provided. + AD_IMAGE_10_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 10 is required because an image link was provided. + AD_IMAGE_11_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 11 is required because an image link was provided. + AD_IMAGE_12_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 12 is required because an image link was provided. + AD_IMAGE_13_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 13 is required because an image link was provided. + AD_IMAGE_14_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 14 is required because an image link was provided. + AD_IMAGE_15_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 15 is required because an image link was provided. + AD_IMAGE_16_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 16 is required because an image link was provided. + AD_IMAGE_17_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 17 is required because an image link was provided. + AD_IMAGE_18_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 18 is required because an image link was provided. + AD_IMAGE_19_TAG_REQUIRED: + $ref: '#/components/schemas/CatalogsItemValidationDetails' + description: Ad image tag 19 is required because an image link was provided. AD_LINK_FORMAT_WARNING: $ref: '#/components/schemas/CatalogsItemValidationDetails' description: Item has an ad link that is formatted incorrectly. @@ -18195,6 +19741,7 @@ components: - $ref: '#/components/schemas/CatalogsCreativeAssetsProductGroupFiltersAllOf' CatalogsCreativeAssetsProductGroupFiltersAllOf: type: object + title: all_of additionalProperties: false properties: all_of: @@ -18206,6 +19753,7 @@ components: - all_of CatalogsCreativeAssetsProductGroupFiltersAnyOf: type: object + title: any_of additionalProperties: false properties: any_of: @@ -18232,6 +19780,7 @@ components: - $ref: '#/components/schemas/GoogleProductCategory1Filter' - $ref: '#/components/schemas/GoogleProductCategory0Filter' - $ref: '#/components/schemas/MediaTypeFilter' + - $ref: '#/components/schemas/TitleKeywordsFilter' CatalogsCreativeAssetsProductGroupCreateRequest: type: object title: creative_assets_product_groups_create_request @@ -18298,6 +19847,8 @@ components: nullable: true filters: $ref: '#/components/schemas/CatalogsHotelProductGroupFilters' + type: + $ref: '#/components/schemas/CatalogsHotelProductGroupType' created_at: description: Unix timestamp in seconds of when catalog product group was created. @@ -18317,6 +19868,7 @@ components: - filters - catalog_type - catalog_id + - type CatalogsHotelProductGroupFilterKeys: title: catalogs_product_group_keys anyOf: @@ -18329,6 +19881,7 @@ components: - $ref: '#/components/schemas/CustomLabel3Filter' - $ref: '#/components/schemas/CustomLabel4Filter' - $ref: '#/components/schemas/CountryFilter' + - $ref: '#/components/schemas/TitleKeywordsFilter' CatalogsHotelProductGroupFilters: description: Object holding a group of filters for a hotel product group title: catalogs_product_group_filters @@ -18338,6 +19891,7 @@ components: - $ref: '#/components/schemas/CatalogsHotelProductGroupFiltersAllOf' CatalogsHotelProductGroupFiltersAllOf: type: object + title: all_of additionalProperties: false properties: all_of: @@ -18349,6 +19903,7 @@ components: - all_of CatalogsHotelProductGroupFiltersAnyOf: type: object + title: any_of additionalProperties: false properties: any_of: @@ -18421,6 +19976,7 @@ components: - catalog_id - feed_id - catalog_type + - type CatalogsHotelProductGroupCreateRequest: type: object title: hotel_product_groups_create_request @@ -18598,6 +20154,12 @@ components: - $ref: '#/components/schemas/GoogleProductCategory1Filter' - $ref: '#/components/schemas/GoogleProductCategory0Filter' - $ref: '#/components/schemas/ProductGroupReferenceFilter' + - $ref: '#/components/schemas/CustomNumber0Filter' + - $ref: '#/components/schemas/CustomNumber1Filter' + - $ref: '#/components/schemas/CustomNumber2Filter' + - $ref: '#/components/schemas/CustomNumber3Filter' + - $ref: '#/components/schemas/CustomNumber4Filter' + - $ref: '#/components/schemas/TitleKeywordsFilter' CatalogsProductGroupFilters: description: Object holding a group of filters for a catalog product group title: catalogs_product_group_filters @@ -18607,6 +20169,7 @@ components: - $ref: '#/components/schemas/CatalogsProductGroupFiltersAllOf' CatalogsProductGroupFiltersAllOf: type: object + title: all_of additionalProperties: false properties: all_of: @@ -18625,6 +20188,7 @@ components: type: object anyOf: - type: object + title: any_of additionalProperties: false properties: any_of: @@ -18636,6 +20200,7 @@ components: required: - any_of - type: object + title: all_of additionalProperties: false properties: all_of: @@ -18648,6 +20213,7 @@ components: - all_of CatalogsProductGroupFiltersAnyOf: type: object + title: any_of additionalProperties: false properties: any_of: @@ -18713,6 +20279,26 @@ components: default: false required: - values + CatalogsProductGroupFilterOperatorTypeCriteria: + title: catalogs_product_group_filter_operator_type_criteria + type: object + additionalProperties: false + properties: + values: + type: array + items: + type: string + negated: + type: boolean + default: false + filter_operator_type: + default: IS + type: string + enum: + - IS + - CONTAINS + required: + - values CatalogsProductGroupMultipleStringListCriteria: title: catalogs_product_group_multiple_string_list_criteria type: object @@ -18745,6 +20331,28 @@ components: default: false required: - values + CatalogsProductGroupUint32Criteria: + title: catalogs_product_group_uint32_criteria + type: object + additionalProperties: false + properties: + operator: + type: string + enum: + - GREATER_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN + - LESS_THAN_OR_EQUALS + value: + type: integer + minimum: 0 + maximum: 4294967295 + negated: + type: boolean + default: false + required: + - operator + - value CatalogsProductGroupProductCountsVertical: type: object description: Product counts for a CatalogsProductGroup @@ -18857,6 +20465,17 @@ components: - SHOPIFY_COLLECTIONS - I2PC example: TOP_SELLERS + CatalogsHotelProductGroupType: + type: string + title: hotel_product_group_type + description: |- +

    Catalog hotel product group type

    +

    MERCHANT_CREATED: Product groups created by merchants. +
    ALL_LISTINGS: Includes every hotel item in your catalog. + enum: + - MERCHANT_CREATED + - ALL_LISTINGS + example: MERCHANT_CREATED CatalogsProductGroupUpdateRequest: type: object title: retail feed based @@ -19738,6 +21357,7 @@ components: CREATIVE_ASSETS: '#/components/schemas/CatalogsCreativeAssetsProductGroupUpdateRequest' ConditionFilter: type: object + title: CONDITION additionalProperties: false properties: CONDITION: @@ -19930,8 +21550,8 @@ components: items: type: string example: - - red-pinterest-shirt-logo-1 - - purple-pinterest-shirt-logo-3 + - product-id-001 + - product-id-002 content_name: description: The name of the page or product associated with the event. @@ -19964,7 +21584,6 @@ components: if you are a merchant for AddToCart and Checkouts. For detail, please check here (Install the Pinterest tag section). - example: red-pinterest-shirt-logo-1 type: string item_price: description: The price of a product. Accepted as a string @@ -19973,7 +21592,6 @@ components: using this if you are a merchant for PageVisit, AddToCart and Checkouts. For detail, please check here (Install the Pinterest tag section). - example: '1325.12' type: string quantity: description: The amount of a product. We recommend using @@ -19982,19 +21600,28 @@ components: target="_blank">here (Install the Pinterest tag section). type: integer format: int64 - example: 5 item_name: description: The name of a product. - example: pinterest-clothing-shirt type: string item_category: description: The category of a product. - example: pinterest-entertainment type: string item_brand: description: The brand of a product. - example: pinterest type: string + example: + - id: product-id-001 + item_price: '14.99' + quantity: 3 + item_name: pinterest-shirt-girl + item_category: pinterest-clothing-shirts + item_brand: pinterest + - id: product-id-002 + item_price: '13.71' + quantity: 2 + item_name: pinterest-shirt-men + item_category: pinterest-clothing-shirts + item_brand: pinterest num_items: description: Total number of products of the event. For example, the total number of items purchased in a checkout event. We @@ -20003,7 +21630,7 @@ components: target="_blank">here (Install the Pinterest tag section). type: integer format: int64 - example: 2 + example: 5 order_id: description: The order ID. We recommend sending order_id to help us deduplicate events when necessary. This also helps to run @@ -20011,6 +21638,16 @@ components: type: string nullable: true example: my_order_id + external_measurement_vendor_id: + description: Only use when instructed. + type: integer + nullable: true + example: 1 + external_measurement_id: + description: Only use when instructed. + type: string + nullable: true + example: rbos-cb7a9e56-4988-4ca0-801b-05c79b29785f search_string: description: The search string related to the user conversion event. @@ -20097,125 +21734,55 @@ components: 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. The string should - be in the UTF-8 format. - 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. The string should be in the - UTF-8 format. - 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. The string should - be in the UTF-8 format. - 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. The string should be in the - UTF-8 format. - 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 + - $ref: '#/components/schemas/ConversionEventsUserDataProperties' + required: + - em + title: EMConversionEventsUserDataPropertyRequired + - $ref: '#/components/schemas/ConversionEventsUserDataProperties' 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. The string should - be in the UTF-8 format. - 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. The string should be in the - UTF-8 format. - 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 + title: HashedMaidsConversionEventsUserDataPropertyRequired + - $ref: '#/components/schemas/ConversionEventsUserDataProperties' required: - client_ip_address - client_user_agent + title: ClientIPAddressConversionEventsUserDataPropertyRequired + ConversionEventsUserDataProperties: + type: object 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. The string should + be in the UTF-8 format. + 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. The string should be in the UTF-8 format. + 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 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 @@ -20318,6 +21885,111 @@ components: type: string example: BUJrTlRRzGJmWhRXFZdkioV6wKPBve7Lom__GU9J74hq2NIQj4O3nOZJrp3mcUr5MptkXsI14juMOIM9mNZnM4zEUFT2JLVaFhcOfuuWz3IWEDtBf6I0DPc nullable: true + ConversionMSOTEvents: + title: Conversion MSOT Events + description: Object containing the MSOT conversion events. + type: object + additionalProperties: false + properties: + event_id: + description: A unique id string that identifies this event. If you are already + sending us events through Conversions API, then this id should match the + event_id sent through Conversions API. + type: string + maxLength: 256 + example: eventId0001 + event_name: + description: Type of user event. + type: string + enum: + - add_to_cart + - checkout + - lead + - signup + example: add_to_cart + event_timestamp: + description: The time when the event occurred. Unix timestamp in seconds. + type: integer + format: int64 + example: 1451431341 + ad_group_id: + description: The ID of the ad group that was attributed to the conversion + event. + type: string + pattern: ^\d+$ + example: '2680060704746' + attribution_scope: + description: Ad event type. + type: string + enum: + - view + - engagement + - click + example: click + value: + description: Order value of the conversion event. Required if event_name + is 'add_to_cart' or 'checkout'. + type: number + format: double + example: 123.45 + currency: + allOf: + - $ref: '#/components/schemas/Currency' + - type: string + description: Currency code for the value field, required if value + is present. Currency Codes should be in ISO 4217 standard. + campaign_id: + description: The ID of the campaign that was attributed to the conversion + event. + type: string + pattern: ^\d+$ + example: '626736533506' + action_timestamps: + description: Timestamp(s) when the ad action(s) happened. Unix timestamp + in seconds. + type: array + items: + type: integer + format: int64 + example: + - 1451410040 + attribution_model: + description: The attribution model used to attribute the conversion event. + type: string + enum: + - first_touch + - last_touch + - multi_touch + example: multi_touch + attribution_score: + description: Credit given to the attributed ad actions. Allowed values are + > 0 and <= 1. + type: number + format: double + minimum: 0 + exclusiveMinimum: true + maximum: 1 + example: 0.5 + total_events: + description: |- + Total number of conversion events that are reported in one API call. +

    If you are sending one API request for one attributed conversion event then this value should be 1.

    +

    If you are sending multiple attributed conversion events in one API request then this value should be the total number of attributed conversion events in the request.

    + type: integer + minimum: 1 + example: 2 + total_event_touchpoints: + description: Total number of ad events including other non-Pinterest ad + platforms. + type: integer + minimum: 1 + example: 2 + required: + - event_id + - event_name + - event_timestamp + - ad_group_id + - attribution_scope ConversionReportAttributionType: type: string description: Attribution type. Refers to the Pinterest Tag endpoints @@ -20434,6 +22106,15 @@ components: type: boolean default: false nullable: true + aem_external_id_enabled: + description: Whether Automatic Enhanced Match location is enabled. See Enhanced + match for more information. + example: true + title: aem_external_id_enabled + type: boolean + default: false + nullable: true title: ConversionTagConfigs ConversionTagCreate: type: object @@ -20754,6 +22435,7 @@ components: - ZW CountryFilter: type: object + title: COUNTRY additionalProperties: false properties: COUNTRY: @@ -21054,6 +22736,7 @@ components: - TRY CurrencyFilter: type: object + title: CURRENCY additionalProperties: false properties: CURRENCY: @@ -21067,49 +22750,104 @@ components: type: string CustomLabel0Filter: type: object + title: CUSTOM_LABEL_0 additionalProperties: false properties: CUSTOM_LABEL_0: type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringCriteria' + $ref: '#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria' required: - CUSTOM_LABEL_0 CustomLabel1Filter: type: object + title: CUSTOM_LABEL_1 additionalProperties: false properties: CUSTOM_LABEL_1: type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringCriteria' + $ref: '#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria' required: - CUSTOM_LABEL_1 CustomLabel2Filter: type: object + title: CUSTOM_LABEL_2 additionalProperties: false properties: CUSTOM_LABEL_2: type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringCriteria' + $ref: '#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria' required: - CUSTOM_LABEL_2 CustomLabel3Filter: type: object + title: CUSTOM_LABEL_3 additionalProperties: false properties: CUSTOM_LABEL_3: type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringCriteria' + $ref: '#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria' required: - CUSTOM_LABEL_3 CustomLabel4Filter: type: object + title: CUSTOM_LABEL_4 additionalProperties: false properties: CUSTOM_LABEL_4: type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringCriteria' + $ref: '#/components/schemas/CatalogsProductGroupFilterOperatorTypeCriteria' required: - CUSTOM_LABEL_4 + CustomNumber0Filter: + type: object + title: CUSTOM_NUMBER_0 + additionalProperties: false + properties: + CUSTOM_NUMBER_0: + type: object + $ref: '#/components/schemas/CatalogsProductGroupUint32Criteria' + required: + - CUSTOM_NUMBER_0 + CustomNumber1Filter: + type: object + title: CUSTOM_NUMBER_1 + additionalProperties: false + properties: + CUSTOM_NUMBER_1: + type: object + $ref: '#/components/schemas/CatalogsProductGroupUint32Criteria' + required: + - CUSTOM_NUMBER_1 + CustomNumber2Filter: + type: object + title: CUSTOM_NUMBER_2 + additionalProperties: false + properties: + CUSTOM_NUMBER_2: + type: object + $ref: '#/components/schemas/CatalogsProductGroupUint32Criteria' + required: + - CUSTOM_NUMBER_2 + CustomNumber3Filter: + type: object + title: CUSTOM_NUMBER_3 + additionalProperties: false + properties: + CUSTOM_NUMBER_3: + type: object + $ref: '#/components/schemas/CatalogsProductGroupUint32Criteria' + required: + - CUSTOM_NUMBER_3 + CustomNumber4Filter: + type: object + title: CUSTOM_NUMBER_4 + additionalProperties: false + properties: + CUSTOM_NUMBER_4: + type: object + $ref: '#/components/schemas/CatalogsProductGroupUint32Criteria' + required: + - CUSTOM_NUMBER_4 CustomerList: properties: ad_account_id: @@ -21202,10 +22940,6 @@ components: default: EMAIL title: list_type type: string - exceptions: - description: Customer list errors. - title: exceptions - type: object required: - name - records @@ -21225,9 +22959,6 @@ components: - $ref: '#/components/schemas/UserListOperationType' title: operation_type type: string - exceptions: - $ref: '#/components/schemas/Exception' - type: object required: - operation_type - records @@ -21414,6 +23145,8 @@ components: description: type: string nullable: true + id: + type: string EnhancedMatchStatusType: description: The enhanced match status of the tag enum: @@ -21480,6 +23213,7 @@ components: - UNISEX GenderFilter: type: object + title: GENDER additionalProperties: false properties: GENDER: @@ -21494,6 +23228,7 @@ components: - VIDEO MediaTypeFilter: type: object + title: MEDIA_TYPE additionalProperties: false properties: MEDIA_TYPE: @@ -21543,6 +23278,25 @@ components: description: An object containing all the information specific to the provided asset group. This field will be populated only if asset_type equals 'ASSET_GROUP'. $ref: '#/components/schemas/AssetGroupBinding' + catalog_info: + nullable: true + description: An object containing all the information specific to the provided + catalog. This field will be populated only if asset_type equals 'CATALOG'. + type: object + properties: + id: + description: Catalog ID. + example: '4836859046874' + type: string + pattern: ^\d+$ + name: + type: string + description: Catalog name + example: Canada Catalog + catalog_type: + type: string + description: Catalog type + example: PRODUCT GetBusinessAssetTypeResponse: description: Type of asset. enum: @@ -21550,6 +23304,7 @@ components: - PROFILE - ASSET_GROUP - CONVERSION_TAG + - CATALOG example: AD_ACCOUNT type: string GetMMMReportResponse: @@ -21618,6 +23373,7 @@ components: $ref: '#/components/schemas/AssetGroupBinding' GoogleProductCategory0Filter: type: object + title: GOOGLE_PRODUCT_CATEGORY_0 additionalProperties: false properties: GOOGLE_PRODUCT_CATEGORY_0: @@ -21627,6 +23383,7 @@ components: - GOOGLE_PRODUCT_CATEGORY_0 GoogleProductCategory1Filter: type: object + title: GOOGLE_PRODUCT_CATEGORY_1 additionalProperties: false properties: GOOGLE_PRODUCT_CATEGORY_1: @@ -21636,6 +23393,7 @@ components: - GOOGLE_PRODUCT_CATEGORY_1 GoogleProductCategory2Filter: type: object + title: GOOGLE_PRODUCT_CATEGORY_2 additionalProperties: false properties: GOOGLE_PRODUCT_CATEGORY_2: @@ -21645,6 +23403,7 @@ components: - GOOGLE_PRODUCT_CATEGORY_2 GoogleProductCategory3Filter: type: object + title: GOOGLE_PRODUCT_CATEGORY_3 additionalProperties: false properties: GOOGLE_PRODUCT_CATEGORY_3: @@ -21654,6 +23413,7 @@ components: - GOOGLE_PRODUCT_CATEGORY_3 GoogleProductCategory4Filter: type: object + title: GOOGLE_PRODUCT_CATEGORY_4 additionalProperties: false properties: GOOGLE_PRODUCT_CATEGORY_4: @@ -21663,6 +23423,7 @@ components: - GOOGLE_PRODUCT_CATEGORY_4 GoogleProductCategory5Filter: type: object + title: GOOGLE_PRODUCT_CATEGORY_5 additionalProperties: false properties: GOOGLE_PRODUCT_CATEGORY_5: @@ -21672,6 +23433,7 @@ components: - GOOGLE_PRODUCT_CATEGORY_5 GoogleProductCategory6Filter: type: object + title: GOOGLE_PRODUCT_CATEGORY_6 additionalProperties: false properties: GOOGLE_PRODUCT_CATEGORY_6: @@ -21681,6 +23443,7 @@ components: - GOOGLE_PRODUCT_CATEGORY_6 ProductGroupReferenceFilter: type: object + title: PRODUCT_GROUP additionalProperties: false properties: PRODUCT_GROUP: @@ -21709,6 +23472,7 @@ components: - DIRECT_TO_DESTINATION HotelIdFilter: type: object + title: HOTEL_ID additionalProperties: false properties: HOTEL_ID: @@ -21718,6 +23482,7 @@ components: - HOTEL_ID CreativeAssetsIdFilter: type: object + title: CREATIVE_ASSETS_ID additionalProperties: false properties: CREATIVE_ASSETS_ID: @@ -21848,7 +23613,7 @@ components: message: type: string description: Explanation of the event that occured. - maxLength: 2048 + maxLength: 8192 app_version_number: type: string description: Version number of the integration application. @@ -21884,7 +23649,7 @@ components: message: type: string description: Human-readable description of the error. - maxLength: 512 + maxLength: 8192 message_detail: type: string description: More detail about the message. @@ -22039,7 +23804,6 @@ components: properties: external_business_id: type: string - nullable: true description: External business ID for the integration. connected_merchant_id: type: string @@ -22372,6 +24136,17 @@ components: example: '630433785246278264' type: string pattern: ^\d+$ + catalogs_ids: + description: A list of catalog IDs under asset group + example: + - '4836859046874' + type: array + nullable: true + items: + description: The ID of a catalog in an asset group. + example: '4836859046874' + type: string + pattern: ^\d+$ created_time: description: The creation time of the asset group example: 1646767577816 @@ -22458,6 +24233,7 @@ components: type: string nullable: true - $ref: '#/components/schemas/UpdatableItemAttributes' + - type: object ItemAttributesRequest: type: object allOf: @@ -22506,6 +24282,7 @@ components: type: string nullable: true - $ref: '#/components/schemas/UpdatableItemAttributes' + - type: object ItemBatchRecord: type: object description: Object describing an item batch record @@ -22543,6 +24320,7 @@ components: type: string ItemGroupIdFilter: type: object + title: ITEM_GROUP_ID additionalProperties: false properties: ITEM_GROUP_ID: @@ -22552,6 +24330,7 @@ components: - ITEM_GROUP_ID ItemIdFilter: type: object + title: ITEM_ID additionalProperties: false properties: ITEM_ID: @@ -22559,6 +24338,16 @@ components: $ref: '#/components/schemas/CatalogsProductGroupMultipleStringCriteria' required: - ITEM_ID + TitleKeywordsFilter: + type: object + title: TITLE_KEYWORDS + additionalProperties: false + properties: + TITLE_KEYWORDS: + type: object + $ref: '#/components/schemas/CatalogsProductGroupMultipleStringCriteria' + required: + - TITLE_KEYWORDS ItemProcessingRecord: type: object description: Object describing an item processing record @@ -22769,11 +24558,6 @@ components: 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 @@ -22919,7 +24703,7 @@ components: - womens_fashion Language: type: string - description: Language code, which is among the offical ISO 639-1 language list. + description: Language code, which is among the official ISO 639-1 language list. example: EN enum: - AM @@ -23313,6 +25097,7 @@ components: - null MaxPriceFilter: type: object + title: MAX_PRICE additionalProperties: false properties: MAX_PRICE: @@ -23602,6 +25387,7 @@ components: type: object PriceFilter: type: object + title: PRICE additionalProperties: false properties: PRICE: @@ -23632,6 +25418,7 @@ components: - PRICE MinPriceFilter: type: object + title: MIN_PRICE additionalProperties: false properties: MIN_PRICE: @@ -23913,6 +25700,46 @@ components: - MIN_AD_PRICE - SHIPPING_WIDTH - SHIPPING_HEIGHT + - AD_IMAGE_0_LINK + - AD_IMAGE_1_LINK + - AD_IMAGE_2_LINK + - AD_IMAGE_3_LINK + - AD_IMAGE_4_LINK + - AD_IMAGE_5_LINK + - AD_IMAGE_6_LINK + - AD_IMAGE_7_LINK + - AD_IMAGE_8_LINK + - AD_IMAGE_9_LINK + - AD_IMAGE_10_LINK + - AD_IMAGE_11_LINK + - AD_IMAGE_12_LINK + - AD_IMAGE_13_LINK + - AD_IMAGE_14_LINK + - AD_IMAGE_15_LINK + - AD_IMAGE_16_LINK + - AD_IMAGE_17_LINK + - AD_IMAGE_18_LINK + - AD_IMAGE_19_LINK + - AD_IMAGE_0_TAG + - AD_IMAGE_1_TAG + - AD_IMAGE_2_TAG + - AD_IMAGE_3_TAG + - AD_IMAGE_4_TAG + - AD_IMAGE_5_TAG + - AD_IMAGE_6_TAG + - AD_IMAGE_7_TAG + - AD_IMAGE_8_TAG + - AD_IMAGE_9_TAG + - AD_IMAGE_10_TAG + - AD_IMAGE_11_TAG + - AD_IMAGE_12_TAG + - AD_IMAGE_13_TAG + - AD_IMAGE_14_TAG + - AD_IMAGE_15_TAG + - AD_IMAGE_16_TAG + - AD_IMAGE_17_TAG + - AD_IMAGE_18_TAG + - AD_IMAGE_19_TAG - null NullableCurrency: type: string @@ -24114,6 +25941,11 @@ components: type: string redirect_uri: type: string + continuous_refresh: + description: Setting this value to true will have a continuous + refresh token be returned from this endpoint rather than the current + legacy, 1-year expiry, refresh token. + type: boolean required: - code - redirect_uri @@ -24137,12 +25969,6 @@ components: type: string scope: type: string - refresh_on: - description: Setting this field to true will add a new refresh - token to your 200 response, as well as the refresh_token_expires_in - and refresh_token_expires_at fields. To see the structure of this payload, - set the 200 response_type to "everlasting_refresh". - type: boolean required: - refresh_token properties: @@ -24420,7 +26246,12 @@ components: type: string pattern: ^[0-9]+$ is_roas_optimized: - description: ROAS optimization is not supported + description: Performance+ ROAS bidding. When enabled, Pinterest will + optimize for conversion value instead of conversion volume. Only supported + when `conversion_event` is set to `"CHECKOUT"` and `bid_strategy_type` + is set to `"AUTOMATIC_BID"`.
    This parameter is not enabled for + all advertisers. Learn + more. nullable: true title: is_roas_optimized type: boolean @@ -24439,6 +26270,9 @@ components: properties: frequency: type: integer + description: Frequency target can only be between 2 and 20 + minimum: 2 + maximum: 20 timerange: type: string description: User entity counts time range @@ -24639,9 +26473,12 @@ components: - ADMIN - ANALYST - FINANCE_MANAGER + - FINANCE_EDIT + - FINANCE_VIEW - AUDIENCE_MANAGER - CAMPAIGN_MANAGER - CATALOGS_MANAGER + - CATALOGS_VIEWER - PROFILE_PUBLISHER PermissionsResponse: type: array @@ -24658,6 +26495,8 @@ components: - ADMIN - ANALYST - FINANCE_MANAGER + - FINANCE_EDIT + - FINANCE_VIEW - AUDIENCE_MANAGER - CAMPAIGN_MANAGER - CATALOGS_MANAGER @@ -24910,21 +26749,33 @@ components: more. type: string nullable: true - PinMedia: - title: Pin media + sponsor_id: + description: The sponsor account id to request paid partnership from. Currently + the field is only available to a list of users in a closed beta. + type: string + pattern: ^\d+$ + nullable: true + PinMediaBase: type: object - description: Pin media objects. - discriminator: - propertyName: media_type - mapping: - image: '#/components/schemas/PinMediaWithImage' - video: '#/components/schemas/PinMediaWithVideo' - multiple_images: '#/components/schemas/PinMediaWithImages' - multiple_videos: '#/components/schemas/PinMediaWithVideos' - multiple_mixed: '#/components/schemas/PinMediaWithImageAndVideo' + description: Pin Base objects. properties: media_type: type: string + PinMedia: + title: Pin media + type: object + description: Pin media objects. + allOf: + - $ref: '#/components/schemas/PinMediaBase' + - type: object + discriminator: + propertyName: media_type + mapping: + image: '#/components/schemas/PinMediaWithImage' + video: '#/components/schemas/PinMediaWithVideo' + multiple_images: '#/components/schemas/PinMediaWithImages' + multiple_videos: '#/components/schemas/PinMediaWithVideos' + multiple_mixed: '#/components/schemas/PinMediaWithImageAndVideo' PinMediaMetadata: type: object anyOf: @@ -25113,6 +26964,11 @@ components: cover_image_data: type: string description: Cover image Base64. + cover_image_key_frame_time: + type: integer + description: Keyframe timestamp for cover image (seconds). If entered time + exceeds video duration, the last frame is used. + minimum: 0 media_id: type: string pattern: ^\d+$ @@ -25130,6 +26986,7 @@ components: title: image description: Pin with image. allOf: + - $ref: '#/components/schemas/PinMediaBase' - type: object properties: images: @@ -25147,7 +27004,6 @@ components: 1200x: type: object $ref: '#/components/schemas/ImageDetails' - - $ref: '#/components/schemas/PinMedia' example: media_type: image images: @@ -25172,30 +27028,31 @@ components: title: Video and image description: Pin with a mix of images and videos. allOf: + - $ref: '#/components/schemas/PinMediaBase' - type: object properties: items: type: array items: $ref: '#/components/schemas/PinMediaMetadata' - - $ref: '#/components/schemas/PinMedia' PinMediaWithImages: type: object title: Images description: Pin with multiple images. allOf: + - $ref: '#/components/schemas/PinMediaBase' - type: object properties: items: type: array items: $ref: '#/components/schemas/ImageMetadata' - - $ref: '#/components/schemas/PinMedia' PinMediaWithVideo: type: object title: video description: Pin with video. allOf: + - $ref: '#/components/schemas/PinMediaBase' - type: object properties: images: @@ -25229,7 +27086,6 @@ components: width: type: integer description: Width (in pixels) - - $ref: '#/components/schemas/PinMedia' example: media_type: video images: @@ -25254,13 +27110,13 @@ components: title: Videos description: Pin with multiple videos. allOf: + - $ref: '#/components/schemas/PinMediaBase' - type: object properties: items: type: array items: $ref: '#/components/schemas/VideoMetadata' - - $ref: '#/components/schemas/PinMedia' PinPromotionSummaryStatus: type: string description: Summary status for pin promotions @@ -25461,6 +27317,8 @@ components: title: product_group_promotion_name type: string nullable: true + creative_type: + $ref: '#/components/schemas/CreativeType' collections_hero_pin_id: description: Hero Pin ID if this PG is promoted as a Collection example: '123123' @@ -25476,12 +27334,50 @@ components: type: string grid_click_type: $ref: '#/components/schemas/GridClickType' + is_generate_background: + type: boolean + description: Enable generate backgrounds for the product group, default + value is FALSE. When enabled, Pinterest will use generative AI to apply + backgrounds for your product images that help drive user inspiration and + engagement. + example: true + nullable: true + customizable_cta_type: + type: string + description: Select a call to action (CTA) to display below your ad. CTA + options for catalog sales campaigns are SHOP_NOW, BOOK_NOW, ON_SALE, GET_DEAL + example: SHOP_NOW + nullable: true + enum: + - SHOP_NOW + - BOOK_NOW + - ON_SALE + - GET_DEAL + - null + collections_header_type: + type: string + nullable: true + description: Collections ad header type + example: SHOP_THIS_COLLECTION + enum: + - SHOP_THIS_COLLECTION + - EXPLORE_THIS_COLLECTION + - NO_HEADER + - ON_SALE + - GET_DEAL + - null + selected_image_tag: + type: string + description: The ad image tag selected for the product group promotion. + example: holiday_sale + nullable: true type: object title: ProductGroupPromotion ProductGroupPromotionCreateRequest: example: product_group_promotion: - slideshow_collections_description: Description + creative_type: REGULAR collections_hero_pin_id: '123123' catalog_product_group_name: catalogProductGroupName collections_hero_destination_url: http://www.pinterest.com @@ -25489,8 +27385,8 @@ components: slideshow_collections_title: Title is_mdl: true status: ACTIVE - creative_type: REGULAR - slideshow_collections_description: Description + creative_type: REGULAR collections_hero_pin_id: '123123' catalog_product_group_name: catalogProductGroupName collections_hero_destination_url: http://www.pinterest.com @@ -25498,7 +27394,6 @@ components: slideshow_collections_title: Title is_mdl: true status: ACTIVE - creative_type: REGULAR ad_group_id: '2680059592705' properties: ad_group_id: @@ -25509,7 +27404,7 @@ components: type: string product_group_promotion: items: - $ref: '#/components/schemas/ProductGroupPromotionCreateRequestElement' + $ref: '#/components/schemas/ProductGroupPromotion' title: product_group_promotion type: array required: @@ -25517,15 +27412,6 @@ components: - product_group_promotion title: ProductGroupPromotionCreateRequest type: object - ProductGroupPromotionCreateRequestElement: - type: object - title: ProductGroupPromotionCreateRequestElement - allOf: - - $ref: '#/components/schemas/ProductGroupPromotion' - - type: object - properties: - creative_type: - $ref: '#/components/schemas/CreativeType' ProductGroupPromotionResponse: type: object title: ProductGroupPromotionResponse @@ -25534,21 +27420,12 @@ components: type: array items: $ref: '#/components/schemas/ProductGroupPromotionResponseItem' - ProductGroupPromotionResponseElement: - type: object - title: ProductGroupPromotionResponseElement - allOf: - - $ref: '#/components/schemas/ProductGroupPromotion' - - type: object - properties: - creative_type: - $ref: '#/components/schemas/CreativeType' ProductGroupPromotionResponseItem: type: object title: ProductGroupPromotionResponseItem properties: data: - $ref: '#/components/schemas/ProductGroupPromotionResponseElement' + $ref: '#/components/schemas/ProductGroupPromotion' exceptions: nullable: true items: @@ -25559,6 +27436,7 @@ components: product_group_promotion: - catalog_product_group_id: '1234123' slideshow_collections_description: Description + creative_type: REGULAR collections_hero_pin_id: '123123' catalog_product_group_name: ProductGroupName collections_hero_destination_url: http://www.pinterest.com @@ -25568,6 +27446,7 @@ components: id: '2680059592705' - catalog_product_group_id: '1231231' slideshow_collections_description: Other description + creative_type: REGULAR collections_hero_pin_id: '123124' catalog_product_group_name: ProductGroupName collections_hero_destination_url: http://www.pinterest.com @@ -25604,6 +27483,7 @@ components: - ARCHIVED ProductType0Filter: type: object + title: PRODUCT_TYPE_0 additionalProperties: false properties: PRODUCT_TYPE_0: @@ -25613,40 +27493,201 @@ components: - PRODUCT_TYPE_0 ProductType1Filter: type: object - additionalProperties: false - properties: - PRODUCT_TYPE_1: - type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' - required: - - PRODUCT_TYPE_1 - ProductType2Filter: + title: PRODUCT_TYPE_1 + additionalProperties: false + properties: + PRODUCT_TYPE_1: + type: object + $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' + required: + - PRODUCT_TYPE_1 + ProductType2Filter: + type: object + title: PRODUCT_TYPE_2 + additionalProperties: false + properties: + PRODUCT_TYPE_2: + type: object + $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' + required: + - PRODUCT_TYPE_2 + ProductType3Filter: + type: object + title: PRODUCT_TYPE_3 + additionalProperties: false + properties: + PRODUCT_TYPE_3: + type: object + $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' + required: + - PRODUCT_TYPE_3 + ProductType4Filter: + type: object + title: PRODUCT_TYPE_4 + additionalProperties: false + properties: + PRODUCT_TYPE_4: + type: object + $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' + required: + - PRODUCT_TYPE_4 + PromotionArrayElement: + title: PromotionArrayElement + type: object + properties: + data: + $ref: '#/components/schemas/PromotionResponse' + exception: + $ref: '#/components/schemas/Exception' + PromotionCommon: + title: Promotion + type: object + properties: + external_id: + description: Platform-specific ID for this promotion. Will be null for promotions + first created within Pinterest. + example: abc + type: string + maxLength: 64 + platform_type: + description: The source integration platform used when creating the promotion. + Currently supported values are 'DEFAULT' and 'SHOPIFY'. + example: DEFAULT + type: string + promotion_title: + description: Internal name for the promotion. + example: Black Friday 10% off + type: string + promotion_code: + description: Code that can be used to redeem a promotion. + example: blackfriday10 + type: string + start_time: + description: Promotion start time. Unix timestamp in seconds. Independent + of campaign start time. + example: 1677003860 + type: integer + end_time: + description: Promotion end time. Unix timestamp in seconds. Independent + of campaign end time. + example: 1678003860 + type: integer + promotion_type: + $ref: '#/components/schemas/PromotionType' + template_values: + description: List of values to be inserted in the promotion type-specific + template. + type: array + minItems: 0 + maxItems: 2 + items: + $ref: '#/components/schemas/PromotionTemplateValue' + discount_status: + type: string + description: Discount status based on the current time and start and end + time of discount + example: ACTIVE + enum: + - OTHER + - ACTIVE + - PAUSED + - SCHEDULED + - EXPIRED + PromotionCreateRequest: + type: object + allOf: + - $ref: '#/components/schemas/PromotionCommon' + - type: object + title: PromotionCreateRequest + required: + - promotion_title + - promotion_type + PromotionResponse: + title: PromotionResponse + type: object + allOf: + - $ref: '#/components/schemas/PromotionCommon' + - type: object + properties: + id: + description: Promotion ID + type: string + pattern: ^\d+$ + example: '7834020347906' + ad_account_id: + description: The Ad Account ID that this promotion belongs to. + example: '549755885175' + type: string + pattern: ^\d+$ + status: + $ref: '#/components/schemas/EntityStatus' + PromotionTemplateValue: + title: Promotion template value type: object - additionalProperties: false properties: - PRODUCT_TYPE_2: - type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' - required: - - PRODUCT_TYPE_2 - ProductType3Filter: + amount: + description: Numeric value. + example: 100 + type: number + percent: + description: Percent value. + example: 10 + type: number + currency_code: + $ref: '#/components/schemas/Currency' + PromotionType: + type: string + description: Determines the displayed promotion text along with what parameters + (if any) are needed to complete the template. This list is not finalized, + and will be updated as new types are supported. + example: VARIABLE + enum: + - VARIABLE + - SITEWIDE + - CHECKOUT + - SAVE_X_ON_Y + - BUY_X_GET_Y + - SPEND_X_SAVE_Y + - FREE_SHIPPING + - FREE_SHIPPING_MINIMUM + - FREE_SHIPPING_WITH_DISCOUNT + - SITEWIDE_IN_STORES + - EXTRA_PERCENT_OFF + - GIFT_WITH_PURCHASE + - GIFT_WITH_PURCHASE_MINIMUM + - FIXED + - PERCENT_OFF_CLEARANCE + - X_OFF_Y + - GIFT_WITH_FIRST_PURCHASE + - BUY_X_GET_ONE_FREE + - CASH_BACK + - POINTS_ON_ALL_PURCHASES + - BONUS + - POINTS_WITH_PURCHASE + PromotionUpdateRequest: + title: PromotionUpdateRequest type: object - additionalProperties: false - properties: - PRODUCT_TYPE_3: - type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' - required: - - PRODUCT_TYPE_3 - ProductType4Filter: + allOf: + - $ref: '#/components/schemas/PromotionCommon' + - type: object + properties: + id: + description: Promotion ID + type: string + pattern: ^\d+$ + example: '7834020347906' + status: + $ref: '#/components/schemas/EntityStatus' + required: + - id + PromotionsResponse: + title: PromotionsResponse type: object - additionalProperties: false properties: - PRODUCT_TYPE_4: - type: object - $ref: '#/components/schemas/CatalogsProductGroupMultipleStringListCriteria' - required: - - PRODUCT_TYPE_4 + promotions: + type: array + items: + $ref: '#/components/schemas/PromotionArrayElement' QuizPinData: description: This field includes all quiz data including questions, options, and results. @@ -25799,6 +27840,7 @@ components: - CTR - ECTR - OUTBOUND_CTR + - OUTBOUND_CTR_1 - COST_PER_OUTBOUND_CLICK - CAMPAIGN_NAME - CAMPAIGN_STATUS @@ -25828,8 +27870,21 @@ components: - AD_GROUP_NAME - AD_GROUP_STATUS - AD_GROUP_ENTITY_STATUS + - AD_GROUP_BID_MULTIPLIER - PRODUCT_GROUP_ID - PRODUCT_GROUP_STATUS + - PROMO_ID + - PROMO_NAME + - PRODUCT_ITEM_NAME + - PRODUCT_ITEM_IMAGE_URL + - PRODUCT_ITEM_PRICE + - PRODUCT_ITEM_PRODUCT_URL + - PRODUCT_ITEM_PIN_URL + - PRODUCT_ITEM_BRAND + - PRODUCT_ITEM_DESCRIPTION + - PRODUCT_ITEM_SALE_PRICE + - PRODUCT_ITEM_PRODUCT_TYPE + - PRODUCT_ITEM_PRODUCT_CATEGORY - ORDER_LINE_ID - ORDER_LINE_NAME - CLICKTHROUGH_1 @@ -25847,6 +27902,7 @@ components: - TOTAL_IMPRESSION_USER - TOTAL_IMPRESSION_FREQUENCY - COST_PER_OUTBOUND_CLICK_IN_DOLLAR + - COST_PER_OUTBOUND_CLICK_IN_DOLLAR_1 - TOTAL_ENGAGEMENT_PAGE_VISIT - TOTAL_ENGAGEMENT_SIGNUP - TOTAL_ENGAGEMENT_CHECKOUT @@ -25953,7 +28009,9 @@ components: - PIN_PROMOTION_NAME - AD_NAME - CAMPAIGN_LIFETIME_SPEND_CAP + - AD_GROUP_OPTIMIZATION - CAMPAIGN_DAILY_SPEND_CAP + - IS_PREMIERE_CAMPAIGN - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION @@ -26078,6 +28136,7 @@ components: - PAGE_VISIT_ROAS - CHECKOUT_ROAS - CUSTOM_ROAS + - PRODUCT_GROUP_AD_IMAGE_TAG - VIDEO_3SEC_VIEWS_1 - VIDEO_P100_COMPLETE_1 - VIDEO_P0_COMBINED_1 @@ -26096,6 +28155,7 @@ components: - VIDEO_MRC_VIEWS_2 - PAID_VIDEO_VIEWABLE_RATE - VIDEO_LENGTH + - VIDEO_SPEND_IN_DOLLAR - CPV_IN_MICRO_DOLLAR - ECPV_IN_DOLLAR - CPCV_IN_MICRO_DOLLAR @@ -26329,6 +28389,12 @@ components: - 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_PAGE_FORWARD_1 + - IDEA_PIN_PAGE_FORWARD_2 + - IDEA_PIN_PAGE_BACKWARD_1 + - IDEA_PIN_PAGE_BACKWARD_2 + - TOTAL_IDEA_PIN_PAGE_FORWARD + - TOTAL_IDEA_PIN_PAGE_BACKWARD - IDEA_PIN_PRODUCT_TAG_VISIT_1 - IDEA_PIN_PRODUCT_TAG_VISIT_2 - TOTAL_IDEA_PIN_PRODUCT_TAG_VISIT @@ -26396,9 +28462,12 @@ components: - ANALYST - SOS_READER - FINANCE_MANAGER + - FINANCE_EDIT + - FINANCE_VIEW - AUDIENCE_MANAGER - CAMPAIGN_MANAGER - CATALOGS_MANAGER + - CATALOGS_VIEWER - RESTRICTED_OWNER - PROFILE_MANAGER - PROFILE_PUBLISHER @@ -26902,6 +28971,8 @@ components: type: string enum: - 18-24 + - 19+ + - 20+ - 21+ - 25-34 - 35-44 @@ -27199,10 +29270,28 @@ components: 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. + in `_TARGETING`.["MEDIA_TYPE"] is only available in PRODUCT_ITEM_TARGETING + level. ["AGE_BUCKET_AND_GENDER"] is in BETA and not yet available to + all users. items: - $ref: '#/components/schemas/AdsAnalyticsTargetingType' + type: string + description: Reporting targeting type + example: APPTYPE + enum: + - KEYWORD + - APPTYPE + - GENDER + - LOCATION + - PLACEMENT + - COUNTRY + - TARGETED_INTEREST + - PINNER_INTEREST + - AUDIENCE_INCLUDE + - GEO + - AGE_BUCKET + - REGION + - MEDIA_TYPE + - AGE_BUCKET_AND_GENDER maxItems: 5 minItems: 1 TemplateResponse: @@ -27337,6 +29426,7 @@ components: - CTR - ECTR - OUTBOUND_CTR + - OUTBOUND_CTR_1 - CPC_IN_MICRO_CURRENCY - CPW_IN_MICRO_DOLLAR - CPW_IN_DOLLAR @@ -27365,7 +29455,6 @@ components: - CROSS_DEVICE_TYPE - INGESTION_SOURCE - SOURCE_PLATFORM - - PIN_PROMOTION_IS_RUNNING - TOTAL_ENGAGEMENT - ENGAGEMENT_1 - ENGAGEMENT_2 @@ -27375,8 +29464,6 @@ components: - ECPE_IN_DOLLAR - ENGAGEMENT_RATE - EENGAGEMENT_RATE - - INTERNAL_ECPE_IN_MICRO_DOLLAR - - INTERNAL_ECPE_IN_DOLLAR - ECPM_IN_MICRO_DOLLAR - ECPM_IN_DOLLAR - REPIN_RATE @@ -27407,8 +29494,6 @@ components: - AD_GROUP_END_DATE - AD_GROUP_BUDGET_TYPE - AD_GROUP_BUDGET_IN_LOCAL_CURRENCY - - AD_GROUP_SUGGESTED_BUDGET_IN_LOCAL_CURRENCY - - AD_GROUP_SUGGESTED_BONUS_BUDGET_IN_LOCAL_CURRENCY - AD_GROUP_ENTITY_STATUS - AD_GROUP_ACTION_TYPE - AD_GROUP_CONVERSION_LEARNING_MODE_TYPE @@ -27416,6 +29501,7 @@ components: - AD_GROUP_BID_STRATEGY_TYPE - AD_GROUP_EXPERIMENT_NAME - AD_GROUP_EXPERIMENT_CELL + - AD_GROUP_BID_MULTIPLIER - CAMPAIGN_WEB_CLOSEUP_WHITELISTED - PRODUCT_GROUP_ID - PRODUCT_GROUP_DEFINITION @@ -27426,6 +29512,8 @@ components: - PRODUCT_GROUP_ENTITY_STATUS - PRODUCT_GROUP_INCLUSION - PRODUCT_GROUP_CREATIVE_TYPE + - PROMO_ID + - PROMO_NAME - ITEM_ID - PRODUCT_ITEM_ID - INTERNAL_PRODUCT_ITEM_ID @@ -27433,6 +29521,15 @@ components: - PRODUCT_ITEM_NAME - PRODUCT_ITEM_IMAGE_URL - PRODUCT_ITEM_PRICE + - PRODUCT_ITEM_PRODUCT_URL + - PRODUCT_ITEM_PIN_URL + - PRODUCT_ITEM_BRAND + - PRODUCT_ITEM_DESCRIPTION + - PRODUCT_ITEM_SALE_PRICE + - PRODUCT_ITEM_PRODUCT_TYPE + - PRODUCT_ITEM_PRODUCT_CATEGORY + - PRODUCT_ITEM_CAMPAIGN_NAME + - PRODUCT_ITEM_AD_GROUP_NAME - ORDER_LINE_ID - ORDER_LINE_NAME - ORDER_LINE_PIN_REV_SHARE @@ -27443,6 +29540,7 @@ components: - CONVERSION_PRODUCT_NAME - CONVERSION_PRODUCT_BRAND - CONVERSION_PRODUCT_CATEGORY + - CONVERSION_PRODUCT_ID_GROUP - CLICKTHROUGH_1 - REPIN_1 - IMPRESSION_1 @@ -27487,6 +29585,7 @@ components: - TOTAL_IMPRESSION_FREQUENCY_HLL - TOTAL_OUTBOUND_CLICK - COST_PER_OUTBOUND_CLICK_IN_DOLLAR + - COST_PER_OUTBOUND_CLICK_IN_DOLLAR_1 - ENGAGEMENT_PAGE_VISIT_1 - ENGAGEMENT_SIGNUP_1 - ENGAGEMENT_CHECKOUT_1 @@ -27498,6 +29597,11 @@ components: - ENGAGEMENT_VIEW_CATEGORY_1 - ENGAGEMENT_APP_INSTALL_1 - ENGAGEMENT_UNKNOWN_1 + - ENGAGEMENT_ADD_PAYMENT_INFO_1 + - ENGAGEMENT_ADD_TO_WISHLIST_1 + - ENGAGEMENT_INITIATE_CHECKOUT_1 + - ENGAGEMENT_SUBSCRIBE_1 + - ENGAGEMENT_VIEW_CONTENT_1 - CLICK_PAGE_VISIT_1 - CLICK_SIGNUP_1 - CLICK_CHECKOUT_1 @@ -27509,6 +29613,11 @@ components: - CLICK_VIEW_CATEGORY_1 - CLICK_APP_INSTALL_1 - CLICK_UNKNOWN_1 + - CLICK_ADD_PAYMENT_INFO_1 + - CLICK_ADD_TO_WISHLIST_1 + - CLICK_INITIATE_CHECKOUT_1 + - CLICK_SUBSCRIBE_1 + - CLICK_VIEW_CONTENT_1 - VIEW_PAGE_VISIT_1 - VIEW_SIGNUP_1 - VIEW_CHECKOUT_1 @@ -27520,6 +29629,11 @@ components: - VIEW_VIEW_CATEGORY_1 - VIEW_APP_INSTALL_1 - VIEW_UNKNOWN_1 + - VIEW_ADD_PAYMENT_INFO_1 + - VIEW_ADD_TO_WISHLIST_1 + - VIEW_INITIATE_CHECKOUT_1 + - VIEW_SUBSCRIBE_1 + - VIEW_VIEW_CONTENT_1 - CONVERSIONS_1 - ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_1 - ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR_1 @@ -27532,6 +29646,11 @@ components: - ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_1 - ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_1 - ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR_1 + - ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_1 + - ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_1 + - ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1 + - ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_1 + - ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_1 - CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_1 - CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR_1 - CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1 @@ -27543,6 +29662,11 @@ components: - CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_1 - CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_1 - CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR_1 + - CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_1 + - CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_1 + - CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1 + - CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_1 + - CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_1 - VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_1 - VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR_1 - VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1 @@ -27554,6 +29678,11 @@ components: - VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_1 - VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_1 - VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR_1 + - VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_1 + - VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_1 + - VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_1 + - VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_1 + - VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_1 - CONVERSIONS_VALUE_IN_MICRO_DOLLAR_1 - ENGAGEMENT_PAGE_VISIT_QUANTITY_1 - ENGAGEMENT_SIGNUP_QUANTITY_1 @@ -27566,6 +29695,11 @@ components: - ENGAGEMENT_VIEW_CATEGORY_QUANTITY_1 - ENGAGEMENT_APP_INSTALL_QUANTITY_1 - ENGAGEMENT_UNKNOWN_QUANTITY_1 + - ENGAGEMENT_ADD_PAYMENT_INFO_QUANTITY_1 + - ENGAGEMENT_ADD_TO_WISHLIST_QUANTITY_1 + - ENGAGEMENT_INITIATE_CHECKOUT_QUANTITY_1 + - ENGAGEMENT_SUBSCRIBE_QUANTITY_1 + - ENGAGEMENT_VIEW_CONTENT_QUANTITY_1 - CLICK_PAGE_VISIT_QUANTITY_1 - CLICK_SIGNUP_QUANTITY_1 - CLICK_CHECKOUT_QUANTITY_1 @@ -27577,6 +29711,11 @@ components: - CLICK_VIEW_CATEGORY_QUANTITY_1 - CLICK_APP_INSTALL_QUANTITY_1 - CLICK_UNKNOWN_QUANTITY_1 + - CLICK_ADD_PAYMENT_INFO_QUANTITY_1 + - CLICK_ADD_TO_WISHLIST_QUANTITY_1 + - CLICK_INITIATE_CHECKOUT_QUANTITY_1 + - CLICK_SUBSCRIBE_QUANTITY_1 + - CLICK_VIEW_CONTENT_QUANTITY_1 - VIEW_PAGE_VISIT_QUANTITY_1 - VIEW_SIGNUP_QUANTITY_1 - VIEW_CHECKOUT_QUANTITY_1 @@ -27588,6 +29727,11 @@ components: - VIEW_VIEW_CATEGORY_QUANTITY_1 - VIEW_APP_INSTALL_QUANTITY_1 - VIEW_UNKNOWN_QUANTITY_1 + - VIEW_ADD_PAYMENT_INFO_QUANTITY_1 + - VIEW_ADD_TO_WISHLIST_QUANTITY_1 + - VIEW_INITIATE_CHECKOUT_QUANTITY_1 + - VIEW_SUBSCRIBE_QUANTITY_1 + - VIEW_VIEW_CONTENT_QUANTITY_1 - CONVERSIONS_QUANTITY_1 - ENGAGEMENT_PAGE_VISIT_2 - ENGAGEMENT_SIGNUP_2 @@ -27600,6 +29744,11 @@ components: - ENGAGEMENT_VIEW_CATEGORY_2 - ENGAGEMENT_APP_INSTALL_2 - ENGAGEMENT_UNKNOWN_2 + - ENGAGEMENT_ADD_PAYMENT_INFO_2 + - ENGAGEMENT_ADD_TO_WISHLIST_2 + - ENGAGEMENT_INITIATE_CHECKOUT_2 + - ENGAGEMENT_SUBSCRIBE_2 + - ENGAGEMENT_VIEW_CONTENT_2 - CLICK_PAGE_VISIT_2 - CLICK_SIGNUP_2 - CLICK_CHECKOUT_2 @@ -27611,6 +29760,11 @@ components: - CLICK_VIEW_CATEGORY_2 - CLICK_APP_INSTALL_2 - CLICK_UNKNOWN_2 + - CLICK_ADD_PAYMENT_INFO_2 + - CLICK_ADD_TO_WISHLIST_2 + - CLICK_INITIATE_CHECKOUT_2 + - CLICK_SUBSCRIBE_2 + - CLICK_VIEW_CONTENT_2 - VIEW_PAGE_VISIT_2 - VIEW_SIGNUP_2 - VIEW_CHECKOUT_2 @@ -27622,6 +29776,11 @@ components: - VIEW_VIEW_CATEGORY_2 - VIEW_APP_INSTALL_2 - VIEW_UNKNOWN_2 + - VIEW_ADD_PAYMENT_INFO_2 + - VIEW_ADD_TO_WISHLIST_2 + - VIEW_INITIATE_CHECKOUT_2 + - VIEW_SUBSCRIBE_2 + - VIEW_VIEW_CONTENT_2 - CONVERSIONS_2 - ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_2 - ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR_2 @@ -27634,6 +29793,11 @@ components: - ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_2 - ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_2 - ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR_2 + - ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_2 + - ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_2 + - ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2 + - ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_2 + - ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_2 - CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_2 - CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR_2 - CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2 @@ -27645,6 +29809,11 @@ components: - CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_2 - CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_2 - CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR_2 + - CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_2 + - CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_2 + - CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2 + - CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_2 + - CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_2 - VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR_2 - VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR_2 - VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2 @@ -27656,6 +29825,11 @@ components: - VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR_2 - VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR_2 - VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR_2 + - VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR_2 + - VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR_2 + - VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR_2 + - VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR_2 + - VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR_2 - CONVERSIONS_VALUE_IN_MICRO_DOLLAR_2 - ENGAGEMENT_PAGE_VISIT_QUANTITY_2 - ENGAGEMENT_SIGNUP_QUANTITY_2 @@ -27668,6 +29842,11 @@ components: - ENGAGEMENT_VIEW_CATEGORY_QUANTITY_2 - ENGAGEMENT_APP_INSTALL_QUANTITY_2 - ENGAGEMENT_UNKNOWN_QUANTITY_2 + - ENGAGEMENT_ADD_PAYMENT_INFO_QUANTITY_2 + - ENGAGEMENT_ADD_TO_WISHLIST_QUANTITY_2 + - ENGAGEMENT_INITIATE_CHECKOUT_QUANTITY_2 + - ENGAGEMENT_SUBSCRIBE_QUANTITY_2 + - ENGAGEMENT_VIEW_CONTENT_QUANTITY_2 - CLICK_PAGE_VISIT_QUANTITY_2 - CLICK_SIGNUP_QUANTITY_2 - CLICK_CHECKOUT_QUANTITY_2 @@ -27679,6 +29858,11 @@ components: - CLICK_VIEW_CATEGORY_QUANTITY_2 - CLICK_APP_INSTALL_QUANTITY_2 - CLICK_UNKNOWN_QUANTITY_2 + - CLICK_ADD_PAYMENT_INFO_QUANTITY_2 + - CLICK_ADD_TO_WISHLIST_QUANTITY_2 + - CLICK_INITIATE_CHECKOUT_QUANTITY_2 + - CLICK_SUBSCRIBE_QUANTITY_2 + - CLICK_VIEW_CONTENT_QUANTITY_2 - VIEW_PAGE_VISIT_QUANTITY_2 - VIEW_SIGNUP_QUANTITY_2 - VIEW_CHECKOUT_QUANTITY_2 @@ -27690,6 +29874,11 @@ components: - VIEW_VIEW_CATEGORY_QUANTITY_2 - VIEW_APP_INSTALL_QUANTITY_2 - VIEW_UNKNOWN_QUANTITY_2 + - VIEW_ADD_PAYMENT_INFO_QUANTITY_2 + - VIEW_ADD_TO_WISHLIST_QUANTITY_2 + - VIEW_INITIATE_CHECKOUT_QUANTITY_2 + - VIEW_SUBSCRIBE_QUANTITY_2 + - VIEW_VIEW_CONTENT_QUANTITY_2 - CONVERSIONS_QUANTITY_2 - TOTAL_ENGAGEMENT_PAGE_VISIT - TOTAL_ENGAGEMENT_SIGNUP @@ -27702,6 +29891,11 @@ components: - TOTAL_ENGAGEMENT_VIEW_CATEGORY - TOTAL_ENGAGEMENT_APP_INSTALL - TOTAL_ENGAGEMENT_UNKNOWN + - TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO + - TOTAL_ENGAGEMENT_ADD_TO_WISHLIST + - TOTAL_ENGAGEMENT_INITIATE_CHECKOUT + - TOTAL_ENGAGEMENT_SUBSCRIBE + - TOTAL_ENGAGEMENT_VIEW_CONTENT - TOTAL_CLICK_PAGE_VISIT - TOTAL_CLICK_SIGNUP - TOTAL_CLICK_CHECKOUT @@ -27713,6 +29907,11 @@ components: - TOTAL_CLICK_VIEW_CATEGORY - TOTAL_CLICK_APP_INSTALL - TOTAL_CLICK_UNKNOWN + - TOTAL_CLICK_ADD_PAYMENT_INFO + - TOTAL_CLICK_ADD_TO_WISHLIST + - TOTAL_CLICK_INITIATE_CHECKOUT + - TOTAL_CLICK_SUBSCRIBE + - TOTAL_CLICK_VIEW_CONTENT - TOTAL_VIEW_PAGE_VISIT - TOTAL_VIEW_SIGNUP - TOTAL_VIEW_CHECKOUT @@ -27724,6 +29923,11 @@ components: - TOTAL_VIEW_VIEW_CATEGORY - TOTAL_VIEW_APP_INSTALL - TOTAL_VIEW_UNKNOWN + - TOTAL_VIEW_ADD_PAYMENT_INFO + - TOTAL_VIEW_ADD_TO_WISHLIST + - TOTAL_VIEW_INITIATE_CHECKOUT + - TOTAL_VIEW_SUBSCRIBE + - TOTAL_VIEW_VIEW_CONTENT - TOTAL_CONVERSIONS - TOTAL_WEB_CONVERSIONS - TOTAL_INAPP_CONVERSIONS @@ -27748,6 +29952,16 @@ components: - TOTAL_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_DOLLAR - TOTAL_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR + - TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR - TOTAL_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_PAGE_VISIT_VALUE_IN_DOLLAR - TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR @@ -27768,6 +29982,16 @@ components: - TOTAL_CLICK_VIEW_CATEGORY_VALUE_IN_DOLLAR - TOTAL_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR + - TOTAL_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR - TOTAL_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_PAGE_VISIT_VALUE_IN_DOLLAR - TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR @@ -27788,6 +30012,16 @@ components: - TOTAL_VIEW_VIEW_CATEGORY_VALUE_IN_DOLLAR - TOTAL_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR + - TOTAL_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR - TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR - TOTAL_CONVERSIONS_VALUE_IN_DOLLAR - TOTAL_ENGAGEMENT_PAGE_VISIT_QUANTITY @@ -27801,6 +30035,11 @@ components: - TOTAL_ENGAGEMENT_VIEW_CATEGORY_QUANTITY - TOTAL_ENGAGEMENT_APP_INSTALL_QUANTITY - TOTAL_ENGAGEMENT_UNKNOWN_QUANTITY + - TOTAL_ENGAGEMENT_ADD_PAYMENT_INFO_QUANTITY + - TOTAL_ENGAGEMENT_ADD_TO_WISHLIST_QUANTITY + - TOTAL_ENGAGEMENT_INITIATE_CHECKOUT_QUANTITY + - TOTAL_ENGAGEMENT_SUBSCRIBE_QUANTITY + - TOTAL_ENGAGEMENT_VIEW_CONTENT_QUANTITY - TOTAL_CLICK_PAGE_VISIT_QUANTITY - TOTAL_CLICK_SIGNUP_QUANTITY - TOTAL_CLICK_CHECKOUT_QUANTITY @@ -27812,6 +30051,11 @@ components: - TOTAL_CLICK_VIEW_CATEGORY_QUANTITY - TOTAL_CLICK_APP_INSTALL_QUANTITY - TOTAL_CLICK_UNKNOWN_QUANTITY + - TOTAL_CLICK_ADD_PAYMENT_INFO_QUANTITY + - TOTAL_CLICK_ADD_TO_WISHLIST_QUANTITY + - TOTAL_CLICK_INITIATE_CHECKOUT_QUANTITY + - TOTAL_CLICK_SUBSCRIBE_QUANTITY + - TOTAL_CLICK_VIEW_CONTENT_QUANTITY - TOTAL_VIEW_PAGE_VISIT_QUANTITY - TOTAL_VIEW_SIGNUP_QUANTITY - TOTAL_VIEW_CHECKOUT_QUANTITY @@ -27823,6 +30067,11 @@ components: - TOTAL_VIEW_VIEW_CATEGORY_QUANTITY - TOTAL_VIEW_APP_INSTALL_QUANTITY - TOTAL_VIEW_UNKNOWN_QUANTITY + - TOTAL_VIEW_ADD_PAYMENT_INFO_QUANTITY + - TOTAL_VIEW_ADD_TO_WISHLIST_QUANTITY + - TOTAL_VIEW_INITIATE_CHECKOUT_QUANTITY + - TOTAL_VIEW_SUBSCRIBE_QUANTITY + - TOTAL_VIEW_VIEW_CONTENT_QUANTITY - TOTAL_CONVERSIONS_QUANTITY - COST_PER_CONVERSION_IN_DOLLAR - TOTAL_WEB_SESSIONS @@ -27846,26 +30095,12 @@ components: - ECPI_IN_MICRO_DOLLAR - CPI_IN_DOLLAR - ECPI_IN_DOLLAR - - ONSITE_CHECKOUTS_CPA_BILLABLE_1 - - ONSITE_CHECKOUTS_CPA_BILLABLE_2 - - ONSITE_CHECKOUTS_CPA_BILLABLE - - ONSITE_CHECKOUTS_VALUE_1 - - ONSITE_CHECKOUTS_VALUE_2 - - ONSITE_CHECKOUTS_VALUE - ONSITE_CHECKOUTS_1 - ONSITE_CHECKOUTS_2 - ONSITE_CHECKOUTS - - ONSITE_CHECKOUTS_VALUE_IN_MICRO_DOLLAR_1 - - ONSITE_CHECKOUTS_VALUE_IN_MICRO_DOLLAR_2 - CONVERSION_RATE - AVERAGE_CHECKOUT_VALUE - - RETURN_ON_ADVERTISER_SPEND - - BUY_BUTTON_CLICKS_1 - - BUY_BUTTON_CLICKS_2 - TOTAL_BUY_BUTTON_CLICKS - - ORDER_DROPOFF_RATE - - ONSITE_CHECKOUTS_VALUE_IN_MICRO_DOLLAR - - ONSITE_CHECKOUTS_VALUE_IN_DOLLAR - PIN_PROMOTION_NAME - AD_NAME - LIFETIME_IMPRESSION_USER_1 @@ -27894,16 +30129,12 @@ components: - AD_GROUP_START_DATE - CAMPAIGN_LIFETIME_SPEND_CAP - AD_GROUP_BID_IN_MICRO_CURRENCY - - CAMPAIGN_AD_GROUP_START_DATE - - CAMPAIGN_AD_GROUP_END_DATE - - CAMPAIGN_NUMBER_OF_AD_GROUPS - AD_GROUP_NUMBER_OF_PIN_PROMOTIONS - TODAY_SPEND_IN_LOCAL_CURRENCY - TOTAL_LIFETIME_SPEND_IN_LOCAL_CURRENCY - BUDGET_UTILIZATION - AD_GROUP_OPTIMIZATION - INSERTION_ORDER - - AD_GROUP_BONUS_BUDGET - FREQUENCY - CAMPAIGN_DAILY_SPEND_CAP - CAMPAIGN_CREATIVE_TYPE @@ -27916,7 +30147,6 @@ components: - FLEXIBLE_DAILY_BUDGETS - IS_PERFORMANCE_PLUS_CAMPAIGN - IS_DCO_FORMAT_ENHANCMENT - - PERCENT_CROSS_DEVICE_CONVERSIONS - PAGE_VISIT_PERCENT_CROSS_DEVICE_CONVERSIONS - SIGNUP_PERCENT_CROSS_DEVICE_CONVERSIONS - CHECKOUT_PERCENT_CROSS_DEVICE_CONVERSIONS @@ -27928,15 +30158,6 @@ components: - VIEW_CATEGORY_PERCENT_CROSS_DEVICE_CONVERSIONS - APP_INSTALL_PERCENT_CROSS_DEVICE_CONVERSIONS - UNKNOWN_PERCENT_CROSS_DEVICE_CONVERSIONS - - TOTAL_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - - TOTAL_DESKTOP_ACTION_TO_MOBILE_CONVERSION - - TOTAL_DESKTOP_ACTION_TO_TABLET_CONVERSION - - TOTAL_MOBILE_ACTION_TO_DESKTOP_CONVERSION - - TOTAL_MOBILE_ACTION_TO_MOBILE_CONVERSION - - TOTAL_MOBILE_ACTION_TO_TABLET_CONVERSION - - TOTAL_TABLET_ACTION_TO_DESKTOP_CONVERSION - - TOTAL_TABLET_ACTION_TO_MOBILE_CONVERSION - - TOTAL_TABLET_ACTION_TO_TABLET_CONVERSION - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION - TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION @@ -28047,6 +30268,11 @@ components: - TOTAL_VIEW_CATEGORY - TOTAL_APP_INSTALL - TOTAL_UNKNOWN + - TOTAL_ADD_PAYMENT_INFO + - TOTAL_ADD_TO_WISHLIST + - TOTAL_INITIATE_CHECKOUT + - TOTAL_SUBSCRIBE + - TOTAL_VIEW_CONTENT - TOTAL_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - TOTAL_SIGNUP_VALUE_IN_MICRO_DOLLAR - TOTAL_CHECKOUT_VALUE_IN_MICRO_DOLLAR @@ -28058,6 +30284,11 @@ components: - TOTAL_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - TOTAL_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_UNKNOWN_VALUE_IN_MICRO_DOLLAR + - TOTAL_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR - AVERAGE_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR - AVERAGE_SIGNUP_VALUE_IN_MICRO_DOLLAR - AVERAGE_CHECKOUT_VALUE_IN_MICRO_DOLLAR @@ -28068,6 +30299,11 @@ components: - AVERAGE_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR - AVERAGE_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR - AVERAGE_UNKNOWN_VALUE_IN_MICRO_DOLLAR + - AVERAGE_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - AVERAGE_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - AVERAGE_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - AVERAGE_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - AVERAGE_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR - AVERAGE_PAGE_VISIT_VALUE_IN_MICRO_US_DOLLAR - AVERAGE_SIGNUP_VALUE_IN_MICRO_US_DOLLAR - AVERAGE_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR @@ -28078,6 +30314,11 @@ components: - AVERAGE_WATCH_VIDEO_VALUE_IN_MICRO_US_DOLLAR - AVERAGE_VIEW_CATEGORY_VALUE_IN_MICRO_US_DOLLAR - AVERAGE_UNKNOWN_VALUE_IN_MICRO_US_DOLLAR + - AVERAGE_ADD_PAYMENT_INFO_VALUE_IN_MICRO_US_DOLLAR + - AVERAGE_ADD_TO_WISHLIST_VALUE_IN_MICRO_US_DOLLAR + - AVERAGE_INITIATE_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR + - AVERAGE_SUBSCRIBE_VALUE_IN_MICRO_US_DOLLAR + - AVERAGE_VIEW_CONTENT_VALUE_IN_MICRO_US_DOLLAR - TOTAL_PAGE_VISIT_VALUE_IN_MICRO_US_DOLLAR - TOTAL_SIGNUP_VALUE_IN_MICRO_US_DOLLAR - TOTAL_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR @@ -28088,6 +30329,11 @@ components: - TOTAL_WATCH_VIDEO_VALUE_IN_MICRO_US_DOLLAR - TOTAL_VIEW_CATEGORY_VALUE_IN_MICRO_US_DOLLAR - TOTAL_UNKNOWN_VALUE_IN_MICRO_US_DOLLAR + - TOTAL_ADD_PAYMENT_INFO_VALUE_IN_MICRO_US_DOLLAR + - TOTAL_ADD_TO_WISHLIST_VALUE_IN_MICRO_US_DOLLAR + - TOTAL_INITIATE_CHECKOUT_VALUE_IN_MICRO_US_DOLLAR + - TOTAL_SUBSCRIBE_VALUE_IN_MICRO_US_DOLLAR + - TOTAL_VIEW_CONTENT_VALUE_IN_MICRO_US_DOLLAR - TOTAL_PAGE_VISIT_QUANTITY - TOTAL_SIGNUP_QUANTITY - TOTAL_CHECKOUT_QUANTITY @@ -28099,6 +30345,11 @@ components: - TOTAL_VIEW_CATEGORY_QUANTITY - TOTAL_APP_INSTALL_QUANTITY - TOTAL_UNKNOWN_QUANTITY + - TOTAL_ADD_PAYMENT_INFO_QUANTITY + - TOTAL_ADD_TO_WISHLIST_QUANTITY + - TOTAL_INITIATE_CHECKOUT_QUANTITY + - TOTAL_SUBSCRIBE_QUANTITY + - TOTAL_VIEW_CONTENT_QUANTITY - TOTAL_PAGE_VISIT_VALUE_IN_DOLLAR - TOTAL_SIGNUP_VALUE_IN_DOLLAR - TOTAL_CHECKOUT_VALUE_IN_DOLLAR @@ -28110,6 +30361,11 @@ components: - TOTAL_VIEW_CATEGORY_VALUE_IN_DOLLAR - TOTAL_APP_INSTALL_VALUE_IN_DOLLAR - TOTAL_UNKNOWN_VALUE_IN_DOLLAR + - TOTAL_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_VIEW_CONTENT_VALUE_IN_DOLLAR - PAGE_VISIT_COST_PER_ACTION - SIGNUP_COST_PER_ACTION - CHECKOUT_COST_PER_ACTION @@ -28122,6 +30378,11 @@ components: - APP_INSTALL_COST_PER_ACTION - UNKNOWN_COST_PER_ACTION - AD_GROUP_CPA_IN_MICRO_CURRENCY + - ADD_PAYMENT_INFO_COST_PER_ACTION + - ADD_TO_WISHLIST_COST_PER_ACTION + - INITIATE_CHECKOUT_COST_PER_ACTION + - SUBSCRIBE_COST_PER_ACTION + - VIEW_CONTENT_COST_PER_ACTION - PAGE_VISIT_COST_PER_ACTION_IN_US_DOLLAR - SIGNUP_COST_PER_ACTION_IN_US_DOLLAR - CHECKOUT_COST_PER_ACTION_IN_US_DOLLAR @@ -28132,6 +30393,11 @@ components: - WATCH_VIDEO_COST_PER_ACTION_IN_US_DOLLAR - VIEW_CATEGORY_COST_PER_ACTION_IN_US_DOLLAR - UNKNOWN_COST_PER_ACTION_IN_US_DOLLAR + - ADD_PAYMENT_INFO_COST_PER_ACTION_IN_US_DOLLAR + - ADD_TO_WISHLIST_COST_PER_ACTION_IN_US_DOLLAR + - INITIATE_CHECKOUT_COST_PER_ACTION_IN_US_DOLLAR + - SUBSCRIBE_COST_PER_ACTION_IN_US_DOLLAR + - VIEW_CONTENT_COST_PER_ACTION_IN_US_DOLLAR - PAGE_VISIT_ROAS - SIGNUP_ROAS - CHECKOUT_ROAS @@ -28147,6 +30413,11 @@ components: - CLICK_ROAS - ENGAGEMENT_ROAS - VIEW_ROAS + - ADD_PAYMENT_INFO_ROAS + - ADD_TO_WISHLIST_ROAS + - INITIATE_CHECKOUT_ROAS + - SUBSCRIBE_ROAS + - VIEW_CONTENT_ROAS - HOUR - BOARD_ENGAGEMENT - BOARD_INSERTION @@ -28162,6 +30433,7 @@ components: - PRODUCT_GROUP_AD_GROUP_ID - PRODUCT_GROUP_AD_GROUP_NAME - PRODUCT_GROUP_AD_GROUP_STATUS + - PRODUCT_GROUP_AD_IMAGE_TAG - PROMOTED_CATALOG_PRODUCT_GROUP_REFERENCE_ID - PROMOTED_CATALOG_PRODUCT_GROUP_REFERENCE_NAME - PROMOTED_CATALOG_PRODUCT_GROUP_ID @@ -28177,6 +30449,7 @@ components: - PROMOTED_CATALOG_PRODUCT_GROUP_AD_GROUP_NAME - PROMOTED_CATALOG_PRODUCT_GROUP_AD_GROUP_STATUS - PROMOTED_CATALOG_PRODUCT_GROUP_TRACKING_TEMPLATE_URL + - PROMOTED_CATALOG_PRODUCT_GROUP_SELECTED_IMAGE_TAG - VIDEO_3SEC_VIEWS_1 - VIDEO_P0_COMPLETE_1 - VIDEO_P25_COMPLETE_1 @@ -28192,6 +30465,9 @@ components: - VIDEO_P95_COMBINED_1 - VIDEO_P97_COMBINED_1 - VIDEO_P100_COMBINED_1 + - VIDEO_STARTS_PAID + - VIDEO_STARTS_EARNED + - TOTAL_VIDEO_STARTS - VIDEO_AVG_WATCHTIME_1 - VIDEO_MRC_VIEWS_1 - VIDEO_VIEW_RATE_1 @@ -28217,6 +30493,8 @@ components: - PAID_VIDEO_IMPRESSION - PAID_VIDEO_VIEWABLE_RATE - VIDEO_LENGTH + - VIDEO_SPEND_IN_MICRO_DOLLAR + - VIDEO_SPEND_IN_DOLLAR - CPV_IN_MICRO_DOLLAR - CPV_IN_DOLLAR - CP3SV_IN_MICRO_DOLLAR @@ -28266,8 +30544,9 @@ components: - VIDEO_AVG_WATCHTIME_IN_SECOND_1 - VIDEO_AVG_WATCHTIME_IN_SECOND_2 - TOTAL_VIDEO_AVG_WATCHTIME_IN_SECOND - - DELIVERY_STATUS_NO_FANOUT - - DELIVERY_STATUS_WITH_FANOUT + - VIDEO_AVG_WATCHTIME_IN_SECOND_VIDEO_STARTS_PAID + - VIDEO_AVG_WATCHTIME_IN_SECOND_VIDEO_STARTS_EARNED + - TOTAL_VIDEO_AVG_WATCHTIME_IN_SECOND_VIDEO_STARTS - KEYWORD_COMPETITION_BAND - KEYWORD_QUERY_VOLUME - KEYWORD_VALUE @@ -28290,13 +30569,6 @@ components: - ONE_TAP_V2_WEBSITE_VIEW_1 - ONE_TAP_V2_WEBSITE_VIEW_2 - TOTAL_ONE_TAP_V2_WEBSITE_VIEW - - ONE_TAP_V2_WEBSITE_VIEW_USER_1 - - ONE_TAP_V2_WEBSITE_VIEW_USER_2 - - TOTAL_LANDING_PAGE_VIEWS - - LANDING_PAGE_VIEWS_1 - - LANDING_PAGE_VIEWS_2 - - COST_PER_LANDING_PAGE_VIEW - - LANDING_PAGE_VIEW_RATE - TOTAL_DESTINATION_VIEWS - DESTINATION_VIEWS_1 - DESTINATION_VIEWS_2 @@ -28309,23 +30581,15 @@ components: - CAROUSEL_SLOT_IMPRESSION_1 - CAROUSEL_SLOT_IMPRESSION_2 - TOTAL_CAROUSEL_SLOT_IMPRESSION - - CAROUSEL_SLOT_IMPRESSION_USER_1 - - CAROUSEL_SLOT_IMPRESSION_USER_2 - CAROUSEL_SLOT_CLICKTHROUGH_1 - CAROUSEL_SLOT_CLICKTHROUGH_2 - TOTAL_CAROUSEL_SLOT_CLICKTHROUGH - - CAROUSEL_SLOT_CLICKTHROUGH_USER_1 - - CAROUSEL_SLOT_CLICKTHROUGH_USER_2 - CAROUSEL_SLOT_SIDESWIPE_1 - CAROUSEL_SLOT_SIDESWIPE_2 - TOTAL_CAROUSEL_SLOT_SIDESWIPE - - CAROUSEL_SLOT_SIDESWIPE_USER_1 - - CAROUSEL_SLOT_SIDESWIPE_USER_2 - CAROUSEL_SLOT_VIEW_WEBSITE_1 - CAROUSEL_SLOT_VIEW_WEBSITE_2 - TOTAL_CAROUSEL_SLOT_VIEW_WEBSITE - - CAROUSEL_SLOT_VIEW_WEBSITE_USER_1 - - CAROUSEL_SLOT_VIEW_WEBSITE_USER_2 - COLLECTION_PIN_ITEM_IMPRESSION_1 - COLLECTION_PIN_ITEM_IMPRESSION_2 - TOTAL_COLLECTION_PIN_ITEM_IMPRESSION @@ -28342,8 +30606,6 @@ components: - DATE_RANGE - DATE_RANGE_START - DATE_RANGE_END - - REPORT_DATE_START - - REPORT_DATE_END - PINNER_LIST_NAME - PINNER_LIST_TYPE - ORDER_VALUE @@ -28654,6 +30916,216 @@ components: - TOTAL_INAPP_VIEW_APP_INSTALL - TOTAL_INAPP_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR - TOTAL_INAPP_VIEW_APP_INSTALL_VALUE_IN_DOLLAR + - WEB_ADD_PAYMENT_INFO_COST_PER_ACTION + - WEB_ADD_PAYMENT_INFO_ROAS + - TOTAL_WEB_ADD_PAYMENT_INFO + - TOTAL_WEB_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_WEB_CLICK_ADD_PAYMENT_INFO + - TOTAL_WEB_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_WEB_ENGAGEMENT_ADD_PAYMENT_INFO + - TOTAL_WEB_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_WEB_VIEW_ADD_PAYMENT_INFO + - TOTAL_WEB_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - INAPP_ADD_PAYMENT_INFO_COST_PER_ACTION + - INAPP_ADD_PAYMENT_INFO_ROAS + - TOTAL_INAPP_ADD_PAYMENT_INFO + - TOTAL_INAPP_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_INAPP_CLICK_ADD_PAYMENT_INFO + - TOTAL_INAPP_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_ADD_PAYMENT_INFO + - TOTAL_INAPP_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_INAPP_VIEW_ADD_PAYMENT_INFO + - TOTAL_INAPP_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - OFFLINE_ADD_PAYMENT_INFO_COST_PER_ACTION + - OFFLINE_ADD_PAYMENT_INFO_ROAS + - TOTAL_OFFLINE_ADD_PAYMENT_INFO + - TOTAL_OFFLINE_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_CLICK_ADD_PAYMENT_INFO + - TOTAL_OFFLINE_CLICK_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_CLICK_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_ADD_PAYMENT_INFO + - TOTAL_OFFLINE_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_VIEW_ADD_PAYMENT_INFO + - TOTAL_OFFLINE_VIEW_ADD_PAYMENT_INFO_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_VIEW_ADD_PAYMENT_INFO_VALUE_IN_DOLLAR + - WEB_ADD_TO_WISHLIST_COST_PER_ACTION + - WEB_ADD_TO_WISHLIST_ROAS + - TOTAL_WEB_ADD_TO_WISHLIST + - TOTAL_WEB_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_WEB_CLICK_ADD_TO_WISHLIST + - TOTAL_WEB_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_WEB_ENGAGEMENT_ADD_TO_WISHLIST + - TOTAL_WEB_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_WEB_VIEW_ADD_TO_WISHLIST + - TOTAL_WEB_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - INAPP_ADD_TO_WISHLIST_COST_PER_ACTION + - INAPP_ADD_TO_WISHLIST_ROAS + - TOTAL_INAPP_ADD_TO_WISHLIST + - TOTAL_INAPP_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_INAPP_CLICK_ADD_TO_WISHLIST + - TOTAL_INAPP_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_ADD_TO_WISHLIST + - TOTAL_INAPP_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_INAPP_VIEW_ADD_TO_WISHLIST + - TOTAL_INAPP_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - OFFLINE_ADD_TO_WISHLIST_COST_PER_ACTION + - OFFLINE_ADD_TO_WISHLIST_ROAS + - TOTAL_OFFLINE_ADD_TO_WISHLIST + - TOTAL_OFFLINE_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_CLICK_ADD_TO_WISHLIST + - TOTAL_OFFLINE_CLICK_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_CLICK_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_ADD_TO_WISHLIST + - TOTAL_OFFLINE_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_VIEW_ADD_TO_WISHLIST + - TOTAL_OFFLINE_VIEW_ADD_TO_WISHLIST_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_VIEW_ADD_TO_WISHLIST_VALUE_IN_DOLLAR + - WEB_INITIATE_CHECKOUT_COST_PER_ACTION + - WEB_INITIATE_CHECKOUT_ROAS + - TOTAL_WEB_INITIATE_CHECKOUT + - TOTAL_WEB_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_WEB_CLICK_INITIATE_CHECKOUT + - TOTAL_WEB_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_WEB_ENGAGEMENT_INITIATE_CHECKOUT + - TOTAL_WEB_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_WEB_VIEW_INITIATE_CHECKOUT + - TOTAL_WEB_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - INAPP_INITIATE_CHECKOUT_COST_PER_ACTION + - INAPP_INITIATE_CHECKOUT_ROAS + - TOTAL_INAPP_INITIATE_CHECKOUT + - TOTAL_INAPP_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_INAPP_CLICK_INITIATE_CHECKOUT + - TOTAL_INAPP_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_INITIATE_CHECKOUT + - TOTAL_INAPP_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_INAPP_VIEW_INITIATE_CHECKOUT + - TOTAL_INAPP_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - OFFLINE_INITIATE_CHECKOUT_COST_PER_ACTION + - OFFLINE_INITIATE_CHECKOUT_ROAS + - TOTAL_OFFLINE_INITIATE_CHECKOUT + - TOTAL_OFFLINE_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_CLICK_INITIATE_CHECKOUT + - TOTAL_OFFLINE_CLICK_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_CLICK_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_INITIATE_CHECKOUT + - TOTAL_OFFLINE_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_VIEW_INITIATE_CHECKOUT + - TOTAL_OFFLINE_VIEW_INITIATE_CHECKOUT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_VIEW_INITIATE_CHECKOUT_VALUE_IN_DOLLAR + - WEB_SUBSCRIBE_COST_PER_ACTION + - WEB_SUBSCRIBE_ROAS + - TOTAL_WEB_SUBSCRIBE + - TOTAL_WEB_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_WEB_CLICK_SUBSCRIBE + - TOTAL_WEB_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_WEB_ENGAGEMENT_SUBSCRIBE + - TOTAL_WEB_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_WEB_VIEW_SUBSCRIBE + - TOTAL_WEB_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR + - INAPP_SUBSCRIBE_COST_PER_ACTION + - INAPP_SUBSCRIBE_ROAS + - TOTAL_INAPP_SUBSCRIBE + - TOTAL_INAPP_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_INAPP_CLICK_SUBSCRIBE + - TOTAL_INAPP_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_SUBSCRIBE + - TOTAL_INAPP_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_INAPP_VIEW_SUBSCRIBE + - TOTAL_INAPP_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR + - OFFLINE_SUBSCRIBE_COST_PER_ACTION + - OFFLINE_SUBSCRIBE_ROAS + - TOTAL_OFFLINE_SUBSCRIBE + - TOTAL_OFFLINE_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_CLICK_SUBSCRIBE + - TOTAL_OFFLINE_CLICK_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_CLICK_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_SUBSCRIBE + - TOTAL_OFFLINE_ENGAGEMENT_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_SUBSCRIBE_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_VIEW_SUBSCRIBE + - TOTAL_OFFLINE_VIEW_SUBSCRIBE_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_VIEW_SUBSCRIBE_VALUE_IN_DOLLAR + - WEB_VIEW_CONTENT_COST_PER_ACTION + - WEB_VIEW_CONTENT_ROAS + - TOTAL_WEB_VIEW_CONTENT + - TOTAL_WEB_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_WEB_CLICK_VIEW_CONTENT + - TOTAL_WEB_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_WEB_ENGAGEMENT_VIEW_CONTENT + - TOTAL_WEB_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_WEB_VIEW_VIEW_CONTENT + - TOTAL_WEB_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_WEB_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR + - INAPP_VIEW_CONTENT_COST_PER_ACTION + - INAPP_VIEW_CONTENT_ROAS + - TOTAL_INAPP_VIEW_CONTENT + - TOTAL_INAPP_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_INAPP_CLICK_VIEW_CONTENT + - TOTAL_INAPP_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_VIEW_CONTENT + - TOTAL_INAPP_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_INAPP_VIEW_VIEW_CONTENT + - TOTAL_INAPP_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_INAPP_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR + - OFFLINE_VIEW_CONTENT_COST_PER_ACTION + - OFFLINE_VIEW_CONTENT_ROAS + - TOTAL_OFFLINE_VIEW_CONTENT + - TOTAL_OFFLINE_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_CLICK_VIEW_CONTENT + - TOTAL_OFFLINE_CLICK_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_CLICK_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_VIEW_CONTENT + - TOTAL_OFFLINE_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_ENGAGEMENT_VIEW_CONTENT_VALUE_IN_DOLLAR + - TOTAL_OFFLINE_VIEW_VIEW_CONTENT + - TOTAL_OFFLINE_VIEW_VIEW_CONTENT_VALUE_IN_MICRO_DOLLAR + - TOTAL_OFFLINE_VIEW_VIEW_CONTENT_VALUE_IN_DOLLAR - IDEA_PIN_PAGE_FORWARD_1 - IDEA_PIN_PAGE_FORWARD_2 - IDEA_PIN_PAGE_BACKWARD_1 @@ -28698,6 +31170,11 @@ components: - TOTAL_WATCH_VIDEO_CONVERSION_RATE - TOTAL_UNKNOWN_CONVERSION_RATE - TOTAL_CUSTOM_CONVERSION_RATE + - TOTAL_ADD_PAYMENT_INFO_CONVERSION_RATE + - TOTAL_ADD_TO_WISHLIST_CONVERSION_RATE + - TOTAL_INITIATE_CHECKOUT_CONVERSION_RATE + - TOTAL_SUBSCRIBE_CONVERSION_RATE + - TOTAL_VIEW_CONTENT_CONVERSION_RATE - STANDARD_AD_FEED_ITEM_ID - IS_STANDARD_FEED_AD - TARGETING_GENDER @@ -28707,6 +31184,7 @@ components: - TARGETING_APPTYPE - TARGETING_LOCATION_CODE - TARGETING_MEDIA_TYPE + - TARGETING_AGE_BUCKET - TOTAL_CONVERSION_PRODUCT_QUANTITY - TOTAL_WEB_CONVERSION_PRODUCT_QUANTITY - TOTAL_INAPP_CONVERSION_PRODUCT_QUANTITY @@ -29194,6 +31672,7 @@ components: Results are ordered, with the first element in the array representing the #1 top trend. type: array items: + title: TrendingKeyword type: object properties: keyword: @@ -29234,6 +31713,7 @@ components: '2023-10-24': 77 '2023-10-31': 100 type: object + title: TimeSeries properties: date: type: string @@ -29358,6 +31838,36 @@ components: example: Man hat type: string nullable: true + custom_number_0: + description: an attribute for any integer information ranging from 0 to + 4,294,967,295, which can be used to group items. + example: 10 + type: integer + nullable: true + custom_number_1: + description: an attribute for any integer information ranging from 0 to + 4,294,967,295, which can be used to group items. + example: 0 + type: integer + nullable: true + custom_number_2: + description: an attribute for any integer information ranging from 0 to + 4,294,967,295, which can be used to group items. + example: 1520000000 + type: integer + nullable: true + custom_number_3: + description: an attribute for any integer information ranging from 0 to + 4,294,967,295, which can be used to group items. + example: 4294967295 + type: integer + nullable: true + custom_number_4: + description: an attribute for any integer information ranging from 0 to + 4,294,967,295, which can be used to group items. + example: 50 + type: integer + nullable: true description: description: |-

    <= 10000 characters

    @@ -29866,6 +32376,11 @@ components: - custom_label_2 - custom_label_3 - custom_label_4 + - custom_number_0 + - custom_number_1 + - custom_number_2 + - custom_number_3 + - custom_number_4 - description - free_shipping_label - free_shipping_limit @@ -30181,7 +32696,114 @@ components: enum: - SHARE - REVOKE + ErrorResponse: + type: object + required: + - code + - message + properties: + code: + type: integer + message: + type: string + LeadSubscription: + type: object + properties: + id: + type: string + pattern: ^\d+$ + description: Subscription ID. + lead_form_id: + type: string + nullable: true + pattern: ^\d+$ + description: Lead form ID. + title: Lead form ID + webhook_url: + type: string + description: Standard HTTPS webhook URL. + title: webhook_url + ad_account_id: + type: string + pattern: ^\d+$ + description: The Ad Account ID that this lead form belongs to. + user_account_id: + type: string + pattern: ^\d+$ + description: User account used to subscribe lead data. + api_version: + type: string + description: API version. + cryptographic_key: + type: string + nullable: true + description: Base64 encoded key for client to decrypt lead data. + cryptographic_algorithm: + type: string + nullable: true + description: Lead data encryption algorithm. + created_time: + type: integer + description: Subscription creation time. Unix timestamp in milliseconds. + LeadSubscriptionPostParamsCreate: + type: object + properties: + partner_access_token: + type: string + description: Partner access token. Only for clients that requires authentication. + We recommend to avoid this param. + partner_refresh_token: + type: string + description: Partner refresh token. Only for clients that requires authentication. + We recommend to avoid this param. + partner_metadata: + allOf: + - type: object + properties: + subscriber_key: + type: string + description: Text field value that uniquely identifies a subscriber. + description: Partner metadata. Only for clients that requires special handling. + We recommend to avoid this param. + allOf: + - type: object + required: + - webhook_url + properties: + lead_form_id: + type: string + pattern: ^\d+$ + description: Lead form ID. + title: Lead form ID + webhook_url: + type: string + description: Standard HTTPS webhook URL. + title: webhook_url + Resource.Error: + type: object + required: + - code + - message + properties: + code: + type: integer + message: + type: string + description: Default error response + title: Generic Error + example: + code: 2 + message: AdAccount not found. parameters: + fetch_system_users: + name: fetch_system_users + in: query + description: Fetches system users if True. Fetches regular user employees if + False. + required: false + schema: + type: boolean + default: false result_limit: description: Max search result size in: query @@ -30287,6 +32909,15 @@ components: schema: type: boolean default: false + path_billing_invoice_id: + name: billing_invoice_id + description: Unique identifier of a billing invoice. + in: path + required: true + schema: + type: string + pattern: ^\d+$ + maxLength: 18 path_business_id: name: business_id in: path @@ -30353,10 +32984,11 @@ components: name: batch_id in: path description: Id of a catalogs items batch to fetch - example: 595953100599279259-66753b9bb65c46c49bd8503b27fecf9e + example: 66753b9bb65c46c49bd8503b27fecf9e required: true schema: type: string + pattern: ^[a-zA-Z0-9]+$ path_catalogs_processing_result_id: description: Unique identifier of a feed processing result. It can be acquired from the "id" field of the "items" array within the response of the [List @@ -30475,6 +33107,15 @@ components: type: string pattern: ^\d+$ maxLength: 18 + path_promotion_id: + name: promotion_id + description: Unique identifier of a promotion + in: path + required: true + schema: + type: string + pattern: ^\d+$ + maxLength: 18 path_scope: name: scope description: Generated audience scope to request. @@ -30753,6 +33394,50 @@ components: $ref: '#/components/schemas/AudienceType' minItems: 1 maxItems: 100 + query_billing_document_type: + name: document_type + in: query + description: Document type of billing invoices to filter by + required: false + schema: + type: string + example: INVOICE + enum: + - INVOICE + - CREDIT_MEMO + query_billing_end_due_date: + name: end_due_date + in: query + description: 'Ending point for due dates when searching for invoices. Format: + YYYY-MM-DD' + required: false + schema: + type: string + format: date + example: '2024-01-01' + pattern: ^(\d{4})-(\d{2})-(\d{2})$ + query_billing_invoice_status: + name: status + in: query + description: Status of billing invoices to filter by + required: false + schema: + type: string + example: OPEN + enum: + - OPEN + - CLOSED + query_billing_start_due_date: + name: start_due_date + in: query + description: 'Starting point for due dates when searching for invoices. Format: + YYYY-MM-DD' + required: false + schema: + type: string + format: date + example: '2023-01-01' + pattern: ^(\d{4})-(\d{2})-(\d{2})$ query_bookmark: name: bookmark description: Cursor used to fetch the next page of items @@ -30825,7 +33510,21 @@ components: required: true style: deepObject schema: - $ref: '#/components/schemas/CatalogsReportParameters' + type: object + description: Report stats parameters + properties: + catalog_type: + $ref: '#/components/schemas/CatalogsType' + required: + - catalog_type + oneOf: + - $ref: '#/components/schemas/CatalogsRetailReportStatsParameters' + - $ref: '#/components/schemas/CatalogsHotelReportStatsParameters' + discriminator: + propertyName: catalog_type + mapping: + RETAIL: '#/components/schemas/CatalogsRetailReportStatsParameters' + HOTEL: '#/components/schemas/CatalogsHotelReportStatsParameters' query_catalogs_feed_id: description: Filter entities for a given feed_id. If not given, all feeds are considered. @@ -30858,18 +33557,6 @@ components: required: false schema: $ref: '#/components/schemas/CatalogsItemValidationIssue' - query_catalogs_items: - deprecated: true - name: item_ids - in: query - description: This parameter is deprecated. Use filters instead. - example: - - CR123 - required: false - schema: - type: array - items: - type: string query_catalogs_items_country: name: country in: query @@ -30964,6 +33651,7 @@ components: - ECPC_IN_DOLLAR - CTR - ECTR + - OUTBOUND_CTR_1 - CAMPAIGN_NAME - PIN_ID - TOTAL_ENGAGEMENT @@ -30985,7 +33673,11 @@ components: - CAMPAIGN_OBJECTIVE_TYPE - CPM_IN_MICRO_DOLLAR - CPM_IN_DOLLAR + - AD_GROUP_NAME - AD_GROUP_ENTITY_STATUS + - AD_GROUP_BID_MULTIPLIER + - PROMO_ID + - PROMO_NAME - ORDER_LINE_ID - ORDER_LINE_NAME - CLICKTHROUGH_1 @@ -31003,6 +33695,7 @@ components: - TOTAL_IMPRESSION_USER - TOTAL_IMPRESSION_FREQUENCY - COST_PER_OUTBOUND_CLICK_IN_DOLLAR + - COST_PER_OUTBOUND_CLICK_IN_DOLLAR_1 - TOTAL_ENGAGEMENT_SIGNUP - TOTAL_ENGAGEMENT_CHECKOUT - TOTAL_ENGAGEMENT_LEAD @@ -31024,8 +33717,11 @@ components: - TOTAL_WEB_SESSIONS - WEB_SESSIONS_1 - WEB_SESSIONS_2 + - AD_NAME - CAMPAIGN_LIFETIME_SPEND_CAP + - AD_GROUP_OPTIMIZATION - CAMPAIGN_DAILY_SPEND_CAP + - IS_PREMIERE_CAMPAIGN - TOTAL_PAGE_VISIT - TOTAL_SIGNUP - TOTAL_CHECKOUT @@ -31038,6 +33734,7 @@ components: - PAGE_VISIT_ROAS - CHECKOUT_ROAS - CUSTOM_ROAS + - PRODUCT_GROUP_AD_IMAGE_TAG - VIDEO_MRC_VIEWS_1 - VIDEO_3SEC_VIEWS_2 - VIDEO_P100_COMPLETE_2 @@ -31049,6 +33746,7 @@ components: - VIDEO_MRC_VIEWS_2 - PAID_VIDEO_VIEWABLE_RATE - VIDEO_LENGTH + - VIDEO_SPEND_IN_DOLLAR - ECPV_IN_DOLLAR - ECPCV_IN_DOLLAR - ECPCV_P95_IN_DOLLAR @@ -31744,6 +34442,7 @@ components: - AD_ACCOUNT - PROFILE - ASSET_GROUP + - CATALOG default: AD_ACCOUNT example: AD_ACCOUNT query_search_query: @@ -31765,6 +34464,21 @@ components: example: RATIO enum: - RATIO + query_sort_billing_invoice: + name: sort + in: query + description: Field of which to sort billing invoices + required: false + schema: + type: string + example: DUE_DATE + default: DUE_DATE + enum: + - DUE_DATE + - BILLING_PERIOD + - DOCUMENT_TYPE + - TOTAL_AMOUNT + - INVOICE_NUMBER query_sort_by: description: Specify sorting order for metrics explode: false @@ -32032,4 +34746,54 @@ components: type will be returned. required: false schema: - $ref: '#/components/schemas/InviteType' \ No newline at end of file + $ref: '#/components/schemas/InviteType' + aggregate_report_rows: + in: query + description: Determines if report rows should be aggregated across all requested + entities. This feature is currently in BETA and is not available to all users. + name: aggregate_report_rows + required: false + schema: + type: boolean + default: false + AdAccountId: + name: ad_account_id + in: path + required: true + description: Unique identifier of an ad account. + schema: + type: string + pattern: ^\d+$ + maxLength: 18 + Resource.BookmarkParams.order: + name: order + in: query + required: false + description: "The order in which to sort the items returned: \u201CASCENDING\u201D\ + \ or \u201CDESCENDING\u201D\nby ID. Note that higher-value IDs are associated\ + \ with more-recently added\nitems." + schema: + type: string + enum: + - ASCENDING + - DESCENDING + default: ASCENDING + Resource.BookmarkParams.page_size: + name: page_size + in: query + required: false + description: Maximum number of items to include in a single page of the response. + See documentation on Pagination + for more information. + schema: + type: integer + minimum: 1 + maximum: 250 + default: 25 + Resource.BookmarkParams.bookmark: + name: bookmark + in: query + required: false + description: Cursor used to fetch the next page of items + schema: + type: string