AssetGroup

An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group.

JSON representation 
{
  "resourceName": string,
  "id": string,
  "campaign": string,
  "name": string,
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "status": enum (AssetGroupStatus),
  "primaryStatus": enum (AssetGroupPrimaryStatus),
  "primaryStatusReasons": [
    enum (AssetGroupPrimaryStatusReason)
  ],
  "path1": string,
  "path2": string,
  "adStrength": enum (AdStrength),
  "assetCoverage": {
    object (AssetCoverage)
  }
}
Fields
resourceName

string

Immutable. The resource name of the asset group. Asset group resource names have the form:

customers/{customerId}/assetGroups/{assetGroupId}
id

string (int64 format)

Output only. The ID of the asset group.
campaign

string

Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
name

string

Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
finalUrls[]

string

A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
finalMobileUrls[]

string

A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
status

enum (AssetGroupStatus)

The status of the asset group.
primaryStatus

enum (AssetGroupPrimaryStatus)

Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.
primaryStatusReasons[]

enum (AssetGroupPrimaryStatusReason)

Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.
path1

string

First part of text that may appear appended to the url displayed in the ad.
path2

string

Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
adStrength

enum (AdStrength)

Output only. Overall ad strength of this asset group.
assetCoverage

object (AssetCoverage)

Output only. The asset coverage of this asset group.

AssetGroupStatus

The possible statuses of an asset group.

Enums
UNSPECIFIED The status has not been specified.
UNKNOWN The received value is not known in this version.
ENABLED The asset group is enabled.
PAUSED The asset group is paused.
REMOVED The asset group is removed.

AssetGroupPrimaryStatus

Enum describing the possible asset group primary status. Provides insights into why an asset group is not serving or not serving optimally.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ELIGIBLE The asset group is eligible to serve.
PAUSED The asset group is paused.
REMOVED The asset group is removed.
NOT_ELIGIBLE The asset group is not eligible to serve.
LIMITED The asset group has limited servability.
PENDING The asset group is pending approval and may serve in the future.

AssetGroupPrimaryStatusReason

Enum describing the possible asset group primary status reasons. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ASSET_GROUP_PAUSED The user-specified asset group status is paused. Contributes to AssetGroupPrimaryStatus.PAUSED
ASSET_GROUP_REMOVED The user-specified asset group status is removed. Contributes to AssetGroupPrimaryStatus.REMOVED.
CAMPAIGN_REMOVED The user-specified campaign status is removed. Contributes to AssetGroupPrimaryStatus.NOT_ELIGIBLE.
CAMPAIGN_PAUSED The user-specified campaign status is paused. Contributes to AssetGroupPrimaryStatus.NOT_ELIGIBLE.
CAMPAIGN_PENDING The user-specified time for this campaign to start is in the future. Contributes to AssetGroupPrimaryStatus.NOT_ELIGIBLE.
CAMPAIGN_ENDED The user-specified time for this campaign to end has passed. Contributes to AssetGroupPrimaryStatus.NOT_ELIGIBLE.
ASSET_GROUP_LIMITED The asset group is approved but only serves in limited capacity due to policies. Contributes to AssetGroupPrimaryStatus.LIMITED.
ASSET_GROUP_DISAPPROVED The asset group has been marked as disapproved. Contributes to AssetGroupPrimaryStatus.NOT_ELIGIBLE.
ASSET_GROUP_UNDER_REVIEW The asset group has not completed policy review. Contributes to AssetGroupPrimaryStatus.PENDING.

AssetCoverage

Information about the asset coverage of an asset group.

JSON representation 
{
  "adStrengthActionItems": [
    {
      object (AdStrengthActionItem)
    }
  ]
}
Fields
adStrengthActionItems[]

object (AdStrengthActionItem)

Output only. A list of action items to improve the ad strength of an asset group.

AdStrengthActionItem

An action item to improve the ad strength of an asset group.

JSON representation 
{
  "actionItemType": enum (AdStrengthActionItemType),

  // Union field action_details can be only one of the following:
  "addAssetDetails": {
    object (AddAssetDetails)
  }
  // End of list of possible types for union field action_details.
}
Fields
actionItemType

enum (AdStrengthActionItemType)

Output only. The action item type.
Union field action_details. The details of this action item. action_details can be only one of the following:
addAssetDetails

object (AddAssetDetails)

Output only. The action item details for action item type ADD_ASSET.

AdStrengthActionItemType

Enumerates ad strength action item types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADD_ASSET This action item suggests adding an asset to the asset group.

AddAssetDetails

The details of the asset to add.

JSON representation 
{
  "assetFieldType": enum (AssetFieldType),
  "assetCount": integer,
  "videoAspectRatioRequirement": enum (AssetCoverageVideoAspectRatioRequirement)
}
Fields
assetFieldType

enum (AssetFieldType)

Output only. The asset field type of the asset(s) to add.
assetCount

integer

Output only. The number of assets to add.
videoAspectRatioRequirement

enum (AssetCoverageVideoAspectRatioRequirement)

Output only. For video field types, the required aspect ratio of the video. When unset and assetFieldType is YOUTUBE_VIDEO, the system recommends the advertiser upload any YouTube video, regardless of aspect ratio.

AssetCoverageVideoAspectRatioRequirement

Enum describing possible ad strength video aspect ratio requirements.

Enums
UNSPECIFIED Not specified.
UNKNOWN The received value is not known in this version.
HORIZONTAL The video requires a horizontal aspect ratio.
SQUARE The video requires a square aspect ratio.
VERTICAL The video requires a vertical aspect ratio.