Links: list

Requires authorization

Retrieves all links that match the query parameters. Publishers can look up available links that belong to advertisers they are in a relationship with. Try it now.


HTTP request



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

Acceptable values are:
  • "advertisers":
  • "publishers": The requester is requesting as a publisher.
roleId string The ID of the requesting advertiser or publisher.
Optional parameters
advertiserId long Limits the resulting links to the ones belonging to the listed advertisers.
assetSize string The size of the given asset.
authorship string The role of the author of the link.

Acceptable values are:
  • "": (default)
  • "publisher":
createDateMax string The end of the create date range.
createDateMin string The beginning of the create date range.
linkType string The type of the link.

Acceptable values are:
  • "banner":
  • "text":
maxResults unsigned integer Max number of items to return in this page. Optional. Defaults to 20. Acceptable values are 0 to 100, inclusive.
pageToken string The value of 'nextPageToken' from the previous page. Optional.
promotionType string The promotion type.

Acceptable values are:
  • "coupon":
  • "free_gift":
  • "free_shipping":
  • "percent_off":
  • "price_cut":
relationshipStatus string The status of the relationship.

Acceptable values are:
  • "approved":
  • "available":
searchText string Field for full text search across title and merchandising text, supports link id search.
startDateMax string The end of the start date range.
startDateMin string The beginning of the start date range.


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


Request body

Do not supply a request body with this method.


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

  "kind": "gan#links",
  "nextPageToken": string,
  "items": [
    links Resource
Property name Value Description Notes
kind string The kind for a page of links.
nextPageToken string The next page token.
items[] list The links.

Try it!

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