Search Ads 360 Reporting API . customers . customerUserAccessInvitations

Instance Methods

close()

Close httplib2 connections.

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

Creates or removes an access invitation. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

Method Details

close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates or removes an access invitation. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()

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

{ # Request message for CustomerUserAccessInvitationService.MutateCustomerUserAccessInvitation
  "operation": { # A single operation (create or remove) on customer user access invitation. # Required. The operation to perform on the access invitation
    "create": { # Represent an invitation to a new user on this customer account. # Create operation: No resource name is expected for the new access invitation.
      "accessRole": "A String", # Immutable. Access role of the user.
      "creationDateTime": "A String", # Output only. Time invitation was created. This field is read-only. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
      "emailAddress": "A String", # Immutable. Email address the invitation was sent to. This can differ from the email address of the account that accepts the invite.
      "invitationId": "A String", # Output only. The ID of the invitation. This field is read-only.
      "invitationStatus": "A String", # Output only. Invitation status of the user.
      "resourceName": "A String", # Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`
    },
    "remove": "A String", # Remove operation: A resource name for the revoke invitation is expected, in this format: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`
  },
}

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