Search Ads 360 Reporting API . customers . customConversionGoals

close()

Close httplib2 connections.

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

Creates, updates or removes custom conversion goals. Operation statuses are returned.

Args:
  customerId: string, Required. The ID of the customer whose custom conversion goals are being modified. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for CustomConversionGoalService.MutateCustomConversionGoals.
  "operations": [ # Required. The list of operations to perform on individual custom conversion goal.
    { # A single operation (create, remove) on a custom conversion goal.
      "create": { # Custom conversion goal that can make arbitrary conversion actions biddable. # Create operation: No resource name is expected for the new custom conversion goal
        "conversionActions": [ # Conversion actions that the custom conversion goal makes biddable.
          "A String",
        ],
        "id": "A String", # Immutable. The ID for this custom conversion goal.
        "name": "A String", # The name for this custom conversion goal.
        "resourceName": "A String", # Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
        "status": "A String", # The status of the custom conversion goal.
      },
      "remove": "A String", # Remove operation: A resource name for the removed custom conversion goal is expected, in this format: 'customers/{customer_id}/customConversionGoals/{goal_id}'
      "update": { # Custom conversion goal that can make arbitrary conversion actions biddable. # Update operation: The custom conversion goal is expected to have a valid resource name.
        "conversionActions": [ # Conversion actions that the custom conversion goal makes biddable.
          "A String",
        ],
        "id": "A String", # Immutable. The ID for this custom conversion goal.
        "name": "A String", # The name for this custom conversion goal.
        "resourceName": "A String", # Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
        "status": "A String", # The status of the custom conversion goal.
      },
      "updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
    },
  ],
  "responseContentType": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
  "validateOnly": True or False, # 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 a custom conversion goal mutate.
  "results": [ # All results for the mutate.
    { # The result for the custom conversion goal mutate.
      "customConversionGoal": { # Custom conversion goal that can make arbitrary conversion actions biddable. # The mutated CustomConversionGoal with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "conversionActions": [ # Conversion actions that the custom conversion goal makes biddable.
          "A String",
        ],
        "id": "A String", # Immutable. The ID for this custom conversion goal.
        "name": "A String", # The name for this custom conversion goal.
        "resourceName": "A String", # Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
        "status": "A String", # The status of the custom conversion goal.
      },
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}