Mutation Reference

Mutation

createPromotionalProperty

Returns: PromotionalProperty

Used to add a new promotional property to your publisher program

ArgumentTypeDescription
inputCreatePromotionalPropertyInputSee CreatePromotionalPropertyInput

updatePromotionalProperty

Returns: PromitionalProperty

Used to update an existing promotional property within your own publisher program.

ArgumentTypeDescription
inputUpdatePromotionalPropertyInputSee UpdatePromotionalPropertyInput

Input Objects

BrowserExtensionDownloadInformationInput

FieldTypeDescription
browserExtensionBrowserBrowserTypeThe browser type for browser extension promotional properties
browserExtensionDownloadLinkStringThe URL where the end user can download the extension onto their own browser for browser extension promotional properties

CreatePromotionalPropertyInput

Used to add a new promotional property to your publisher program.

FieldTypeDescription
nameString!The name for the promotional property
descriptionStringAn advertiser-facing description of the promotional property. This field is optional.
publisherIdID!The publisher CID
propertyTypeDetailsPromotionalPropertyTypeDetailsInput!Details about the promotional property specific to the property’s property type.
promotionalModels[PromotionalModelInput!]!Details about the promotional property’s promotional models.
tags[PromotionalPropertyTagInput!]!Publisher-supplied tags to describe the promotional property. Used as keywords, categories, or any other type of tag.
statusPromotionalPropertyStatus!The status of the promotional property
isPrimaryBoolean!Indicates if this property is the primary property for the whole publisher account. This is used primarily for reporting purposes.

MobileAppDownloadInformationInput

FieldTypeDescription
mobileAppDownloadLinkStringThe URL where the end user may download the app onto their own device for mobile app promotional properties
mobileAppPlatformMobileAppPlatformThe mobile app platform for mobile app promotional properties

PromotionalModelInput

FieldTypeDescription
typePromotionalModelType!The promotional model type
isPrimaryBoolean!indicates if this is the primary promotional model for this promotional property
descriptionStringA text description of the promotional model for "other" type properties. Only supported on "other" type promotional models

PromotionalPropertyTagInput

Used to add a tag to a promotional property. Tags can be keywords, categories, or other value that describes your property. They are searchable and visible by advertisers.

FieldTypeDescription
nameString!Name of publisher-supplied tags on the promotional property.

PromotionalPropertyTypeDetailsInput

FieldTypeDescription
typePromotionalPropertyType!The property type of the promotional property.
websiteUrlStringthe URL for website promotional properties
browserExtensionNameStringThe name of the browser extension as it appears in the download store
browserExtensionDownloadInformation[BrowserExtensionDownloadInformationInput!]Browser extension download information input
browserExtensionTrackingConsentTypeTrackingConsentTypeIndicates if the browser extension operates on affirmative click only or automatic redirect with affirmative click on request for browser extension promotional properties.
browserExtensionDescriptionStringDescribe how your browser extension functions and how customers engage with it.
browserExtensionTrackingDescriptionStringIndicates if the browser extension operates on affirmative click only or automatic redirect with affirmative click on request for browser extension promotional properties.
mobileAppNameStringThe app name for mobile app promotional properties
mobileAppDownloadInformation[MobileAppDownloadInformationInput!]Mobile app download information input
servicesAndToolsMarketingSiteUrlStringThe marking site URL for the services and tools promotional properties
emailAddressStringThe send-from email address for email promotional properties
emailMailingListSizeIntThe size of the mailing list for email promotional properties
emailOpenRateFloatThe approximate open rate for email promotional properties
socialMediaPlatformSocialPlatformThe social media platform for social media promotional properties
socialMediaHandleStringThe account link or handle for social promotional properties
paidDisplayAdsDescriptionStringThe platforms where display ads are purchased and the click through rates the ads achieve.
paidSearchEngineDescriptionStringThe platforms where search ads are purchased and the click through rates the ads achieve.
otherDescriptionStringA text description of the promotional property type for other promotional properties

UpdatePromotionalPropertyInput

Used to update an existing promotional property within your own publisher program.

FieldTypeDescription
idID!The promotional property ID
nameString!The name for the promotional property
descriptionStringAn advertiser-facing description of the promotional property. This field is optional.
publisherIdID!The publisher CID
propertyTypeDetailsPromotionalPropertyTypeDetailsInput!Details about the promotional property specific to the property’s property type.
promotionalModels[PromotionalModelInput!]!Details about the promotional property’s promotional models.
tags[PromotionalPropertyTagInput!]!Publisher-supplied tags to describe the promotional property. Used as keywords, categories, or any other type of tag.
statusPromotionalPropertyStatus!The status of the promotional property
isPrimaryBoolean!Indicates if this property is the primary property for the whole publisher account. This is used primarily for reporting purposes.

Interfaces

PromotionalPropertyTypeDetails

Implementations
PromotionalPropertyBrowserExtensionDetails
PromotionalPropertyEmailDetails
PromotionalPropertyMobileAppDetails
PromotionalPropertyOtherDetails
PromotionalPropertyPaidDisplayAdsDetails
PromotionalPropertyPaidSearchDetails
PromotionalPropertyServicesAndToolsDetails
PromotionalPropertySocialMediaDetails
PromotionalPropertyWebsiteDetails
FieldTypeDescription
typePromotionalPropertyType!List of property types


Did this page help you?