Google Affiliate Network API (Deprecated)

Links

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "gan#link",
  "id": long,
  "name": string,
  "isActive": boolean,
  "advertiserId": long,
  "destinationUrl": string,
  "linkType": string,
  "startDate": datetime,
  "endDate": datetime,
  "description": string,
  "imageAltText": string,
  "availability": string,
  "authorship": string,
  "promotionType": string,
  "duration": string,
  "createDate": datetime,
  "impressionTrackingUrl": string,
  "clickTrackingUrl": string,
  "epcSevenDayAverage": {
    "amount": double,
    "currencyCode": string
  },
  "epcNinetyDayAverage": {
    "amount": double,
    "currencyCode": string
  },
  "specialOffers": {
    "promotionCodes": [
      string
    ],
    "percentOff": double,
    "percentOffMin": {
      "amount": double,
      "currencyCode": string
    },
    "priceCut": {
      "amount": double,
      "currencyCode": string
    },
    "priceCutMin": {
      "amount": double,
      "currencyCode": string
    },
    "freeShipping": boolean,
    "freeShippingMin": {
      "amount": double,
      "currencyCode": string
    },
    "freeGift": boolean
  }
}
Property name Value Description Notes
kind string The kind of resource, which will be gan#link.
id long The link ID.
name string The link name.
isActive boolean Indicates if this link is active and tracking.
advertiserId long The advertiser ID for the advertiser of this link.
destinationUrl string The destination URL for the link.
startDate datetime The date that this link becomes active.
endDate datetime The date that this link becomes inactive.
description string The link description.
imageAltText string The link image alt text.
availability string
The link status. Valid values are, 'expired', 'available', and 'pending'.
authorship string The creator of the link. Valid values are 'publisher' or 'advertiser'.
promotionType string The link promotion type. Valid values are 'none', 'coupon', 'free_gift', 'free_shipping', 'percent_off, 'price_cut'.
duration string The link duration. Valid values are 'unlimited', 'limited', 'one_day'.
createDate datetime The link creation date.
impressionTrackingUrl string The image for the banner ad. Only available for banner ads.
clickTrackingUrl string The link tracking url.
linkType string The link type.
epcSevenDayAverage nested object The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
epcSevenDayAverage.amount double The amount of money.
epcSevenDayAverage.currencyCode string The 3-letter code of the currency in question.
epcNinetyDayAverage nested object The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
epcNinetyDayAverage.amount double The amount of money.
epcNinetyDayAverage.currencyCode string The 3-letter code of the currency in question.
specialOffers object Special offers on the link.
specialOffers.promotionCodes[] list List of promotion code associated with the link
specialOffers.percentOff double Percent off on the purchase
specialOffers.percentOffMin nested object Minimum purchase amount for percent off promotion
specialOffers.percentOffMin.amount double The amount of money.
specialOffers.percentOffMin.currencyCode string The 3-letter code of the currency in question.
specialOffers.priceCut nested object Price cut on the purchase
specialOffers.priceCut.amount double The amount of money.
specialOffers.priceCut.currencyCode string The 3-letter code of the currency in question.
specialOffers.priceCutMin nested object Minimum purchase amount for price cut promotion
specialOffers.priceCutMin.amount double The amount of money.
specialOffers.priceCutMin.currencyCode string The 3-letter code of the currency in question.
specialOffers.freeShipping boolean Whether there is free shipping
specialOffers.freeShippingMin nested object Minimum purchase amount for free shipping promotion
specialOffers.freeShippingMin.amount double The amount of money.
specialOffers.freeShippingMin.currencyCode string The 3-letter code of the currency in question.
specialOffers.freeGift boolean Whether there is a free gift

Methods

get
Gets all available information about a single link, if the requesting advertiser/publisher has access to it.
insert
Creates a new publisher-specific link.
list
Retrieves all links that match the query parameters. Publishers can look up available links that belong to advertisers they are in a relationship with.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.