The program object holds information for your programs. You can retrieve a program's object as well as list all program objects.

Attributes

Id integer

Unique identifier for the object referred to as the impact.com Program Id.

Name string

Name of the program.

State enum

State of the program.

Categories object

Categories, subcategories, and additional categories that the program is contained in.

ShortDescription string

Initial description of the program when viewed in the marketplace. Max 100 characters.

LongDescription string

Description found on the program's marketplace brand card. Max 250 characters.

ListInMarketplace boolean

Whether the program can be viewed in the marketplace or not.

DisplayServicingAgency boolean

Whether partners can view the program's management agency. Will be false if the program is not managed by an agency.

Rating integer

Program's star rating.

SearchKeywords string

Comma-separated list of SEO keywords used to find the program in the marketplace.

ShippingRegions array

An array of countries representing the global regions this program services.

Resources object

Links that partners can select to learn more about the program or brand.

CompanyContacts array

Contact information that partners can use to contact the brand.

GiftCardPayouts boolean

If the program pays out on actions that were paid for with a gift card.

TrademarkBidding boolean

If the program allows partners to bid on using the brand's trademarked terms in marketing materials.

ThirdPartyImpressionPixel string

Any third-party tracking pixels used by the brand.

MobileReadyAds boolean

If the program's ads can be used on mobile browsers.

DisplayFutureAds boolean

If partners can view ads that cannot yet be used.

PromoCodeTracking boolean

If the program utilizes promo code tracking.

TrackingDomain string

Program's unique tracking link.

SiteDefinition string

Where the tracking domain points to.

ImpressionTracking boolean

If the program tracks ad impressions.

ViewThroughCrediting boolean

If the program tracks view-through conversions.

IdentityMatching enum

How the program matches traffic and conversion identities, usually across devices. Consumer data is hashed before it reaches impact.com.

GatewayTrackingSettings object

Program's gateway tracking details.

DirectTrackingSettings object

Program's direct tracking details.

Uri string

The program's direct URI.

{
  "Id": "1000",
  "Name": "Acme Campaign",
  "State": "ACTIVE",
  "Categories": {
    "PrimaryCategory": "B2B, Services & Office Supplies",
    "PrimarySubCategories": [
      "B2B"
    ],
    "AdditionalCategory": "",
    "AdditionalSubCategories": []
    },
  "ShortDescription": "This is a short description.",
  "LongDescription": "This is a long description. Find more words here.",
  "ListInMarketplace": "true",
  "DisplayServicingAgency": "false",
  "Rating": "3",
  "SearchKeywords": "Anvils",
  "ShippingRegions": [
    "United States"
  ],
  "Resources": {
    "CompanyHomepage": "www.acme.com",
    "ExampleLandingPage": "",
    "InformationPage": "",
    "AdditionalRelatedLinks": []
  },
  "CompanyContacts": [
    {
      "FirstName": "Brand",
      "LastName": "Man",
      "EmailAddress": "[email protected]",
      "PhoneNumber": "+1(805) 123-1234"
    }
  ],
  "GiftCardPayouts": "false",
  "TrademarkBidding": "false",
  "ThirdPartyImpressionPixel": "",
  "MobileReadyAds": "false",
  "DisplayFutureAds": "false",
  "PromoCodeTracking": "true",
  "TrackingDomain": "acme.sjv.io",
  "SiteDefinition": "www.acme.com",
  "ImpressionTracking": "false",
  "ViewThroughCrediting": "false",
  "IdentityMatching": "IR_CONSORTIUM",
  "GatewayTrackingSettings": {
    "DefaultLandingPage": "http://www.acme.com",
    "MediaPartnerTrackingTemplate": "asd=1&foo=4&asf=2&clickid={clickid}",
    "CampaignTrackingTemplate": "",
    "SSLSupport": "true",
    "DeepLinking": "true",
    "DeepLinkDomains": "acme.com/store/forge/anvils/anvil2",
    "ThirdPartyGatewayUrl": "",
    "ThirdPartyGatewayQueryStringParameters": "",
    "UniqueClickWindowLength": "30m",
    "UniqueClickWindowType": "ROLLING"
    },
  "DirectTrackingSettings": {
    "UnidentifiedName": "",
    "SessionWindowLength": ""
    },
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000"
}