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

Resource: CampaignSharedSet

CampaignSharedSets are used for managing the shared sets associated with a campaign.

JSON representation
{
  "resourceName": string,
  "status": enum (CampaignSharedSetStatus),
  "campaign": string,
  "sharedSet": string
}
Fields
resourceName

string

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

customers/{customerId}/campaignSharedSets/{campaignId}~{shared_set_id}

status

enum (CampaignSharedSetStatus)

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

campaign

string

Immutable. The campaign to which the campaign shared set belongs.

sharedSet

string

Immutable. The shared set associated with the campaign. This may be a negative keyword shared set of another customer. This customer should be a manager of the other customer, otherwise the campaign shared set will exist but have no serving effect. Only negative keyword shared sets can be associated with Shopping campaigns. Only negative placement shared sets can be associated with Display mobile app campaigns.

CampaignSharedSetStatus

Enum listing the possible campaign shared set statuses.

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

Methods

get

Returns the requested campaign shared set in full detail.

mutate

Creates or removes campaign shared sets.