# Ad Exchange Buyer API II . accounts . clients

## Instance Methods

Returns the invitations Resource.

Returns the users Resource.

Creates a new client buyer.

Gets a client buyer with a given client account ID.

Lists all the clients for the current sponsor buyer.

Retrieves the next page of results.

Updates an existing client buyer.

### Method Details

`create(accountId, body, x__xgafv=None)`

    Creates a new client buyer.

    Args:
      accountId: string, Unique numerical account ID for the buyer of which the client buyer
    is a customer; the sponsor buyer to create a client for. (required) (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A client resource represents a client buyer—an agency,
          # a brand, or an advertiser customer of the sponsor buyer.
          # Users associated with the client buyer have restricted access to
          # the Ad Exchange Marketplace and certain other sections
          # of the Ad Exchange Buyer 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.
        "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
            # 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.
            # The entity can be an advertiser, a brand, or an agency.
            # This identifier is unique among all the entities with the same type.
            #
            # A list of all known advertisers with their identifiers is available in the
            # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
            # file.
            #
            # A list of all known brands with their identifiers is available in the
            # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
            # file.
            #
            # 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.
      }

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

    Returns:
      An object of the form:

        { # A client resource represents a client buyer—an agency,
            # a brand, or an advertiser customer of the sponsor buyer.
            # Users associated with the client buyer have restricted access to
            # the Ad Exchange Marketplace and certain other sections
            # of the Ad Exchange Buyer 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.
          "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
              # 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.
              # The entity can be an advertiser, a brand, or an agency.
              # This identifier is unique among all the entities with the same type.
              #
              # A list of all known advertisers with their identifiers is available in the
              # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
              # file.
              #
              # A list of all known brands with their identifiers is available in the
              # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
              # file.
              #
              # 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.
        }

`get(accountId, clientAccountId, x__xgafv=None)`

    Gets a client buyer with a given client account ID.

    Args:
      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
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A client resource represents a client buyer—an agency,
            # a brand, or an advertiser customer of the sponsor buyer.
            # Users associated with the client buyer have restricted access to
            # the Ad Exchange Marketplace and certain other sections
            # of the Ad Exchange Buyer 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.
          "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
              # 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.
              # The entity can be an advertiser, a brand, or an agency.
              # This identifier is unique among all the entities with the same type.
              #
              # A list of all known advertisers with their identifiers is available in the
              # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
              # file.
              #
              # A list of all known brands with their identifiers is available in the
              # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
              # file.
              #
              # 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.
        }

`list(accountId, pageSize=None, pageToken=None, x__xgafv=None)`

    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.
      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.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      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.
          { # A client resource represents a client buyer—an agency,
                # a brand, or an advertiser customer of the sponsor buyer.
                # Users associated with the client buyer have restricted access to
                # the Ad Exchange Marketplace and certain other sections
                # of the Ad Exchange Buyer 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.
              "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
                  # 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.
                  # The entity can be an advertiser, a brand, or an agency.
                  # This identifier is unique among all the entities with the same type.
                  #
                  # A list of all known advertisers with their identifiers is available in the
                  # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
                  # file.
                  #
                  # A list of all known brands with their identifiers is available in the
                  # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
                  # file.
                  #
                  # 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.
            },
        ],
      }

`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.

`update(accountId, clientAccountId, body, x__xgafv=None)`

    Updates an existing client buyer.

    Args:
      accountId: string, Unique numerical account ID for the buyer of which the client buyer
    is a customer; the sponsor buyer to update a client for. (required) (required)
      clientAccountId: string, Unique numerical account ID of the client to update. (required) (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A client resource represents a client buyer—an agency,
          # a brand, or an advertiser customer of the sponsor buyer.
          # Users associated with the client buyer have restricted access to
          # the Ad Exchange Marketplace and certain other sections
          # of the Ad Exchange Buyer 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.
        "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
            # 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.
            # The entity can be an advertiser, a brand, or an agency.
            # This identifier is unique among all the entities with the same type.
            #
            # A list of all known advertisers with their identifiers is available in the
            # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
            # file.
            #
            # A list of all known brands with their identifiers is available in the
            # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
            # file.
            #
            # 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.
      }

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

    Returns:
      An object of the form:

        { # A client resource represents a client buyer—an agency,
            # a brand, or an advertiser customer of the sponsor buyer.
            # Users associated with the client buyer have restricted access to
            # the Ad Exchange Marketplace and certain other sections
            # of the Ad Exchange Buyer 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.
          "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
              # 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.
              # The entity can be an advertiser, a brand, or an agency.
              # This identifier is unique among all the entities with the same type.
              #
              # A list of all known advertisers with their identifiers is available in the
              # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
              # file.
              #
              # A list of all known brands with their identifiers is available in the
              # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
              # file.
              #
              # 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.
        }