adexchangebuyer2

package
v0.0.0-...-adeea6a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 10, 2022 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package adexchangebuyer2 provides access to the Ad Exchange Buyer API II.

See https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/

Usage example: 

import "google.golang.org/api/adexchangebuyer2/v2beta1"
...
adexchangebuyer2Service, err := adexchangebuyer2.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// Manage your Ad Exchange buyer account configuration
	AdexchangeBuyerScope = "https://www.googleapis.com/auth/adexchange.buyer"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountsClientsCreateCall 

type AccountsClientsCreateCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsCreateCall) Context 

func (c *AccountsClientsCreateCall) Context(ctx context.Context) *AccountsClientsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsCreateCall) Do 

func (c *AccountsClientsCreateCall) Do(opts ...googleapi.CallOption) (*Client, error)

Do executes the "adexchangebuyer2.accounts.clients.create" call. Exactly one of *Client or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Client.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsCreateCall) Fields 

func (c *AccountsClientsCreateCall) Fields(s ...googleapi.Field) *AccountsClientsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type AccountsClientsGetCall 

type AccountsClientsGetCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsGetCall) Context 

func (c *AccountsClientsGetCall) Context(ctx context.Context) *AccountsClientsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsGetCall) Do 

func (c *AccountsClientsGetCall) Do(opts ...googleapi.CallOption) (*Client, error)

Do executes the "adexchangebuyer2.accounts.clients.get" call. Exactly one of *Client or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Client.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsGetCall) Fields 

func (c *AccountsClientsGetCall) Fields(s ...googleapi.Field) *AccountsClientsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsClientsGetCall) IfNoneMatch 

func (c *AccountsClientsGetCall) IfNoneMatch(entityTag string) *AccountsClientsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsClientsInvitationsCreateCall 

type AccountsClientsInvitationsCreateCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsInvitationsCreateCall) Context 

func (c *AccountsClientsInvitationsCreateCall) Context(ctx context.Context) *AccountsClientsInvitationsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsInvitationsCreateCall) Do 

func (c *AccountsClientsInvitationsCreateCall) Do(opts ...googleapi.CallOption) (*ClientUserInvitation, error)

Do executes the "adexchangebuyer2.accounts.clients.invitations.create" call. Exactly one of *ClientUserInvitation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ClientUserInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsInvitationsCreateCall) Fields 

func (c *AccountsClientsInvitationsCreateCall) Fields(s ...googleapi.Field) *AccountsClientsInvitationsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type AccountsClientsInvitationsGetCall 

type AccountsClientsInvitationsGetCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsInvitationsGetCall) Context 

func (c *AccountsClientsInvitationsGetCall) Context(ctx context.Context) *AccountsClientsInvitationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsInvitationsGetCall) Do 

func (c *AccountsClientsInvitationsGetCall) Do(opts ...googleapi.CallOption) (*ClientUserInvitation, error)

Do executes the "adexchangebuyer2.accounts.clients.invitations.get" call. Exactly one of *ClientUserInvitation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ClientUserInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsInvitationsGetCall) Fields 

func (c *AccountsClientsInvitationsGetCall) Fields(s ...googleapi.Field) *AccountsClientsInvitationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsClientsInvitationsGetCall) IfNoneMatch 

func (c *AccountsClientsInvitationsGetCall) IfNoneMatch(entityTag string) *AccountsClientsInvitationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsClientsInvitationsListCall 

type AccountsClientsInvitationsListCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsInvitationsListCall) Context 

func (c *AccountsClientsInvitationsListCall) Context(ctx context.Context) *AccountsClientsInvitationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsInvitationsListCall) Do 

func (c *AccountsClientsInvitationsListCall) Do(opts ...googleapi.CallOption) (*ListClientUserInvitationsResponse, error)

Do executes the "adexchangebuyer2.accounts.clients.invitations.list" call. Exactly one of *ListClientUserInvitationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListClientUserInvitationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsInvitationsListCall) Fields 

func (c *AccountsClientsInvitationsListCall) Fields(s ...googleapi.Field) *AccountsClientsInvitationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsClientsInvitationsListCall) IfNoneMatch 

func (c *AccountsClientsInvitationsListCall) IfNoneMatch(entityTag string) *AccountsClientsInvitationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AccountsClientsInvitationsListCall) PageSize 

func (c *AccountsClientsInvitationsListCall) PageSize(pageSize int64) *AccountsClientsInvitationsListCall

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.

func (*AccountsClientsInvitationsListCall) PageToken 

func (c *AccountsClientsInvitationsListCall) PageToken(pageToken string) *AccountsClientsInvitationsListCall

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.

func (*AccountsClientsInvitationsListCall) Pages 

func (c *AccountsClientsInvitationsListCall) Pages(ctx context.Context, f func(*ListClientUserInvitationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type AccountsClientsInvitationsService 

type AccountsClientsInvitationsService struct {
	// contains filtered or unexported fields
}

func NewAccountsClientsInvitationsService 

func NewAccountsClientsInvitationsService(s *Service) *AccountsClientsInvitationsService

func (*AccountsClientsInvitationsService) Create 

func (r *AccountsClientsInvitationsService) Create(accountId int64, clientAccountId int64, clientuserinvitation *ClientUserInvitation) *AccountsClientsInvitationsCreateCall

Create: Creates and sends out an email invitation to access an Ad Exchange client buyer account.

func (*AccountsClientsInvitationsService) Get 

func (r *AccountsClientsInvitationsService) Get(accountId int64, clientAccountId int64, invitationId int64) *AccountsClientsInvitationsGetCall

Get: Retrieves an existing client user invitation.

func (*AccountsClientsInvitationsService) List 

func (r *AccountsClientsInvitationsService) List(accountId int64, clientAccountId string) *AccountsClientsInvitationsListCall

List: Lists all the client users invitations for a client with a given account ID.

type AccountsClientsListCall 

type AccountsClientsListCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsListCall) Context 

func (c *AccountsClientsListCall) Context(ctx context.Context) *AccountsClientsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsListCall) Do 

func (c *AccountsClientsListCall) Do(opts ...googleapi.CallOption) (*ListClientsResponse, error)

Do executes the "adexchangebuyer2.accounts.clients.list" call. Exactly one of *ListClientsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListClientsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsListCall) Fields 

func (c *AccountsClientsListCall) Fields(s ...googleapi.Field) *AccountsClientsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsClientsListCall) IfNoneMatch 

func (c *AccountsClientsListCall) IfNoneMatch(entityTag string) *AccountsClientsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AccountsClientsListCall) PageSize 

func (c *AccountsClientsListCall) PageSize(pageSize int64) *AccountsClientsListCall

PageSize sets the optional parameter "pageSize": Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

func (*AccountsClientsListCall) PageToken 

func (c *AccountsClientsListCall) PageToken(pageToken string) *AccountsClientsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*AccountsClientsListCall) Pages 

func (c *AccountsClientsListCall) Pages(ctx context.Context, f func(*ListClientsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type AccountsClientsService 

type AccountsClientsService struct {
	Invitations *AccountsClientsInvitationsService

	Users *AccountsClientsUsersService
	// contains filtered or unexported fields
}

func NewAccountsClientsService 

func NewAccountsClientsService(s *Service) *AccountsClientsService

func (*AccountsClientsService) Create 

func (r *AccountsClientsService) Create(accountId int64, client *Client) *AccountsClientsCreateCall

Create: Creates a new client buyer.

func (*AccountsClientsService) Get 

func (r *AccountsClientsService) Get(accountId int64, clientAccountId int64) *AccountsClientsGetCall

Get: Gets a client buyer with a given client account ID.

func (*AccountsClientsService) List 

func (r *AccountsClientsService) List(accountId int64) *AccountsClientsListCall

List: Lists all the clients for the current sponsor buyer.

func (*AccountsClientsService) Update 

func (r *AccountsClientsService) Update(accountId int64, clientAccountId int64, client *Client) *AccountsClientsUpdateCall

Update: Updates an existing client buyer.

type AccountsClientsUpdateCall 

type AccountsClientsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsUpdateCall) Context 

func (c *AccountsClientsUpdateCall) Context(ctx context.Context) *AccountsClientsUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsUpdateCall) Do 

func (c *AccountsClientsUpdateCall) Do(opts ...googleapi.CallOption) (*Client, error)

Do executes the "adexchangebuyer2.accounts.clients.update" call. Exactly one of *Client or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Client.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsUpdateCall) Fields 

func (c *AccountsClientsUpdateCall) Fields(s ...googleapi.Field) *AccountsClientsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type AccountsClientsUsersGetCall 

type AccountsClientsUsersGetCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsUsersGetCall) Context 

func (c *AccountsClientsUsersGetCall) Context(ctx context.Context) *AccountsClientsUsersGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsUsersGetCall) Do 

func (c *AccountsClientsUsersGetCall) Do(opts ...googleapi.CallOption) (*ClientUser, error)

Do executes the "adexchangebuyer2.accounts.clients.users.get" call. Exactly one of *ClientUser or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ClientUser.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsUsersGetCall) Fields 

func (c *AccountsClientsUsersGetCall) Fields(s ...googleapi.Field) *AccountsClientsUsersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsClientsUsersGetCall) IfNoneMatch 

func (c *AccountsClientsUsersGetCall) IfNoneMatch(entityTag string) *AccountsClientsUsersGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsClientsUsersListCall 

type AccountsClientsUsersListCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsUsersListCall) Context 

func (c *AccountsClientsUsersListCall) Context(ctx context.Context) *AccountsClientsUsersListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsUsersListCall) Do 

func (c *AccountsClientsUsersListCall) Do(opts ...googleapi.CallOption) (*ListClientUsersResponse, error)

Do executes the "adexchangebuyer2.accounts.clients.users.list" call. Exactly one of *ListClientUsersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListClientUsersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsUsersListCall) Fields 

func (c *AccountsClientsUsersListCall) Fields(s ...googleapi.Field) *AccountsClientsUsersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsClientsUsersListCall) IfNoneMatch 

func (c *AccountsClientsUsersListCall) IfNoneMatch(entityTag string) *AccountsClientsUsersListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AccountsClientsUsersListCall) PageSize 

func (c *AccountsClientsUsersListCall) PageSize(pageSize int64) *AccountsClientsUsersListCall

PageSize sets the optional parameter "pageSize": Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

func (*AccountsClientsUsersListCall) PageToken 

func (c *AccountsClientsUsersListCall) PageToken(pageToken string) *AccountsClientsUsersListCall

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.

func (*AccountsClientsUsersListCall) Pages 

func (c *AccountsClientsUsersListCall) Pages(ctx context.Context, f func(*ListClientUsersResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type AccountsClientsUsersService 

type AccountsClientsUsersService struct {
	// contains filtered or unexported fields
}

func NewAccountsClientsUsersService 

func NewAccountsClientsUsersService(s *Service) *AccountsClientsUsersService

func (*AccountsClientsUsersService) Get 

func (r *AccountsClientsUsersService) Get(accountId int64, clientAccountId int64, userId int64) *AccountsClientsUsersGetCall

Get: Retrieves an existing client user.

func (*AccountsClientsUsersService) List 

func (r *AccountsClientsUsersService) List(accountId int64, clientAccountId string) *AccountsClientsUsersListCall

List: Lists all the known client users for a specified sponsor buyer account ID.

func (*AccountsClientsUsersService) Update 

func (r *AccountsClientsUsersService) Update(accountId int64, clientAccountId int64, userId int64, clientuser *ClientUser) *AccountsClientsUsersUpdateCall

Update: Updates an existing client user. Only the user status can be changed on update.

type AccountsClientsUsersUpdateCall 

type AccountsClientsUsersUpdateCall struct {
	// contains filtered or unexported fields
}

func (*AccountsClientsUsersUpdateCall) Context 

func (c *AccountsClientsUsersUpdateCall) Context(ctx context.Context) *AccountsClientsUsersUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsClientsUsersUpdateCall) Do 

func (c *AccountsClientsUsersUpdateCall) Do(opts ...googleapi.CallOption) (*ClientUser, error)

Do executes the "adexchangebuyer2.accounts.clients.users.update" call. Exactly one of *ClientUser or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ClientUser.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccountsClientsUsersUpdateCall) Fields 

func (c *AccountsClientsUsersUpdateCall) Fields(s ...googleapi.Field) *AccountsClientsUsersUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type AccountsService 

type AccountsService struct {
	Clients *AccountsClientsService
	// contains filtered or unexported fields
}

func NewAccountsService 

func NewAccountsService(s *Service) *AccountsService

type Client 

type Client struct {
	// ClientAccountId: The globally-unique numerical ID of the client.
	// The value of this field is ignored in create and update operations.
	ClientAccountId int64 `json:"clientAccountId,omitempty,string"`

	// ClientName: 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.
	ClientName string `json:"clientName,omitempty"`

	// EntityId: 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-dictionar
	// ies/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/b
	// rands.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.
	EntityId int64 `json:"entityId,omitempty,string"`

	// EntityName: 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.
	EntityName string `json:"entityName,omitempty"`

	// EntityType: The type of the client entity: `ADVERTISER`, `BRAND`, or
	// `AGENCY`.
	//
	// Possible values:
	//   "ENTITY_TYPE_UNSPECIFIED" - A placeholder for an undefined client
	// entity type. Should not be used.
	//   "ADVERTISER" - An advertiser.
	//   "BRAND" - A brand.
	//   "AGENCY" - An advertising agency.
	EntityType string `json:"entityType,omitempty"`

	// Role: 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`.
	//
	// Possible values:
	//   "CLIENT_ROLE_UNSPECIFIED" - A placeholder for an undefined client
	// role.
	//   "CLIENT_DEAL_VIEWER" - Users associated with this client can see
	// publisher deal offers
	// in the Marketplace.
	// They can neither negotiate proposals nor approve deals.
	// If this client is visible to publishers, they can send deal
	// proposals
	// to this client.
	//   "CLIENT_DEAL_NEGOTIATOR" - Users associated with this client can
	// respond to deal proposals
	// sent to them by publishers. They can also initiate deal proposals
	// of their own.
	//   "CLIENT_DEAL_APPROVER" - Users associated with this client can
	// approve eligible deals
	// on your behalf. Some deals may still explicitly require
	// publisher
	// finalization. If this role is not selected, the sponsor buyer
	// will need to manually approve each of their deals.
	Role string `json:"role,omitempty"`

	// Status: The status of the client buyer.
	//
	// Possible values:
	//   "CLIENT_STATUS_UNSPECIFIED" - A placeholder for an undefined client
	// status.
	//   "DISABLED" - A client that is currently disabled.
	//   "ACTIVE" - A client that is currently active.
	Status string `json:"status,omitempty"`

	// VisibleToSeller: Whether the client buyer will be visible to sellers.
	VisibleToSeller bool `json:"visibleToSeller,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ClientAccountId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Client: 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.

func (*Client) MarshalJSON 

func (s *Client) MarshalJSON() ([]byte, error)

type ClientUser 

type ClientUser struct {
	// ClientAccountId: Numerical account ID of the client buyer
	// with which the user is associated; the
	// buyer must be a client of the current sponsor buyer.
	// The value of this field is ignored in an update operation.
	ClientAccountId int64 `json:"clientAccountId,omitempty,string"`

	// Email: User's email address. The value of this field
	// is ignored in an update operation.
	Email string `json:"email,omitempty"`

	// Status: The status of the client user.
	//
	// Possible values:
	//   "USER_STATUS_UNSPECIFIED" - A placeholder for an undefined user
	// status.
	//   "PENDING" - A user who was already created but hasn't accepted the
	// invitation yet.
	//   "ACTIVE" - A user that is currently active.
	//   "DISABLED" - A user that is currently disabled.
	Status string `json:"status,omitempty"`

	// UserId: The unique numerical ID of the client user
	// that has accepted an invitation.
	// The value of this field is ignored in an update operation.
	UserId int64 `json:"userId,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ClientAccountId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ClientUser: A client user is created under a client buyer and has restricted access to the Ad Exchange Marketplace and certain other sections of the Ad Exchange Buyer UI based on the role granted to the associated client buyer.

The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method).

All fields are required unless otherwise specified.

func (*ClientUser) MarshalJSON 

func (s *ClientUser) MarshalJSON() ([]byte, error)

type ClientUserInvitation 

type ClientUserInvitation struct {
	// ClientAccountId: Numerical account ID of the client buyer
	// that the invited user is associated with.
	// The value of this field is ignored in create operations.
	ClientAccountId int64 `json:"clientAccountId,omitempty,string"`

	// Email: The email address to which the invitation is sent.
	// Email
	// addresses should be unique among all client users under each
	// sponsor
	// buyer.
	Email string `json:"email,omitempty"`

	// InvitationId: The unique numerical ID of the invitation that is sent
	// to the user.
	// The value of this field is ignored in create operations.
	InvitationId int64 `json:"invitationId,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ClientAccountId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ClientUserInvitation: An invitation for a new client user to get access to the AdExchange Buyer UI.

All fields are required unless otherwise specified.

func (*ClientUserInvitation) MarshalJSON 

func (s *ClientUserInvitation) MarshalJSON() ([]byte, error)

type ListClientUserInvitationsResponse 

type ListClientUserInvitationsResponse struct {
	// Invitations: The returned list of client users.
	Invitations []*ClientUserInvitation `json:"invitations,omitempty"`

	// NextPageToken: A token to retrieve the next page of results.
	// Pass this value in
	// the
	// ListClientUserInvitationsRequest.pageToken
	// field in the subsequent call to the
	// clients.invitations.list
	// method to retrieve the next
	// page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Invitations") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ListClientUserInvitationsResponse) MarshalJSON 

func (s *ListClientUserInvitationsResponse) MarshalJSON() ([]byte, error)

type ListClientUsersResponse 

type ListClientUsersResponse struct {
	// NextPageToken: A token to retrieve the next page of results.
	// Pass this value in the
	// ListClientUsersRequest.pageToken
	// field in the subsequent call to the
	// clients.invitations.list
	// method to retrieve the next
	// page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Users: The returned list of client users.
	Users []*ClientUser `json:"users,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ListClientUsersResponse) MarshalJSON 

func (s *ListClientUsersResponse) MarshalJSON() ([]byte, error)

type ListClientsResponse 

type ListClientsResponse struct {
	// Clients: The returned list of clients.
	Clients []*Client `json:"clients,omitempty"`

	// NextPageToken: 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.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Clients") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ListClientsResponse) MarshalJSON 

func (s *ListClientsResponse) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Accounts *AccountsService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.