Search Ads 360 Reporting API . customers . adGroupLabels

close()

Close httplib2 connections.

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

Creates and removes ad group labels. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()

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

{ # Request message for AdGroupLabelService.MutateAdGroupLabels.
  "operations": [ # Required. The list of operations to perform on ad group labels.
    { # A single operation (create, remove) on an ad group label.
      "create": { # A relationship between an ad group and a label. # Create operation: No resource name is expected for the new ad group label.
        "adGroup": "A String", # Immutable. The ad group to which the label is attached.
        "label": "A String", # Immutable. The label assigned to the ad group.
        "ownerCustomerId": "A String", # Output only. The ID of the Customer which owns the label.
        "resourceName": "A String", # Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
      },
      "remove": "A String", # Remove operation: A resource name for the ad group label being removed, in this format: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_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.
  "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 an ad group 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 an ad group label mutate.
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}