Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.assetGroups

Resource: AssetGroup

An asset group. AssetGroupAsset will be used to link an asset to the asset group. AssetGroupHint will be used to associate a hint to an asset group.

JSON representation
{
  "resourceName": string,
  "id": string,
  "campaign": string,
  "name": string,
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "status": enum (AssetGroupStatus),
  "path1": string,
  "path2": string
}
Fields
resourceName

string

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

customers/{customerId}/assetGroups/{asset_group_id}

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 will be 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 will be eligible for expansion unless opted out.

status

enum (AssetGroupStatus)

The status of the asset group.

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.

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.

Methods

get

Returns the requested asset group in full detail.

mutate

Creates, updates or removes asset groups.