Google Affiliate Network API v1beta1

Version: 5.3

Google Affiliate Network API v1beta1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you have programmatic access to your Google Affiliate Network data. Google documentation.

(require gapi/macro)

(require-gapi-doc gan.v1beta1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 links

procedure
(gan-links-list #:role role
#:roleId roleId
[ #:advertiserId advertiserId
#:authorship authorship
#:linkType linkType
#:promotionType promotionType
#:advertiserCategory advertiserCategory
#:maxResults maxResults
#:pageToken pageToken
#:relationshipStatus relationshipStatus
#:assetSize assetSize
#:startDateMax startDateMax
#:startDateMin startDateMin
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  role : string?
  roleId : string?
  advertiserId : string? = 'N/A
  authorship : string? = 'N/A
  linkType : string? = 'N/A
  promotionType : string? = 'N/A
  advertiserCategory : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  relationshipStatus : string? = 'N/A
  assetSize : string? = 'N/A
  startDateMax : string? = 'N/A
  startDateMin : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves all links that match the query parameters.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

advertiserId: Limits the resulting links to the ones belonging to the listed advertisers.

authorship: The role of the author of the link.

linkType: The type of the link.

promotionType: The promotion type.

advertiserCategory: The advertiser’s primary vertical.

maxResults: Max number of items to return in this page. Optional. Defaults to 20.

pageToken: The value of ’nextPageToken’ from the previous page. Optional.

relationshipStatus: The status of the relationship.

assetSize: The size of the given asset.

startDateMax: The end of the start date range.

startDateMin: The beginning of the start date range.

procedure
(gan-links-get #:role role
#:roleId roleId
#:linkId linkId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  role : string?
  roleId : string?
  linkId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves data about a single link if the requesting advertiser/publisher has access to it. Advertisers can look up their own links. Publishers can look up visible links or links belonging to advertisers they are in a relationship with.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

linkId: The ID of the link to look up.

procedure
(gan-links-insert
#:role role
#:roleId roleId
[ #:id id
#:name name
#:description description
#:kind kind
#:endDate endDate
#:startDate startDate
#:advertiserId advertiserId
#:authorship authorship
#:availability availability
#:clickTrackingUrl clickTrackingUrl
#:createDate createDate
#:destinationUrl destinationUrl
#:duration duration
#:imageAltText imageAltText
#:impressionTrackingUrl impressionTrackingUrl
#:isActive isActive
#:linkType linkType
#:promotionType promotionType
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  role : string?
  roleId : string?
  id : string? = 'N/A
  name : string? = 'N/A
  description : string? = 'N/A
  kind : string? = 'N/A
  endDate : string? = 'N/A
  startDate : string? = 'N/A
  advertiserId : string? = 'N/A
  authorship : string? = 'N/A
  availability : string? = 'N/A
  clickTrackingUrl : string? = 'N/A
  createDate : string? = 'N/A
  destinationUrl : string? = 'N/A
  duration : string? = 'N/A
  imageAltText : string? = 'N/A
  impressionTrackingUrl : string? = 'N/A
  isActive : string? = 'N/A
  linkType : string? = 'N/A
  promotionType : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Inserts a new link.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

id: The ID of this link.

name: The logical name for this link.

description: Description.

kind: The kind for one entity.

endDate: Date that this link becomes inactive.

startDate: Date that this link becomes active.

advertiserId: The advertiser id for the advertiser who owns this link.

authorship: Authorship

availability: Availability.

clickTrackingUrl: Tracking url for clicks.

createDate: Date that this link was created.

destinationUrl: The destination URL for the link.

duration: Duration

imageAltText: image alt text.

impressionTrackingUrl: Tracking url for impressions.

isActive: Flag for if this link is active.

linkType: The link type.

promotionType: Promotion Type

2.2 advertisers

procedure
(gan-advertisers-list #:role role
#:roleId roleId
[ #:advertiserCategory advertiserCategory
#:maxResults maxResults
#:minNinetyDayEpc minNinetyDayEpc
#:minPayoutRank minPayoutRank
#:minSevenDayEpc minSevenDayEpc
#:pageToken pageToken
#:relationshipStatus relationshipStatus
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  role : string?
  roleId : string?
  advertiserCategory : string? = 'N/A
  maxResults : string? = 'N/A
  minNinetyDayEpc : string? = 'N/A
  minPayoutRank : string? = 'N/A
  minSevenDayEpc : string? = 'N/A
  pageToken : string? = 'N/A
  relationshipStatus : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves data about all advertisers that the requesting advertiser/publisher has access to.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

advertiserCategory: Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.

maxResults: Max number of items to return in this page. Optional. Defaults to 20.

minNinetyDayEpc: Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.

minPayoutRank: A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.

minSevenDayEpc: Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.

pageToken: The value of ’nextPageToken’ from the previous page. Optional.

relationshipStatus: Filters out all advertisers for which do not have the given relationship status with the requesting publisher.

procedure
(gan-advertisers-get #:role role
#:roleId roleId
[ #:advertiserId advertiserId
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  role : string?
  roleId : string?
  advertiserId : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

advertiserId: The ID of the advertiser to look up. Optional.

2.3 ccOffers

procedure
(gan-ccOffers-list #:publisher publisher
[ #:projection projection
#:advertiser advertiser
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  publisher : string?
  projection : string? = 'N/A
  advertiser : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves credit card offers for the given publisher.

publisher: The ID of the publisher in question.

projection: The set of fields to return.

advertiser: The advertiser ID of a card issuer whose offers to include. Optional, may be repeated.

2.4 events

procedure
(gan-events-list #:role role
#:roleId roleId
[ #:type type
#:status status
#:sku sku
#:advertiserId advertiserId
#:chargeType chargeType
#:memberId memberId
#:orderId orderId
#:publisherId publisherId
#:maxResults maxResults
#:pageToken pageToken
#:eventDateMax eventDateMax
#:eventDateMin eventDateMin
#:linkId linkId
#:modifyDateMax modifyDateMax
#:modifyDateMin modifyDateMin
#:productCategory productCategory
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  role : string?
  roleId : string?
  type : string? = 'N/A
  status : string? = 'N/A
  sku : string? = 'N/A
  advertiserId : string? = 'N/A
  chargeType : string? = 'N/A
  memberId : string? = 'N/A
  orderId : string? = 'N/A
  publisherId : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  eventDateMax : string? = 'N/A
  eventDateMin : string? = 'N/A
  linkId : string? = 'N/A
  modifyDateMax : string? = 'N/A
  modifyDateMin : string? = 'N/A
  productCategory : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves event data for a given advertiser/publisher.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

type: Filters out all events that are not of the given type. Valid values: ’action’, ’transaction’, ’charge’. Optional.

status: Filters out all events that do not have the given status. Valid values: ’active’, ’canceled’. Optional.

sku: Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.

advertiserId: Caret(^) delimited list of advertiser IDs. Filters out all events that do not reference one of the given advertiser IDs. Only used when under publishers role. Optional.

chargeType: Filters out all charge events that are not of the given charge type. Valid values: ’other’, ’slotting_fee’, ’monthly_minimum’, ’tier_bonus’, ’credit’, ’debit’. Optional.

memberId: Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.

orderId: Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.

publisherId: Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publishers IDs. Only used when under advertiser role. Optional.

maxResults: Max number of offers to return in this page. Optional. Defaults to 20.

pageToken: The value of ’nextPageToken’ from the previous page. Optional.

eventDateMax: Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.

eventDateMin: Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.

linkId: Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.

modifyDateMax: Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.

modifyDateMin: Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.

productCategory: Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional.

2.5 publishers

procedure
(gan-publishers-list #:role role
#:roleId roleId
[ #:maxResults maxResults
#:minNinetyDayEpc minNinetyDayEpc
#:minPayoutRank minPayoutRank
#:minSevenDayEpc minSevenDayEpc
#:pageToken pageToken
#:relationshipStatus relationshipStatus
#:publisherCategory publisherCategory
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  role : string?
  roleId : string?
  maxResults : string? = 'N/A
  minNinetyDayEpc : string? = 'N/A
  minPayoutRank : string? = 'N/A
  minSevenDayEpc : string? = 'N/A
  pageToken : string? = 'N/A
  relationshipStatus : string? = 'N/A
  publisherCategory : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves data about all publishers that the requesting advertiser/publisher has access to.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

maxResults: Max number of items to return in this page. Optional. Defaults to 20.

minNinetyDayEpc: Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.

minPayoutRank: A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.

minSevenDayEpc: Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.

pageToken: The value of ’nextPageToken’ from the previous page. Optional.

relationshipStatus: Filters out all publishers for which do not have the given relationship status with the requesting publisher.

procedure
(gan-publishers-get #:role role
#:roleId roleId
[ #:publisherId publisherId
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  role : string?
  roleId : string?
  publisherId : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only advertisers can look up publishers. Publishers can request information about themselves by omitting the publisherId query parameter.

role: The role of the requester. Valid values: ’advertisers’ or ’publishers’.

roleId: The ID of the requesting advertiser or publisher.

publisherId: The ID of the publisher to look up. Optional.