Attributes

`AdvertiserId` integer

The unique identifier for the advertisers with whom you've partnered.

`AdvertiserName` string

The name of the advertisers with whom you've partnered.

`AdvertiserUrl` string

This is the URL to the website of the brands with whom you've partnered.

`CampaignId` integer

The unique identifier of the program (formerly known as campaigns) that you have partnered with.

`CampaignName` string

The name of the program (formerly known as campaigns) that you have partnered with.

`CampaignUrl` string

This is the URL of the programs that you've joined.

`CampaignDescription` string

This is a field that brands use to describe their programs.

`ShippingRegions` array

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

View possible country values

Possible enum values
`US`
`UK`
`CANADA`
`AUSTRALIA`
`GERMANY`
`FRANCE`
`AFGHANISTAN`
`ALBANIA`
`ALGERIA`
`AMERICANSAMOA`
`ANDORRA`
`ANGOLA`
`ANGUILLA`
`ANTARCTICA`
`ANTIGUABARBUDA`
`ARGENTINA`
`ARMENIA`
`ARUBA`
`AUSTRIA`
`AZERBAIJAN`
`BAHAMAS`
`BAHRAIN`
`BANGLADESH`
`BARBADOS`
`BELARUS`
`BELGIUM`
`BELIZE`
`BENIN`
`BERMUDA`
`BHUTAN`
`BOLIVIA`
`BOSNIAHERZEGOVINA`
`BOTSWANA`
`BRAZIL`
`BRITISHINDIANOCEANTERRITORY`
`BRUNEIDARUSSALAM`
`BULGARIA`
`BURKINAFASO`
`BURUNDI`
`CAMBODIA`
`CAMEROON`
`CAPVERDE`
`CAYMANISLANDS`
`CENTRALAFRICANREPUBLIC`
`CHAD`
`CHILE`
`CHINA`
`CHRISTMASISLAND`
`COCOSISLANDS`
`COLOMBIA`
`COMOROS`
`CONGO`
`DEMOCRATICREPUBLICCONGO`
`COOKISLANDS`
`COSTARICA`
`IVORYCOAST`
`CROATIA`
`CUBA`
`CYPRUS`
`CZECHREPUBLIC`
`DENMARK`
`DIJIBOUTI`
`DOMINICA`
`DOMINICANREPUBLIC`
`ECUADOR`
`EGYPT`
`ELSALVADOR`
`EQUATORIALGUINEA`
`ELSALVADOR`
`ERITREA`
`ESTONIA`
`ETHIOPIA`
`FALKLANDISLANDS`
`FAROEISLANDS`
`FIJI`
`FINLAND`
`FRENCHGUIANA`
`FRENCHPOLYNESIA`
`FRENCHSOUTHERNTERRITORIES`
`GABON`
`GAMBIA`
`GEORGIA`
`GHANA`
`GIBRALTAR`
`GREECE`
`GREENLAND`
`GRENADA`
`GUADELOUPE`
`GUAM`
`GUATEMALA`
`GUERNSEY`
`GUINEA`
`GUINEABISSAU`
`GUYANA`
`HAITI`
`VATICAN`
`HONDURAS`
`HONGKONG`
`HUNGARY`
`ICELAND`
`INDIA`
`INDONESIA`
`IRAN`
`IRAQ`
`IRELAND`
`ISRAEL`
`ITALY`
`JAMAICA`
`JAPAN`
`JORDAN`
`KAZAKHSTAN`
`KENYA`
`KIRIBATI`
`SOUTHKOREA`
`KUWAIT`
`KYRGYZSTAN`
`LAOS`
`LATVIA`
`LEBANON`
`LESOTHO`
`LIBERIA`
`LIBYA`
`LICHTENSTEIN`
`LITHUANIA`
`LUXEMBOURG`
`MACAO`
`MACEDONIA`
`MADAGASCAR`
`MALAWI`
`MALAYSIA`
`MALDIVES`
`MALI`
`MALTA`
`MARSHALLISLANDS`
`MARTINIQUE`
`MAURITANIA`
`MAURITIUS`
`MAYOTTE`
`MEXICO`
`MICRONESIA`
`MOLDOVA`
`MONACO`
`MONGOLIA`
`MONTENEGRO`
`MONTSERRAT`
`MOROCCO`
`MOZAMBIQUE`
`MYANMAR`
`NAMIBIA`
`NAURU`
`NEPAL`
`NETHERLANDS`
`NETHERLANDSANTILLES`
`NEWCALEDONIA`
`NEWZEALAND`
`NICARAGUA`
`NIGER`
`NIGERIA`
`NIUE`
`NORFOLKISLAND`
`NORTHKOREA`
`NORTHERNMARIANAISLANDS`
`NORWAY`
`OMAN`
`PAKISTAN`
`PALAU`
`PALESTINIANTERRITORY`
`PANAMA`
`PAPUANEWGUINEA`
`PARAGUAY`
`PERU`
`PHILIPPINES`
`PITCAIRN`
`POLAND`
`PORTUGAL`
`PUERTORICO`
`QATAR`
`REUNION`
`ROMANIA`
`RUSSIA`
`RWANDA`
`SAINTHELENA`
`SAINTKITTSNEVIS`
`SAINTLUCIA`
`SAINTPIERREMIQUELON`
`SAINTVINCENTGRENADINES`
`SAMOA`
`SANMARINO`
`SAOTOME`
`SAUDIARABIA`
`SENEGAL`
`YOGOSLAVIA`
`SEYCHELLES`
`SIERRALEONE`
`SINGAPORE`
`SLOVAKIA`
`SLOVENIA`
`SOLOMONISLANDS`
`SOMALIA`
`SOUTHAFRICA`
`SPAIN`
`SRILANKA`
`SUDAN`
`SURINAME`
`SVALBARDJANMAYEN`
`SWAZILAND`
`SWEDEN`
`SWITZERLAND`
`SYRIA`
`TAIWAN`
`TAJIKISTAN`
`TANZANIA`
`THAILAND`
`TIMOR`
`TOGO`
`TOKELAU`
`TONGA`
`TRINIDADTOBAGO`
`TUNISIA`
`TURKEY`
`TURKMENISTAN`
`TURKSCAICOSISLANDS`
`TUVALU`
`UGANDA`
`UKRAINE`
`UAE`
`URUGUAY`
`UZBEKISTAN`
`VANUATU`
`VENEZUELA`
`VIETNAM`
`BRITISHVIRGINISLANDS`
`USVIRGINISLANDS`
`WALLISFUTUNA`
`WESTERNSAHARA`
`YEMEN`
`ZAMBIA`
`ZIMBABWE`

`CampaignLogoUri` string

A link to the logo of a program. The link's subdomain will always be one of cdn1, cdn2, or cdn3.

`PublicTermsUri` string

The URI to the Public Terms in the contract of a program.

`ContractStatus` enum

These are the possible statuses of the contract for a given program.

Possible enum values
`Expired`	The contract status is expired.
`Active`	The contract status is active.

`ContractUri` string

The URI to the contract between you and the brands you've partnered with.

`TrackingLink` string

A tracking link used to drive traffic to a brand.

Note: This field may be empty if the brand didn't enable the default tracking links for their campaign. If so, use the tracking link found on the brand's specific ad or asset.

`AllowsDeeplinking` boolean

A boolean value stating whether deep linking is enabled for this program or not.

Possible boolean values
`true`	Deep linking is enabled for this program.
`false`	Deep linking is not enabled for this program.

`DeeplinkDomains` array

These are all the full base domains which a brand has allowed you to deep-link to on their website.

{
  "AdvertiserId": "1234567",
  "AdvertiserName": "ACME Inc",
  "AdvertiserUrl": "http://www.acme.com",
  "CampaignId": "12345",
  "CampaignName": "ACMEInc",
  "CampaignUrl": "http://www.ac.me",
  "CampaignDescription": "You can earn commission for promoting my products.",
  "ShippingRegions": [
  "SOUTHAFRICA",
  "UK",
  "US"
    ],
    "CampaignLogoUri": "/display-logo-via-campaign/10306.gif",
    "PublicTermsUri": "/Mediapartners/<AccountSID>/Campaigns/12345/PublicTerms",
    "ContractStatus": "Active",
    "ContractUri": "/Mediapartners/<AccountSID>/Campaigns/12345/Contracts/Active",
    "TrackingLink": "https://acme.sjv.io/c/1924609/650971/12345",
    "AllowsDeeplinking": "true",
    "DeeplinkDomains": {
      "DeeplinkDomain": "acme.com"
    },
  "Uri": "/Mediapartners/<AccountSID>/Campaigns/12345" 
}

Attributes

AdvertiserId integer

AdvertiserName string

AdvertiserUrl string

CampaignId integer

CampaignName string

CampaignUrl string

CampaignDescription string

ShippingRegions array

CampaignLogoUri string

PublicTermsUri string

ContractStatus enum

ContractUri string

TrackingLink string

AllowsDeeplinking boolean

DeeplinkDomains array