manageraccounts

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Sep 22, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package manageraccounts provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.15.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCreateManagerAccountRequestWithApplicationVndCreatemanageraccountrequestV1PlusJSONBody 

func NewCreateManagerAccountRequestWithApplicationVndCreatemanageraccountrequestV1PlusJSONBody(server string, params *CreateManagerAccountParams, body CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody) (*http.Request, error)

NewCreateManagerAccountRequestWithApplicationVndCreatemanageraccountrequestV1PlusJSONBody calls the generic CreateManagerAccount builder with application/vnd.createmanageraccountrequest.v1+json body

func NewCreateManagerAccountRequestWithBody 

func NewCreateManagerAccountRequestWithBody(server string, params *CreateManagerAccountParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateManagerAccountRequestWithBody generates requests for CreateManagerAccount with any type of body

func NewGetManagerAccountsForUserRequest 

func NewGetManagerAccountsForUserRequest(server string, params *GetManagerAccountsForUserParams) (*http.Request, error)

NewGetManagerAccountsForUserRequest generates requests for GetManagerAccountsForUser

func NewLinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody 

func NewLinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody(server string, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, body LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*http.Request, error)

NewLinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody calls the generic LinkAdvertisingAccountsToManagerAccountPublicAPI builder with application/vnd.updateadvertisingaccountsinmanageraccountrequest.v1+json body

func NewLinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithBody 

func NewLinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithBody(server string, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*http.Request, error)

NewLinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithBody generates requests for LinkAdvertisingAccountsToManagerAccountPublicAPI with any type of body

func NewUnlinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody 

func NewUnlinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody(server string, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, body UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*http.Request, error)

NewUnlinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody calls the generic UnlinkAdvertisingAccountsToManagerAccountPublicAPI builder with application/vnd.updateadvertisingaccountsinmanageraccountrequest.v1+json body

func NewUnlinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithBody 

func NewUnlinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithBody(server string, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*http.Request, error)

NewUnlinkAdvertisingAccountsToManagerAccountPublicAPIRequestWithBody generates requests for UnlinkAdvertisingAccountsToManagerAccountPublicAPI with any type of body

Types

type Account 

type Account struct {
	// AccountId Id of the Amazon Advertising account.
	AccountId *string `json:"accountId,omitempty"`

	// AccountName The name given to the Amazon Advertising account.
	AccountName *string `json:"accountName,omitempty"`

	// AccountType Type of the Amazon Advertising account.
	AccountType *AccountType `json:"accountType,omitempty"`

	// DspAdvertiserId The identifier of a DSP advertiser. Note that this value is only populated for accounts with type `DSP_ADVERTISING_ACCOUNT`. It will be `null` for accounts of other types.
	DspAdvertiserId *string `json:"dspAdvertiserId,omitempty"`

	// MarketplaceId The identifier of the marketplace to which the account is associated. See [this table](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_Endpoints.html) for `marketplaceId` mappings.
	MarketplaceId *string `json:"marketplaceId,omitempty"`

	// ProfileId The identifier of a profile associated with the advertiser account. Note that this value is only populated for a subset of account types: `[ SELLER, VENDOR, MARKETING_CLOUD ]`. It will be `null` for accounts of other types.
	ProfileId *string `json:"profileId,omitempty"`
}

Account Object representation of an Amazon Advertising account.

type AccountRelationshipRole 

type AccountRelationshipRole string

AccountRelationshipRole The type of a role used in account relationships. 

const (
	ENTITYOWNER  AccountRelationshipRole = "ENTITY_OWNER"
	ENTITYUSER   AccountRelationshipRole = "ENTITY_USER"
	ENTITYVIEWER AccountRelationshipRole = "ENTITY_VIEWER"
	SELLERUSER   AccountRelationshipRole = "SELLER_USER"
)

Defines values for AccountRelationshipRole.

type AccountToUpdate 

type AccountToUpdate struct {
	// Id Id of the Amazon Advertising account.
	Id *string `json:"id,omitempty"`

	// Roles The types of role that will exist with the Amazon Advertising account. Depending on account type, the default role will be ENTITY_USER or SELLER_USER. Only one role at a time is currently supported
	Roles *[]AccountRelationshipRole `json:"roles,omitempty"`

	// Type The type of the Id
	Type *AccountToUpdateType `json:"type,omitempty"`
}

AccountToUpdate String identifier for an Amazon Advertising account or advertiser. `ACCOUNT_ID` is an identifier that is returned by the [Profiles resource](https://advertising.amazon.com/API/docs/en-us/reference/2/profiles#/Profiles/listProfiles), within the `AccountInfo.id` data member. `ACCOUNT_ID` may begin with the string `"ENTITY"`. `DSP_ADVERTISER_ID` is an identifier for a DSP advertiser, which is returned by the [DSP resource](https://advertising.amazon.com/API/docs/en-us/dsp-advertiser/#/Advertiser/get_dsp_advertisers).

type AccountToUpdateFailure 

type AccountToUpdateFailure struct {
	// Account String identifier for an Amazon Advertising account or advertiser. `ACCOUNT_ID` is an identifier that is returned by the [Profiles resource](https://advertising.amazon.com/API/docs/en-us/reference/2/profiles#/Profiles/listProfiles), within the `AccountInfo.id` data member. `ACCOUNT_ID` may begin with the string `"ENTITY"`.
	// `DSP_ADVERTISER_ID` is an identifier for a DSP advertiser, which is returned by the [DSP resource](https://advertising.amazon.com/API/docs/en-us/dsp-advertiser/#/Advertiser/get_dsp_advertisers).
	Account *AccountToUpdate `json:"account,omitempty"`

	// Error The error response object.
	Error *ErrorDetail `json:"error,omitempty"`
}

AccountToUpdateFailure Object representation of an Amazon Advertising account or [DSP advertiser](https://advertising.amazon.com/API/docs/en-us/dsp-advertiser/#/) that failed to update.

type AccountToUpdateType 

type AccountToUpdateType string

AccountToUpdateType The type of the Id 

const (
	ACCOUNTID       AccountToUpdateType = "ACCOUNT_ID"
	DSPADVERTISERID AccountToUpdateType = "DSP_ADVERTISER_ID"
)

Defines values for AccountToUpdateType.

type AccountType 

type AccountType string

AccountType Type of the Amazon Advertising account. 

const (
	DSPADVERTISINGACCOUNT AccountType = "DSP_ADVERTISING_ACCOUNT"
	MARKETINGCLOUD        AccountType = "MARKETING_CLOUD"
	SELLER                AccountType = "SELLER"
	VENDOR                AccountType = "VENDOR"
)

Defines values for AccountType.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateManagerAccountWithApplicationVndCreatemanageraccountrequestV1PlusJSONBody 

func (c *Client) CreateManagerAccountWithApplicationVndCreatemanageraccountrequestV1PlusJSONBody(ctx context.Context, params *CreateManagerAccountParams, body CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody) (*http.Response, error)

func (*Client) CreateManagerAccountWithBody 

func (c *Client) CreateManagerAccountWithBody(ctx context.Context, params *CreateManagerAccountParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) GetManagerAccountsForUser 

func (c *Client) GetManagerAccountsForUser(ctx context.Context, params *GetManagerAccountsForUserParams) (*http.Response, error)

func (*Client) LinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody 

func (c *Client) LinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, body LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*http.Response, error)

func (*Client) LinkAdvertisingAccountsToManagerAccountPublicAPIWithBody 

func (c *Client) LinkAdvertisingAccountsToManagerAccountPublicAPIWithBody(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*http.Response, error)

func (*Client) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody 

func (c *Client) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, body UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*http.Response, error)

func (*Client) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBody 

func (c *Client) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBody(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetManagerAccountsForUser request
	GetManagerAccountsForUser(ctx context.Context, params *GetManagerAccountsForUserParams) (*http.Response, error)

	// CreateManagerAccountWithBody request with any body
	CreateManagerAccountWithBody(ctx context.Context, params *CreateManagerAccountParams, contentType string, body io.Reader) (*http.Response, error)

	CreateManagerAccountWithApplicationVndCreatemanageraccountrequestV1PlusJSONBody(ctx context.Context, params *CreateManagerAccountParams, body CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody) (*http.Response, error)

	// LinkAdvertisingAccountsToManagerAccountPublicAPIWithBody request with any body
	LinkAdvertisingAccountsToManagerAccountPublicAPIWithBody(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*http.Response, error)

	LinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, body LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*http.Response, error)

	// UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBody request with any body
	UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBody(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*http.Response, error)

	UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBody(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, body UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithResponseEditorFn added in v0.0.2 

func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateManagerAccountWithApplicationVndCreatemanageraccountrequestV1PlusJSONBodyWithResponse 

func (c *ClientWithResponses) CreateManagerAccountWithApplicationVndCreatemanageraccountrequestV1PlusJSONBodyWithResponse(ctx context.Context, params *CreateManagerAccountParams, body CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody) (*CreateManagerAccountResp, error)

func (*ClientWithResponses) CreateManagerAccountWithBodyWithResponse 

func (c *ClientWithResponses) CreateManagerAccountWithBodyWithResponse(ctx context.Context, params *CreateManagerAccountParams, contentType string, body io.Reader) (*CreateManagerAccountResp, error)

CreateManagerAccountWithBodyWithResponse request with arbitrary body returning *CreateManagerAccountResp

func (*ClientWithResponses) GetManagerAccountsForUserWithResponse 

func (c *ClientWithResponses) GetManagerAccountsForUserWithResponse(ctx context.Context, params *GetManagerAccountsForUserParams) (*GetManagerAccountsForUserResp, error)

GetManagerAccountsForUserWithResponse request returning *GetManagerAccountsForUserResp

func (*ClientWithResponses) LinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBodyWithResponse 

func (c *ClientWithResponses) LinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBodyWithResponse(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, body LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*LinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

func (*ClientWithResponses) LinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse 

func (c *ClientWithResponses) LinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*LinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

LinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse request with arbitrary body returning *LinkAdvertisingAccountsToManagerAccountPublicAPIResp

func (*ClientWithResponses) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBodyWithResponse 

func (c *ClientWithResponses) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBodyWithResponse(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, body UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

func (*ClientWithResponses) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse 

func (c *ClientWithResponses) UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse request with arbitrary body returning *UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetManagerAccountsForUserWithResponse request
	GetManagerAccountsForUserWithResponse(ctx context.Context, params *GetManagerAccountsForUserParams) (*GetManagerAccountsForUserResp, error)

	// CreateManagerAccountWithBodyWithResponse request with any body
	CreateManagerAccountWithBodyWithResponse(ctx context.Context, params *CreateManagerAccountParams, contentType string, body io.Reader) (*CreateManagerAccountResp, error)

	CreateManagerAccountWithApplicationVndCreatemanageraccountrequestV1PlusJSONBodyWithResponse(ctx context.Context, params *CreateManagerAccountParams, body CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody) (*CreateManagerAccountResp, error)

	// LinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse request with any body
	LinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*LinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

	LinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBodyWithResponse(ctx context.Context, managerAccountId string, params *LinkAdvertisingAccountsToManagerAccountPublicAPIParams, body LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*LinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

	// UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse request with any body
	UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithBodyWithResponse(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, contentType string, body io.Reader) (*UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

	UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONBodyWithResponse(ctx context.Context, managerAccountId string, params *UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams, body UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody) (*UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody 

type CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody = CreateManagerAccountRequest

CreateManagerAccountApplicationVndCreatemanageraccountrequestV1PlusJSONRequestBody defines body for CreateManagerAccount for application/vnd.createmanageraccountrequest.v1+json ContentType.

type CreateManagerAccountParams 

type CreateManagerAccountParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

CreateManagerAccountParams defines parameters for CreateManagerAccount.

type CreateManagerAccountRequest 

type CreateManagerAccountRequest struct {
	// ManagerAccountName Name of the Manager account.
	ManagerAccountName *string `json:"managerAccountName,omitempty"`

	// ManagerAccountType Type of the Manager account, which indicates how the Manager account will be used. Use `Advertiser` if the Manager account will be used for **your own** products and services, or `Agency` if you are managing accounts **on behalf of your clients**.
	ManagerAccountType *CreateManagerAccountRequestManagerAccountType `json:"managerAccountType,omitempty"`
}

CreateManagerAccountRequest Request object that defines the fields required to create a Manager account.

type CreateManagerAccountRequestManagerAccountType 

type CreateManagerAccountRequestManagerAccountType string

CreateManagerAccountRequestManagerAccountType Type of the Manager account, which indicates how the Manager account will be used. Use `Advertiser` if the Manager account will be used for **your own** products and services, or `Agency` if you are managing accounts **on behalf of your clients**. 

const (
	Advertiser CreateManagerAccountRequestManagerAccountType = "Advertiser"
	Agency     CreateManagerAccountRequestManagerAccountType = "Agency"
)

Defines values for CreateManagerAccountRequestManagerAccountType.

type CreateManagerAccountResp 

type CreateManagerAccountResp struct {
	Body                                  []byte
	HTTPResponse                          *http.Response
	ApplicationvndManageraccountV1JSON200 *ManagerAccount
	ApplicationvndManageraccountV1JSON400 *ErrorDetail
	ApplicationvndManageraccountV1JSON403 *ErrorDetail
	ApplicationvndManageraccountV1JSON429 *ErrorDetail
	ApplicationvndManageraccountV1JSON500 *ErrorDetail
}

func ParseCreateManagerAccountResp 

func ParseCreateManagerAccountResp(rsp *http.Response) (*CreateManagerAccountResp, error)

ParseCreateManagerAccountResp parses an HTTP response from a CreateManagerAccountWithResponse call

func (CreateManagerAccountResp) Status 

func (r CreateManagerAccountResp) Status() string

Status returns HTTPResponse.Status

func (CreateManagerAccountResp) StatusCode 

func (r CreateManagerAccountResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ErrorDetail 

type ErrorDetail struct {
	Code *ErrorDetailCode `json:"code,omitempty"`

	// Message A human-readable description of the error.
	Message *string `json:"message,omitempty"`
}

ErrorDetail The error response object.

type ErrorDetailCode 

type ErrorDetailCode string

ErrorDetailCode defines model for ErrorDetail.Code. 

const (
	BADREQUEST           ErrorDetailCode = "BAD_REQUEST"
	FORBIDDEN            ErrorDetailCode = "FORBIDDEN"
	INTERNALSERVICEERROR ErrorDetailCode = "INTERNAL_SERVICE_ERROR"
	TOOMANYREQUESTS      ErrorDetailCode = "TOO_MANY_REQUESTS"
	UNAUTHORIZED         ErrorDetailCode = "UNAUTHORIZED"
)

Defines values for ErrorDetailCode.

type GetManagerAccountsForUserParams 

type GetManagerAccountsForUserParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

GetManagerAccountsForUserParams defines parameters for GetManagerAccountsForUser.

type GetManagerAccountsForUserResp 

type GetManagerAccountsForUserResp struct {
	Body                                              []byte
	HTTPResponse                                      *http.Response
	ApplicationvndGetmanageraccountsresponseV1JSON200 *GetManagerAccountsResponse
}

func ParseGetManagerAccountsForUserResp 

func ParseGetManagerAccountsForUserResp(rsp *http.Response) (*GetManagerAccountsForUserResp, error)

ParseGetManagerAccountsForUserResp parses an HTTP response from a GetManagerAccountsForUserWithResponse call

func (GetManagerAccountsForUserResp) Status 

func (r GetManagerAccountsForUserResp) Status() string

Status returns HTTPResponse.Status

func (GetManagerAccountsForUserResp) StatusCode 

func (r GetManagerAccountsForUserResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetManagerAccountsResponse 

type GetManagerAccountsResponse struct {
	// ManagerAccounts List of Manager Accounts that the user has access to
	ManagerAccounts *[]ManagerAccount `json:"managerAccounts,omitempty"`
}

GetManagerAccountsResponse Response containing a list of Manager Accounts that a given user has access to.

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody 

type LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody = UpdateAdvertisingAccountsInManagerAccountRequest

LinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody defines body for LinkAdvertisingAccountsToManagerAccountPublicAPI for application/vnd.updateadvertisingaccountsinmanageraccountrequest.v1+json ContentType.

type LinkAdvertisingAccountsToManagerAccountPublicAPIParams 

type LinkAdvertisingAccountsToManagerAccountPublicAPIParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

LinkAdvertisingAccountsToManagerAccountPublicAPIParams defines parameters for LinkAdvertisingAccountsToManagerAccountPublicAPI.

type LinkAdvertisingAccountsToManagerAccountPublicAPIResp 

type LinkAdvertisingAccountsToManagerAccountPublicAPIResp struct {
	Body                                                                     []byte
	HTTPResponse                                                             *http.Response
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON207 *UpdateAdvertisingAccountsInManagerAccountResponse
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON400 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON401 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON403 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON429 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON500 *ErrorDetail
}

func ParseLinkAdvertisingAccountsToManagerAccountPublicAPIResp 

func ParseLinkAdvertisingAccountsToManagerAccountPublicAPIResp(rsp *http.Response) (*LinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

ParseLinkAdvertisingAccountsToManagerAccountPublicAPIResp parses an HTTP response from a LinkAdvertisingAccountsToManagerAccountPublicAPIWithResponse call

func (LinkAdvertisingAccountsToManagerAccountPublicAPIResp) Status 

func (r LinkAdvertisingAccountsToManagerAccountPublicAPIResp) Status() string

Status returns HTTPResponse.Status

func (LinkAdvertisingAccountsToManagerAccountPublicAPIResp) StatusCode 

func (r LinkAdvertisingAccountsToManagerAccountPublicAPIResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ManagerAccount 

type ManagerAccount struct {
	LinkedAccounts *[]Account `json:"linkedAccounts,omitempty"`

	// ManagerAccountId Id of the Manager Account.
	ManagerAccountId *string `json:"managerAccountId,omitempty"`

	// ManagerAccountName The name given to a Manager Account.
	ManagerAccountName *string `json:"managerAccountName,omitempty"`
}

ManagerAccount Object representation of an Amazon Advertising Manager Account.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseEditorFn added in v0.0.2 

type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

ResponseEditorFn is the function signature for the ResponseEditor callback function

type UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody 

type UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody = UpdateAdvertisingAccountsInManagerAccountRequest

UnlinkAdvertisingAccountsToManagerAccountPublicAPIApplicationVndUpdateadvertisingaccountsinmanageraccountrequestV1PlusJSONRequestBody defines body for UnlinkAdvertisingAccountsToManagerAccountPublicAPI for application/vnd.updateadvertisingaccountsinmanageraccountrequest.v1+json ContentType.

type UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams 

type UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams struct {
	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account. This is a required header for advertisers and integrators using the Advertising API.
	AmazonAdvertisingAPIClientId string `json:"Amazon-Advertising-API-ClientId"`
}

UnlinkAdvertisingAccountsToManagerAccountPublicAPIParams defines parameters for UnlinkAdvertisingAccountsToManagerAccountPublicAPI.

type UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp 

type UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp struct {
	Body                                                                     []byte
	HTTPResponse                                                             *http.Response
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON207 *UpdateAdvertisingAccountsInManagerAccountResponse
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON400 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON401 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON403 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON429 *ErrorDetail
	ApplicationvndUpdateadvertisingaccountsinmanageraccountresponseV1JSON500 *ErrorDetail
}

func ParseUnlinkAdvertisingAccountsToManagerAccountPublicAPIResp 

func ParseUnlinkAdvertisingAccountsToManagerAccountPublicAPIResp(rsp *http.Response) (*UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp, error)

ParseUnlinkAdvertisingAccountsToManagerAccountPublicAPIResp parses an HTTP response from a UnlinkAdvertisingAccountsToManagerAccountPublicAPIWithResponse call

func (UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp) Status 

func (r UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp) Status() string

Status returns HTTPResponse.Status

func (UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp) StatusCode 

func (r UnlinkAdvertisingAccountsToManagerAccountPublicAPIResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateAdvertisingAccountsInManagerAccountRequest 

type UpdateAdvertisingAccountsInManagerAccountRequest struct {
	// Accounts List of Advertising accounts or advertisers to link/unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8). User can pass a list with a maximum of 20 accounts/advertisers using any mix of identifiers.
	Accounts *[]AccountToUpdate `json:"accounts,omitempty"`
}

UpdateAdvertisingAccountsInManagerAccountRequest A list of Advertising accounts or advertisers to link/unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8). User can pass a list with a maximum of 20 accounts/advertisers using any mix of identifiers.

type UpdateAdvertisingAccountsInManagerAccountResponse 

type UpdateAdvertisingAccountsInManagerAccountResponse struct {
	// FailedAccounts List of Advertising accounts or advertisers failed to Link/Unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8).
	FailedAccounts *[]AccountToUpdateFailure `json:"failedAccounts,omitempty"`

	// SucceedAccounts List of Advertising accounts or advertisers successfully Link/Unlink with [Manager Account](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8).
	SucceedAccounts *[]AccountToUpdate `json:"succeedAccounts,omitempty"`
}

UpdateAdvertisingAccountsInManagerAccountResponse Link/Unlink Advertising account or advertiser Response

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.