Google Affiliate Network API (Deprecated)

Events: list

Requires authorization

Retrieves event data for a given advertiser/publisher and returns it in ascending order with respect to event date. Try it now.

The events.list method returns a paginated list of information about events, sorted in chronological order on event date. Returned resources are not guaranteed to have all of the possible attributes. 

Request

HTTP request

GET https://www.googleapis.com/gan/v1beta1/role/roleId/events?{params}

Parameters

Parameter name Value Description
Required parameters
role string The role of the requester. Valid values: 'advertisers' or 'publishers'.

Acceptable values are:
  • "advertisers": The requester is requesting as an advertiser.
  • "publishers": The requester is requesting as a publisher.
roleId string The ID of the requesting advertiser or publisher.
Optional parameters
advertiserId string 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 string 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.

Acceptable values are:
  • "credit": A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.
  • "debit": A debit reduces the publisher's payout and increases the advertiser's invoice amount.
  • "monthly_minimum": A payment made to Google by an advertiser as a minimum monthly network fee.
  • "other": Catch all. Default if unset
  • "slotting_fee": A one time payment made from an advertiser to a publisher.
  • "tier_bonus": A payment from an advertiser to a publisher for the publisher maintaining a high tier level
eventDateMax string Filters out all events later than given date. Optional. Defaults to 24 hours after eventDateMin.
eventDateMin string Filters out all events earlier than given date. Optional. Defaults to 24 hours before the current date/time.
linkId string Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.
maxResults unsigned integer Max number of offers to return in this page. Optional. Defaults to 20. Acceptable values are 0 to 100, inclusive.
memberId string Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.
modifyDateMax string Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.
modifyDateMin string Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.
orderId string Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.
pageToken string The value of 'nextPageToken' from the previous page. Optional.
productCategory string Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional.
publisherId string Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publisher IDs. Only used when under advertiser role. Optional.
sku string Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.
status string Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.

Acceptable values are:
  • "active": Event is currently active.
  • "canceled": Event is currently canceled.
type string Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.

Acceptable values are:
  • "action": The completion of an application, sign-up, or other process. For example, an action occurs if a user clicks an ad for a credit card and completes an application for that card.
  • "charge": A charge represents a miscellaneous fee or account adjustment for an advertiser.
  • "transaction": A conversion event, typically an e-commerce transaction. Some advertisers use a transaction to record other types of events, such as magazine subscriptions.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/gan
https://www.googleapis.com/auth/gan.readonly

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "gan#events",
  "nextPageToken": string,
  "items": [
    {
      "kind": "gan#event",
      "modifyDate": datetime,
      "eventDate": datetime,
      "orderId": string,
      "chargeId": string,
      "commissionableSales": {
        "amount": double,
        "currencyCode": string
      },
      "status": string,
      "type": string,
      "chargeType": string,
      "products": [
        {
          "sku": string,
          "skuName": string,
          "categoryId": string,
          "categoryName": string,
          "quantity": long,
          "unitPrice": {
            "amount": double,
            "currencyCode": string
          },
          "publisherFee": {
            "amount": double,
            "currencyCode": string
          },
          "networkFee": {
            "amount": double,
            "currencyCode": string
          },
          "earnings": {
            "amount": double,
            "currencyCode": string
          }
        }
      ],
      "publisherId": long,
      "publisherName": string,
      "publisherFee": {
        "amount": double,
        "currencyCode": string
      },
      "networkFee": {
        "amount": double,
        "currencyCode": string
      },
      "advertiserId": long,
      "advertiserName": string,
      "memberId": string,
      "earnings": {
        "amount": double,
        "currencyCode": string
      }
    }
  ]
}
Property name Value Description Notes
kind string The kind for a page of events.
nextPageToken string The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
items[] list The event list.
items[].kind string The kind for one event.
items[].modifyDate datetime The date-time this event was last modified as a RFC 3339 date-time value.
items[].eventDate datetime The date-time this event occured as a RFC 3339 date-time value.
items[].orderId string The order ID for this event. Only returned for conversion events.
items[].commissionableSales nested object Amount of money exchanged during the transaction. Only returned for charge and conversion events.
items[].status string Status of the event (active|canceled). Only returned for charge and conversion events.
items[].type string Type of the event (action|transaction|charge).
items[].products[] list Products associated with the event.
items[].products[].sku string Sku of this product.
items[].products[].skuName string Sku name of this product.
items[].products[].categoryId string Id of the category this product belongs to.
items[].products[].categoryName string Name of the category this product belongs to.
items[].products[].quantity long Quantity of this product bought/exchanged.
items[].products[].unitPrice nested object Price per unit of this product.
items[].products[].publisherFee nested object Fee that the advertiser paid to the publisehr for this product.
items[].products[].networkFee nested object Fee that the advertiser paid to the Google Affiliate Network for this product.
items[].products[].earnings nested object Amount earned by the publisher on this product.
items[].publisherId long The ID of the publisher for this event.
items[].publisherName string The name of the publisher for this event.
items[].publisherFee nested object Fee that the advertiser paid to the publisher.
items[].networkFee nested object Fee that the advertiser paid to the Google Affiliate Network.
items[].advertiserId long The ID of advertiser for this event.
items[].advertiserName string The name of the advertiser for this event.
items[].memberId string The ID of the member attached to this event. Only returned for conversion events.
items[].earnings nested object Earnings by the publisher.
items[].chargeId string The charge ID for this event. Only returned for charge events.
items[].commissionableSales.amount double The amount of money.
items[].commissionableSales.currencyCode string The 3-letter code of the currency in question.
items[].chargeType string Charge type of the event (other|slotting_fee|monthly_minimum|tier_bonus|debit|credit). Only returned for charge events.
items[].products[].unitPrice.amount double The amount of money.
items[].products[].unitPrice.currencyCode string The 3-letter code of the currency in question.
items[].products[].publisherFee.amount double The amount of money.
items[].products[].publisherFee.currencyCode string The 3-letter code of the currency in question.
items[].products[].networkFee.amount double The amount of money.
items[].products[].networkFee.currencyCode string The 3-letter code of the currency in question.
items[].products[].earnings.amount double The amount of money.
items[].products[].earnings.currencyCode string The 3-letter code of the currency in question.
items[].publisherFee.amount double The amount of money.
items[].publisherFee.currencyCode string The 3-letter code of the currency in question.
items[].networkFee.amount double The amount of money.
items[].networkFee.currencyCode string The 3-letter code of the currency in question.
items[].earnings.amount double The amount of money.
items[].earnings.currencyCode string The 3-letter code of the currency in question.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.

Authentication required

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

Signing you in...

Google Developers needs your permission to do that.