entitiesHierarchy Object – API Help Center

entitiesHierarchy Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

For more information, see Generate a Report with Multiple Accounts. (Note that you need AAS credentials to access this article.)

Parameter	Description	Type	Required	Notes
entitiesHierarchyLevelType	Level from which data will be pulled for the report.	String	Optional	View values ACCOUNT ADVERTISER CAMPAIGN
accountContext	Parent account with account extensions. Required to validate that accounts requested in the scope of the report are related to this parent account.	Integer	Required/Optional	Required if using multiple accounts.
accounts	List of account IDs.	Array of integer	Required	Possible values: single account ID; multiple accounts not currently supported
advertisers	List of advertiser IDs.	Array of integer	Required	Possible values: multiple, comma-separated values
campaigns	List of display campaign IDs.	Array of integer	Optional	Possible values: multiple, comma-separated values
displayCampaignIds	List of display campaign IDs.	Array of integer	Optional	Possible values: multiple, comma-separated values
searchCampaignIds	List of search campaign IDs.	Array of integer	Optional	Possible values: multiple, comma-separated values
sites	List of site IDs.	Array of integer	Optional	This array should always be empty. If you want to filter by sites, use the filter parameter in the reportScope object.
campaignsType	Type of campaign.	String	Optional	View Values Display Search Display,Search

Object JSON Example

"entitiesHierarchy": {
          "entitiesHierarchyLevelType": "ACCOUNT",
          "accountContext": 6789678967,
          "accounts": [
            1234567890
          ],
          "advertisers": [
            1234567891,
            1234567892,
            1234567893
          ],
          "campaigns": [],
          "sites": [
        },

For aggregated reports that contain search campaign data:

"entitiesHierarchy": {
          "entitiesHierarchyLevelType": "ACCOUNT",
          "accountContext": 6789678967,
          "accounts": [
            1234567890
          ],
          "advertisers": [],
          "campaigns": [],
          "displayCampaignsIds": [],
          "searchCampaignsIds": [],
          "sites": [],
          "campaignsType": [
            "Display",
            "Search"
          ]
        }

Parent Objects

reportScope Object

entitiesHierarchy Object Definition

Note

Object JSON Example

Parent Objects

Comments