Search Ads 360 Reporting API . customers . customerUserAccesses

Instance Methods

close()

Close httplib2 connections.

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

Updates, removes permission of a user on a given customer. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Method Details

close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Updates, removes permission of a user on a given customer. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CustomerUserAccessError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

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

{ # Mutate Request for CustomerUserAccessService.MutateCustomerUserAccess.
  "operation": { # A single operation (update, remove) on customer user access. # Required. The operation to perform on the customer
    "remove": "A String", # Remove operation: A resource name for the removed access is expected, in this format: `customers/{customer_id}/customerUserAccesses/{CustomerUserAccess.user_id}`
    "update": { # Represents the permission of a single user onto a single customer. # Update operation: The customer user access is expected to have a valid resource name.
      "accessCreationDateTime": "A String", # Output only. The customer user access creation time. Read only field The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
      "accessRole": "A String", # Access role of the user.
      "emailAddress": "A String", # Output only. Email address of the user. Read only field
      "inviterUserEmailAddress": "A String", # Output only. The email address of the inviter user. Read only field
      "resourceName": "A String", # Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccesses/{user_id}`
      "userId": "A String", # Output only. User id of the user with the customer access. Read only field
    },
    "updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
  },
}

  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 customer user access mutate.
  "result": { # The result for the customer user access mutate. # Result for the mutate.
    "resourceName": "A String", # Returned for successful operations.
  },
}