This represents a mapping from app type targeting criteria to a bid price adjustment. Multiplier values must be between 0 and 10. A value of 10 represents a 900% increase in bid price (from $1 to $10 for example). A value of 0 will stop distribution for this item on the specified app type in `MAX_BID` ad groups in `CATALOG_SALES` campaigns. All app type multipliers must be set at the same time. If a multiplier is not provided it is assumed to be 1 (no bid adjustment).
This represents a mapping from placement to a bid price adjustment. Multiplier values must be between 0 and 10. A value of 10 represents a 900% increase in bid price (from $1 to $10 for example). A value of 0 will stop distribution for this item on the specified placement in `MAX_BID` ad groups in `CATALOG_SALES` campaigns. All placement multipliers must be set at the same time. If a multiplier is not provided it is assumed to be 1 (no bid adjustment).
Board model containing properties related to a Pinterest Board.
Metadata of the member/partner that has access to the asset.
Pin model containing properties related to a Pinterest Pin.
Ad group targeting specification defining the ad group target audience. For example, `{"APPTYPE":["iphone"], "GENDER":["male"], "LOCALE":["en-US"], "LOCATION":["501"], "MINIMUM_AGE":"18", "MAXIMUM_AGE":"65+"}`
Third-party tracking URLs. Up to three tracking URLs - with a max length of 2,000 - are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. For more information, see Third-party and dynamic tracking.
Object describing an item batch record to create items
Object describing an item batch record to discontinue items
Object describing an item batch record to update items
Object describing an item batch record to upsert items
Object describing an item batch record to delete items
Request for a brand, category, SKU report
Per-ad, per-day analytics row produced by the ad_daily_stats harness entity.
This field includes all quiz data including questions, options, and results.
This field contains multiple options to a quiz question.
The result, and link out, based on the user’s choice.
Object describing an item bid option operation
Object uniquely identifying a retail catalog item
Request object used to get bid options values for a batch of retail catalog items
Response object containing item bid options
Object describing a retail catalog item's bid options (bid price and bid multipliers).
Request containing operations to perform on bid prices and bid multipliers for a batch of retail catalog items
Advanced Auction Items Submit Upsert Record
Object describing an item bid option upsert operation
Error which occurred when applying a bid options operation to a specific item.
Advanced Auction Items Submit Delete Record
Object describing an item bid option deletion operation
Response object containing the results of an operation on an item bid option
Demographic detail for a single audience demographic
JSON object defining targeted audience users. Example rule formats per audience type: CUSTOMER_LIST: { "customer_list_id": "<customer list ID>"} ACTALIKE: { "seed_id": ["<audience ID>"], "country": "US", "percentage": "10" } (Valid countries include: "US", "CA", and "GB". Percentage should be 1-10. The targeted audience should be this % size across Pinterest.) VISITOR: { "visitor_source_id": ["<conversion tag ID>"], "retention_days": "180", "event_source": {"=": ["web", "mobile"]}, "ingestion_source": {"=": ["tag"]}} (Retention days should be 1-540. Retention applies to specific customers.) ENGAGEMENT: {"engagement_domain": ["www.example.com"], "engager_type": 1} Learn more about engagement audiences.
Optional for VISITOR `audience_type`. With the Pinterest tag, you can use event data to capture event details from your website. This object lists all the available predefined event data fields in the Pinterest tag. You can include these event data fields as part of a VISITOR audience’s `rule`; however, you **must** specify an `event` for the `event_data` fields to be evaluated. Besides what’s listed, you can also create your own set of `event_data` fields and define their usages or purposes according to your website needs. However, the benefit of using the predefined event data fields is that we can provide various metrics based on those fields' data. Examples per `event` type: `pagevisit` "event_data": { "page_name": "My online store 123 | view items | shoe" } `signup` "event_data": { "lead_type": "New release promotion" } `checkout` "event_data": { "value": 116, "order_quantity": 2, "currency": "USD", "line_items": [ { "product_name": "Pillows (Set of 2)", "product_id": "11", "product_price": 48, "product_quantity": 1 }, { "product_name": "Pillows, Large (Set of 2)", "product_id": "15", "product_price": 68, "product_quantity": 1 } ] } `addtocart` "event_data": { "value": 499, "order_quantity": 1, "currency": "USD", "line_items": [ { "product_name": "Red leather boots", "product_id": "3486", "product_category": "shoe", "product_variant_id": "JB11103000", "product_price": 499, "product_quantity": "1", "product_brand": "My brand" }]} `watchvideo` "event_data": { "video_title": "My Product Video 01" } `lead` "event_data": { "lead_type": "Newsletter" }
Sections help organize pins within a board.
Resource create or update operation model.
Object describing the campaign level bid multipliers.
This represents a mapping from Audience ID to a bid price adjustment. Multiplier values must be between 0 and 10. A value of 10 represents a 900% increase in bid price (from $1 to $10 for example). A value of 0 will stop distribution for this item on the specified audience in `MAX_BID` ad groups in `CATALOG_SALES` campaigns. All audience multipliers must be set at the same time. If a multiplier is not provided it is assumed to be 1 (no bid adjustment).
Catalogs Product Group Multiple String Criteria
Two set of objects to be managed asyncronusly by bulk. One for creations, one for modifications.
Request for creation of entities in bulk.
Request object for creating a product group.
Catalogs Product Group Filters Request Any Of1
Catalogs Product Group Currency Criteria
A currency filter. This filter cannot be negated
Catalogs Product Group Filter Operator Type Criteria
Catalogs Product Group Multiple Gender Criteria
Catalogs Product Group Multiple Media Types Criteria
Catalogs Product Group Multiple String List Criteria
Catalogs Product Group Filters Request Any Of2
Catalogs Retail Product Group Create Request
Catalogs Hotel Product Group Create Request
Request object for creating a hotel product group.
Catalogs Hotel Product Group Filters Any Of
Catalogs Product Group Multiple Countries Criteria
Catalogs Hotel Product Group Filters All Of
Catalogs Creative Assets Product Group Create Request
Request object for creating a creative assets product group.
Catalogs Creative Assets Product Group Filters Any Of
Catalogs Creative Assets Product Group Filters All Of
Object describing an update to the campaign level bid multipliers.
Request object for updating a product group.
Catalogs Retail Product Group Update Request
Request object for updating a retail product group.
Catalogs Hotel Product Group Update Request
Request object for updating a hotel product group.
Catalogs Creative Assets Product Group Update Request
Request object for updating a creative assets product group.
An object containing the permissions a business member has on the asset.
Delete Partner Assets Results Response Array
An object with a list of all the new accesses.
Delete Member Access Results Response Array
Request body used to delete asset groups
Update Member Assets Results Response Array
An object containing the permissions a business member/partner has on the asset.
An object containing the permissions a business partner has on the asset.
Update Partner Assets Results Response Array
An object with a list of all the invites the user would like to respond to and the action to take.
An object containing a list of all the asset access requests
Create Membership Or Partnership Invites Body
Body to be used on path to send Members or Partners Invite or Request
Ad accounts and profiles the member/partner will be granted access to with this invite/request.
An exception object if there is an error performing the action. Will only be provided if there is an error.
An invite object if the invite/request was successfully updated. Will only be provided if the an invite/request is successfully updated.
Object declaring an asset role update to an invite.
Request body for updating asset roles for existing invites.
Response to delete invites sent to Members or Partners, if there is an exception, return the exception mapped with the invite id
Ad accounts and profiles the business member/partner has access to.
Single instance of a business member to have its role updated
An object with a list of members that were deleted.
An object with a list of partners that were deleted.
This field is **OPTIONAL**. Use this if your feed file requires username and password.
Daily processing schedule. This field is **OPTIONAL**. Use this to configure the preferred time for processing a feed (otherwise random).
The counts can be null early in the process.
Counts of total, ingested, and not ingested videos in the feed file. The counts may not appear early in the process.
Request object for creating a feed. Please, be aware that "default_country" and "default_locale" are not required in the spec for forward compatibility but for now the API will not accept requests without those fields.
Request object for creating a retail feed.
Catalogs Creative Assets Feeds Create Request
Catalogs Creative Assets Feeds Update Request
Object describing the catalogs items batch
If specified, you must provide all properties
Catalogs Creative Assets Items Post Filter
Object describing an item validation event
Catalogs Creative Assets Item Error Response
Object describing a creative assets item error
Catalogs Updatable Creative Assets Attributes
Object describing the catalogs creative assets items batch
Object describing an item processing record
Object describing the catalogs hotel items batch
Object describing the catalogs retail items batch
Catalogs Items Delete Discontinued Batch Request
Request object to discontinue catalogs items
A request object that can have multiple operations on a single retail batch
Request object to update catalogs hotel items
Object describing an hotel item batch record
Request object to update catalogs creative assets items
Catalogs Product Group Product Counts Vertical
Product counts for a CatalogsProductGroup
Catalogs List Products By Feed Based Filter
Request object to list products for a given feed_id and product group filter.
Catalogs Retail List Products By Catalog Based Filter Request
Request object to list products for a given retail catalog_id and product group filter.
Catalogs Hotel List Products By Catalog Based Filter Request
Request object to list products for a given hotel catalog_id and product group filter.
Catalogs Creative Assets List Products By Catalog Based Filter Request
Request object to list products for a given creative assets catalog_id and product group filter.
Catalogs Hotel Product Group Product Counts
Product counts for a Hotel CatalogsProductGroup
Catalogs Creative Assets Product Group Product Counts
Product counts for a Creative Assets CatalogsProductGroup
Catalogs Retail Product Group Product Counts
Product counts for a Retail CatalogsProductGroup
Catalogs Creative Assets Product Metadata
Catalogs Report Distribution Issue Filter
Catalogs Creative Assets Available Filter Values
Set of quality components, with each component containing a event coverage and details.
Metrics for a specific event type within a quality component.
Details of an issue with a quality component.
Schema describing the object in the response, which contains information about the events that were received and processed.
A list of events (one or more) encapsulated by a data object.
Object containing information about the application where event occurred.
Object containing information about the device where event occurred.
Schema for log sent from an integration application.
System error details included in the log sent by the client.
HTTP request details included in the log sent by the client.
Batch of logs sent from an integration application.
Response when logs are successfully processed.
Schema used for creating the integration metadata.
Schema used for updating the integration metadata.
Lead Subscription Post Params Create Partner Metadata All Of1
Request to create test data for lead data test API.
Media upload that has been registered but not uploaded/processed yet.
Object containing the MSOT conversion events.
Multiple Base64-based images media source
Pin URL-based media source for product pin creation. Currently the field is only available to a list of beta users.
Age and gender distribution who engaged with this product category in the past 3 months
Key performance metrics highlights for this product category
Inner Product Categories Metrics Highlights
Featured trending topics for a specific interest and market
Individual trending topic within an interest category
Single Interest Targeting Option Response
Gets an audience size estimate for a set of given targeting spec data. Returns: An object containing an audience size estimate that has a reach estimate (number of unique users) against the given targeting template. This by default provides a monthly estimate.
Ad group billable event type. For update, only draft ad groups may update billable event.
Audience operation type (update or remove).
The operation performed by the batch. The DELETE_DISCONTINUED operation only updates availablity to "Out of Stock".
The status of the operation performed by the batch
Budget type. If DAILY, an ad group's daily spend will not exceed the budget parameter value. If LIFETIME, the end_time parameter is **REQUIRED**, and the ad group spend is spread evenly between the ad group `start_time` and `end_time` range. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. For CBO campaigns, only "CBO_ADGROUP" is allowed. For WEB_SESSIONS campaigns, only "LIFETIME" is allowed. For update, only draft ad groups may update budget type.
Refers ads entity type. Schedule enum is only applicable to beta users
Possible status for a bulk reporting job
Specifies if the partner is internal or external.
The access level a member has to the business. Values are case-sensitive. - EMPLOYEE: Can only view and access assets you assign to them. They cannot see details about other employees, partners, or other assets. - BIZ_ADMIN: Have full control of roles and can add employees and partners as well as grant asset access.
Catalog hotel product group type MERCHANT_CREATED: Product groups created by merchants. ALL_LISTINGS: Includes every hotel item in your catalog.
Catalog product group type MERCHANT_CREATED: Product groups created by merchants. ALL_PRODUCTS: Consists of every product in your latest successful feed upload. BEST_DEALS: Consists of products with the deepest drop in price. PINNER_FAVORITES: Consists of products that are resonating most with people on Pinterest, based on engagement. TOP_SELLERS: Consists of products with the highest conversion rate, if you have the conversion tag installed. BACK_IN_STOCK: Consists of products that were previously out of stock and are now in stock. NEW_ARRIVALS: Consists of products that are new to your Catalog. SHOPIFY_COLLECTION: Product groups created based on Shopify Product Collections. I2PC: Product groups created based on predicted product category.
Status for catalogs entities. Present in catalogs_feed values. When a feed is deleted, the response will inform DELETED as status.
Total Offline Conversion Product Quantity
Total Web Conversion Product Value In Usd
Total Inapp Conversion Product Value In Usd
Total Offline Conversion Product Value In Usd
Total Checkout Conversion Product Quantity
Total Checkout Conversion Product Value In Usd
Total Web Checkout Conversion Product Quantity
Total Web Checkout Conversion Product Value
Total Web Checkout Conversion Product Value In Usd
Total Inapp Checkout Conversion Product Quantity
Total Inapp Checkout Conversion Product Value
Total Inapp Checkout Conversion Product Value In Usd
Total Offline Checkout Conversion Product Quantity
Total Offline Checkout Conversion Product Value
Total Offline Checkout Conversion Product Value In Usd
Total Add To Cart Conversion Product Quantity
Total Add To Cart Conversion Product Value
Total Add To Cart Conversion Product Value In Usd
Total Web Add To Cart Conversion Product Quantity
Total Web Add To Cart Conversion Product Value
Total Web Add To Cart Conversion Product Value In Usd
Total Inapp Add To Cart Conversion Product Quantity
Total Inapp Add To Cart Conversion Product Value
Total Inapp Add To Cart Conversion Product Value In Usd
Total Page Visit Conversion Product Quantity
Total Page Visit Conversion Product Value
Total Page Visit Conversion Product Value In Usd
Total Web Page Visit Conversion Product Quantity
Total Web Page Visit Conversion Product Value
Total Web Page Visit Conversion Product Value In Usd
Total Signup Conversion Product Quantity
Total Signup Conversion Product Value In Usd
Total Web Signup Conversion Product Quantity
Total Web Signup Conversion Product Value
Total Web Signup Conversion Product Value In Usd
Total Inapp Signup Conversion Product Quantity
Total Inapp Signup Conversion Product Value
Total Inapp Signup Conversion Product Value In Usd
Total Offline Signup Conversion Product Quantity
Total Offline Signup Conversion Product Value
Total Offline Signup Conversion Product Value In Usd
Total Watch Video Conversion Product Quantity
Total Watch Video Conversion Product Value
Total Watch Video Conversion Product Value In Usd
Total Web Watch Video Conversion Product Quantity
Total Web Watch Video Conversion Product Value
Total Web Watch Video Conversion Product Value In Usd
Total Lead Conversion Product Value In Usd
Total Web Lead Conversion Product Quantity
Total Web Lead Conversion Product Value In Usd
Total Offline Lead Conversion Product Quantity
Total Offline Lead Conversion Product Value
Total Offline Lead Conversion Product Value In Usd
Total Search Conversion Product Quantity
Total Search Conversion Product Value In Usd
Total Web Search Conversion Product Quantity
Total Web Search Conversion Product Value
Total Web Search Conversion Product Value In Usd
Total Inapp Search Conversion Product Quantity
Total Inapp Search Conversion Product Value
Total Inapp Search Conversion Product Value In Usd
Total View Category Conversion Product Quantity
Total View Category Conversion Product Value
Total View Category Conversion Product Value In Usd
Total Web View Category Conversion Product Quantity
Total Web View Category Conversion Product Value
Total Web View Category Conversion Product Value In Usd
Total Custom Conversion Product Quantity
Total Custom Conversion Product Value In Usd
Total Web Custom Conversion Product Quantity
Total Web Custom Conversion Product Value
Total Web Custom Conversion Product Value In Usd
Total Offline Custom Conversion Product Quantity
Total Offline Custom Conversion Product Value
Total Offline Custom Conversion Product Value In Usd
Total Unknown Conversion Product Quantity
Total Unknown Conversion Product Value In Usd
Total Web Unknown Conversion Product Quantity
Total Web Unknown Conversion Product Value
Total Web Unknown Conversion Product Value In Usd
Total Inapp Unknown Conversion Product Quantity
Total Inapp Unknown Conversion Product Value
Total Inapp Unknown Conversion Product Value In Usd
Total Offline Unknown Conversion Product Quantity
Total Offline Unknown Conversion Product Value
Total Offline Unknown Conversion Product Value In Usd
Total Add Payment Info Conversion Product Quantity
Total Add Payment Info Conversion Product Value
Total Add Payment Info Conversion Product Value In Usd
Total Web Add Payment Info Conversion Product Quantity
Total Web Add Payment Info Conversion Product Value
Total Web Add Payment Info Conversion Product Value In Usd
Total Inapp Add Payment Info Conversion Product Quantity
Total Inapp Add Payment Info Conversion Product Value
Total Inapp Add Payment Info Conversion Product Value In Usd
Total Offline Add Payment Info Conversion Product Quantity
Total Offline Add Payment Info Conversion Product Value
Total Offline Add Payment Info Conversion Product Value In Usd
Total Add To Wishlist Conversion Product Quantity
Total Add To Wishlist Conversion Product Value
Total Add To Wishlist Conversion Product Value In Usd
Total Web Add To Wishlist Conversion Product Quantity
Total Web Add To Wishlist Conversion Product Value
Total Web Add To Wishlist Conversion Product Value In Usd
Total Inapp Add To Wishlist Conversion Product Quantity
Total Inapp Add To Wishlist Conversion Product Value
Total Inapp Add To Wishlist Conversion Product Value In Usd
Total Offline Add To Wishlist Conversion Product Quantity
Total Offline Add To Wishlist Conversion Product Value
Total Offline Add To Wishlist Conversion Product Value In Usd
Total Initiate Checkout Conversion Product Quantity
Total Initiate Checkout Conversion Product Value
Total Initiate Checkout Conversion Product Value In Usd
Total Web Initiate Checkout Conversion Product Quantity
Total Web Initiate Checkout Conversion Product Value
Total Web Initiate Checkout Conversion Product Value In Usd
Total Inapp Initiate Checkout Conversion Product Quantity
Total Inapp Initiate Checkout Conversion Product Value
Total Inapp Initiate Checkout Conversion Product Value In Usd
Total Offline Initiate Checkout Conversion Product Quantity
Total Offline Initiate Checkout Conversion Product Value
Total Offline Initiate Checkout Conversion Product Value In Usd
Total Subscribe Conversion Product Quantity
Total Subscribe Conversion Product Value
Total Subscribe Conversion Product Value In Usd
Total Web Subscribe Conversion Product Quantity
Total Web Subscribe Conversion Product Value
Total Web Subscribe Conversion Product Value In Usd
Total Inapp Subscribe Conversion Product Quantity
Total Inapp Subscribe Conversion Product Value
Total Inapp Subscribe Conversion Product Value In Usd
Total Offline Subscribe Conversion Product Quantity
Total Offline Subscribe Conversion Product Value
Total Offline Subscribe Conversion Product Value In Usd
Total View Content Conversion Product Quantity
Total View Content Conversion Product Value
Total View Content Conversion Product Value In Usd
Total Web View Content Conversion Product Quantity
Total Web View Content Conversion Product Value
Total Web View Content Conversion Product Value In Usd
Total Inapp View Content Conversion Product Quantity
Total Inapp View Content Conversion Product Value
Total Inapp View Content Conversion Product Value In Usd
Total Offline View Content Conversion Product Quantity
Total Offline View Content Conversion Product Value
Total Offline View Content Conversion Product Value In Usd
Attribution type. Refers to the Pinterest Tag endpoints
Ad creative type enum. **Note:** SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.
Select a call to action (CTA) to display below your ad. Available only for ads with direct links enabled. CTA options for consideration and conversion campaigns are LEARN_MORE, SHOP_NOW, BOOK_NOW, SIGN_UP, VISIT_SITE, BUY_NOW, GET_OFFER, ORDER_NOW, ADD_TO_CART (for conversion campaigns with add to cart conversion events only)
Before Audience Monthly Metric Start Date
Purchasers Metric Smaller Than Threshold
Type of information in the page referenced by `disclosure_url`, provided either by the Food and Drug Administration (FDA) or the manufacturer.
Specifies the time interval at which analytics data is broken down. Determines how metrics are grouped within the requested date range. **Note:** The `HOUR` enum no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums are unchanged.
Where a user is taken after clicking on an ad in grid. Note: This parameter is read-only and is set to DIRECT_TO_DESTINATION by default for direct links supported ads. grid_click_type values provided will be ignored.
List of ingestion sources for a conversion event.
The type of invite. 'MEMBER_INVITE' is to invite a member to access your business assets. 'PARTNER INVITE' is to invite a partner to access your business assets. 'PARTNER_REQUEST' is to request access a partner's business assets.
The status of the item processing record
The new status you want to give the label, either `ACTIVE` (in use) or no longer in use (`ARCHIVED`).
Category for the labeled items. You can apply one BRAND label to a campaign. You can apply 30 CUSTOM labels to a campaign.
Language code, which is among the official ISO 639-1 language list.
Days in lookback window in the GET Conversion EQS response.
Marketing Mix Modeling (MMM) Reporting Columns
Intended result of the campaign. You can only update objectives for draft campaigns. `WEB_SESSIONS` and `VIDEO_VIEW` objectives are deprecated. We recommend using `VIDEO_COMPLETION` as an alternative for the latter.
Operation type to share a specific audience or revoke access to a previously shared audience
Ad group pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a day. When using CBO, only the STANDARD pacing delivery type is allowed.
Default availability for products in a feed.
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.
Total Engagement Page Visit Value In Micro Dollar
Total Engagement Signup Value In Micro Dollar
Total Engagement Checkout Value In Micro Dollar
Total Engagement Custom Value In Micro Dollar
Total Engagement Add To Cart Value In Micro Dollar
Total Engagement Lead Value In Micro Dollar
Total Engagement Search Value In Micro Dollar
Total Engagement Watch Video Value In Micro Dollar
Total Engagement View Category Value In Micro Dollar
Total Engagement App Install Value In Micro Dollar
Total Engagement Unknown Value In Micro Dollar
Total Click Page Visit Value In Micro Dollar
Total Click Signup Value In Micro Dollar
Total Click Checkout Value In Micro Dollar
Total Click Custom Value In Micro Dollar
Total Click Add To Cart Value In Micro Dollar
Total Click Search Value In Micro Dollar
Total Click Watch Video Value In Micro Dollar
Total Click View Category Value In Micro Dollar
Total Click App Install Value In Micro Dollar
Total Click Unknown Value In Micro Dollar
Total View Page Visit Value In Micro Dollar
Total View Checkout Value In Micro Dollar
Total View Add To Cart Value In Micro Dollar
Total View Watch Video Value In Micro Dollar
Total View View Category Value In Micro Dollar
Total View App Install Value In Micro Dollar
Total View Unknown Value In Micro Dollar
Total Page Visit Desktop Action To Desktop Conversion
Total Page Visit Desktop Action To Mobile Conversion
Total Page Visit Desktop Action To Tablet Conversion
Total Page Visit Mobile Action To Desktop Conversion
Total Page Visit Mobile Action To Mobile Conversion
Total Page Visit Mobile Action To Tablet Conversion
Total Page Visit Tablet Action To Desktop Conversion
Total Page Visit Tablet Action To Mobile Conversion
Total Page Visit Tablet Action To Tablet Conversion
Total Signup Desktop Action To Desktop Conversion
Total Signup Desktop Action To Mobile Conversion
Total Signup Desktop Action To Tablet Conversion
Total Signup Mobile Action To Desktop Conversion
Total Signup Mobile Action To Mobile Conversion
Total Signup Mobile Action To Tablet Conversion
Total Signup Tablet Action To Desktop Conversion
Total Signup Tablet Action To Mobile Conversion
Total Signup Tablet Action To Tablet Conversion
Total Checkout Desktop Action To Desktop Conversion
Total Checkout Desktop Action To Mobile Conversion
Total Checkout Desktop Action To Tablet Conversion
Total Checkout Mobile Action To Desktop Conversion
Total Checkout Mobile Action To Mobile Conversion
Total Checkout Mobile Action To Tablet Conversion
Total Checkout Tablet Action To Desktop Conversion
Total Checkout Tablet Action To Mobile Conversion
Total Checkout Tablet Action To Tablet Conversion
Total Custom Desktop Action To Desktop Conversion
Total Custom Desktop Action To Mobile Conversion
Total Custom Desktop Action To Tablet Conversion
Total Custom Mobile Action To Desktop Conversion
Total Custom Mobile Action To Mobile Conversion
Total Custom Mobile Action To Tablet Conversion
Total Custom Tablet Action To Desktop Conversion
Total Custom Tablet Action To Mobile Conversion
Total Custom Tablet Action To Tablet Conversion
Total Add To Cart Desktop Action To Desktop Conversion
Total Add To Cart Desktop Action To Mobile Conversion
Total Add To Cart Desktop Action To Tablet Conversion
Total Add To Cart Mobile Action To Desktop Conversion
Total Add To Cart Mobile Action To Mobile Conversion
Total Add To Cart Mobile Action To Tablet Conversion
Total Add To Cart Tablet Action To Desktop Conversion
Total Add To Cart Tablet Action To Mobile Conversion
Total Add To Cart Tablet Action To Tablet Conversion
Total Lead Desktop Action To Desktop Conversion
Total Lead Desktop Action To Mobile Conversion
Total Lead Desktop Action To Tablet Conversion
Total Lead Mobile Action To Desktop Conversion
Total Lead Mobile Action To Mobile Conversion
Total Lead Mobile Action To Tablet Conversion
Total Lead Tablet Action To Desktop Conversion
Total Lead Tablet Action To Mobile Conversion
Total Lead Tablet Action To Tablet Conversion
Total Search Desktop Action To Desktop Conversion
Total Search Desktop Action To Mobile Conversion
Total Search Desktop Action To Tablet Conversion
Total Search Mobile Action To Desktop Conversion
Total Search Mobile Action To Mobile Conversion
Total Search Mobile Action To Tablet Conversion
Total Search Tablet Action To Desktop Conversion
Total Search Tablet Action To Mobile Conversion
Total Search Tablet Action To Tablet Conversion
Total Watch Video Desktop Action To Desktop Conversion
Total Watch Video Desktop Action To Mobile Conversion
Total Watch Video Desktop Action To Tablet Conversion
Total Watch Video Mobile Action To Desktop Conversion
Total Watch Video Mobile Action To Mobile Conversion
Total Watch Video Mobile Action To Tablet Conversion
Total Watch Video Tablet Action To Desktop Conversion
Total Watch Video Tablet Action To Mobile Conversion
Total Watch Video Tablet Action To Tablet Conversion
Total View Category Desktop Action To Desktop Conversion
Total View Category Desktop Action To Mobile Conversion
Total View Category Desktop Action To Tablet Conversion
Total View Category Mobile Action To Desktop Conversion
Total View Category Mobile Action To Mobile Conversion
Total View Category Mobile Action To Tablet Conversion
Total View Category Tablet Action To Desktop Conversion
Total View Category Tablet Action To Mobile Conversion
Total View Category Tablet Action To Tablet Conversion
Total App Install Desktop Action To Desktop Conversion
Total App Install Desktop Action To Mobile Conversion
Total App Install Desktop Action To Tablet Conversion
Total App Install Mobile Action To Desktop Conversion
Total App Install Mobile Action To Mobile Conversion
Total App Install Mobile Action To Tablet Conversion
Total App Install Tablet Action To Desktop Conversion
Total App Install Tablet Action To Mobile Conversion
Total App Install Tablet Action To Tablet Conversion
Total Unknown Desktop Action To Desktop Conversion
Total Unknown Desktop Action To Mobile Conversion
Total Unknown Desktop Action To Tablet Conversion
Total Unknown Mobile Action To Desktop Conversion
Total Unknown Mobile Action To Mobile Conversion
Total Unknown Mobile Action To Tablet Conversion
Total Unknown Tablet Action To Desktop Conversion
Total Unknown Tablet Action To Mobile Conversion
Total Unknown Tablet Action To Tablet Conversion
Total View Category Value In Micro Dollar
Total Web Checkout Value In Micro Dollar
Total Web Click Checkout Value In Micro Dollar
Total Web Engagement Checkout Value In Micro Dollar
Total Web View Checkout Value In Micro Dollar
Total Inapp Checkout Value In Micro Dollar
Total Inapp Click Checkout Value In Micro Dollar
Total Inapp Engagement Checkout Value In Micro Dollar
Total Inapp View Checkout Value In Micro Dollar
Total Offline Checkout Value In Micro Dollar
Total Offline Click Checkout Value In Micro Dollar
Total Offline Engagement Checkout Value In Micro Dollar
Total Offline View Checkout Value In Micro Dollar
Total Pinterest Checkout Value In Micro Dollar
Total Web Add To Cart Value In Micro Dollar
Total Web Click Add To Cart Value In Micro Dollar
Total Web Engagement Add To Cart Value In Micro Dollar
Total Web View Add To Cart Value In Micro Dollar
Total Inapp Add To Cart Value In Micro Dollar
Total Inapp Click Add To Cart Value In Micro Dollar
Total Inapp Engagement Add To Cart Value In Micro Dollar
Total Inapp View Add To Cart Value In Micro Dollar
Total Web Page Visit Value In Micro Dollar
Total Web Click Page Visit Value In Micro Dollar
Total Web Engagement Page Visit Value In Micro Dollar
Total Web View Page Visit Value In Micro Dollar
Total Web Click Signup Value In Micro Dollar
Total Web Engagement Signup Value In Micro Dollar
Total Web View Signup Value In Micro Dollar
Total Inapp Signup Value In Micro Dollar
Total Inapp Click Signup Value In Micro Dollar
Total Inapp Engagement Signup Value In Micro Dollar
Total Inapp View Signup Value In Micro Dollar
Total Offline Signup Value In Micro Dollar
Total Offline Click Signup Value In Micro Dollar
Total Offline Engagement Signup Value In Micro Dollar
Total Offline View Signup Value In Micro Dollar
Total Web Watch Video Value In Micro Dollar
Total Web Click Watch Video Value In Micro Dollar
Total Web Engagement Watch Video Value In Micro Dollar
Total Web View Watch Video Value In Micro Dollar
Total Web Click Lead Value In Micro Dollar
Total Web Engagement Lead Value In Micro Dollar
Total Web View Lead Value In Micro Dollar
Total Offline Lead Value In Micro Dollar
Total Offline Click Lead Value In Micro Dollar
Total Offline Engagement Lead Value In Micro Dollar
Total Offline View Lead Value In Micro Dollar
Total Web Click Search Value In Micro Dollar
Total Web Engagement Search Value In Micro Dollar
Total Web View Search Value In Micro Dollar
Total Inapp Search Value In Micro Dollar
Total Inapp Click Search Value In Micro Dollar
Total Inapp Engagement Search Value In Micro Dollar
Total Inapp View Search Value In Micro Dollar
Total Web View Category Value In Micro Dollar
Total Web Click View Category Value In Micro Dollar
Total Web Engagement View Category Value In Micro Dollar
Total Web View View Category Value In Micro Dollar
Total Web Click Custom Value In Micro Dollar
Total Web Engagement Custom Value In Micro Dollar
Total Web View Custom Value In Micro Dollar
Total Offline Custom Value In Micro Dollar
Total Offline Click Custom Value In Micro Dollar
Total Offline Engagement Custom Value In Micro Dollar
Total Offline View Custom Value In Micro Dollar
Total Web Click Unknown Value In Micro Dollar
Total Web Engagement Unknown Value In Micro Dollar
Total Web View Unknown Value In Micro Dollar
Total Inapp Unknown Value In Micro Dollar
Total Inapp Click Unknown Value In Micro Dollar
Total Inapp Engagement Unknown Value In Micro Dollar
Total Inapp View Unknown Value In Micro Dollar
Total Offline Unknown Value In Micro Dollar
Total Offline Click Unknown Value In Micro Dollar
Total Offline Engagement Unknown Value In Micro Dollar
Total Offline View Unknown Value In Micro Dollar
Total Inapp App Install Value In Micro Dollar
Total Inapp Click App Install Value In Micro Dollar
Total Inapp Engagement App Install Value In Micro Dollar
Total Inapp View App Install Value In Micro Dollar
Showcase Average Subpage Closeup Per Session
[Closed beta](/docs/getting-started/using-beta-and-restricted-features/) Specify the timezone to be applied for the reporting.
An internal role type used on business access, EMPLOYEE, ADMIN.
List of source platforms for a conversion event.
Advertiser's ISO two character country code.
bid option field to apply operation updates to
The field types supported by the update mask
User list operation type (add or remove)
List of verticals for product categories.
Query alias: 2 models declare acceptedTermsId.
Query alias: 2 models declare accessToken.
Query alias: 1 model declares ACCOUNT_FLAGGED.
Query alias: 1 model declares accountId.
Query alias: 1 model declares accountName.
Query alias: 2 models declare accountType.
Query alias: 1 model declares actionTimestamps.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_CONTENT_READ_ERROR.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_DNS_LOOKUP_ERROR.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_FILE_NOT_ACCESSIBLE.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_FILE_NOT_FOUND.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS400.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS403.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS404.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS405.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS410.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS429.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS500.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS502.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS503.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS504.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS507.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS508.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS520.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS521.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS522.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_HTTP_STATUS525.
ad image download internal configuration error
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_INTERNAL_CONFIGURATION_ERROR.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_INTERNAL_ERROR.
ad image download internal failed to download
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_INTERNAL_FAILED_TO_DOWNLOAD.
ad image download internal malformed url
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_INTERNAL_MALFORMED_URL.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_INTERNAL_RATE_LIMITED.
ad image download internal request expired
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_INTERNAL_REQUEST_EXPIRED.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_INVALID_FILE.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_SITE_ERROR.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_SITE_TIMEOUT.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_SSL_ERROR.
Query alias: 1 model declares AD_IMAGE_DOWNLOAD_SSL_HANDSHAKE_ERROR.
Query alias: 1 model declares AD_IMAGE_PROCESSING_EMPTY_FILE.
Query alias: 1 model declares AD_IMAGE_PROCESSING_HEIGHT_TOO_SMALL.
Query alias: 1 model declares AD_IMAGE_PROCESSING_TOO_MANY_PIXELS.
Query alias: 1 model declares AD_IMAGE_PROCESSING_TYPE_MISMATCH.
Query alias: 1 model declares AD_IMAGE_PROCESSING_WIDTH_TOO_SMALL.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_CONTENT_READ_ERROR.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_DNS_LOOKUP_ERROR.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_FILE_NOT_ACCESSIBLE.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_FILE_NOT_FOUND.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS400.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS403.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS404.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS405.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS410.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS429.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS500.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS502.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS503.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS504.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS507.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS508.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS520.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS521.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS522.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_HTTP_STATUS525.
ad video download internal configuration error
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_INTERNAL_CONFIGURATION_ERROR.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_INTERNAL_ERROR.
ad video download internal failed to download
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_INTERNAL_FAILED_TO_DOWNLOAD.
ad video download internal malformed url
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_INTERNAL_MALFORMED_URL.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_INTERNAL_RATE_LIMITED.
ad video download internal request expired
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_INTERNAL_REQUEST_EXPIRED.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_INVALID_FILE.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_SITE_ERROR.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_SITE_TIMEOUT.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_SSL_ERROR.
Query alias: 1 model declares AD_VIDEO_DOWNLOAD_SSL_HANDSHAKE_ERROR.
Query alias: 1 model declares AD_VIDEO_LENGTH_TOO_SHORT.
Query alias: 1 model declares AD_VIDEO_PROCESSING_EMPTY_FILE.
Query alias: 1 model declares AD_VIDEO_PROCESSING_HEIGHT_TOO_SMALL.
Query alias: 1 model declares AD_VIDEO_PROCESSING_TOO_MANY_PIXELS.
Query alias: 1 model declares AD_VIDEO_PROCESSING_TYPE_MISMATCH.
Query alias: 1 model declares AD_VIDEO_PROCESSING_WIDTH_TOO_SMALL.
Query alias: 26 models declare adAccountId.
Query alias: 1 model declares adAccountName.
Query alias: 1 model declares adAccountsIds.
Query alias: 1 model declares ADDITIONAL_IMAGE_FILE_NOT_ACCESSIBLE.
Query alias: 1 model declares ADDITIONAL_IMAGE_FILE_NOT_FOUND.
Query alias: 1 model declares ADDITIONAL_IMAGE_INVALID_FILE.
Query alias: 1 model declares ADDITIONAL_IMAGE_LEVEL_INTERNAL_ERROR.
Query alias: 1 model declares ADDITIONAL_IMAGE_MALFORMED_URL.
Query alias: 4 models declare additionalId1.
Query alias: 1 model declares addresses.
Query alias: 1 model declares addressId.
Query alias: 1 model declares addressPrimary.
Query alias: 1 model declares addressSecondary.
Query alias: 8 models declare adGroupId.
Query alias: 1 model declares adGroupIds.
Query alias: 3 models declare adImage0Link.
Query alias: 3 models declare adImage0Tag.
Query alias: 3 models declare adImage10Link.
Query alias: 3 models declare adImage10Tag.
Query alias: 3 models declare adImage11Link.
Query alias: 3 models declare adImage11Tag.
Query alias: 3 models declare adImage12Link.
Query alias: 3 models declare adImage12Tag.
Query alias: 3 models declare adImage13Link.
Query alias: 3 models declare adImage13Tag.
Query alias: 3 models declare adImage14Link.
Query alias: 3 models declare adImage14Tag.
Query alias: 3 models declare adImage15Link.
Query alias: 3 models declare adImage15Tag.
Query alias: 3 models declare adImage16Link.
Query alias: 3 models declare adImage16Tag.
Query alias: 3 models declare adImage17Link.
Query alias: 3 models declare adImage17Tag.
Query alias: 3 models declare adImage18Link.
Query alias: 3 models declare adImage18Tag.
Query alias: 3 models declare adImage19Link.
Query alias: 3 models declare adImage19Tag.
Query alias: 3 models declare adImage1Link.
Query alias: 3 models declare adImage1Tag.
Query alias: 3 models declare adImage2Link.
Query alias: 3 models declare adImage2Tag.
Query alias: 3 models declare adImage3Link.
Query alias: 3 models declare adImage3Tag.
Query alias: 3 models declare adImage4Link.
Query alias: 3 models declare adImage4Tag.
Query alias: 3 models declare adImage5Link.
Query alias: 3 models declare adImage5Tag.
Query alias: 3 models declare adImage6Link.
Query alias: 3 models declare adImage6Tag.
Query alias: 3 models declare adImage7Link.
Query alias: 3 models declare adImage7Tag.
Query alias: 3 models declare adImage8Link.
Query alias: 3 models declare adImage8Tag.
Query alias: 3 models declare adImage9Link.
Query alias: 3 models declare adImage9Tag.
Query alias: 2 models declare adsManagerOrderLineId.
Query alias: 1 model declares advertiserExternalId.
Query alias: 3 models declare advertiserId.
Query alias: 3 models declare adVideo0Link.
Query alias: 3 models declare adVideo0Tag.
Query alias: 3 models declare adVideo1Link.
Query alias: 3 models declare adVideo1Tag.
Query alias: 3 models declare adVideo2Link.
Query alias: 3 models declare adVideo2Tag.
Query alias: 2 models declare aemDbEnabled.
Query alias: 2 models declare aemEnabled.
Query alias: 2 models declare aemExternalIdEnabled.
Query alias: 2 models declare aemFnlnEnabled.
Query alias: 2 models declare aemGeEnabled.
Query alias: 2 models declare aemLocEnabled.
Query alias: 2 models declare aemPhEnabled.
Query alias: 1 model declares AGE_BUCKET.
Query alias: 4 models declare agencyLink.
Query alias: 1 model declares amountBilledMicroCurrency.
Query alias: 1 model declares amountDiscountMicroCurrency.
Query alias: 1 model declares amountNetMicroCurrency.
Query alias: 1 model declares amountTaxMicroCurrency.
Query alias: 9 models declare androidDeepLink.
Query alias: 1 model declares apiVersion.
Query alias: 1 model declares appPackageName.
Query alias: 4 models declare appTypeMultipliers.
Query alias: 1 model declares appVersion.
Query alias: 1 model declares appVersionNumber.
Query alias: 1 model declares assetGroup.
Query alias: 2 models declare assetGroupDescription.
Query alias: 1 model declares assetGroupInfo.
Query alias: 2 models declare assetGroupName.
Query alias: 1 model declares assetGroupsToDelete.
Query alias: 1 model declares assetGroupsToUpdate.
Query alias: 2 models declare assetGroupTypes.
Query alias: 1 model declares assetIdToPermissions.
Query alias: 1 model declares assetRequests.
Query alias: 3 models declare assetType.
Query alias: 1 model declares attribute.
Query alias: 1 model declares attributeName.
Query alias: 1 model declares attributionModel.
Query alias: 1 model declares attributionScope.
Query alias: 1 model declares attributionScore.
Query alias: 1 model declares attributionTypes.
Query alias: 1 model declares AUDIENCE_EXCLUDE.
Query alias: 1 model declares AUDIENCE_ID.
Query alias: 1 model declares AUDIENCE_INCLUDE.
Query alias: 4 models declare audienceId.
Query alias: 3 models declare audienceMultipliers.
Query alias: 1 model declares audienceSizeLowerBound.
Query alias: 1 model declares audienceSizeUpperBound.
Query alias: 2 models declare audienceType.
Query alias: 1 model declares audienceVerification.
Query alias: 1 model declares autoFollow.
Query alias: 7 models declare autoTargetingEnabled.
Query alias: 4 models declare availability.
Query alias: 1 model declares AVAILABILITY.
Query alias: 3 models declare averageReviewRating.
Query alias: 2 models declare basePrice.
Query alias: 1 model declares batteryLevel.
Query alias: 1 model declares bidFloors.
Query alias: 1 model declares bidFloorSpecs.
Query alias: 3 models declare bidMultiplier.
Query alias: 3 models declare bidStrategyType.
Query alias: 3 models declare billableEvent.
Query alias: 4 models declare billingContactEmail.
Query alias: 4 models declare billingContactFirstname.
Query alias: 4 models declare billingContactLastname.
Query alias: 1 model declares billingPeriodEndDate.
Query alias: 1 model declares billingPeriodStartDate.
Query alias: 1 model declares billingType.
Query alias: 1 model declares billtoBillingAddressId.
Query alias: 1 model declares billtoBusinessAddressId.
Query alias: 1 model declares billtoCompanyId.
Query alias: 1 model declares billToCompanyName.
Query alias: 1 model declares billToCountry.
Query alias: 1 model declares billtoInfos.
Query alias: 1 model declares boardCount.
Query alias: 1 model declares boardOwner.
Query alias: 3 models declare boardPinsModifiedAt.
Query alias: 3 models declare boardSectionId.
Query alias: 4 models declare budgetAmount.
Query alias: 3 models declare budgetInMicroCurrency.
Query alias: 3 models declare budgetType.
Query alias: 1 model declares businessName.
Query alias: 3 models declare businessRole.
Query alias: 2 models declare businessRoles.
Query alias: 1 model declares buyableButton.
Query alias: 1 model declares campaignFilter.
Query alias: 7 models declare campaignId.
Query alias: 2 models declare campaignIds.
Query alias: 1 model declares campaignObjectiveTypes.
Query alias: 1 model declares canonicalUrl.
Query alias: 3 models declare carouselAndroidDeepLinks.
Query alias: 3 models declare carouselDestinationUrls.
Query alias: 3 models declare carouselIosDeepLinks.
Query alias: 1 model declares carouselSlots.
Query alias: 19 models declare catalog_type.
Query alias: 28 models declare catalogId.
Query alias: 1 model declares catalogProductGroupId.
Query alias: 1 model declares catalogProductGroupName.
Query alias: 2 models declare catalogProductGroups.
Query alias: 1 model declares catalogsIds.
Query alias: 37 models declare catalogType.
Query alias: 1 model declares categories.
Query alias: 3 models declare checkoutEnabled.
Query alias: 1 model declares childInterests.
Query alias: 1 model declares clickIdEpik.
Query alias: 1 model declares clickthrough1.
Query alias: 3 models declare clickTrackingUrl.
Query alias: 2 models declare clickWindowDays.
Query alias: 1 model declares clientIpAddress.
Query alias: 1 model declares clientSecret.
Query alias: 1 model declares clientTimestamp.
Query alias: 1 model declares clientUserAgent.
Query alias: 2 models declare codeLabel.
Query alias: 3 models declare codeSnippet.
Query alias: 3 models declare collaboratorCount.
collection items destination url template
Query alias: 1 model declares collectionItemsDestinationUrlTemplate.
Query alias: 1 model declares collectionsHeaderType.
Query alias: 1 model declares collectionsHeroDestinationUrl.
Query alias: 1 model declares collectionsHeroPinId.
Query alias: 1 model declares columnNumber.
Query alias: 1 model declares combineTargetingTypes.
Query alias: 3 models declare completedTime.
Query alias: 3 models declare completionMessage.
Query alias: 3 models declare condition.
Query alias: 1 model declares CONDITION.
Query alias: 4 models declare connectedAdvertiserId.
Query alias: 4 models declare connectedLbaId.
Query alias: 4 models declare connectedMerchantId.
Query alias: 4 models declare connectedTagId.
Query alias: 2 models declare connectedUserId.
Query alias: 1 model declares Content-Type.
Query alias: 2 models declare contentType.
Query alias: 1 model declares conversionEvent.
Query alias: 1 model declares conversionLearningModeType.
Query alias: 1 model declares conversionMetricsReady.
Query alias: 1 model declares conversionProductAttributionType.
Query alias: 1 model declares conversionProductBreakdown.
Query alias: 2 models declare conversionReportTime.
Query alias: 1 model declares conversionTagId.
Query alias: 1 model declares conversionTagV3GoalMetadata.
Query alias: 1 model declares coverImageContentType.
Query alias: 1 model declares coverImageData.
Query alias: 1 model declares coverImageKeyFrameTime.
Query alias: 3 models declare coverImageUrl.
Query alias: 1 model declares createdBy.
Query alias: 2 models declare createdByBusiness.
Query alias: 1 model declares createdByBusinessId.
Query alias: 1 model declares createdByCompanyName.
Query alias: 2 models declare createdByUser.
Query alias: 1 model declares createdByUserId.
Query alias: 1 model declares CREATIVE_ASSETS_ID.
Query alias: 8 models declare creativeAssetsId.
Query alias: 1 model declares creativeAssetsIds.
Query alias: 5 models declare creativeType.
Query alias: 1 model declares creativeTypes.
Query alias: 11 models declare credentials.
Query alias: 1 model declares cryptographicAlgorithm.
Query alias: 1 model declares cryptographicKey.
Query alias: 1 model declares currencyCode.
Query alias: 2 models declare currencyInfo.
Query alias: 1 model declares CUSTOM_LABEL0.
Query alias: 1 model declares CUSTOM_LABEL1.
Query alias: 1 model declares CUSTOM_LABEL2.
Query alias: 1 model declares CUSTOM_LABEL3.
Query alias: 1 model declares CUSTOM_LABEL4.
Query alias: 1 model declares CUSTOM_NUMBER0.
Query alias: 1 model declares CUSTOM_NUMBER1.
Query alias: 1 model declares CUSTOM_NUMBER2.
Query alias: 1 model declares CUSTOM_NUMBER3.
Query alias: 1 model declares CUSTOM_NUMBER4.
Query alias: 1 model declares customConversionEventMetrics.
Query alias: 3 models declare customerListId.
Query alias: 1 model declares customerListUpload.
Query alias: 4 models declare customizableCtaType.
Query alias: 7 models declare customLabel0.
Query alias: 7 models declare customLabel1.
Query alias: 7 models declare customLabel2.
Query alias: 7 models declare customLabel3.
Query alias: 7 models declare customLabel4.
Query alias: 3 models declare customNumber0.
Query alias: 3 models declare customNumber1.
Query alias: 3 models declare customNumber2.
Query alias: 3 models declare customNumber3.
Query alias: 3 models declare customNumber4.
Query alias: 1 model declares customQuestionFieldType.
Query alias: 1 model declares customQuestionLabel.
Query alias: 1 model declares customQuestionOptions.
Query alias: 1 model declares customText.
Query alias: 4 models declare dailySpendCap.
Query alias: 1 model declares dataStatus.
Query alias: 1 model declares dcaAssets.
default ad group budget in micro currency
Query alias: 2 models declare defaultAdGroupBudgetInMicroCurrency.
Query alias: 5 models declare defaultAvailability.
Query alias: 5 models declare defaultCountry.
Query alias: 11 models declare defaultCurrency.
Query alias: 7 models declare defaultLocale.
Query alias: 1 model declares definition.
Query alias: 1 model declares deletedAssetGroups.
Query alias: 1 model declares deletedMembers.
Query alias: 1 model declares deletedPartners.
Query alias: 1 model declares DELIMITER_ERROR.
Query alias: 35 models declare description.
Query alias: 4 models declare destinationUrl.
Query alias: 3 models declare disclosureLanguage.
Query alias: 3 models declare disclosureType.
Query alias: 3 models declare disclosureUrl.
Query alias: 1 model declares discountCurrency.
Query alias: 1 model declares discountInMicroCurrency.
Query alias: 3 models declare discountStatus.
Query alias: 1 model declares discountType.
Query alias: 1 model declares dnsTxtRecord.
Query alias: 1 model declares documentType.
Query alias: 2 models declare dominantColor.
Query alias: 2 models declare downloadUrl.
Query alias: 1 model declares DUPLICATE_HEADERS.
Query alias: 1 model declares ENCODING_ERROR.
Query alias: 1 model declares engagementDomain.
Query alias: 2 models declare engagementType.
Query alias: 1 model declares engagementWindowDays.
Query alias: 1 model declares engagerType.
Query alias: 3 models declare enhancedMatchStatus.
Query alias: 1 model declares entityIds.
Query alias: 1 model declares entityTypes.
Query alias: 1 model declares errorCode.
Query alias: 1 model declares errorMessage.
Query alias: 2 models declare errorMessages.
Query alias: 2 models declare estimatedMonthlySpend.
Query alias: 1 model declares eventData.
Query alias: 1 model declares eventName.
Query alias: 1 model declares eventSource.
Query alias: 1 model declares eventTimestamp.
Query alias: 1 model declares eventType.
Query alias: 1 model declares exception.
Query alias: 1 model declares exclusionWindow.
Query alias: 1 model declares expiresIn.
Query alias: 1 model declares exportStatus.
Query alias: 4 models declare externalBusinessId.
Query alias: 1 model declares externalEventId.
Query alias: 4 models declare externalId.
Query alias: 1 model declares externalStorageFreeSpace.
Query alias: 1 model declares externalStorageSize.
Query alias: 1 model declares FEED_LENGTH_TOO_LONG.
Query alias: 1 model declares FEED_TOO_SMALL.
Query alias: 2 models declare feedProfileId.
Query alias: 1 model declares FETCH_ERROR.
Query alias: 1 model declares FETCH_GOOGLE_SHEET_NOT_SHARED.
Query alias: 1 model declares FETCH_GOOGLE_SHEET_PUBLIC_CAN_EDIT.
Query alias: 1 model declares FETCH_INACTIVE_FEED_ERROR.
Query alias: 1 model declares FETCH_SAME_SIGNATURE.
Query alias: 1 model declares fileContent.
Query alias: 1 model declares fileParts.
Query alias: 1 model declares filterOperatorType.
Query alias: 4 models declare followerCount.
Query alias: 1 model declares followingCount.
Query alias: 1 model declares formFactor.
Query alias: 3 models declare freeShippingLabel.
Query alias: 3 models declare freeShippingLimit.
Query alias: 1 model declares frequencyGoalMetadata.
Query alias: 1 model declares GOOGLE_PRODUCT_CATEGORY0.
Query alias: 1 model declares GOOGLE_PRODUCT_CATEGORY1.
Query alias: 1 model declares GOOGLE_PRODUCT_CATEGORY2.
Query alias: 1 model declares GOOGLE_PRODUCT_CATEGORY3.
Query alias: 1 model declares GOOGLE_PRODUCT_CATEGORY4.
Query alias: 1 model declares GOOGLE_PRODUCT_CATEGORY5.
Query alias: 1 model declares GOOGLE_PRODUCT_CATEGORY6.
Query alias: 5 models declare googleProductCategory.
Query alias: 1 model declares grantType.
Query alias: 3 models declare granularity.
Query alias: 4 models declare gridClickType.
Query alias: 2 models declare guestRatings.
Query alias: 1 model declares hasAccepted.
Query alias: 3 models declare hasAcceptedTerms.
Query alias: 1 model declares hasBeenPromoted.
Query alias: 1 model declares hashedEmail.
Query alias: 1 model declares hashedMaid.
Query alias: 1 model declares hashedMaids.
Query alias: 1 model declares hasPrediction.
Query alias: 1 model declares HOTEL_PRICE_HEADER_IS_PRESENT.
Query alias: 1 model declares IMAGE_FILE_NOT_ACCESSIBLE.
Query alias: 1 model declares IMAGE_FILE_NOT_FOUND.
Query alias: 1 model declares IMAGE_INVALID_FILE.
Query alias: 1 model declares IMAGE_LEVEL_INTERNAL_ERROR.
Query alias: 1 model declares IMAGE_MALFORMED_URL.
Query alias: 1 model declares imageCoverUrl.
Query alias: 1 model declares imageLargeUrl.
Query alias: 1 model declares imageMediumUrl.
Query alias: 1 model declares imageSmallUrl.
Query alias: 1 model declares imageXlargeUrl.
Query alias: 1 model declares impression.
Query alias: 1 model declares impression1.
Query alias: 1 model declares inclusion.
Query alias: 1 model declares INCONSISTENT_CURRENCY_VALUES.
Query alias: 1 model declares INDEXED_PRODUCT_COUNT_LARGE_DELTA.
Query alias: 1 model declares ineligibleForAds.
Query alias: 1 model declares ineligibleForOrganic.
Query alias: 1 model declares ingestedVideos.
Query alias: 1 model declares ingestionDetails.
Query alias: 3 models declare installmentPrice.
Query alias: 1 model declares installTime.
Query alias: 1 model declares INTERNAL_SERVICE_ERROR.
Query alias: 1 model declares inviteIds.
Query alias: 1 model declares inviteOrRequestId.
Query alias: 2 models declare inviteType.
Query alias: 1 model declares invoiceDueDate.
Query alias: 9 models declare iosDeepLink.
Query alias: 1 model declares ioTermsId.
Query alias: 1 model declares ipAddress.
Query alias: 4 models declare isAdsOnly.
Query alias: 1 model declares isAffiliateLink.
Query alias: 4 models declare isAutomatedCampaign.
Query alias: 4 models declare isCampaignBudgetOptimization.
Query alias: 3 models declare isCreativeOptimization.
Query alias: 3 models declare isFeatured.
Query alias: 4 models declare isFlexibleDailyBudgets.
Query alias: 1 model declares isGenerateBackground.
Query alias: 4 models declare isPerformancePlus.
Query alias: 3 models declare isPinDeleted.
Query alias: 3 models declare isReceivedInvite.
Query alias: 3 models declare isRemovable.
Query alias: 2 models declare isSharedPartner.
Query alias: 4 models declare isStandard.
Query alias: 1 model declares ITEM_GROUP_ID.
Query alias: 4 models declare itemGroupId.
Query alias: 1 model declares itemNumber.
Query alias: 1 model declares kernelVersion.
Query alias: 1 model declares keywordQueryVolume.
Query alias: 1 model declares labelType.
Query alias: 14 models declare language.
Query alias: 1 model declares languages.
Query alias: 1 model declares LARGE_PRODUCT_COUNT_DECREASE.
Query alias: 3 models declare lastFiredTimeMs.
Query alias: 1 model declares lastModifiedDateTime.
Query alias: 4 models declare lastUpdatedTime.
Query alias: 5 models declare leadFormId.
Query alias: 1 model declares leadsExportId.
Query alias: 3 models declare lifetimeFrequencyCap.
Query alias: 1 model declares lifetimeMetrics.
Query alias: 4 models declare lifetimeSpendCap.
Query alias: 1 model declares LINE_LEVEL_INTERNAL_ERROR.
Query alias: 1 model declares lineItems.
Query alias: 1 model declares lineNumber.
Query alias: 1 model declares lookbackPeriod.
Query alias: 1 model declares lookbackWindow.
Query alias: 1 model declares mainImage.
Query alias: 1 model declares MALFORMED_XML.
Query alias: 3 models declare matchType.
Query alias: 1 model declares MAX_PRICE.
Query alias: 1 model declares MAXIMUM_AGE.
Query alias: 2 models declare mdFrequency.
Query alias: 1 model declares MEDIA_TYPE.
Query alias: 4 models declare mediaContactEmail.
Query alias: 4 models declare mediaContactFirstname.
Query alias: 4 models declare mediaContactLastname.
Query alias: 1 model declares mediaSource.
Query alias: 8 models declare mediaType.
Query alias: 1 model declares merchantId.
Query alias: 1 model declares messageDetail.
Query alias: 1 model declares metricsHighlights.
Query alias: 1 model declares MIN_PRICE.
Query alias: 3 models declare minAdPrice.
Query alias: 1 model declares MINIMUM_AGE.
Query alias: 3 models declare mobileLink.
Query alias: 1 model declares monthlyViews.
Query alias: 2 models declare neighborhood.
Query alias: 1 model declares networkType.
Query alias: 1 model declares NO_VERIFIED_DOMAIN.
Query alias: 1 model declares noCodeCapiDomains.
Query alias: 1 model declares nonConversionMetricsReady.
Query alias: 1 model declares notIngestedVideos.
Query alias: 1 model declares numBatches.
Query alias: 3 models declare numberOfRatings.
Query alias: 1 model declares numberOfReviewers.
Query alias: 3 models declare numberOfReviews.
Query alias: 1 model declares numEventsProcessed.
Query alias: 1 model declares numEventsReceived.
Query alias: 1 model declares numRemovedUserRecords.
Query alias: 1 model declares numUploadedUserRecords.
Query alias: 5 models declare objectiveType.
Query alias: 2 models declare occurrences.
Query alias: 1 model declares offerCodeHash.
Query alias: 23 models declare operation.
Query alias: 5 models declare operationType.
Query alias: 3 models declare optimizationGoalMetadata.
Query alias: 1 model declares oracleLineId.
Query alias: 1 model declares orderLegalEntity.
Query alias: 4 models declare orderLineId.
Query alias: 1 model declares orderLineType.
Query alias: 2 models declare orderName.
Query alias: 1 model declares orderQuantity.
Query alias: 1 model declares orderValue.
Query alias: 1 model declares organicPinId.
Query alias: 1 model declares osReleaseName.
Query alias: 1 model declares osVersion.
Query alias: 1 model declares OUT_OF_STOCK.
Query alias: 1 model declares outboundClicks.
Query alias: 1 model declares outOfStock.
Query alias: 1 model declares outputFormat.
Query alias: 1 model declares overallStatus.
Query alias: 1 model declares ownerUserId.
Query alias: 3 models declare pacingDeliveryType.
Query alias: 2 models declare paidBudget.
Query alias: 2 models declare parentPinId.
Query alias: 2 models declare parentType.
Query alias: 4 models declare partnerAccessToken.
Query alias: 3 models declare partnerId.
Query alias: 1 model declares partnerIds.
Query alias: 3 models declare partnerPrimaryEmail.
Query alias: 4 models declare partnerRefreshToken.
Query alias: 1 model declares partnerType.
Query alias: 1 model declares partNumber.
Query alias: 1 model declares paymentMethodBrand.
Query alias: 1 model declares paymentTerms.
Query alias: 1 model declares percentage.
Query alias: 1 model declares percentGrowthMom.
Query alias: 1 model declares percentRelativeVolume.
Query alias: 8 models declare permissions.
Query alias: 1 model declares pinMetrics.
Query alias: 4 models declare pinOrderId.
Query alias: 1 model declares pinThumbnailUrls.
Query alias: 1 model declares PLACEMENT.
Query alias: 7 models declare placementGroup.
Query alias: 4 models declare placementMultipliers.
Query alias: 3 models declare platformType.
Query alias: 1 model declares platformVersionNumber.
Query alias: 2 models declare postalCode.
Query alias: 1 model declares predictedTimeSeries.
Query alias: 1 model declares preferredMediaType.
Query alias: 11 models declare preferredProcessingSchedule.
Query alias: 1 model declares presignedUrl.
Query alias: 1 model declares primarySort.
Query alias: 3 models declare privacyPolicyLink.
Query alias: 1 model declares processingResultId.
Query alias: 1 model declares PRODUCT_GROUP.
Query alias: 1 model declares PRODUCT_TYPE0.
Query alias: 1 model declares PRODUCT_TYPE1.
Query alias: 1 model declares PRODUCT_TYPE2.
Query alias: 1 model declares PRODUCT_TYPE3.
Query alias: 1 model declares PRODUCT_TYPE4.
Query alias: 1 model declares productBrand.
Query alias: 3 models declare productCategory.
Query alias: 1 model declares productCounts.
Query alias: 1 model declares productGroupIds.
Query alias: 2 models declare productGroupPromotion.
Query alias: 1 model declares productName.
Query alias: 1 model declares productPrice.
Query alias: 1 model declares productQuantity.
Query alias: 1 model declares productSkuIds.
Query alias: 3 models declare productType.
Query alias: 1 model declares productVariant.
Query alias: 1 model declares productVariantId.
Query alias: 1 model declares profileImage.
Query alias: 1 model declares profilesIds.
Query alias: 1 model declares promoCode.
Query alias: 3 models declare promotionApplicationLevel.
Query alias: 3 models declare promotionCode.
Query alias: 3 models declare promotionCustomId.
Query alias: 6 models declare promotionId.
Query alias: 1 model declares promotions.
Query alias: 3 models declare promotionTitle.
Query alias: 3 models declare promotionType.
Query alias: 1 model declares providedValue.
Query alias: 2 models declare purchaseOrderId.
Query alias: 1 model declares qualityComponents.
Query alias: 1 model declares questionId.
Query alias: 1 model declares questionText.
Query alias: 1 model declares questionType.
Query alias: 3 models declare quizPinData.
Query alias: 1 model declares ratingSystem.
Query alias: 1 model declares reachEstimate.
Query alias: 2 models declare recipientAccountIds.
Query alias: 2 models declare recipientBusinessIds.
Query alias: 1 model declares redirectUri.
Query alias: 2 models declare refreshToken.
Query alias: 1 model declares refreshTokenExpiresIn.
Query alias: 1 model declares rejectedReasons.
Query alias: 1 model declares rejectionLabels.
Query alias: 1 model declares relatedInterests.
Query alias: 2 models declare relatedSearches.
Query alias: 1 model declares relatedTermCount.
Query alias: 1 model declares relatedTermsList.
Query alias: 1 model declares relativeDefinition.
Query alias: 1 model declares remainingDiscountInMicroCurrency.
Query alias: 3 models declare report_type.
Query alias: 1 model declares reportFormat.
Query alias: 1 model declares reportingTimezone.
Query alias: 2 models declare reportName.
Query alias: 4 models declare reportStatus.
Query alias: 3 models declare reportType.
Query alias: 1 model declares requestHeaders.
Query alias: 2 models declare requestId.
Query alias: 1 model declares REQUIRED_COLUMNS_MISSING.
Query alias: 1 model declares responseHeaders.
Query alias: 1 model declares responseStatusCode.
Query alias: 1 model declares resultUrl.
Query alias: 1 model declares retentionDays.
Query alias: 1 model declares reviewStatus.
Query alias: 1 model declares rowTermsId.
Query alias: 1 model declares s3MultipartUploadData.
Query alias: 3 models declare salePriceEffectiveDate.
Query alias: 1 model declares salesforceOrderId.
Query alias: 2 models declare salesforceOrderLineId.
Query alias: 1 model declares savePinDisabled.
Query alias: 1 model declares screenDensity.
Query alias: 1 model declares screenHeight.
Query alias: 1 model declares screenWidth.
Query alias: 1 model declares scrollupGoalMetadata.
Query alias: 1 model declares searchQuery.
Query alias: 1 model declares selectedImageTag.
Query alias: 1 model declares selectedVideoTag.
Query alias: 1 model declares sharedOnTimestamp.
Query alias: 3 models declare shippingHeight.
Query alias: 3 models declare shippingWeight.
Query alias: 3 models declare shippingWidth.
Query alias: 1 model declares SHOPPING_RETARGETING.
Query alias: 1 model declares sizeIsUpperBound.
Query alias: 3 models declare sizeSystem.
Query alias: 1 model declares slideshowCollectionsDescription.
Query alias: 1 model declares slideshowCollectionsTitle.
Query alias: 1 model declares sourcePlatform.
Query alias: 6 models declare sourceType.
Query alias: 1 model declares sourceUrl.
Query alias: 1 model declares spendInDollar.
Query alias: 1 model declares sponsorId.
Query alias: 1 model declares stackTrace.
Query alias: 1 model declares startHour.
Query alias: 1 model declares statusCode.
Query alias: 1 model declares storageFreeSpace.
Query alias: 1 model declares storageSize.
Query alias: 1 model declares storeCode.
Query alias: 1 model declares subcategories.
Query alias: 1 model declares subscriberKey.
Query alias: 1 model declares subscriptionId.
Query alias: 4 models declare summaryStatus.
Query alias: 1 model declares TARGETING_STRATEGY.
Query alias: 4 models declare targetingAttributes.
Query alias: 5 models declare targetingSpec.
Query alias: 3 models declare targetingTemplateIds.
Query alias: 1 model declares targetingTypes.
Query alias: 1 model declares templateId.
Query alias: 3 models declare templateValues.
Query alias: 1 model declares tieBreakerCustomResult.
Query alias: 1 model declares tieBreakerType.
Query alias: 1 model declares timezoneAbbr.
Query alias: 1 model declares TITLE_KEYWORDS.
Query alias: 2 models declare tokenType.
Query alias: 1 model declares totalClickthrough.
Query alias: 1 model declares totalConversions.
Query alias: 1 model declares totalEvents.
Query alias: 1 model declares totalEventTouchpoints.
Query alias: 1 model declares totalImpression.
Query alias: 1 model declares totalParts.
Query alias: 1 model declares totalVideos.
Query alias: 1 model declares trackingUrl.
Query alias: 13 models declare trackingUrls.
Query alias: 3 models declare unitPricingBaseMeasure.
Query alias: 3 models declare unitPricingMeasure.
Query alias: 1 model declares unspecified.
Query alias: 1 model declares UPDATED_TIME_INVALID.
Query alias: 1 model declares updatedAssetGroups.
Query alias: 1 model declares updatedSince.
Query alias: 4 models declare updateMask.
Query alias: 1 model declares uploadParameters.
Query alias: 1 model declares uploadUrl.
Query alias: 1 model declares userAccountId.
Query alias: 3 models declare userEmail.
Query alias: 1 model declares usersOrPartnerIds.
Query alias: 1 model declares usTermsId.
Query alias: 1 model declares validateOnly.
Query alias: 1 model declares validationDetails.
Query alias: 3 models declare variantNames.
Query alias: 3 models declare variantValues.
Query alias: 1 model declares verificationCode.
Query alias: 1 model declares verificationMethod.
Query alias: 1 model declares verifiedAt.
Query alias: 1 model declares verticals.
Query alias: 1 model declares VIDEO_DOWNLOAD_VIDEO_TOO_SHORT.
Query alias: 1 model declares VIDEO_FILE_NOT_ACCESSIBLE.
Query alias: 1 model declares VIDEO_FILE_NOT_FOUND.
Query alias: 1 model declares VIDEO_INVALID_FILE.
Query alias: 1 model declares VIDEO_LEVEL_INTERNAL_ERROR.
Query alias: 1 model declares VIDEO_MALFORMED_URL.
Query alias: 1 model declares videoCounts.
Query alias: 3 models declare videoLink.
Query alias: 1 model declares videoTitle.
Query alias: 3 models declare viewTrackingUrl.
Query alias: 2 models declare viewWindowDays.
Query alias: 3 models declare visibility.
Query alias: 1 model declares visitorSourceId.
Query alias: 2 models declare webhookUrl.
Query alias: 1 model declares websiteUrl.
Query alias: 1 model declares windowHeight.
Query alias: 1 model declares windowWidth.
Query alias: 1 model declares x-amz-algorithm.
Query alias: 1 model declares x-amz-credential.
Query alias: 1 model declares x-amz-date.
Query alias: 1 model declares x-amz-security-token.
Query alias: 1 model declares x-amz-signature.
Redirect URI used in the authorization request
Date and time of last board pins modified.
If set to `true`, the board will be ad-only and can store ad-only Pins.
Name of the board. **Note:** If you create an ad-only board by setting `is_ads_only` to `true`, the board name automatically becomes "Ad-only Pins".
Privacy setting for a board. Learn more about [secret](https://help.pinterest.com/en/article/secret-boards) boards and [protected](https://help.pinterest.com/en/business/article/protected-boards) boards. **Note:** If you create an ad-only board by setting `is_ads_only` to `true`, the `privacy` settng automatically becomes `PROTECTED`.
Unique identifier of the business member/partner.
Username of the business member/partner.
Whether Automatic Enhanced Match birthdate is enabled. See [Enhanced match](https://help.pinterest.com/en/business/article/enhanced-match) for more information.
Whether Automatic Enhanced Match email is enabled. See [Enhanced match](https://help.pinterest.com/en/business/article/enhanced-match) for more information.
Whether Automatic Enhanced Match location is enabled. See [Enhanced match](https://help.pinterest.com/en/business/article/enhanced-match) for more information.
Whether Automatic Enhanced Match name is enabled. See [Enhanced match](https://help.pinterest.com/en/business/article/enhanced-match) for more information.
Whether Automatic Enhanced Match gender is enabled. See [Enhanced match](https://help.pinterest.com/en/business/article/enhanced-match) for more information.
Whether Automatic Enhanced Match phone is enabled. See [Enhanced match](https://help.pinterest.com/en/business/article/enhanced-match) for more information.
List of advertiser subdomains configured for NoCodeCAPI calls.
Order line paid budget in micro currency.
The board section to which this Pin belongs.
Dominant pin color. Hex number, e.g. `#6E7874`.
Whether the Pin has been promoted or not.
Whether the "operation user_account" is the Pin owner.
Whether the Pin is standard or not. See documentation on [Changes to Pin creation](/docs/api-features/content-overview/) for more information.
The source pin id if this pin was saved from another pin. [Learn more](https://help.pinterest.com/article/save-pins-on-pinterest).
Pin metrics with associated time intervals if any.
Duration (in miliseconds). Field maybe null after creation due to video processing time.
Height (in pixels). Field maybe null after creation due to video processing time.
Video url (720p). **Note:** This field is limited and not available to all apps.
Width (in pixels). Field maybe null after creation due to video processing time.
**Legacy field.** Predefined age ranges. We recommend using MINIMUM_AGE and MAXIMUM_AGE instead for more flexible targeting. Cannot be combined with MINIMUM_AGE/MAXIMUM_AGE. If neither AGE_BUCKET nor MINIMUM_AGE/MAXIMUM_AGE are specified, all ages will be targeted.
Allowed devices. If the APPTYPE field is missing, the default behavior in terms of ad delivery is that **All devices/apptypes** will be targeted.
Excluded customer list IDs. Used to drive new customer acquisition goals. For example: ["2542620905475"]. Audience lists need to have at least 100 people with Pinterest accounts in them. If the AUDIENCE_EXCLUDE field is missing, the default behavior in terms of ad delivery is that **No users will be excluded**.
Targeted customer list IDs. For example: ["2542620905473"]. Audience lists need to have at least 100 people with Pinterest accounts in them Audience lists need to have at least 100 people with Pinterest accounts in them. If the AUDIENCE_INCLUDE field is missing, the default behavior in terms of ad delivery is that **All users will be included**.
Targeted genders. Values: ["unknown","male","female"]. If the GENDER field is missing, the default behavior in terms of ad delivery is that **All genders will be targeted**.
Location region codes, e.g., "BE-VOV" (East Flanders, Belgium) For complete list, click here or postal codes, e.g., "US-94107". Use either region codes or postal codes but not both. At least one of LOCATION or GEO must be specified. If the GEO field is missing, then only LOCATION values will be targeted (see LOCATION field below).
Array of interest object IDs. If the INTEREST field is missing, the default behavior in terms of ad delivery is that **All interests will be targeted**.
24 ISO 639-1 two-letter language codes. If the LOCALE field is not included in the request, all languages are targeted.
22 ISO Alpha 2 two letter country codes or US Nielsen DMA (Designated Market Area) codes (location region codes) (e.g., ["US", "807"]). For complete list, click here. Location-Country and Location-Metro codes apply. At least one of LOCATION or GEO must be specified. If the LOCATION field is missing, then only GEO values will be targeted (see GEO field above).
Maximum age to target (inclusive). Values: "18", "19", ..., "65", "65+". Must be used together with `MINIMUM_AGE`. Cannot be combined with `AGE_BUCKET`. If neither `MINIMUM_AGE`/`MAXIMUM_AGE` nor `AGE_BUCKET` are specified, all ages will be targeted.
Minimum age to target (inclusive). Values: "18", "19", ..., "65". Note: 65+ is not allowed for minimum age. Must be used together with `MAXIMUM_AGE`. Cannot be combined with `AGE_BUCKET`. If neither `MINIMUM_AGE`/`MAXIMUM_AGE` nor `AGE_BUCKET` are specified, all ages will be targeted.
Array of object: lookback_window [Integer]: Number of days ago to start lookback timeframe for dynamic retargeting tag_types [Array of integer]: Event types to target for dynamic retargeting exclusion_window [Integer]: Number of days ago to stop lookback timeframe for dynamic retargeting
Number of days ago to stop lookback timeframe for dynamic retargeting
Number of days ago to start lookback timeframe for dynamic retargeting
Event types to target for dynamic retargeting
Country code where the store is located.
Geographic latitude coordinate of the store.
Geographic longitude coordinate of the store.
State or region code where the store is located.
Merchant provided code for the local store. Unique within the merchant's catalog.
The catalog item id in the merchant namespace
Restricted <= 2000 characters Ad image link that supplements main image for shopping campaigns. Image format: Pixel size at least 75 x 75 Link guidelines: Include extension in file name Do not include template or placeholder images in link Make URL accessible to Pinterest user-agent Must start with http:// or https://
Restricted <= 511 characters If you provide an ad_image_x_link, include the image tag with the corresponding ad_image_x_tag attribute.
Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking—do not send tracking parameters only. At this time we do not support impression tracking. Must begin with http:// or https://.
Restricted <= 2000 characters Ad video link that supplements main video for shopping campaigns. Video format: Pixel size between 75 x 75 and 9450 x 9450 File size smaller than 2 GB Time span between 4 seconds and 15 minutes Accepted formats: .MP4, .MOV, .M4V Link guidelines: Include extension in file name Do not include template or placeholder videos in link Make URL accessible to Pinterest user-agent Must start with http:// or https://
Restricted <= 511 characters If you provide an ad_video_x_link, include the video tag with the corresponding ad_video_x_tag attribute.
Set this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest.
The age group to apply a demographic range to the product. Must be one of the following values (upper or lowercased): ‘newborn’, ‘infant’, ‘toddler’, ‘kids’, or ‘adult’.
The deep link to the product on the Android app.
The availability of the product. Must be one of the following values (upper or lowercased): ‘in stock’, ‘out of stock’, ‘preorder’.
Average reviews for the item. Can be a number from 1-5.
This attribute is not supported anymore.
The condition of the product. Must be one of the following values (upper or lowercased): ‘new’, ‘used’, or ‘refurbished’.
<= 511 characters for retail and creative asset catalogs, <= 127 characters for hotel catalogs Custom grouping of products.
an attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
<= 10000 characters The description of the product.
The minimum order purchase necessary for the customer to get free shipping. Only relevant if free shipping is offered.
The gender associated with the product. Must be one of the following values (upper or lowercased): ‘male’, ‘female’, or ‘unisex’.
The categorization of the product based on the standardized Google Product Taxonomy. This is a set taxonomy. Both the text values and numeric codes are accepted.
The unique universal product identifier.
<= 127 characters The user-created unique ID that represents the product. Only Unicode characters are accepted.
Installment price of the product. This data will only be shown to pinners in the enabled countries. Expected format: <payment_count>:<payment_amount> <currency>
The deep link to the product on the iOS app.
<= 127 characters The parent ID of the product.
The millisecond timestamp when the item was lastly modified by the merchant.
<= 511 characters The landing page for the product.
The minimum advertised price of the product. It supports the following formats, "19.99 USD", "19.99USD" and "19.99". If the currency is not included, we default to US dollars.
The mobile-optimized version of your landing page. Must begin with http:// or https://.
Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer.
The number of reviews available for the item.
The description of the pattern used for the product.
The price of the product. It supports the following formats, "24.99 USD", "24.99USD" and "24.99". If the currency is not included, we default to US dollars.
<= 1000 characters The categorization of your product based on your custom product taxonomy. Subcategories must be sent separated by “ > “. The > must be wrapped by spaces. We do not recognize any other delimiters such as comma or pipe.
A unique identifier referencing the promotion associated with this catalog item.
The discounted price of the product. The sale_price must be lower than the price. It supports the following formats, "14.99 USD", "14.99USD" and "14.99". If the currency is not included, we default to US dollars.
Sale price effective date. Expected format: <start_date>/<end_date> (ISO 8601 format)
Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required). All colons, even for blank values, are required.
The height of the package needed to ship the product. Ensure there is a space between the numeric string and the metric.
The weight of the product. Ensure there is a space between the numeric string and the metric.
The width of the package needed to ship the product. Ensure there is a space between the numeric string and the metric.
Indicates the country’s sizing system in which you are submitting your product. Must be one of the following values (upper or lowercased): ‘US’, ‘UK’, ‘EU’, ‘DE’, ‘FR’, ‘JP’, ‘CN’, ‘IT’, ‘BR’, ‘MEX’, or ‘AU’.
Additional description for the size. Must be one of the following values (upper or lowercased): ‘regular’, ‘petite’, ‘plus’, ‘big_and_tall’, or ‘maternity’.
Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional). All colons, even for blank values, are required.
<= 500 characters The name of the product.
Unit pricing base measure of the product. This data will only be shown to pinners in the enabled countries. Expected format: <base_measure> <unit_type>
Unit pricing total measure of the product. This data will only be shown to pinners in the enabled countries. Expected format: <total_units> <unit_type>
Options for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed.
Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. The order of the variant values must be consistent with the order of the variant names.
<= 2000 characters The links to additional images for your product. Up to ten additional images can be used to show a product from different angles or to show different stages. Must begin with http:// or https://.
<= 2000 characters The links to the main product images. Images should be at least 75x75 pixels to avoid errors. Use the additional_image_link field to add more images of your product. The URL of your image_link must be accessible by the Pinterest user-agent, and send the accurate images. Please make sure there are no template or placeholder images at the link. Must start with http:// or https://.
By default, product pins created from a catalog are able to be saved by Pinners. If you want to disable the save pin feature, set this attribute to true. This feature is only available for allowlisted merchants. Please contact your account manager to enable this feature.
<= 2,000 characters Hosted link to the product video. File types for linked videos must be .mp4, .mov or .m4v. File size cannot exceed 2GB.
The list of product attributes to be updated. Attributes specified in the update mask without a value specified in the body will be deleted from the product item.
List of types of attribution for the conversion report
Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days.
The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.
Metric report end date (UTC). Format: YYYY-MM-DD
Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days.
TOTAL - metrics are aggregated over the specified date range. DAY - metrics are broken down daily. HOUR - metrics are broken down hourly. WEEKLY - metrics are broken down weekly. MONTHLY - metrics are broken down monthly
Metric report start date (UTC). Format: YYYY-MM-DD
Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day.
Metric and entity columns. Pin promotion and ad related columns are not supported for the Product Item level reports.
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.
List of advertiser-defined custom conversion event metrics to include in the report
Which hour of the end date to stop the report (inclusive). For example, with an end_date of '2020-01-01' and end_hour of '15', the report will contain metrics up to '2020-01-01 14:59:59'. The entire day will be included if no end hour is provided. Only allowed for hourly reports.
Specification for formatting the report data. Reports in JSON will not zero-fill metrics, whereas reports in CSV will. Both report formats will omit rows where all the columns are equal to 0.
Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
Which hour of the start date to begin the report. The entire day will be included if no start hour is provided. Only allowed for hourly reports.
List of ad group ids. Only support ad_group_ids field when level of the report is AD_GROUP.
List of campaign ids. Only support campaign_ids field when level of the report is CAMPAIGN.
List of values for filtering. Default is ['CONSIDERATION','AWARENESS','WEB_CONVERSION','VIDEO_COMPLETION'].
Required attribution type of the B/C/S report. When the attribution type is BRAND_ATTRIBUTION, start_date for the report must be after 2025-04-01.
Report breakdown type. This is used to specify the breakdown of the report by brand, category, or SKU.
Metric report end date (UTC). Format: YYYY-MM-DD. A max of 1 year is allowed between the start and end date for reports.
TOTAL - metrics are aggregated over the specified date range. WEEK - metrics are broken down weekly. MONTH - metrics are broken down monthly.
List of SKU ids. Only support product_sku_ids field when report breakdown type is PRODUCT_SKU_GROUP.
Metric report start date (UTC). Format: YYYY-MM-DD. Start date must be after 2024-03-16. 7 day minimum time window for report is required.
Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` day.
DAY - metrics are broken down daily. WEEK - metrics are broken down weekly.
Name of the Marketing Mix Modeling (MMM) report
Creation time. Unix timestamp in seconds.
Enable auto-targeting for ad group. Default value is True. Also known as "Pinterest Performance+ targeting".
Bid price in micro currency. This field is **REQUIRED** for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH.
Bid strategy type. For Campaigns with Video Completion objectives, the only supported bid strategy type is AUTOMATIC_BID, also known as "Pinterest Performance+ bidding".
Budget in micro currency. This field is **REQUIRED** for non-CBO (campaign budget optimization) campaigns. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups.
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.
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.
Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions)) ad groups. A CPM ad group has an IMPRESSION billable_event value. This field **REQUIRES** the `end_time` field.
Optimization goals for objective-based performance campaigns. **REQUIRED** when campaign's `objective_type` is set to `"WEB_CONVERSION"`.
Placement group.
Specify if the promotion is applied at ad group or item level
Promotion ID. To clear this field, set to null.
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.
Targeting template IDs applied to the ad group. We currently only support 1 targeting template per ad group. To use targeting templates, do not set any other targeting fields: targeting_spec, tracking_urls, auto_targeting_enabled, placement_group. To clear all targeting template IDs, set this field to ['0'].
Third-party tracking URLs. JSON object with the format: {"Tracking event enum":[URL string array],...} For example: {"impression": ["URL1", "URL2"], "click": ["URL1", "URL2", "URL3"]}. Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs. For more information, see Third-party and dynamic tracking.
Open beta Bid multiplier for ad group. This value is a double between 0.1 and 10.0. Enter 0 to remove the bid multiplier. - Not currently supported for Pinterest Performance+ campaigns.
Ad group creation time. Unix timestamp in seconds.
[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.
Feed Profile ID associated to the adgroup.
Ad group last update time. Unix timestamp in seconds.
Open beta Bid multiplier for ad group. This value is a double between 0.1 and 10.0. Enter 0 to remove the bid multiplier. - Make sure the `bid_strategy` type for your ad group is set to `AUTOMATIC_BID`. - Not currently supported for Pinterest Performance+ campaigns.
Pin creative types filter. Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.
Array of keyword objects. If the keywords field is missing, all keywords will be targeted.
Targeted product group IDs. Note: This can only be combined with shopping/catalog sales campaigns. For more information, click here. SHOPPING_RETARGETING must be included in targeting_spec object or this field will be ignored.
The lower confidence bound of the estimated potential audience size. "Potential audience size" estimates the number of people you may be able to reach per month with your campaign. It is based on historical advertising data and the targeting criteria you select. It does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments.
The upper confidence bound of the estimated potential audience size. "Potential audience size" estimates the number of people you may be able to reach per month with your campaign. It is based on historical advertising data and the targeting criteria you select. It does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments.
A list of bid floors in micro currency. For example, [100000, 200000]
Total conversions across all attribution windows
Total impressions across attribution windows
ID of the ad group that contains the ad.
Comma-separated deep links for the carousel pin on Android.
Comma-separated destination URLs for the carousel pin to promote.
Comma-separated deep links for the carousel pin on iOS.
URL for a page that provides disclosures about a pharmaceutical product, such as potential side effects. Make sure the URL takes the user directly to the disclosure content and the referenced site is secure.
Before creating a quiz ad, you must create an organic Pin using POST/Create Pin for each result in the quiz. Quiz ads cannot be saved by a Pinner. Quiz ad results can be saved.
The ID of the advertiser that this ad belongs to.
ID of the ad campaign that contains this ad.
Destination URL template for all items within a collections drawer.
Pin creation time. Unix timestamp in seconds.
Enum reason why the pin was rejected. Returned if review_status is "REJECTED".
Text reason why the pin was rejected. Returned if review_status is "REJECTED".
Last update time. Unix timestamp in seconds.
Quiz ad tie breaker type, default is RANDOM
'Preview URL, expires in 7 days. Can be used in an iframe. For example: https://ads.pinterest.com/ad-preview/74667c814dd2b19/ The preview object ID/key is the last param - 74667c814dd2b19'
Pin ID. This field may only be updated for draft ads.
The catalog retail item id in the merchant namespace
Catalog id pertaining to the retail item
A list of retail catalog items to fetch bid options for
Bid price in micro currency. A value of 0 will stop distribution for this item in `MAX_BID` ad groups in `CATALOG_SALES` campaigns. A value of `null` will fallback to the ad group's `bid_in_micro_currency`.
Array with validation errors for the supplied item bid option modification operation. A non empty errors list means this single item operation was not applied.
The list of item bid option fields to be set or updated. Fields specified in the updated mask without a value specified in the `bid_options` object in the body will be set to `null`. If an item bid option record is being created, fields not specified in the update mask will be initialized to `null`.
The error code for the item bid option operation validation error
Message describing the item bid option operation validation error
Array of advanced auction processed items
Interest's percent of category's total audience.
Value of demographic item as a percent of total audience
Indicates whether the audience size has been rounded up to the next highest upper boundary.
Audience types: ACTALIKE, ENGAGEMENT, CUSTOMER_LIST and VISITOR
Audience status. READY, INITIALIZING, TOO_SMALL - Each audience list needs to have at least 100 people with Pinterest accounts before you can start using it.
Campaign ID for engagement audience filter.
Valid countries include: "US", "CA", and "GB".
Customer list ID. For CUSTOMER_LIST `audience_type`.
The audience account's verified domain. **Required** for ENGAGEMENT `audience_type`.
Engagement type enum. Optional for ENGAGEMENT `audience_type`. Supported values are `click`, `save`, `closeup`, `comment` and `like`. All engagements are included if this field is not set.
Optional for ENGAGEMENT. Engager type value should be 1-2.
A Pinterest tag event. Optional for VISITOR `audience_type`. Possible values are `pagevisit`, `signup`, `checkout`, `viewcategory`, `search`, `addtocart`, `watchvideo`, `lead`, and `custom`. This field also accepts a partner-defined Pinterest tag event.
Optional for VISITOR. You can use it as a {'=': [value]}. Supported values are: web, mobile, offline
Optional for VISITOR. You can use it as a {'=': [value]}. Supported values are: tag, mmp, file_upload, conversions_api
Objective for engagement audience filter.
Percentage should be 1-10. The targeted audience should be this % size across Pinterest.
IDs of engaged organic pins. Optional for ENGAGEMENT `audience_type`. For example, "pin_id:": ["34567"]
Optional for VISITOR `audience_type`. If `true`, the specified rule on existing engagement data is applied to pre-populate the audience. If `false`, the audience is empty at creation time. The default is `true`.
Number of days a Pinterest user remains in the audience. Optional for ENGAGEMENT and VISITOR `audience_type`. Accepted range is 1-540. Defaults to 180 if not specified.
Audience ID(s). For ACTALIKE `audience_type`.
Optional for ENGAGEMENT or VISITOR `audience_type`. For ENGAGEMENT, it is the engaged pin's URL. For VISITOR, you can use it as a string or a {operator: value} object for filtering visitors based on conversion tag event URLs. Supported operators are [ =, !=, contains, not_contains]. Example 1: "url": "http://www.myonlinestore123.com/view_item/shoe" Example 2: "url": {"contains": "/view_item/shoe"}
The conversion tag ID, or the Pinterest tag ID, that you use on your website. For VISITOR `audience_type`.
Promotion code. For example, 'Newsletter'.
Page name. For example, 'Our Favorite Pins on Pinterest'.
Promotion code. For example, 'WINTER10'.
Search query string. For example, 'boots'.
Video title. For example, 'How to style your Parker Boots'.
Product name. For example, 'Parker Boots'.
Product variant ID. For example, '1414-34832'.
Epoch timestamp in seconds for the shared audience event
List of ad account IDs to share with or revoke from.
List of business IDs to share with or revoke from.
Audience types: ACTALIKE, ENGAGEMENT, CUSTOMER_LIST and VISITOR. Values are case-sensitive.
True if the offer code is currently active.
The discount applied in the offer’s currency value.
Takes in a SHA256 hash of the offerCode.
If true, only validate if we can redeem offer code. Otherwise it will actually apply the offer code to the account
Returns true if the offer code was successfully applied(validateOnly=false) or can be applied(validateOnly=true).
The ID of the ad account this invoice belongs to
The name of the ad account this invoice belongs to
The amount billed in this invoice. Denoted in micro currency
The discount in this invoice. Denoted in micro currency
The net amount in this invoice. Denoted in micro currency
The tax in this invoice. Denoted in micro currency
The end date of the billing period. Format: YYYY-MM-DD
The start date of the billing period. Format: YYYY-MM-DD
Unique identifier for the billing invoice
The date the invoice is due. Format: YYYY-MM-DD
The download url for the billing invoice
Purpose for which the address is used, usually Billing or Businness
Address information that is associated with this account.
Salesforce text for IO Terms and Conditions
Salesforce id for IO Terms and Conditions
Insertion Order Type - Pinterest Paper or Agency Paper
Salesforce text for Rest of the World Terms and Conditions
Salesforce id for Rest of the World Terms and Conditions
Salesforce text for US Terms and Conditions
Salesforce id for US Terms and Conditions
An array of Salesforce account information that includes address, io terms, etc.
Advertiser eligible to update order lines
Advertiser eligible to create order lines
Error indicator from Salesforce which could be "No Error"
If Budget order line, the budget amount.
End date of time period. Format: YYYY-MM-DD
Starting date of time period. Format: YYYY-MM-DD
The email of user submitting the insertion order
The UTC timestamp (to the nearest sec) of when terms were accepted
If Ongoing (perpetual) order line, the estimated monthly spend
Salesforce insertion order creation time
The pin order id associated with the order line in SFDC
All entities specified by these IDs as well as their children and grandchildren will be downloaded if the entity type is one of the types requested to be downloaded.
All entity types specified will be downloaded. Fewer types result in faster downloads.
Unix UTC timestamp to retrieve all entities that have changed since this time.
Campaign's Advertiser ID. If you want to create a campaign in a Business Account shared account you need to specify the Business Access advertiser ID in both the query path param as well as the request body schema.
Campaign daily spending cap. Required for Campaign Budget Optimization (CBO) campaigns. This and "lifetime_spend_cap" cannot be set at the same time.
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.
Specifies whether the campaign was created in the automated campaign flow
Determine if a campaign has setup for flexible daily budgets, also known as "Pinterest Performance+ budgets".
Campaign total spending cap. Required for Campaign Budget Optimization (CBO) campaigns. This and "daily_spend_cap" cannot be set at the same time.
Order line ID that appears on the invoice.
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.
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.
Determines if a campaign automatically generate ad-group level budgets given a campaign budget to maximize campaign outcome. When transitioning from non-cbo to cbo, all previous child ad group budget will be cleared.
Enable Pinterest Performance+ for your campaign. To learn more, see Pinterest Performance+ Setup.
Catalog Feed id pertaining to the catalog product group.
Object holding a group of filters for request on catalog product group. This is a distinct schema It is not possible to create or update a Product Group with empty filters. But some automatically generated Product Groups might have empty filters.
boolean indicator of whether the product group is being featured or not
Catalog id pertaining to the retail product group.
Retail catalog based product group is available only for selected partners at the moment. If you are not eligible, please use feed based one.
Catalog id pertaining to the hotel product group.
Object holding a group of filters for a hotel product group
Catalog id pertaining to the creative assets product group.
Object holding a group of filters for a creative assets product group
Keyword JSON array. Each array element has 3 fields
Keyword parent entity ID (advertiser, campaign, ad group).
Note: bid field has been deprecated. Input will not be set and field will return null. Keyword custom bid in microcurrency - null if inherited from parent ad group.
Labels that you are applying to the campaign.
Unique identifier of the asset you are labelling. Currently, you can only label campaigns.
ID of the Ad Group the Product Group Promotion belongs to.
ID of the ad group the product group belongs to.
ID of the catalogs product group that this product group promotion references
Hero Pin ID if this PG is promoted as a Collection
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, BUY_ONLINE_PICKUP_IN_STORE
True if the group is BIDDABLE, false if it should be EXCLUDED from serving ads.
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.
If set to true products promoted in this product group will use the Mobile Deep Link specified in your catalog
The parent Product Group ID of this Product Group
Select whether to promote the image or video pin by default for items in the promoted product group. If selecting IMAGE, image will be promoted for all ads in the product group, and when selecting VIDEO, video will be promoted when present, otherwise fall back to image. This is applicable for standard shopping ads only.
The definition of the product group, relative to its parent - an attribute name/value pair
The ad image tag selected for the product group promotion.
The ad video tag selected for the product group promotion.
Tracking template for proudct group promotions. 4000 limit
Enable Pinterest Performance+ for your campaign. To learn more, see Pinterest Performance+ Setup. This field is immutable, except only for campaigns in draft status which may update this field.
List of fields to update, only the fields in the list will be updated.
Type of asset. Currently we only support AD_ACCOUNT, PROFILE, ASSET_GROUP and CATALOG.
Permission levels member or partner has on an asset.
A list of ad account IDs under the asset group
The data of the user that created the asset group.
The data of the business that owns the asset group.
If is_shared_partner=FALSE, you terminated a partner's asset access to your business asset. If is_shared_partner=TRUE, you terminated your asset access to your partner's business asset.
Unique identifier of a business partner.
Asset Group Types. Note: The asset group types are used for user reference and categorization purposes only and do not impact the functionality of the asset group.
Unique identifier of the business asset.
Unique identifier of the business member.
List of member asset permissions that were deleted.
A list of asset groups and the data that will be used to update them.
A list of errors associated with the asset groups. Will be returned if there is an error.
A list of successfully edited asset groups.
List of ids of asset groups to be deleted
A list of ids of successfully deleted asset groups.
List of assigned/updated member asset access. If there is an error, an exception object will be returned. If the action was successfully completed, a response object will be returned.
Unique identifier of the business member with asset access.
List of assigned/updated partner asset access.
Unique identifier of the invite/request.
Indicates whether the invite/request was received.
Metadata for the member/partner that was sent the invite/request.
List of invite/request ids to be cancelled
A list of errors associated with the asset access requests. Will be returned if there is an error.
List of invite/request creation status. If there is an error, an exception object will be returned. If the action was successfully completed, an invite object will be returned.
The business access level to grant member/partner. Note, values are case-sensitive. - EMPLOYEE: Can only view and access assets you assign them to. They cannot see details about other employees, partners, or other assets. - BIZ_ADMIN: Have full control of roles and can add employees and partners as well as grant asset access. - PARTNER: Can only view and access assets you assign them to/or they assign to you.
A list of usernames, emails, or a mix of them. Should be used if invite_type is MEMBER_INVITE
A list of partner_id. Should be used if invite_type is PARTNER_INVITE or PARTNER_REQUEST
List of ad account IDs and respective permission levels that will be assigned.
List of profile IDs and respective permission levels that will be assigned.
Error code associated with the error in performing the action on the invite/request.
Error message associated with the error in performing the action on the invite/request.
A list of users' usernames or emails OR a list of partner ids that caused the error.
Unique identifier for the business that created the invite/request.
Unique identifier for the user that created the invite/request.
The access level a user would be granted on the business if the invite/request is accepted. This can be EMPLOYEE, BIZ_ADMIN, or PARTNER.
Metadata for the business that created the invite/request.
Metadata for the user that created the invite/request.
The time the invite/request was created. Returned in milliseconds.
List of invite/request accept/decline status. If there is an error, an exception object will be returned. If the invite/request was successfully accepted/declined, an invite object will be returned.
An object mapping asset ids to lists of business permissions. This can be used to setting/requesting permissions on various assets. If accepting an invite or request, this object would be used to grant asset permissions to the member or partner.
List of invite/Request action status. If there is an error, an exception object will be returned. If the action was successfully completed, an invite object will be returned.
List of invite/Request deletion status. If there is an error, an exception object will be returned. If the invite/request was successfully cancelled, an invite object will be returned for the invite that was cancelled.
List of ad account IDs and respective permission levels.
List of profile IDs and respective permission levels.
List of members with updated business access role.
List of members whose business membership have been terminated.
List of partners whose business partnership have been terminated.
The access level a user has on the business. This can be EMPLOYEE, BIZ_ADMIN, or PARTNER.
Metadata for the business that created the business relationship.
Metadata for the user that created the business relationship.
The time the business relationship was created. Returned in milliseconds.
Unique identifier of the business member/business partner/employer.
This field is only relevant when business_role="PARTNER". If is_shared_partner=FALSE, the partner can access your business assets. If assets_summary is not empty, the assets listed are your business assets the partner has access to. If is_shared_partner=TRUE, you can access the partner's business asset. If assets_summary is not empty, the assets listed are the partner's business assets you have access to.
Metadata for the business member/business partner/employer.
Current metrics date. Only returned when granularity is a time-based value (`DAY`, `HOUR`, `WEEK`, `MONTH`)
The ID of the pin that the metric belongs to.
Campaign creation time. Unix timestamp in seconds.
Catalog id pertaining to the feed. If not provided, feed will use a default catalog based on type.
The locale used within a feed for product descriptions.
The URL where a feed is available for download. This URL is what Pinterest will use to download a feed for processing.
A human-friendly name associated to a given feed. This value is currently nullable due to historical reasons. It is expected to become non-nullable in the future.
The required password for downloading a feed.
The required username for downloading a feed.
A time in format HH:MM with leading 0 (zero)
The timezone considered for the processing schedule time.
We detected an issue with your account and are not currently ingesting your items. Please review our policies at policy.pinterest.com/community-guidelines#section-spam or contact us at help.pinterest.com/contact for more information.
Update your Google Sheets sharing settings to 'Anyone with link' as a Viewer so that Pinterest can access your file.
Image files are unreadable. Please upload new files to continue.
We experienced a technical difficulty and were unable to download some images. The next download attempt will happen in 24 hours.
Image files are unreadable. Please check your link and upload new files to continue.
The product count has decreased by more than 99% compared to the last successful ingestion.
We experienced a technical difficulty and were unable to ingest this some items. The next ingestion will happen in 24 hours.
The number of ingested products that are in stock.
The number of ingested products that are in out of stock.
The number of ingested products that are in preorder.
Ad image files are unreadable. Please check your link and upload new files to continue.
We experienced a technical difficulty and were unable to download some additional images. The next download attempt will happen in 24 hours.
Ad images must have a height larger than 75 pixels
Ad images must have a maximum area (width x height) of less than 89478485 pixels
Some ad images could not be processed due to a file type mismatch.
Ad images must have a width larger than 75 pixels
Ad video files are unreadable. Please check your link and upload new files to continue.
Ad videos length is too short. Please ensure that all ad videos are at least 4 seconds long.
Ad videos must have a height larger than 75 pixels
Ad videos must have a maximum area (width x height) of less than 89478485 pixels
Some ad videos could not be processed due to a file type mismatch.
Ad videos must have a width larger than 75 pixels
Additional image files are unreadable. Please upload new files to continue.
Additional image files are unreadable. Please check your link and upload new files to continue.
Update your Google Sheets sharing settings from 'Editor' to 'Viewer'.
Price is not a supported column. Use base_price and sale_price instead.
Video length is too short. Please ensure that the main video is at least 4 seconds long.
Video files are unreadable. Please upload new files to continue.
We experienced a technical difficulty and were unable to download some additional videos. The next download attempt will happen in 24 hours.
Video files are unreadable. Please check your link and upload new files to continue.
The number of products successfully ingested from the feed file.
The number of products in the feed file.
Some adwords links contain too many characters.
Some items are missing an availability value in their product metadata, those items will not be published.
Some items were not published because they don't meet Pinterest's Merchant Guidelines.
Your feed includes data with formatting errors.
Some items are missing a description in their product metadata, those items will not be published.
Your feed includes data with an unsupported encoding format.
Your feed contains too many items, some items will not be published.
Your feed couldn't be validated because the file doesn't contain the minimum number of lines required.
Your feed wasn't ingested because it hasn’t changed in the previous 90 days.
Some image links are formatted incorrectly.
Some items have image_link URLs that contain too many characters, so those items will not be published.
Some items are missing an image link URL in their product metadata, those items will not be published.
We experienced a technical difficulty and were unable to ingest your feed. The next ingestion will happen in 24 hours.
Some of your product link values don't match the verified domain associated with this account.
Some items are missing an item id in their product metadata, those items will not be published.
Some link values are formatted incorrectly.
Some product links contain too many characters, those items will not be published.
Some items have list price formatting errors in their product metadata, those items will not be published.
Your feed couldn't be validated because the xml file is formatted incorrectly.
Some items exceed the maximum number of items per item group, those items will not be published.
Your merchant domain needs to be claimed.
Your feed contains formatting errors for some items.
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.
Some products are missing a price, those items will not be published.
Some items are missing a link URL in their product metadata, those items will not be published.
Some items have price formatting errors in their product metadata, those items will not be published.
Your feed is missing some required column headers.
Some items are missing a title in their product metadata, those items will not be published.
ad_image_0_link is duplicated with another ad image link.
Ad image link 0 length is too long. The maximum length is 2047 characters.
Ad image link 0 is required because an image tag was provided.
ad_image_0_tag is duplicated with another ad image tag.
Ad image tag 0 length is too long. The maximum length is 511 characters.
Ad image tag 0 is required because an image link was provided.
ad_image_10_link is duplicated with another ad image link.
Ad image link 10 length is too long. The maximum length is 2047 characters.
Ad image link 10 is required because an image tag was provided.
ad_image_10_tag is duplicated with another ad image tag.
Ad image tag 10 length is too long. The maximum length is 511 characters.
Ad image tag 10 is required because an image link was provided.
ad_image_11_link is duplicated with another ad image link.
Ad image link 11 length is too long. The maximum length is 2047 characters.
Ad image link 11 is required because an image tag was provided.
ad_image_11_tag is duplicated with another ad image tag.
Ad image tag 11 length is too long. The maximum length is 511 characters.
Ad image tag 11 is required because an image link was provided.
ad_image_12_link is duplicated with another ad image link.
Ad image link 12 length is too long. The maximum length is 2047 characters.
Ad image link 12 is required because an image tag was provided.
ad_image_12_tag is duplicated with another ad image tag.
Ad image tag 12 length is too long. The maximum length is 511 characters.
Ad image tag 12 is required because an image link was provided.
ad_image_13_link is duplicated with another ad image link.
Ad image link 13 length is too long. The maximum length is 2047 characters.
Ad image link 13 is required because an image tag was provided.
ad_image_13_tag is duplicated with another ad image tag.
Ad image tag 13 length is too long. The maximum length is 511 characters.
Ad image tag 13 is required because an image link was provided.
ad_image_14_link is duplicated with another ad image link.
Ad image link 14 length is too long. The maximum length is 2047 characters.
Ad image link 14 is required because an image tag was provided.
ad_image_14_tag is duplicated with another ad image tag.
Ad image tag 14 length is too long. The maximum length is 511 characters.
Ad image tag 14 is required because an image link was provided.
ad_image_15_link is duplicated with another ad image link.
Ad image link 15 length is too long. The maximum length is 2047 characters.
Ad image link 15 is required because an image tag was provided.
ad_image_15_tag is duplicated with another ad image tag.
Ad image tag 15 length is too long. The maximum length is 511 characters.
Ad image tag 15 is required because an image link was provided.
ad_image_16_link is duplicated with another ad image link.
Ad image link 16 length is too long. The maximum length is 2047 characters.
Ad image link 16 is required because an image tag was provided.
ad_image_16_tag is duplicated with another ad image tag.
Ad image tag 16 length is too long. The maximum length is 511 characters.
Ad image tag 16 is required because an image link was provided.
ad_image_17_link is duplicated with another ad image link.
Ad image link 17 length is too long. The maximum length is 2047 characters.
Ad image link 17 is required because an image tag was provided.
ad_image_17_tag is duplicated with another ad image tag.
Ad image tag 17 length is too long. The maximum length is 511 characters.
Ad image tag 17 is required because an image link was provided.
ad_image_18_link is duplicated with another ad image link.
Ad image link 18 length is too long. The maximum length is 2047 characters.
Ad image link 18 is required because an image tag was provided.
ad_image_18_tag is duplicated with another ad image tag.
Ad image tag 18 length is too long. The maximum length is 511 characters.
Ad image tag 18 is required because an image link was provided.
ad_image_19_link is duplicated with another ad image link.
Ad image link 19 length is too long. The maximum length is 2047 characters.
Ad image link 19 is required because an image tag was provided.
ad_image_19_tag is duplicated with another ad image tag.
Ad image tag 19 length is too long. The maximum length is 511 characters.
Ad image tag 19 is required because an image link was provided.
ad_image_1_link is duplicated with another ad image link.
Ad image link 1 length is too long. The maximum length is 2047 characters.
Ad image link 1 is required because an image tag was provided.
ad_image_1_tag is duplicated with another ad image tag.
Ad image tag 1 length is too long. The maximum length is 511 characters.
Ad image tag 1 is required because an image link was provided.
ad_image_2_link is duplicated with another ad image link.
Ad image link 2 length is too long. The maximum length is 2047 characters.
Ad image link 2 is required because an image tag was provided.
ad_image_2_tag is duplicated with another ad image tag.
Ad image tag 2 length is too long. The maximum length is 511 characters.
Ad image tag 2 is required because an image link was provided.
ad_image_3_link is duplicated with another ad image link.
Ad image link 3 length is too long. The maximum length is 2047 characters.
Ad image link 3 is required because an image tag was provided.
ad_image_3_tag is duplicated with another ad image tag.
Ad image tag 3 length is too long. The maximum length is 511 characters.
Ad image tag 3 is required because an image link was provided.
ad_image_4_link is duplicated with another ad image link.
Ad image link 4 length is too long. The maximum length is 2047 characters.
Ad image link 4 is required because an image tag was provided.
ad_image_4_tag is duplicated with another ad image tag.
Ad image tag 4 length is too long. The maximum length is 511 characters.
Ad image tag 4 is required because an image link was provided.
ad_image_5_link is duplicated with another ad image link.
Ad image link 5 length is too long. The maximum length is 2047 characters.
Ad image link 5 is required because an image tag was provided.
ad_image_5_tag is duplicated with another ad image tag.
Ad image tag 5 length is too long. The maximum length is 511 characters.
Ad image tag 5 is required because an image link was provided.
ad_image_6_link is duplicated with another ad image link.
Ad image link 6 length is too long. The maximum length is 2047 characters.
Ad image link 6 is required because an image tag was provided.
ad_image_6_tag is duplicated with another ad image tag.
Ad image tag 6 length is too long. The maximum length is 511 characters.
Ad image tag 6 is required because an image link was provided.
ad_image_7_link is duplicated with another ad image link.
Ad image link 7 length is too long. The maximum length is 2047 characters.
Ad image link 7 is required because an image tag was provided.
ad_image_7_tag is duplicated with another ad image tag.
Ad image tag 7 length is too long. The maximum length is 511 characters.
Ad image tag 7 is required because an image link was provided.
ad_image_8_link is duplicated with another ad image link.
Ad image link 8 length is too long. The maximum length is 2047 characters.
Ad image link 8 is required because an image tag was provided.
ad_image_8_tag is duplicated with another ad image tag.
Ad image tag 8 length is too long. The maximum length is 511 characters.
Ad image tag 8 is required because an image link was provided.
ad_image_9_link is duplicated with another ad image link.
Ad image link 9 length is too long. The maximum length is 2047 characters.
Ad image link 9 is required because an image tag was provided.
ad_image_9_tag is duplicated with another ad image tag.
Ad image tag 9 length is too long. The maximum length is 511 characters.
Ad image tag 9 is required because an image link was provided.
Some items have ad links that are formatted incorrectly.
Some items have ad link URLs that are duplicates of the link URLs for those items.
ad_video_0_link is duplicated with another ad video link.
ad_video_0_link length is too long. The maximum length is 511 characters.
ad_video_0_link is required for this item because ad_video_0_tag was provided.
ad_video_0_link is formatted incorrectly and will not be published with your items.
ad_video_0_tag is duplicated with another ad video tag.
ad_video_0_tag length is too long. The maximum length is 511 characters.
ad_video_0_tag is required because ad_video_0_link was provided.
ad_video_1_link is duplicated with another ad video link.
ad_video_1_link length is too long. The maximum length is 511 characters.
ad_video_1_link is required for this item because ad_video_1_tag was provided.
ad_video_1_link is formatted incorrectly and will not be published with your items.
ad_video_1_tag is duplicated with another ad video tag.
ad_video_1_tag length is too long. The maximum length is 511 characters.
ad_video_1_tag is required because ad_video_1_link was provided.
ad_video_2_link is duplicated with another ad video link.
ad_video_2_link length is too long. The maximum length is 511 characters.
ad_video_2_link is required for this item because ad_video_2_tag was provided.
ad_video_2_link is formatted incorrectly and will not be published with your items.
ad_video_2_tag is duplicated with another ad video tag.
ad_video_2_tag length is too long. The maximum length is 511 characters.
ad_video_2_tag is required because ad_video_2_link was provided.
Some items have additional_image_link URLs that contain too many characters, so those items will not be published.
Some items have additional_image_link URLs that are formatted incorrectly and will not be published with your items.
Some items have adwords_redirect links that are formatted incorrectly.
Some items have adwords_redirect URLs that are duplicates of the link URLs for those items.
Some items have age group values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
Some items include invalid android_deep_link.
Some items have availability_date values that are formatted incorrectly, those items will be published without an availability date.
Some items include a currency that doesn't match the usual currency for the location where that product is sold or shipped.
Some items have custom_label values that are too long, those items will be published without that custom label.
The description for some items were truncated because they contain too many characters.
Some items have expiration_date values that are formatted incorrectly, those items will be published without an expiration date.
Ingestion completed early because there are no changes to your feed since the last successful update.
Some items have gender values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
Some items include incorrectly formatted GTINs.
Some items have image_link URLs that are formatted incorrectly and will not be published with those items.
Some items include inconsistent currencies in price fields.
The product count has increased or decreased significantly compared to the last successful ingestion.
Some items include invalid ios_deep_link values.
Some items have is_bundle values that are formatted incorrectly, those items will be published without being bundled with other products.
Some items include additional_image_links that can't be found.
Some items have an invalid product link which contains invalid UTM tracking paramaters.
Some items include min_ad_price values that are formatted incorrectly.
Some items include incorrectly formatted MPNs.
Some items have invalid multipack values.
Some items include condition values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
Some items are missing a condition value, which may limit visibility in recommendations, search results and shopping experiences.
Some items include google_product_category values that are not formatted correctly according to the GPC taxonomy.
Some items are missing a google_product_category.
Some items only have 1 or 2 levels of google_product_category values, which may limit visibility in recommendations, search results and shopping experiences.
Some items have product_type values that are too long, those items will be published without that product type.
Some items have sale_price_effective_date values that are formatted incorrectly, those items will be published without a sale date.
Some items have sale price values that are higher than the original price of the item.
Some items include a sales price that is higher than the list price. The sales price has been defaulted to the list price.
Some items include sales price that is much lower than the list price.
Some items include incorrectly formatted shipping_height.
Some items have shipping values that are formatted incorrectly.
Some items have invalid shipping_weight values.
Some items include incorrectly formatted shipping_width.
Some items have size system values which are not one of the supported size systems.
Some items have size type values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
Some items have tax values that are formatted incorrectly.
The title for some items were truncated because they contain too many characters.
Some items have additional_image_link values that exceed the limit for additional images, those items will be published without some of your images.
Some items have updated_time values thate are formatted incorrectly, those items will be published without an updated time.
Some items include utm_source values that are formatted incorrectly and have been automatically corrected.
A video is required in the item when ad_video fields are provided.
Some items have weight_unit values that are formatted incorrectly, those items will be published without a weight unit.
The number of videos successfully ingested from the feed file.
The number of videos that were not ingested from the feed file.
A human-friendly name associated to a given feed.
Catalog id pertaining to the feed. If not provided, feed will use a default catalog based on type. Currently, this field has no effect.
Catalog id pertaining to the feed. If not provided, feed will use a default catalog based on type. At the moment a catalog can not have multiple hotel feeds but this will change in the future.
Catalog id pertaining to the feed. If not provided, feed will use a default catalog based on type. At the moment a catalog can not have multiple creative assets feeds but this will change in the future.
Provided value that caused the validation issue.
The merchant-created unique ID that represents the product.
Item number based on order of appearance in the Catalogs Feed. For example, '0' refers to first item found in a feed that was downloaded from a 'location' specified during feed creation.
Base price of the hotel room per night followed by the ISO currency code
The brand to which this hotel belongs to.
The type of property. The category can be any type of internal description desired.
A list of neighborhoods where the hotel is located
Sale price of a hotel room per night. Used to advertise discounts off the regular price of the hotel.
Required for countries with a postal code system. Postal or zip code of the hotel.
State, county, province, where the hotel is located.
Total number of people who have rated this hotel.
<= 2000 characters The links to additional images for your hotel. Up to ten additional images can be used to show a hotel from different angles. Must begin with http:// or https://.
<= 2000 characters The link to the main hotel image. Image should be at least 75x75 pixels to avoid errors. Use the additional_image_link field to add more images of your hotel. The URL of your main_image.link must be accessible by the Pinterest user-agent, and send the accurate image. Please make sure there is no template or placeholder image at the link. Must start with http:// or https://.
Tag appended to the image that identifies image category or details. There can be multiple tags associated with an image
Catalog id pertaining to the retail item. If not provided, default to oldest retail catalog
Catalog id pertaining to the hotel item. If not provided, default to oldest hotel catalog
Catalog id pertaining to the creative assets item. If not provided, default to oldest creative assets catalog
<= 2000 characters The link to the main product images. Images should be at least 75x75 pixels to avoid errors. Use the additional_image_link field to add more images of your product. The URL of your image_link must be accessible by the Pinterest user-agent, and send the accurate images. Please make sure there are no template or placeholder images at the link. Must start with http:// or https://.
The catalog hotel id in the merchant namespace
The catalog creative assets id in the merchant namespace
Brief description of the creative assets.
IOS deep link to the creative assets page.
Visibility of the creative assets. Must be one of the following values (upper or lowercase): ‘visible’, ‘hidden’.
Array with the errors for the item id requested
The attribute that the item validation event references
The event code that the item validation event references
Title message describing the item validation event
Date and time (UTC) of the batch completion: YYYY-MM-DD'T'hh:mm:ss
Date and time (UTC) of the batch creation: YYYY-MM-DD'T'hh:mm:ss
Array with the catalogs items processing records part of the catalogs items batch
Array with the validation errors for the item processing record. A non empty errors list causes the item processing to fail.
Array with the validation warnings for the item processing record
Date and time (UTC) of the batch creation: YYYY-MM-DD'T'hh:mm:ss. If null, batch creation was skipped due to a recent duplicate ingestion.
We recommend using the CatalogsLocale values.
The catalog hotel item id in the merchant namespace
Array with creative assets item operations
The catalog creative assets item id in the merchant namespace
Catalog Feed id pertaining to the catalog product group filter.
Object holding a group of filters for a catalog product group
Unix timestamp in seconds of when catalog product group was created.
ID of the creative assets product group.
Unix timestamp in seconds of last time catalog product group was updated.
id of the catalogs feed belonging to this catalog product group
The user-created unique ID that represents the product.
The user-created unique ID that represents the hotel item.
The user-created unique ID that represents the creative assets item.
The event code that a diagnostics aggregated number references
A human-friendly label for the event code (e.g, 'AVAILABILITY_INVALID')
Title message describing the diagnostic issue
An ERROR means that items have been dropped, while a WARN denotes that items have been ingested despite an issue
A human-friendly label for the event code (e.g, 'SPAM')
Indicates if issue makes items ineligible for ads distribution
Indicates if issue makes items ineligible for organic distribution
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 processing results for a given feed](/docs/api/v5/#operation/feed_processing_results/list). If not provided, default to most recent completed processing result.
Unique identifier of a catalog. If not given, oldest catalog will be used
A human-friendly name associated to a catalog entity.
A human-friendly name associated to a given catalog.
A map of filter attributes to their available values.
Coverage percentage for this event type.
List of issues detected for this event type, if any.
Overlap percentage for this event type. Only populated for external_event_id
Specific messages for each event received. The order will match the order in which the events were received in the request.
Number of events that were successfully processed from the events.
Total number of events received in the request.
App ID in Google Play Store, AppStore or other stores.
Name of the app. Primarily used for Mobile Apps.
The name of the app distributor or store from which the app was installed. Some options: Samsung Galaxy Store, Google Play Store, Amazon Store, Apple App Store, F-Droid, Aptoide, Obtanium, Huawei AppGallery, Xiaomi Mi GetApps
App version. Primarily used for mobile apps
App install time. Unix timestamp in seconds
User Agent request header. Primarily used for Web events
Kernel version. Examples: Linux: 6.15. Obtain by running: uname -r MacOS: 24.3.0. Obtain by running: sysctl kern.version Android: 6.6. Obtain from OS.uname().release
List of user installed languages. ISO 639-1 format
Network type: 4G, 5G, ethernet, wifi In Android: NetworkCapabilities.getNetworkCapabilities()
Short name of the OS. This value if specific to os family. Examples: Windows: 10, 11; Android: 16; iOS: 18; MacOS: 15; Linux: Debian, Ubuntu, Arch
Marketing name for the release version iOS: Dawn Android: Baklava MacOS: Sequoia Ubuntu Linux: Plucky Puffin
Full name of the version. Examples: iOS: 18.3 Android: 16.1 MacOS: 15.5 Windows: 24H2 Ubuntu Linux: 25.04
The unique identifier stored in _epik cookie on your domain or &epik= query parameter in the URL. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA.
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.
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.
Sha256 hashes of two-character ISO-3166 country code indicating the user's country, in lowercase. The string should be in the UTF-8 format.
Sha256 hashes of user's city, in lowercase, and without spaces or punctuation. User residency city (mostly billing). The string should be in the UTF-8 format.
Sha256 hashes of user's date of birthday, given as year, month, and day. The string should be in the UTF-8 format.
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.
Sha256 hashes of the unique id from the advertiser that identifies a user in their space, e.g. user id, loyalty id, etc. We highly recommend this on all events. It may improve reporting performance such as ROAS/CPA. The string should be in the UTF-8 format.
Sha256 hashes of user's first name, in lowercase. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. The string should be in the UTF-8 format.
Sha256 hashes of user's gender, in lowercase. Either "f" or "m" or "n" for non-binary gender. The string should be in the UTF-8 format.
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.
Sha256 hashes of user's last name, in lowercase. We highly recommend this on checkout events at least. It may improve reporting performance such as ROAS/CPA. The string should be in the UTF-8 format.
A unique identifier of visitors' information defined by third party partners. e.g RampID
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.
Sha256 hashes of user's state, given as a two-letter code in lowercase. User residency state (mostly billing). The string should be in the UTF-8 format.
Sha256 hashes of user's zipcode, only digits. User residency zipcode (mostly billing). The string should be in the UTF-8 format.
Customer List Upload creation_time. Epoch (seconds).
ID of the customer list associated with this upload.
Customer List Upload updated_time. Epoch (seconds).
Array of file parts with pre-signed URLs.
Total number of list updates. List creation counts as one batch. Each Append or Remove API call counts as another. List creation via the Ads Manager UI could result in more than one batch since the UI breaks up large lists.
Number of removed user records. In a Remove API call, this counter increases even if the user is not found in the list.
Number of uploaded user records. In an Append API call, this counter increases even if the uploaded user is already in the list.
Customer list status. TOO_SMALL - the list has less than 100 Pinterest users.
Records list. Can be any combination of emails, MAIDs, or IDFAs. Emails must be lowercase and can be plain text or hashed using SHA1, SHA256, or MD5. MAIDs and IDFAs must be hashed with SHA1, SHA256, or MD5.
Version number of the integration application.
Timestamp in milliseconds of when the log was executed at the client.
Version number of the platform the integration application is running on.
Column number in the line of the file that raised the error.
Human-readable description of the error.
Stack trace of where the error happened.
HTTP request headers as key-value pairs.
HTTP response headers as key-value pairs.
External business ID for the integration.
Keyword's search frequency. This value is based on keyword frequency in pepsi client response
Keyword name, e.g., "keyword":"fashion outfits"
Keywords to update. Object array. Each object has 2 possible fields: 1. "id": (required) keyword ID 2. "archived": boolean. Should keyword be archived? For example: [{"id":"2886610576653", "archived": false}, {"id":"2886610576654", "archived": true}, ...]
The top trending keywords for the specified trend type in the requested region. Results are ordered, with the first element in the array representing the #1 top trend.
Labels that were not successfully applied.
The Ad Account ID that this lead form belongs to.
Subscription creation time. Unix timestamp in milliseconds.
Base64 encoded key for client to decrypt lead data.
User account used to subscribe lead data.
Partner access token. Only for clients that requires authentication. We recommend to avoid this param.
Partner metadata. Only for clients that requires special handling. We recommend to avoid this param.
Partner refresh token. Only for clients that requires authentication. We recommend to avoid this param.
Text field value that uniquely identifies a subscriber.
A message for people who complete the form to let them know what happens next.
Additional disclosure language to be included in the lead form.
Whether the advertiser has accepted Pinterest's terms of service for creating a lead ad. By sending us TRUE for this parameter, you agree that (i) you will use any personal information received in compliance with the privacy policy you share with Pinterest, and (ii) you will comply with Pinterest's Lead Ad Terms. As a reminder, all advertising on Pinterest is subject to the Pinterest Advertising Services Agreement or an equivalent agreement as set forth on an IO
List of additional policy links to be displayed on the lead form.
A link to the advertiser's privacy policy. This will be included in the lead form's disclosure language.
List of questions to be displayed on the lead form.
Test lead answers. Should follow the creation order.
Lead form creation time. Unix timestamp in seconds.
Export leads collected on and before end date (UTC). Format: YYYY-MM-DD
Export leads collected on and after start date (UTC). Format: YYYY-MM-DD
Unique identifier for this media upload. Used to track status and for attaching during Pin creation.
The list of parameter key/value pairs you will need to send with your POST request to upload your media file.
The URL where you will POST your media file.
Timestamp(s) when the ad action(s) happened. Unix timestamp in seconds.
The ID of the ad group that was attributed to the conversion event.
The attribution model used to attribute the conversion event.
Credit given to the attributed ad actions. Allowed values are > 0 and <= 1.
The ID of the campaign that was attributed to the conversion event.
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.
The time when the event occurred. Unix timestamp in seconds.
Total number of ad events including other non-Pinterest ad platforms.
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.
Order value of the conversion event. Required if event_name is 'add_to_cart' or 'checkout'.
Array with the requested daily metric records
The metric name and value over the requested period for each requested metric
Pin media source that can be an image, video, or a mix of both passed in as a request.
The sponsor account id to request paid partnership from. Currently the field is only available to a list of users in a closed beta.
Set the parameter to false to create the new simplified Pin instead of the standard pin. Currently the field is only available to a list of beta users.
Keyframe timestamp for cover image (seconds). If entered time exceeds video duration, the last frame is used.
This is an affiliate link or sponsored product. The FTC requires disclosure for paid partnerships and affiliate products.
Indicates whether the keyword has a prediction available for the next 90 days. This field is only applicable when include_prediction query parameter is set to true. By default, the value is false and no prediction data is included in the response.
A sequence of weekly observations of the predicted relative search volume for this keyword over the next 3 months. These values are normalized to a [0-100] range, and can be used to visualize the forecasted user interest in this keyword. Similar to the historical time_series, normalization is applied independently to the predicted time series of each keyword, but the normalize_against_group query parameter can be used in cases where you wish to compare relative predicted volume between keywords. **Note**: The cut-off date between historical and predicted time series depends on Pinterest data availability. Usually the data needs a few days to be calculated, so the predicted time series may contain some past dates compared to today. **Note**: The date of each observation is in ISO-8601 format and represents the end of the week. For example, a value of 2024-01-07 would include predicted searches for the week ending on 2024-01-07.
Related search terms for this product category
Time series data showing trend values over time, indexed between 0 and 100
Percentage of users with unspecified gender
Vertical name associated with the product category
List of trending topics within this interest category
Array of pin images related to this trend (up to 6)
Time series data showing trend values over time, with dates as keys and values as numeric
Discount status based on the current time and start and end time of discount
Promotion end time. Unix timestamp in seconds. Independent of campaign end time.
Platform-specific ID for this promotion. Will be null for promotions first created within Pinterest.
The source integration platform used when creating the promotion. Currently supported values are 'DEFAULT' and 'SHOPIFY'.
Code that can be used to redeem a promotion.
An optional field for user defined promotion ID for this promotion. Will copy from Pinterest system generated ID if user did not provide one.
Promotion start time. Unix timestamp in seconds. Independent of campaign start time.
List of values to be inserted in the promotion type-specific template.
The Ad Account ID that this promotion belongs to.
Enable auto-targeting for ad group. Also known as "expanded targeting".
The ID of the advertiser that this targeting template belongs to.
Targeting template created time. Unix timestamp in seconds.
Indicate targeting template is active or Deleted
Targeting template updated time.Unix timestamp in seconds.
Inform if the targeting template is valid (ex. would be false if has revoked audience)
First input term. For example, if you pass "?terms=clothes,workout", then id will be "clothes"
Whether the ad account has accepted terms of service.
The metric name and daily value for each requested metric
User account board count. **Note**: Board count on user account level may differ from counts found elsewhere due to attribution of collaborative Boards.
User account pin count. This includes both created and saved pins.
Whether this request comes as result of auto-follow after clicking on a link. Follow links can be used by partners on their site or in emails. Only selected partners can be followed this way. We verify that partner can be auto-followed.
UTC timestamp when the verification happened - sometimes missing
DNS TXT record to check against for the website to be claimed
A full html file to upload to the website in order for it to be claimed
File expected to find on the website being claimed
Metatag the verification process searchs for the website to be claimed
Code to check against the user claiming the website