The AdX Seller REST API has been deprecated and will be sunset on July 23, 2018. New and existing users should migrate to the DoubleClick for Publishers API.

Accounts.metadata.dimensions: list

Requires authorization

List the metadata for the dimensions available to this AdExchange account. Try it now.

Request

HTTP request

GET https://www.googleapis.com/adexchangeseller/v2.0/accounts/accountId/metadata/dimensions

Parameters

Parameter name Value Description
Path parameters
accountId string Account with visibility to the dimensions.

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/adexchange.seller
https://www.googleapis.com/auth/adexchange.seller.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": "adexchangeseller#metadata",
  "items": [
    {
      "kind": "adexchangeseller#reportingMetadataEntry",
      "id": string,
      "compatibleDimensions": [
        string
      ],
      "compatibleMetrics": [
        string
      ],
      "requiredDimensions": [
        string
      ],
      "requiredMetrics": [
        string
      ],
      "supportedProducts": [
        string
      ]
    }
  ]
}
Property name Value Description Notes
kind string Kind of list this is, in this case adexchangeseller#metadata.
items[] list
items[].kind string Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.
items[].id string Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
items[].compatibleDimensions[] list For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
items[].compatibleMetrics[] list The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
items[].requiredDimensions[] list The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
items[].requiredMetrics[] list The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
items[].supportedProducts[] list The codes of the projects supported by the dimension or metric this reporting metadata entry describes.

Try it!

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

Send feedback about...

Seller REST API
Seller REST API