Method: customers.campaignLifecycleGoal.configureCampaignLifecycleGoals

Process the given campaign lifecycle configurations.

List of thrown errors: AuthenticationError AuthorizationError CampaignLifecycleGoalConfigError HeaderError InternalError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v15/customers/{customerId}/campaignLifecycleGoal:configureCampaignLifecycleGoals

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer performing the upload.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operation": {
    object (CampaignLifecycleGoalOperation)
  },
  "validateOnly": boolean
}
Fields
operation

object (CampaignLifecycleGoalOperation)

Required. The operation to perform campaign lifecycle goal update.

validateOnly

boolean

Optional. If true, the request is validated but not executed. Only errors are returned, not results.

Response body

Response message for [CampaignLifecycleGoalService.configureCampaignLifecycleGoals][].

If successful, the response body contains data with the following structure:

JSON representation
{
  "result": {
    object (ConfigureCampaignLifecycleGoalsResult)
  }
}
Fields
result

object (ConfigureCampaignLifecycleGoalsResult)

Result for the campaign lifecycle goal configuration.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignLifecycleGoalOperation

A single operation on a campaign lifecycle goal.

JSON representation
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "create": {
    object (CampaignLifecycleGoal)
  }
  // End of list of possible types for union field operation.
}
Fields
updateMask

string (FieldMask format)

Optional. FieldMask that determines which resource fields are modified in an update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Union field operation. The mutate operation. operation can be only one of the following:
create

object (CampaignLifecycleGoal)

Create operation: to create a new campaign lifecycle goal or update an existing campaign lifecycle goal. When creating a new campaign lifecycle goal, all required fields, including campaign field, needs to be set. Resource name and field mask needs to be empty. When updating an existing campaign lifecycle goal, resource name and field mask need to be set, and campaign field needs to be empty. Partial update based on field mask is supported when updating an existing campaign lifecycle goal.

ConfigureCampaignLifecycleGoalsResult

The result for the campaign lifecycle goal configuration.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for the successful operation.