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.

CampaignGroup

Stay organized with collections Save and categorize content based on your preferences.

A campaign group.

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "status": enum (CampaignGroupStatus)
}
Fields
resourceName

string

Immutable. The resource name of the campaign group. Campaign group resource names have the form:

customers/{customerId}/campaignGroups/{campaign_group_id}

id

string (int64 format)

Output only. The ID of the campaign group.

name

string

The name of the campaign group.

This field is required and should not be empty when creating new campaign groups.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

status

enum (CampaignGroupStatus)

The status of the campaign group.

When a new campaign group is added, the status defaults to ENABLED.

CampaignGroupStatus

Possible statuses of a CampaignGroup.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The campaign group is active.
REMOVED The campaign group has been removed.