docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/displayvideo_v1.users.html b/docs/dyn/displayvideo_v1.users.html
index 7a66fa2..f549287 100644
--- a/docs/dyn/displayvideo_v1.users.html
+++ b/docs/dyn/displayvideo_v1.users.html
@@ -90,7 +90,7 @@
<code><a href="#get">get(userId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a user.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, orderBy=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageToken=None, pageSize=None, orderBy=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -114,9 +114,9 @@
],
"createdAssignedUserRoles": [ # The assigned user roles to create in batch, specified as a list of AssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
@@ -133,9 +133,9 @@
{
"createdAssignedUserRoles": [ # The list of assigned user roles that have been successfully created. This list will be absent if empty.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
@@ -156,18 +156,18 @@
The object takes the form of:
{ # A single user in Display & Video 360.
- "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+ "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "email": "A String", # Required. Immutable. The email address used to identify the user.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
- "email": "A String", # Required. Immutable. The email address used to identify the user.
- "name": "A String", # Output only. The resource name of the user.
}
x__xgafv: string, V1 error format.
@@ -179,18 +179,18 @@
An object of the form:
{ # A single user in Display & Video 360.
- "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+ "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "email": "A String", # Required. Immutable. The email address used to identify the user.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
- "email": "A String", # Required. Immutable. The email address used to identify the user.
- "name": "A String", # Output only. The resource name of the user.
}</pre>
</div>
@@ -227,30 +227,30 @@
An object of the form:
{ # A single user in Display & Video 360.
- "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+ "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "email": "A String", # Required. Immutable. The email address used to identify the user.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
- "email": "A String", # Required. Immutable. The email address used to identify the user.
- "name": "A String", # Output only. The resource name of the user.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, orderBy=None, filter=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageToken=None, pageSize=None, orderBy=None, filter=None, x__xgafv=None)</code>
<pre>Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other.
Args:
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned.
+ pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.
orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
filter: string, Allows filtering by user properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following fields: - `displayName` - `email` * The operator must be `EQUALS (=)` for the following fields: - `assignedUserRole.userRole` - `assignedUserRole.partnerId` - `assignedUserRole.advertiserId` - `assignedUserRole.entityType`: A synthetic field of AssignedUserRole used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. - `assignedUserRole.parentPartnerId`: A synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned." Examples: * The user with displayName containing `foo`: `displayName:"foo"` * The user with email containing `bar`: `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` The length of this field should be no more than 500 characters.
- pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -260,23 +260,23 @@
An object of the form:
{
- "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return.
"users": [ # The list of users. This list will be absent if empty.
{ # A single user in Display & Video 360.
- "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+ "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "email": "A String", # Required. Immutable. The email address used to identify the user.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
- "email": "A String", # Required. Immutable. The email address used to identify the user.
- "name": "A String", # Output only. The resource name of the user.
},
],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return.
}</pre>
</div>
@@ -304,18 +304,18 @@
The object takes the form of:
{ # A single user in Display & Video 360.
- "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+ "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "email": "A String", # Required. Immutable. The email address used to identify the user.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
- "email": "A String", # Required. Immutable. The email address used to identify the user.
- "name": "A String", # Output only. The resource name of the user.
}
updateMask: string, Required. The mask to control which fields to update.
@@ -328,18 +328,18 @@
An object of the form:
{ # A single user in Display & Video 360.
- "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
+ "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "email": "A String", # Required. Immutable. The email address used to identify the user.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
- "userRole": "A String", # Required. The user role to assign to a user for the entity.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
+ "userRole": "A String", # Required. The user role to assign to a user for the entity.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
},
],
- "email": "A String", # Required. Immutable. The email address used to identify the user.
- "name": "A String", # Output only. The resource name of the user.
}</pre>
</div>