Search Ads 360 Reporting API . customers . conversionCustomVariables

close()

Close httplib2 connections.

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

Creates or updates conversion custom variables. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ConversionCustomVariableError]() [DatabaseError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

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

{ # Request message for ConversionCustomVariableService.MutateConversionCustomVariables.
  "operations": [ # Required. The list of operations to perform on individual conversion custom variables.
    { # A single operation (create, update) on a conversion custom variable.
      "create": { # A conversion custom variable. See "About custom Floodlight metrics and dimensions in the new Search Ads 360" at https://support.google.com/sa360/answer/13567857 # Create operation: No resource name is expected for the new conversion custom variable.
        "cardinality": "A String", # Output only. Cardinality of the conversion custom variable.
        "customColumnIds": [ # Output only. The IDs of custom columns that use this conversion custom variable.
          "A String",
        ],
        "family": "A String", # Output only. Family of the conversion custom variable.
        "floodlightConversionCustomVariableInfo": { # Information for Search Ads 360 Floodlight Conversion Custom Variables. # Output only. Fields for Search Ads 360 floodlight conversion custom variables.
          "floodlightVariableDataType": "A String", # Output only. Floodlight variable data type defined in Search Ads 360.
          "floodlightVariableType": "A String", # Output only. Floodlight variable type defined in Search Ads 360.
        },
        "id": "A String", # Output only. The ID of the conversion custom variable.
        "name": "A String", # Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
        "ownerCustomer": "A String", # Output only. The resource name of the customer that owns the conversion custom variable.
        "resourceName": "A String", # Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
        "status": "A String", # The status of the conversion custom variable for conversion event accrual.
        "tag": "A String", # Required. Immutable. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".
      },
      "update": { # A conversion custom variable. See "About custom Floodlight metrics and dimensions in the new Search Ads 360" at https://support.google.com/sa360/answer/13567857 # Update operation: The conversion custom variable is expected to have a valid resource name.
        "cardinality": "A String", # Output only. Cardinality of the conversion custom variable.
        "customColumnIds": [ # Output only. The IDs of custom columns that use this conversion custom variable.
          "A String",
        ],
        "family": "A String", # Output only. Family of the conversion custom variable.
        "floodlightConversionCustomVariableInfo": { # Information for Search Ads 360 Floodlight Conversion Custom Variables. # Output only. Fields for Search Ads 360 floodlight conversion custom variables.
          "floodlightVariableDataType": "A String", # Output only. Floodlight variable data type defined in Search Ads 360.
          "floodlightVariableType": "A String", # Output only. Floodlight variable type defined in Search Ads 360.
        },
        "id": "A String", # Output only. The ID of the conversion custom variable.
        "name": "A String", # Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
        "ownerCustomer": "A String", # Output only. The resource name of the customer that owns the conversion custom variable.
        "resourceName": "A String", # Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
        "status": "A String", # The status of the conversion custom variable for conversion event accrual.
        "tag": "A String", # Required. Immutable. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".
      },
      "updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
    },
  ],
  "partialFailure": True or False, # If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
  "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 ConversionCustomVariableService.MutateConversionCustomVariables.
  "partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "results": [ # All results for the mutate.
    { # The result for the conversion custom variable mutate.
      "conversionCustomVariable": { # A conversion custom variable. See "About custom Floodlight metrics and dimensions in the new Search Ads 360" at https://support.google.com/sa360/answer/13567857 # The mutated conversion custom variable with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "cardinality": "A String", # Output only. Cardinality of the conversion custom variable.
        "customColumnIds": [ # Output only. The IDs of custom columns that use this conversion custom variable.
          "A String",
        ],
        "family": "A String", # Output only. Family of the conversion custom variable.
        "floodlightConversionCustomVariableInfo": { # Information for Search Ads 360 Floodlight Conversion Custom Variables. # Output only. Fields for Search Ads 360 floodlight conversion custom variables.
          "floodlightVariableDataType": "A String", # Output only. Floodlight variable data type defined in Search Ads 360.
          "floodlightVariableType": "A String", # Output only. Floodlight variable type defined in Search Ads 360.
        },
        "id": "A String", # Output only. The ID of the conversion custom variable.
        "name": "A String", # Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
        "ownerCustomer": "A String", # Output only. The resource name of the customer that owns the conversion custom variable.
        "resourceName": "A String", # Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
        "status": "A String", # The status of the conversion custom variable for conversion event accrual.
        "tag": "A String", # Required. Immutable. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".
      },
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}