Search Ads 360 Reporting API . customers . campaignCustomizers

close()

Close httplib2 connections.

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

Creates, updates or removes campaign customizers. Operation statuses are returned.

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

{ # Request message for CampaignCustomizerService.MutateCampaignCustomizers.
  "operations": [ # Required. The list of operations to perform on individual campaign customizers.
    { # A single operation (create, remove) on a customizer attribute.
      "create": { # A customizer value for the associated CustomizerAttribute at the Campaign level. # Create operation: No resource name is expected for the new campaign customizer
        "campaign": "A String", # Immutable. The campaign to which the customizer attribute is linked.
        "customizerAttribute": "A String", # Required. Immutable. The customizer attribute which is linked to the campaign.
        "resourceName": "A String", # Immutable. The resource name of the campaign customizer. Campaign customizer resource names have the form: `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
        "status": "A String", # Output only. The status of the campaign customizer.
        "value": { # A customizer value that is referenced in customizer linkage entities like CustomerCustomizer, CampaignCustomizer, etc. # Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
          "stringValue": "A String", # Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.
          "type": "A String", # Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type.
        },
      },
      "remove": "A String", # Remove operation: A resource name for the removed campaign customizer is expected, in this format: `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
    },
  ],
  "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 a campaign customizer mutate.
  "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 campaign customizer mutate.
      "campaignCustomizer": { # A customizer value for the associated CustomizerAttribute at the Campaign level. # The mutated CampaignCustomizer with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "campaign": "A String", # Immutable. The campaign to which the customizer attribute is linked.
        "customizerAttribute": "A String", # Required. Immutable. The customizer attribute which is linked to the campaign.
        "resourceName": "A String", # Immutable. The resource name of the campaign customizer. Campaign customizer resource names have the form: `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
        "status": "A String", # Output only. The status of the campaign customizer.
        "value": { # A customizer value that is referenced in customizer linkage entities like CustomerCustomizer, CampaignCustomizer, etc. # Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
          "stringValue": "A String", # Required. Value to insert in creative text. Customizer values of all types are stored as string to make formatting unambiguous.
          "type": "A String", # Required. The data type for the customizer value. It must match the attribute type. The string_value content must match the constraints associated with the type.
        },
      },
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}