docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html
index 8494420..6a68c90 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.html
@@ -91,7 +91,7 @@
<code><a href="#get">get(accountId, clientAccountId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a client buyer with a given client account ID.</p>
<p class="toc_element">
- <code><a href="#list">list(accountId, pageSize=None, partnerClientId=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(accountId, pageToken=None, partnerClientId=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the clients for the current sponsor buyer.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -115,10 +115,8 @@
# buyer have restricted access to the Marketplace and certain other sections of
# the Authorized Buyers UI based on the role granted to the client buyer. All
# fields are required unless otherwise specified.
- "status": "A String", # The status of the client buyer.
- "clientAccountId": "A String", # The globally-unique numerical ID of the client.
- # The value of this field is ignored in create and update operations.
- "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
+ "status": "A String", # The status of the client buyer.
+ "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
# standpoint of its Ad Exchange sponsor buyer.
#
# This field can be used to associate a client buyer with the identifier
@@ -128,15 +126,17 @@
#
# If present, must be unique among all the client buyers for its
# Ad Exchange sponsor buyer.
- "entityName": "A String", # The name of the entity. This field is automatically fetched based on
- # the type and ID.
- # The value of this field is ignored in create and update operations.
- "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
- "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
- "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
- "entityId": "A String", # Numerical identifier of the client entity.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
#
@@ -151,11 +151,11 @@
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
# file.
- "clientName": "A String", # Name used to represent this client to publishers.
- # You may have multiple clients that map to the same entity,
- # but for each client the combination of `clientName` and entity
- # must be unique.
- # You can specify this field as empty.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
}
x__xgafv: string, V1 error format.
@@ -171,10 +171,8 @@
# buyer have restricted access to the Marketplace and certain other sections of
# the Authorized Buyers UI based on the role granted to the client buyer. All
# fields are required unless otherwise specified.
- "status": "A String", # The status of the client buyer.
- "clientAccountId": "A String", # The globally-unique numerical ID of the client.
- # The value of this field is ignored in create and update operations.
- "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
+ "status": "A String", # The status of the client buyer.
+ "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
# standpoint of its Ad Exchange sponsor buyer.
#
# This field can be used to associate a client buyer with the identifier
@@ -184,15 +182,17 @@
#
# If present, must be unique among all the client buyers for its
# Ad Exchange sponsor buyer.
- "entityName": "A String", # The name of the entity. This field is automatically fetched based on
- # the type and ID.
- # The value of this field is ignored in create and update operations.
- "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
- "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
- "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
- "entityId": "A String", # Numerical identifier of the client entity.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
#
@@ -207,11 +207,11 @@
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
# file.
- "clientName": "A String", # Name used to represent this client to publishers.
- # You may have multiple clients that map to the same entity,
- # but for each client the combination of `clientName` and entity
- # must be unique.
- # You can specify this field as empty.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
}</pre>
</div>
@@ -220,7 +220,7 @@
<pre>Gets a client buyer with a given client account ID.
Args:
- accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
+ accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
clientAccountId: string, Numerical account ID of the client buyer to retrieve. (required) (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -235,10 +235,8 @@
# buyer have restricted access to the Marketplace and certain other sections of
# the Authorized Buyers UI based on the role granted to the client buyer. All
# fields are required unless otherwise specified.
- "status": "A String", # The status of the client buyer.
- "clientAccountId": "A String", # The globally-unique numerical ID of the client.
- # The value of this field is ignored in create and update operations.
- "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
+ "status": "A String", # The status of the client buyer.
+ "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
# standpoint of its Ad Exchange sponsor buyer.
#
# This field can be used to associate a client buyer with the identifier
@@ -248,15 +246,17 @@
#
# If present, must be unique among all the client buyers for its
# Ad Exchange sponsor buyer.
- "entityName": "A String", # The name of the entity. This field is automatically fetched based on
- # the type and ID.
- # The value of this field is ignored in create and update operations.
- "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
- "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
- "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
- "entityId": "A String", # Numerical identifier of the client entity.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
#
@@ -271,31 +271,31 @@
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
# file.
- "clientName": "A String", # Name used to represent this client to publishers.
- # You may have multiple clients that map to the same entity,
- # but for each client the combination of `clientName` and entity
- # must be unique.
- # You can specify this field as empty.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(accountId, pageSize=None, partnerClientId=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(accountId, pageToken=None, partnerClientId=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists all the clients for the current sponsor buyer.
Args:
accountId: string, Unique numerical account ID of the sponsor buyer to list the clients for. (required)
- pageSize: integer, Requested page size. The server may return fewer clients than requested.
-If unspecified, the server will pick an appropriate default.
- partnerClientId: string, Optional unique identifier (from the standpoint of an Ad Exchange sponsor
-buyer partner) of the client to return.
-If specified, at most one client will be returned in the response.
pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
ListClientsResponse.nextPageToken
returned from the previous call to the
accounts.clients.list
method.
+ partnerClientId: string, Optional unique identifier (from the standpoint of an Ad Exchange sponsor
+buyer partner) of the client to return.
+If specified, at most one client will be returned in the response.
+ pageSize: integer, Requested page size. The server may return fewer clients than requested.
+If unspecified, the server will pick an appropriate default.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -305,22 +305,14 @@
An object of the form:
{
- "nextPageToken": "A String", # A token to retrieve the next page of results.
- # Pass this value in the
- # ListClientsRequest.pageToken
- # field in the subsequent call to the
- # accounts.clients.list
- # method to retrieve the next page of results.
- "clients": [ # The returned list of clients.
+ "clients": [ # The returned list of clients.
{ # A client resource represents a client buyer&mdash;an agency, a brand, or an
# advertiser customer of the sponsor buyer. Users associated with the client
# buyer have restricted access to the Marketplace and certain other sections of
# the Authorized Buyers UI based on the role granted to the client buyer. All
# fields are required unless otherwise specified.
- "status": "A String", # The status of the client buyer.
- "clientAccountId": "A String", # The globally-unique numerical ID of the client.
- # The value of this field is ignored in create and update operations.
- "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
+ "status": "A String", # The status of the client buyer.
+ "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
# standpoint of its Ad Exchange sponsor buyer.
#
# This field can be used to associate a client buyer with the identifier
@@ -330,15 +322,17 @@
#
# If present, must be unique among all the client buyers for its
# Ad Exchange sponsor buyer.
- "entityName": "A String", # The name of the entity. This field is automatically fetched based on
- # the type and ID.
- # The value of this field is ignored in create and update operations.
- "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
- "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
- "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
- "entityId": "A String", # Numerical identifier of the client entity.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
#
@@ -353,13 +347,19 @@
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
# file.
- "clientName": "A String", # Name used to represent this client to publishers.
- # You may have multiple clients that map to the same entity,
- # but for each client the combination of `clientName` and entity
- # must be unique.
- # You can specify this field as empty.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
},
],
+ "nextPageToken": "A String", # A token to retrieve the next page of results.
+ # Pass this value in the
+ # ListClientsRequest.pageToken
+ # field in the subsequent call to the
+ # accounts.clients.list
+ # method to retrieve the next page of results.
}</pre>
</div>
@@ -372,7 +372,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -393,10 +393,8 @@
# buyer have restricted access to the Marketplace and certain other sections of
# the Authorized Buyers UI based on the role granted to the client buyer. All
# fields are required unless otherwise specified.
- "status": "A String", # The status of the client buyer.
- "clientAccountId": "A String", # The globally-unique numerical ID of the client.
- # The value of this field is ignored in create and update operations.
- "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
+ "status": "A String", # The status of the client buyer.
+ "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
# standpoint of its Ad Exchange sponsor buyer.
#
# This field can be used to associate a client buyer with the identifier
@@ -406,15 +404,17 @@
#
# If present, must be unique among all the client buyers for its
# Ad Exchange sponsor buyer.
- "entityName": "A String", # The name of the entity. This field is automatically fetched based on
- # the type and ID.
- # The value of this field is ignored in create and update operations.
- "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
- "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
- "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
- "entityId": "A String", # Numerical identifier of the client entity.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
#
@@ -429,11 +429,11 @@
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
# file.
- "clientName": "A String", # Name used to represent this client to publishers.
- # You may have multiple clients that map to the same entity,
- # but for each client the combination of `clientName` and entity
- # must be unique.
- # You can specify this field as empty.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
}
x__xgafv: string, V1 error format.
@@ -449,10 +449,8 @@
# buyer have restricted access to the Marketplace and certain other sections of
# the Authorized Buyers UI based on the role granted to the client buyer. All
# fields are required unless otherwise specified.
- "status": "A String", # The status of the client buyer.
- "clientAccountId": "A String", # The globally-unique numerical ID of the client.
- # The value of this field is ignored in create and update operations.
- "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
+ "status": "A String", # The status of the client buyer.
+ "partnerClientId": "A String", # Optional arbitrary unique identifier of this client buyer from the
# standpoint of its Ad Exchange sponsor buyer.
#
# This field can be used to associate a client buyer with the identifier
@@ -462,15 +460,17 @@
#
# If present, must be unique among all the client buyers for its
# Ad Exchange sponsor buyer.
- "entityName": "A String", # The name of the entity. This field is automatically fetched based on
- # the type and ID.
- # The value of this field is ignored in create and update operations.
- "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
- "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
- "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
- "entityId": "A String", # Numerical identifier of the client entity.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
#
@@ -485,11 +485,11 @@
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
# file.
- "clientName": "A String", # Name used to represent this client to publishers.
- # You may have multiple clients that map to the same entity,
- # but for each client the combination of `clientName` and entity
- # must be unique.
- # You can specify this field as empty.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
}</pre>
</div>