Search Ads 360 Reporting API . customers . labels

close()

Close httplib2 connections.

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

Creates, updates, or removes labels. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

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

{ # Request message for LabelService.MutateLabels.
  "operations": [ # Required. The list of operations to perform on labels.
    { # A single operation (create, remove, update) on a label.
      "create": { # A label. # Create operation: No resource name is expected for the new label.
        "id": "A String", # Output only. ID of the label. Read only.
        "name": "A String", # The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
        "resourceName": "A String", # Immutable. Name of the resource. Label resource names have the form: `customers/{owner_customer_id}/labels/{label_id}`
        "status": "A String", # Output only. Status of the label. Read only.
        "textLabel": { # A type of label displaying text on a colored background. # A type of label displaying text on a colored background.
          "backgroundColor": "A String", # Background color of the label in HEX format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
          "description": "A String", # A short description of the label. The length must be no more than 200 characters.
        },
      },
      "remove": "A String", # Remove operation: A resource name for the label being removed, in this format: `customers/{customer_id}/labels/{label_id}`
      "update": { # A label. # Update operation: The label is expected to have a valid resource name.
        "id": "A String", # Output only. ID of the label. Read only.
        "name": "A String", # The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
        "resourceName": "A String", # Immutable. Name of the resource. Label resource names have the form: `customers/{owner_customer_id}/labels/{label_id}`
        "status": "A String", # Output only. Status of the label. Read only.
        "textLabel": { # A type of label displaying text on a colored background. # A type of label displaying text on a colored background.
          "backgroundColor": "A String", # Background color of the label in HEX format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
          "description": "A String", # A short description of the label. The length must be no more than 200 characters.
        },
      },
      "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 a labels 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 a label mutate.
      "label": { # A label. # The mutated label with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "id": "A String", # Output only. ID of the label. Read only.
        "name": "A String", # The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
        "resourceName": "A String", # Immutable. Name of the resource. Label resource names have the form: `customers/{owner_customer_id}/labels/{label_id}`
        "status": "A String", # Output only. Status of the label. Read only.
        "textLabel": { # A type of label displaying text on a colored background. # A type of label displaying text on a colored background.
          "backgroundColor": "A String", # Background color of the label in HEX format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
          "description": "A String", # A short description of the label. The length must be no more than 200 characters.
        },
      },
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}