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

Resource: KeywordPlanCampaign

A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1.

JSON representation
{
  "resourceName": string,
  "languageConstants": [
    string
  ],
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "geoTargets": [
    {
      object (KeywordPlanGeoTarget)
    }
  ],
  "keywordPlan": string,
  "id": string,
  "name": string,
  "cpcBidMicros": string
}
Fields
resourceName

string

Immutable. The resource name of the Keyword Plan campaign. KeywordPlanCampaign resource names have the form:

customers/{customerId}/keywordPlanCampaigns/{kp_campaign_id}

languageConstants[]

string

The languages targeted for the Keyword Plan campaign. Max allowed: 1.

keywordPlanNetwork

enum (KeywordPlanNetwork)

Targeting network.

This field is required and should not be empty when creating Keyword Plan campaigns.

geoTargets[]

object (KeywordPlanGeoTarget)

The geo targets. Max number allowed: 20.

keywordPlan

string

The keyword plan this campaign belongs to.

id

string (int64 format)

Output only. The ID of the Keyword Plan campaign.

name

string

The name of the Keyword Plan campaign.

This field is required and should not be empty when creating Keyword Plan campaigns.

cpcBidMicros

string (int64 format)

A default max cpc bid in micros, and in the account currency, for all ad groups under the campaign.

This field is required and should not be empty when creating Keyword Plan campaigns.

KeywordPlanNetwork

Enumerates keyword plan forecastable network types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
GOOGLE_SEARCH_AND_PARTNERS Google googleAds.search + googleAds.search partners.

KeywordPlanGeoTarget

A geo target.

JSON representation
{
  "geoTargetConstant": string
}
Fields
geoTargetConstant

string

Required. The resource name of the geo target.

Methods

get

Returns the requested Keyword Plan campaign in full detail.

mutate

Creates, updates, or removes Keyword Plan campaigns.