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.sharedSets

Resource: SharedSet

SharedSets are used for sharing criterion exclusions across multiple campaigns.

JSON representation
{
  "resourceName": string,
  "type": enum (SharedSetType),
  "status": enum (SharedSetStatus),
  "id": string,
  "name": string,
  "memberCount": string,
  "referenceCount": string
}
Fields
resourceName

string

Immutable. The resource name of the shared set. Shared set resource names have the form:

customers/{customerId}/sharedSets/{shared_set_id}

type

enum (SharedSetType)

Immutable. The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.

status

enum (SharedSetStatus)

Output only. The status of this shared set. Read only.

id

string (int64 format)

Output only. The ID of this shared set. Read only.

name

string

The name of this shared set. Required. Shared Sets must have names that are unique among active shared sets of the same type. The length of this string should be between 1 and 255 UTF-8 bytes, inclusive.

memberCount

string (int64 format)

Output only. The number of shared criteria within this shared set. Read only.

referenceCount

string (int64 format)

Output only. The number of campaigns associated with this shared set. Read only.

SharedSetType

Enum listing the possible shared set types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NEGATIVE_KEYWORDS A set of keywords that can be excluded from targeting.
NEGATIVE_PLACEMENTS A set of placements that can be excluded from targeting.

SharedSetStatus

Enum listing the possible shared set statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The shared set is enabled.
REMOVED The shared set is removed and can no longer be used.

Methods

get

Returns the requested shared set in full detail.

mutate

Creates, updates, or removes shared sets.