Retrieves all links that match the query parameters.

Required Scalar Arguments

  • <role> (string)
    • The role of the requester. Valid values: 'advertisers' or 'publishers'.
  • <role-id> (string)
    • The ID of the requesting advertiser or publisher.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p advertiser-id=string

    • Limits the resulting links to the ones belonging to the listed advertisers.

  • -p asset-size=string

    • The size of the given asset.

  • -p authorship=string

    • The role of the author of the link.

  • -p create-date-max=string

    • The end of the create date range.

  • -p create-date-min=string

    • The beginning of the create date range.

  • -p link-type=string

    • The type of the link.

  • -p max-results=integer

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

  • -p page-token=string

    • The value of 'nextPageToken' from the previous page. Optional.

  • -p promotion-type=string

    • The promotion type.

  • -p relationship-status=string

    • The status of the relationship.

  • -p search-text=string

    • Field for full text search across title and merchandising text, supports link id search.

  • -p start-date-max=string

    • The end of the start date range.

  • -p start-date-min=string

    • The beginning of the start date range.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

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

  • -p key=string

    • 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.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • 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.

  • -p user-ip=string

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