blob: 8cbf68493493baae7741efaa48e169b21fb0ee68 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="searchads360_v23.html">Search Ads 360 Reporting API</a> . <a href="searchads360_v23.customers.html">customers</a> . <a href="searchads360_v23.customers.customerUserAccessInvitations.html">customerUserAccessInvitations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#mutate">mutate(customerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or removes an access invitation. List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="mutate">mutate(customerId, body=None, x__xgafv=None)</code>
<pre>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
&quot;operation&quot;: { # A single operation (create or remove) on customer user access invitation. # Required. The operation to perform on the access invitation
&quot;create&quot;: { # Represent an invitation to a new user on this customer account. # Create operation: No resource name is expected for the new access invitation.
&quot;accessRole&quot;: &quot;A String&quot;, # Immutable. Access role of the user.
&quot;creationDateTime&quot;: &quot;A String&quot;, # Output only. Time invitation was created. This field is read-only. The format is &quot;YYYY-MM-DD HH:MM:SS&quot;. Examples: &quot;2018-03-05 09:15:00&quot; or &quot;2018-02-01 14:34:30&quot;
&quot;emailAddress&quot;: &quot;A String&quot;, # Immutable. Email address the invitation was sent to. This can differ from the email address of the account that accepts the invite.
&quot;invitationId&quot;: &quot;A String&quot;, # Output only. The ID of the invitation. This field is read-only.
&quot;invitationStatus&quot;: &quot;A String&quot;, # Output only. Invitation status of the user.
&quot;resourceName&quot;: &quot;A String&quot;, # Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`
},
&quot;remove&quot;: &quot;A String&quot;, # 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.
&quot;result&quot;: { # The result for the access invitation mutate. # Result for the mutate.
&quot;resourceName&quot;: &quot;A String&quot;, # Returned for successful operations.
},
}</pre>
</div>
</body></html>