REST Resource: networks.suggestedAdUnits

Resource: SuggestedAdUnit

A read-only suggestion for a new ad unit based on an ad tag that has served 10+ times in the past week for an undefined ad unit.

JSON representation
{
  "name": string,
  "newCodePath": [
    string
  ],
  "existingCodePath": [
    {
      object (AdUnitParent)
    }
  ],
  "adUnitSizes": [
    {
      object (AdUnitSize)
    }
  ],
  "weeklyRequestCount": string,
  "targetWindow": enum (TargetWindow),
  "targetPlatform": enum (TargetPlatform)
}
Fields
name

string

Identifier. Resource name of the SuggestedAdUnit. Format: networks/{networkCode}/suggestedAdUnits/{suggested_ad_unit_id}

newCodePath[]

string

Output only. Path of suggested ad unit codes from the closest existing ancestor ad unit that will all be created as ad units when the suggestion is approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the newCodePath is (x). If x is the grandchild of c, the newCodePath is (y, x) where y is an ad unit that would be created as the parent ad unit of x (and the child of c) if the suggestion is approved.

existingCodePath[]

object (AdUnitParent)

Output only. Code path of ad units leading up to and including the parent of the first suggested ad unit. Combined with the newCodePath field, this represents the full path for the suggested ad unit if approved.

Example: If a -> b -> c are existing ad units with parent-child relationships, and the suggested ad unit x is a child of c, the existingCodePath is (a, b, c). If x is the grandchild of c, the existingCodePath is also (a, b, c).

adUnitSizes[]

object (AdUnitSize)

Output only. Sizes associated with this suggested ad unit.

weeklyRequestCount

string (int64 format)

Output only. Number of times the ad tag has been served in the past week.

targetWindow

enum (TargetWindow)

Output only. Target window of the underlying ad tag which will be used in the ad unit if the suggestion is approved.

targetPlatform

enum (TargetPlatform)

Output only. Target platform for the browser that clicked the underlying ad tag.

TargetPlatform

The target platform of a line item.

Enums
TARGET_PLATFORM_UNSPECIFIED Default value. This value is unused.
ANY A universal target platform that combines mobile and desktop features.
MOBILE Mobile devices.
WEB The desktop web.

Methods

get

Get a SuggestedAdUnit object.

list

Retrieve a list of SuggestedAdUnit objects.