Search Ads 360 Reporting API . customers . campaignLifecycleGoal

close()

Close httplib2 connections.

configureCampaignLifecycleGoals(customerId, body=None, x__xgafv=None)

Process the given campaign lifecycle configurations. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignLifecycleGoalConfigError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Args:
  customerId: string, Required. The ID of the customer performing the upload. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for CampaignLifecycleGoalService.ConfigureCampaignLifecycleGoals.
  "operation": { # A single operation on a campaign lifecycle goal. # Required. The operation to perform campaign lifecycle goal update.
    "create": { # Campaign level customer lifecycle goal settings.
      "campaign": "A String", # Output only. The campaign where the goal is attached.
      "customerAcquisitionGoalSettings": { # The customer acquisition goal settings for the campaign. # Output only. The customer acquisition goal settings for the campaign. The customer acquisition goal is described in this article: https://support.google.com/google-ads/answer/12080169
        "optimizationMode": "A String", # Output only. Customer acquisition optimization mode of this campaign.
        "valueSettings": { # Lifecycle goal value settings. # Output only. Campaign specific values for the customer acquisition goal.
          "highLifetimeValue": 3.14, # High lifetime value of the lifecycle goal. For example, for customer acquisition goal, high lifetime value is the incremental conversion value for new customers who are of high value. High lifetime value should be greater than value, if set.
          "value": 3.14, # Value of the lifecycle goal. For example, for customer acquisition goal, value is the incremental conversion value for new customers who are not of high value.
        },
      },
      "resourceName": "A String", # Immutable. The resource name of the customer lifecycle goal of a campaign. `customers/{customer_id}/campaignLifecycleGoal/{campaign_id}`
    },
    "update": { # Campaign level customer lifecycle goal settings. # Update operation: Update an existing campaign lifecycle goal. The campaign field should not be set for this operation.
      "campaign": "A String", # Output only. The campaign where the goal is attached.
      "customerAcquisitionGoalSettings": { # The customer acquisition goal settings for the campaign. # Output only. The customer acquisition goal settings for the campaign. The customer acquisition goal is described in this article: https://support.google.com/google-ads/answer/12080169
        "optimizationMode": "A String", # Output only. Customer acquisition optimization mode of this campaign.
        "valueSettings": { # Lifecycle goal value settings. # Output only. Campaign specific values for the customer acquisition goal.
          "highLifetimeValue": 3.14, # High lifetime value of the lifecycle goal. For example, for customer acquisition goal, high lifetime value is the incremental conversion value for new customers who are of high value. High lifetime value should be greater than value, if set.
          "value": 3.14, # Value of the lifecycle goal. For example, for customer acquisition goal, value is the incremental conversion value for new customers who are not of high value.
        },
      },
      "resourceName": "A String", # Immutable. The resource name of the customer lifecycle goal of a campaign. `customers/{customer_id}/campaignLifecycleGoal/{campaign_id}`
    },
    "updateMask": "A String", # Optional. FieldMask that determines which resource fields are modified in an update.
  },
  "validateOnly": True or False, # Optional. If true, the request is validated but not executed. Only errors are returned, not results.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for CampaignLifecycleGoalService.ConfigureCampaignLifecycleGoals.
  "result": { # The result for the campaign lifecycle goal configuration. # Result for the campaign lifecycle goal configuration.
    "resourceName": "A String", # Returned for the successful operation.
  },
}