Returns: DistinctPropertyValues
Returns an object that contains the list of a publisher's unique promotional methods and property types.
| Argument | Type | Description |
|---|
| publisherId | ID! | The publisher’s CID |
Returns: PromotionalProperties
Returns the details of one or more promotional properties, filtered according to the supplied arguments.
| Argument | Type | Description |
|---|
| limit | Int | The maximum number of results to display. Default is 10. Maximum is 100. |
| offset | Int | The record number of the first record to display. For example setting Offset to 10 will display results starting with the tenth result. Use in conjunction with Limit to control pagination. |
| publisherId | ID! | The publisher’s CID |
| search | String | Keyword search for publisher’s promotional properties. Searches the property name, property ID and description. |
| status | PromotionalPropertyStatus | The status of the property |
Returns: [PromotionalProperty!]!
Returns a list of promotional properties by their PIDs.
| Argument | Type | Description |
|---|
ids | [ID!]! | Comma separated list of property IDs. Maximum 100 Ids can be sent in one request. |
Returns: PromotionalProperty
Returns a single promotional property by its ID.
| Argument | Type | Description |
|---|
id | ID! | A promotional property ID. |
Browser extension type properties may each have multiple browser extension platforms. In other words you may have links to the Chrome, Firefox, Safari and Opera versions of your app all registered to the same property. Use the BrowserExtensionDownloadInformation object to indicate the download links and supported browsers for your browser extension.
| Field | Type | Description |
|---|
| browserExtensionBrowser | BrowserType! | The type of browser that the extension operates on |
| browserExtensionDownloadLink | String! | The link where the end user can download the extension onto their own browser |
| Field | Type | Description |
|---|
| promotionalModels | [String!]! | List of all promotional models a publisher is using for their promotional properties |
| propertyTypes | [String!]! | List of all property types a publisher is using for their promotional properties |
Mobile app type properties may each have multiple mobile app platforms. In other words you may have both the iOS and Android download links for your app registered to the same property. Use the MobileAppDownloadInformation object to indicate the download link and supported devices for your mobile app.
| Field | Type | Description |
|---|
| mobileAppDownloadLink | String! | The link where the end user may download the app onto their own device |
| mobileAppPlatform | MobileAppPlatform! | The platform or operating system that the app is built to operate on |
| Field | Type | Description |
|---|
| description | String | A text description of the promotional model for "other" type properties. Not supported for other property types. |
| isPrimary | Boolean! | Indicates whether this property is the primary property for this CID. This is used primarily for reporting. |
| type | PromotionalModelType! | Describes the kind of promotional model |
| Field | Type | Description |
|---|
| resultList | [PromotionalProperty!]! | A list of promotional properties |
| totalCount | Int! | Total count of promotional properties |
| Field | Type | Description |
|---|
| createdAt | ISODateTime | The time stamp of when the promotional property was created |
| description | String | A text description of the promotional property |
| id | ID! | The promotional property ID |
| isPrimary | Boolean! | Indicates whether this promotional property is the primary promotional property for this CID |
| name | String! | Indicates the name of the promotional property |
| promotionalModels | [PromotionalModel!]! | Indicates the promotional models associated with this promotional property |
| propertyTypeDetails | PromotionalPropertyTypeDetails! | Details for the type of this promotional property |
| publisherId | ID! | The publisher’s CID |
| status | PromotionalPropertyStatus! | Indicates the property’s status |
| tags | [PromotionalPropertyTag!]! | The tags added to this promotional property. |
| updatedAt | ISODateTime | The date stamp of when the promotional property was last edited |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| browserExtensionDescription | String | Describe how your browser extension functions and how customers engage with it. |
| browserExtensionDownloadInformation | [BrowserExtensionDownloadInformation!]! | Browser extension download information |
| browserExtensionName | String! | The name of the browser extension as it appears in the download store |
| browserExtensionTrackingConsentType | TrackingConsentType | Indicates if the browser extension operates on affirmative click only or automatic redirect with affirmative click on request |
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.BROWSER_EXTENSION |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| emailAddress | String! | The address from which the email newsletter campaign is sent to end users |
| emailMailingListSize | String! | The approximate number of unique subscribers to the email newsletter campaign |
| emailOpenRate | String! | The approximate open rate for email newsletters |
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.EMAIL |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| mobileAppDownloadInformation | [MobileAppDownloadInformation!]! | Mobile app download information |
| mobileAppName | String! | The name of the mobile app as it appears in the mobile app store |
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.MOBILE_APP |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| otherDescription | String! | A text description of the promotional property type |
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.OTHER |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| paidDisplayAdsDescription | String! | The platforms where ads are displayed and the click through rates the ads achieve. |
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.PAID_DISPLAY_ADS |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| paidSearchEngineDescription | String! | The platforms where search ads are purchased and the click through rates the ads achieve. |
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.PAID_SEARCH_ENGINE |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| socialMediaHandle | String! | The link or handle to the social media account |
| socialMediaPlatform | SocialPlatform! | The social platform for social media account |
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.SOCIAL |
Optional. Used to add one or more tags to a promotional property. Tags can be keywords, categories, or other values that describes your property. They are searchable and visible by advertisers.
| Field | Type | Description |
|---|
| name | String! | Indicates a tag added to the promotional property |
| Implements |
|---|
| PromotionalPropertyTypeDetails |
| Field | Type | Description |
|---|
| type | PromotionalPropertyType! | Describes the kind of promotional property, in this case PromotionalPropertyType.WEBSITE |
| websiteUrl | String! | The website URL |
