Authorized Buyers Marketplace API . buyers . clients

activate(name, body=None, x__xgafv=None)

Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.

Args:
  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for activating a client.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
  "sellerVisible": True or False, # Whether the client will be visible to sellers.
  "state": "A String", # Output only. The state of the client.
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new client.

Args:
  parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
  "sellerVisible": True or False, # Whether the client will be visible to sellers.
  "state": "A String", # Output only. The state of the client.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
  "sellerVisible": True or False, # Whether the client will be visible to sellers.
  "state": "A String", # Output only. The state of the client.
}

deactivate(name, body=None, x__xgafv=None)

Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.

Args:
  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for disabling a client.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
  "sellerVisible": True or False, # Whether the client will be visible to sellers.
  "state": "A String", # Output only. The state of the client.
}

get(name, x__xgafv=None)

Gets a client with a given resource name.

Args:
  name: string, Required. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
  "sellerVisible": True or False, # Whether the client will be visible to sellers.
  "state": "A String", # Output only. The state of the client.
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists all the clients for the current buyer.

Args:
  parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
  filter: string, Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response.
  pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
  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 list method.
  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 the list method.
  "clients": [ # The returned list of clients.
    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
      "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
      "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
      "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
      "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
      "sellerVisible": True or False, # Whether the client will be visible to sellers.
      "state": "A String", # Output only. The state of the client.
    },
  ],
  "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 list method to retrieve the next page of results.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  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
  page. Returns None if there are no more items in the collection.
    

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing client.

Args:
  name: string, Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
  "sellerVisible": True or False, # Whether the client will be visible to sellers.
  "state": "A String", # Output only. The state of the client.
}

  updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, e.g. false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
  "sellerVisible": True or False, # Whether the client will be visible to sellers.
  "state": "A String", # Output only. The state of the client.
}