Ads
Get a list of the ad_accounts that the User has access to.
View-Specific Information
SELECT
The driver uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the driver.
| Column | Supported Operators |
| AdAccountId | = |
| Id | =, IN |
| AdGroupId | =, IN |
| CampaignId | =, IN |
| Status | = |
For example:
SELECT * FROM Ads WHERE AdAccountId = '3457832451'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The ID of this ad. | |
| AdAccountId | String |
AdAccounts.Id | Unique identifier of an ad account. |
| AdGroupId | String |
AdGroups.Id | ID of the ad group that contains the ad. |
| AndroidDeepLink | String | Deep link URL for Android devices. Not currently available. Using this field will generate an error. | |
| CampaignId | String |
Campaigns.Id | ID of the ad campaign that contains this ad. |
| CarouselAndroidDeepLinks | String | Comma-separated deep links for the carousel pin on Android. | |
| CarouselDestinationUrls | String | Comma-separated destination URLs for the carousel pin to promote. | |
| CarouselIosDeepLinks | String | Comma-separated deep links for the carousel pin on iOS. | |
| ClickTrackingUrl | String | Tracking URL for the ad clicks. | |
| CollectionItemsDestinationUrlTemplate | String | Destination URL template for all items within a collections drawer. | |
| CreatedTime | Datetime | Pin creation time. | |
| CreativeType | String | The creative type of the ad.
The allowed values are REGULAR, VIDEO, SHOPPING, CAROUSEL, MAX_VIDEO, SHOP_THE_PIN, COLLECTION, IDEA, SHOWCASE, QUIZ, COLLAGE, MAX_WIDTH_REGULAR_COLLECTION, MAX_WIDTH_VIDEO_COLLECTION. | |
| DestinationUrl | String | The destination URL where users are directed after clicking the ad. | |
| DisclosureType | String | Type of disclosure displayed with the ad.
The allowed values are IMPORTANT_SAFETY_INFO, MED_GUIDE, PATIENT_INFORMATION, NO_DISCLOSURE, PRESCRIBING_INFORMATION, PRESCRIBING_INFORMATION_BOX_WARNING. | |
| DisclosureUrl | String | URL of the disclosure document associated with the ad. | |
| IosDeepLink | String | Deep link URL for iOS devices. | |
| IsPinDeleted | Boolean | Indicates whether the original pin has been deleted. | |
| IsRemovable | Boolean | Indicates whether the pin can be repinned by other users. | |
| Name | String | Name of the ad. | |
| PinId | String | The ID of the pin associated with this ad. | |
| RejectedReasons | String | Reason why the pin was rejected. | |
| RejectionLabels | String | Text reason why the pin was rejected. | |
| ReviewStatus | String | The current review status of the ad.
The allowed values are OTHER, PENDING, REJECTED, APPROVED. | |
| Status | String | The current status of the ad.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| SummaryStatus | String | Ad summary status.
The allowed values are APPROVED, PAUSED, PENDING, REJECTED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| TrackingUrlsAudienceVerification | String | The third-party audience verification tracking URL for the ad. | |
| TrackingUrlsBuyableButton | String | The third-party buyable button tracking URL for the ad. | |
| TrackingUrlsClick | String | The third-party click tracking URL for the ad. | |
| TrackingUrlsEngagement | String | The third-party engagement tracking URL for the ad. | |
| TrackingUrlsImpression | String | The third-party impression tracking URL for the ad. | |
| Type | String | The type of the ad. | |
| UpdatedTime | Datetime | Last update time. | |
| ViewTrackingUrl | String | Tracking URL for ad impressions. | |
| LeadFormId | String | The ID of the lead form linked to this lead generation ad. | |
| GridClickType | String | Specifies the destination when a user clicks on an ad in the grid view.
The allowed values are CLOSEUP, DIRECT_TO_DESTINATION. | |
| CustomizableCTAType | String | The type of call-to-action (CTA) displayed below the ad. | |
| QuizPinDataQuestions | String | The list of questions presented to users in the quiz pin. | |
| QuizPinDataResults | String | The possible results shown to users based on their quiz answers, including outbound links. | |
| QuizPinDataTieBreakerType | String | The method used to resolve ties in quiz results, with a default of RANDOM.
The allowed values are RANDOM, CUSTOM. | |
| QuizPinDataTieBreakerCustomResultAndroidDeepLink | String | The Android deep link URL for the custom tie-breaker result of the quiz pin. | |
| QuizPinDataTieBreakerCustomResultDestinationURL | String | The destination URL for the custom tie-breaker result of the quiz pin. | |
| QuizPinDataTieBreakerCustomResultIosDeepLink | String | The iOS deep link URL for the custom tie-breaker result of the quiz pin. | |
| QuizPinDataTieBreakerCustomResultOrganicPinId | String | The organic pin ID used as the custom tie-breaker result for the quiz pin. | |
| QuizPinDataTieBreakerCustomResultId | Integer | The unique identifier of the custom tie-breaker result for the quiz pin. | |
| IsCollageSingleDestination | Boolean | Whether the collage ad has a single destination URL override. | |
| IsCollageAcceptedTerms | Boolean | Whether the advertiser has accepted the terms and conditions for the collage ad. |