dataprovider

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 dataprovider 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 NewGetV2DpAudiencemetadataAudienceIdRequest 

func NewGetV2DpAudiencemetadataAudienceIdRequest(server string, audienceId AudienceId, params *GetV2DpAudiencemetadataAudienceIdParams) (*http.Request, error)

NewGetV2DpAudiencemetadataAudienceIdRequest generates requests for GetV2DpAudiencemetadataAudienceId

func NewPatchV2DpAudienceRequest 

func NewPatchV2DpAudienceRequest(server string, params *PatchV2DpAudienceParams, body PatchV2DpAudienceJSONRequestBody) (*http.Request, error)

NewPatchV2DpAudienceRequest calls the generic PatchV2DpAudience builder with application/json body

func NewPatchV2DpAudienceRequestWithBody 

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

NewPatchV2DpAudienceRequestWithBody generates requests for PatchV2DpAudience with any type of body

func NewPatchV2DpUsersRequest 

func NewPatchV2DpUsersRequest(server string, params *PatchV2DpUsersParams, body PatchV2DpUsersJSONRequestBody) (*http.Request, error)

NewPatchV2DpUsersRequest calls the generic PatchV2DpUsers builder with application/json body

func NewPatchV2DpUsersRequestWithBody 

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

NewPatchV2DpUsersRequestWithBody generates requests for PatchV2DpUsers with any type of body

func NewPostV2DpAudiencemetadataRequest 

func NewPostV2DpAudiencemetadataRequest(server string, params *PostV2DpAudiencemetadataParams, body PostV2DpAudiencemetadataJSONRequestBody) (*http.Request, error)

NewPostV2DpAudiencemetadataRequest calls the generic PostV2DpAudiencemetadata builder with application/json body

func NewPostV2DpAudiencemetadataRequestWithBody 

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

NewPostV2DpAudiencemetadataRequestWithBody generates requests for PostV2DpAudiencemetadata with any type of body

func NewPutV2DpAudiencemetadataAudienceIdRequest 

func NewPutV2DpAudiencemetadataAudienceIdRequest(server string, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, body PutV2DpAudiencemetadataAudienceIdJSONRequestBody) (*http.Request, error)

NewPutV2DpAudiencemetadataAudienceIdRequest calls the generic PutV2DpAudiencemetadataAudienceId builder with application/json body

func NewPutV2DpAudiencemetadataAudienceIdRequestWithBody 

func NewPutV2DpAudiencemetadataAudienceIdRequestWithBody(server string, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutV2DpAudiencemetadataAudienceIdRequestWithBody generates requests for PutV2DpAudiencemetadataAudienceId with any type of body

Types

type AdvertiserId 

type AdvertiserId = int64

AdvertiserId The advertiser identifier.

type AudienceDescription 

type AudienceDescription = string

AudienceDescription The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length.

type AudienceFees 

type AudienceFees = []struct {
	// CpmCents Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents.
	CpmCents int `json:"cpmCents"`

	// Currency Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.
	Currency AudienceFeesCurrency `json:"currency"`
}

AudienceFees defines model for audienceFees.

type AudienceFeesCurrency 

type AudienceFeesCurrency string

AudienceFeesCurrency Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account. 

const (
	AED AudienceFeesCurrency = "AED"
	AUD AudienceFeesCurrency = "AUD"
	CAD AudienceFeesCurrency = "CAD"
	EUR AudienceFeesCurrency = "EUR"
	GBP AudienceFeesCurrency = "GBP"
	INR AudienceFeesCurrency = "INR"
	JPY AudienceFeesCurrency = "JPY"
	MXN AudienceFeesCurrency = "MXN"
	SAR AudienceFeesCurrency = "SAR"
	SEK AudienceFeesCurrency = "SEK"
	TRY AudienceFeesCurrency = "TRY"
	USD AudienceFeesCurrency = "USD"
)

Defines values for AudienceFeesCurrency.

type AudienceId 

type AudienceId = int64

AudienceId defines model for audienceId.

type AudienceName 

type AudienceName = string

AudienceName The audience name. Must be an alphanumeric string between 10 to 128 characters in length.

type AuthorizationHeader 

type AuthorizationHeader = string

AuthorizationHeader defines model for authorizationHeader.

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) GetV2DpAudiencemetadataAudienceId 

func (c *Client) GetV2DpAudiencemetadataAudienceId(ctx context.Context, audienceId AudienceId, params *GetV2DpAudiencemetadataAudienceIdParams) (*http.Response, error)

func (*Client) PatchV2DpAudience 

func (c *Client) PatchV2DpAudience(ctx context.Context, params *PatchV2DpAudienceParams, body PatchV2DpAudienceJSONRequestBody) (*http.Response, error)

func (*Client) PatchV2DpAudienceWithBody 

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

func (*Client) PatchV2DpUsers 

func (c *Client) PatchV2DpUsers(ctx context.Context, params *PatchV2DpUsersParams, body PatchV2DpUsersJSONRequestBody) (*http.Response, error)

func (*Client) PatchV2DpUsersWithBody 

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

func (*Client) PostV2DpAudiencemetadata 

func (c *Client) PostV2DpAudiencemetadata(ctx context.Context, params *PostV2DpAudiencemetadataParams, body PostV2DpAudiencemetadataJSONRequestBody) (*http.Response, error)

func (*Client) PostV2DpAudiencemetadataWithBody 

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

func (*Client) PutV2DpAudiencemetadataAudienceId 

func (c *Client) PutV2DpAudiencemetadataAudienceId(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, body PutV2DpAudiencemetadataAudienceIdJSONRequestBody) (*http.Response, error)

func (*Client) PutV2DpAudiencemetadataAudienceIdWithBody 

func (c *Client) PutV2DpAudiencemetadataAudienceIdWithBody(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, contentType string, body io.Reader) (*http.Response, error)

type ClientHeader 

type ClientHeader = string

ClientHeader defines model for clientHeader.

type ClientInterface 

type ClientInterface interface {
	// PatchV2DpAudienceWithBody request with any body
	PatchV2DpAudienceWithBody(ctx context.Context, params *PatchV2DpAudienceParams, contentType string, body io.Reader) (*http.Response, error)

	PatchV2DpAudience(ctx context.Context, params *PatchV2DpAudienceParams, body PatchV2DpAudienceJSONRequestBody) (*http.Response, error)

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

	PostV2DpAudiencemetadata(ctx context.Context, params *PostV2DpAudiencemetadataParams, body PostV2DpAudiencemetadataJSONRequestBody) (*http.Response, error)

	// GetV2DpAudiencemetadataAudienceId request
	GetV2DpAudiencemetadataAudienceId(ctx context.Context, audienceId AudienceId, params *GetV2DpAudiencemetadataAudienceIdParams) (*http.Response, error)

	// PutV2DpAudiencemetadataAudienceIdWithBody request with any body
	PutV2DpAudiencemetadataAudienceIdWithBody(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, contentType string, body io.Reader) (*http.Response, error)

	PutV2DpAudiencemetadataAudienceId(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, body PutV2DpAudiencemetadataAudienceIdJSONRequestBody) (*http.Response, error)

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

	PatchV2DpUsers(ctx context.Context, params *PatchV2DpUsersParams, body PatchV2DpUsersJSONRequestBody) (*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) GetV2DpAudiencemetadataAudienceIdWithResponse 

func (c *ClientWithResponses) GetV2DpAudiencemetadataAudienceIdWithResponse(ctx context.Context, audienceId AudienceId, params *GetV2DpAudiencemetadataAudienceIdParams) (*GetV2DpAudiencemetadataAudienceIdResp, error)

GetV2DpAudiencemetadataAudienceIdWithResponse request returning *GetV2DpAudiencemetadataAudienceIdResp

func (*ClientWithResponses) PatchV2DpAudienceWithBodyWithResponse 

func (c *ClientWithResponses) PatchV2DpAudienceWithBodyWithResponse(ctx context.Context, params *PatchV2DpAudienceParams, contentType string, body io.Reader) (*PatchV2DpAudienceResp, error)

PatchV2DpAudienceWithBodyWithResponse request with arbitrary body returning *PatchV2DpAudienceResp

func (*ClientWithResponses) PatchV2DpAudienceWithResponse 

func (c *ClientWithResponses) PatchV2DpAudienceWithResponse(ctx context.Context, params *PatchV2DpAudienceParams, body PatchV2DpAudienceJSONRequestBody) (*PatchV2DpAudienceResp, error)

func (*ClientWithResponses) PatchV2DpUsersWithBodyWithResponse 

func (c *ClientWithResponses) PatchV2DpUsersWithBodyWithResponse(ctx context.Context, params *PatchV2DpUsersParams, contentType string, body io.Reader) (*PatchV2DpUsersResp, error)

PatchV2DpUsersWithBodyWithResponse request with arbitrary body returning *PatchV2DpUsersResp

func (*ClientWithResponses) PatchV2DpUsersWithResponse 

func (c *ClientWithResponses) PatchV2DpUsersWithResponse(ctx context.Context, params *PatchV2DpUsersParams, body PatchV2DpUsersJSONRequestBody) (*PatchV2DpUsersResp, error)

func (*ClientWithResponses) PostV2DpAudiencemetadataWithBodyWithResponse 

func (c *ClientWithResponses) PostV2DpAudiencemetadataWithBodyWithResponse(ctx context.Context, params *PostV2DpAudiencemetadataParams, contentType string, body io.Reader) (*PostV2DpAudiencemetadataResp, error)

PostV2DpAudiencemetadataWithBodyWithResponse request with arbitrary body returning *PostV2DpAudiencemetadataResp

func (*ClientWithResponses) PostV2DpAudiencemetadataWithResponse 

func (c *ClientWithResponses) PostV2DpAudiencemetadataWithResponse(ctx context.Context, params *PostV2DpAudiencemetadataParams, body PostV2DpAudiencemetadataJSONRequestBody) (*PostV2DpAudiencemetadataResp, error)

func (*ClientWithResponses) PutV2DpAudiencemetadataAudienceIdWithBodyWithResponse 

func (c *ClientWithResponses) PutV2DpAudiencemetadataAudienceIdWithBodyWithResponse(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, contentType string, body io.Reader) (*PutV2DpAudiencemetadataAudienceIdResp, error)

PutV2DpAudiencemetadataAudienceIdWithBodyWithResponse request with arbitrary body returning *PutV2DpAudiencemetadataAudienceIdResp

func (*ClientWithResponses) PutV2DpAudiencemetadataAudienceIdWithResponse 

func (c *ClientWithResponses) PutV2DpAudiencemetadataAudienceIdWithResponse(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, body PutV2DpAudiencemetadataAudienceIdJSONRequestBody) (*PutV2DpAudiencemetadataAudienceIdResp, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// PatchV2DpAudienceWithBodyWithResponse request with any body
	PatchV2DpAudienceWithBodyWithResponse(ctx context.Context, params *PatchV2DpAudienceParams, contentType string, body io.Reader) (*PatchV2DpAudienceResp, error)

	PatchV2DpAudienceWithResponse(ctx context.Context, params *PatchV2DpAudienceParams, body PatchV2DpAudienceJSONRequestBody) (*PatchV2DpAudienceResp, error)

	// PostV2DpAudiencemetadataWithBodyWithResponse request with any body
	PostV2DpAudiencemetadataWithBodyWithResponse(ctx context.Context, params *PostV2DpAudiencemetadataParams, contentType string, body io.Reader) (*PostV2DpAudiencemetadataResp, error)

	PostV2DpAudiencemetadataWithResponse(ctx context.Context, params *PostV2DpAudiencemetadataParams, body PostV2DpAudiencemetadataJSONRequestBody) (*PostV2DpAudiencemetadataResp, error)

	// GetV2DpAudiencemetadataAudienceIdWithResponse request
	GetV2DpAudiencemetadataAudienceIdWithResponse(ctx context.Context, audienceId AudienceId, params *GetV2DpAudiencemetadataAudienceIdParams) (*GetV2DpAudiencemetadataAudienceIdResp, error)

	// PutV2DpAudiencemetadataAudienceIdWithBodyWithResponse request with any body
	PutV2DpAudiencemetadataAudienceIdWithBodyWithResponse(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, contentType string, body io.Reader) (*PutV2DpAudiencemetadataAudienceIdResp, error)

	PutV2DpAudiencemetadataAudienceIdWithResponse(ctx context.Context, audienceId AudienceId, params *PutV2DpAudiencemetadataAudienceIdParams, body PutV2DpAudiencemetadataAudienceIdJSONRequestBody) (*PutV2DpAudiencemetadataAudienceIdResp, error)

	// PatchV2DpUsersWithBodyWithResponse request with any body
	PatchV2DpUsersWithBodyWithResponse(ctx context.Context, params *PatchV2DpUsersParams, contentType string, body io.Reader) (*PatchV2DpUsersResp, error)

	PatchV2DpUsersWithResponse(ctx context.Context, params *PatchV2DpUsersParams, body PatchV2DpUsersJSONRequestBody) (*PatchV2DpUsersResp, error)
}

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

type ContentTypeHeader 

type ContentTypeHeader = string

ContentTypeHeader defines model for contentTypeHeader.

type ErrorDescription 

type ErrorDescription = string

ErrorDescription A human-readable description of the error.

type ExternalAudienceId 

type ExternalAudienceId = string

ExternalAudienceId The user-defined audience identifier.

type GetV2DpAudiencemetadataAudienceIdParams 

type GetV2DpAudiencemetadataAudienceIdParams struct {
	// Authorization A valid access token.
	Authorization AuthorizationHeader `json:"Authorization"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// ContentType The `Content-Type` is application/json.
	ContentType ContentTypeHeader `json:"Content-Type"`
}

GetV2DpAudiencemetadataAudienceIdParams defines parameters for GetV2DpAudiencemetadataAudienceId.

type GetV2DpAudiencemetadataAudienceIdResp 

type GetV2DpAudiencemetadataAudienceIdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Audience *struct {
			// AdvertiserId The advertiser identifier.
			AdvertiserId *AdvertiserId `json:"advertiserId,omitempty"`

			// Description The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length.
			Description *AudienceDescription `json:"description,omitempty"`

			// Id The
			RenameAudienceId *RenameAudienceId `json:"id,omitempty"`
			Metadata         *struct {
				AudienceFees *AudienceFees `json:"audienceFees,omitempty"`

				// AudienceSize Information about the size of the audience.
				AudienceSize *struct {
					// MatchRate The match rate.
					MatchRate *float32 `json:"matchRate,omitempty"`

					// MatchedRecordSize The number of matched records.
					MatchedRecordSize *int `json:"matchedRecordSize,omitempty"`

					// ReceivedRecordSize The number of received records.
					ReceivedRecordSize *int `json:"receivedRecordSize,omitempty"`
				} `json:"audienceSize,omitempty"`

				// ExternalAudienceId The user-defined audience identifier.
				ExternalAudienceId *ExternalAudienceId `json:"externalAudienceId,omitempty"`

				// Ttl Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.
				Ttl *RecordTtl `json:"ttl,omitempty"`

				// Type The audience metadata type. Only 'DATA_PROVIDER' is currently supported.
				Type *MetadataType `json:"type,omitempty"`
			} `json:"metadata,omitempty"`

			// Name The audience name. Must be an alphanumeric string between 10 to 128 characters in length.
			Name *AudienceName `json:"name,omitempty"`
		} `json:"audience,omitempty"`

		// RequestId The request identifier.
		RequestId *RequestId `json:"requestId,omitempty"`
	}
	JSON403 *N403NotAllowed
	JSON404 *N404NotFound
	JSON429 *N429TooManyRequests
	JSON500 *N500InternalError
	JSON503 *N503ServiceUnavailable
}

func ParseGetV2DpAudiencemetadataAudienceIdResp 

func ParseGetV2DpAudiencemetadataAudienceIdResp(rsp *http.Response) (*GetV2DpAudiencemetadataAudienceIdResp, error)

ParseGetV2DpAudiencemetadataAudienceIdResp parses an HTTP response from a GetV2DpAudiencemetadataAudienceIdWithResponse call

func (GetV2DpAudiencemetadataAudienceIdResp) Status 

func (r GetV2DpAudiencemetadataAudienceIdResp) Status() string

Status returns HTTPResponse.Status

func (GetV2DpAudiencemetadataAudienceIdResp) StatusCode 

func (r GetV2DpAudiencemetadataAudienceIdResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type HttpStatusCode 

type HttpStatusCode = string

HttpStatusCode The HTTP status code.

type MetadataType 

type MetadataType string

MetadataType The audience metadata type. Only 'DATA_PROVIDER' is currently supported. 

const (
	DATAPROVIDER MetadataType = "DATA_PROVIDER"
)

Defines values for MetadataType.

type N400BadRequest 

type N400BadRequest struct {
	Error *struct {
		// Description A human-readable description of the error.
		Description *ErrorDescription `json:"description,omitempty"`
		Errors      *SubError         `json:"errors,omitempty"`

		// HttpStatusCode The HTTP status code.
		HttpStatusCode *HttpStatusCode `json:"httpStatusCode,omitempty"`
	} `json:"error,omitempty"`

	// RequestId The request identifier.
	RequestId *RequestId `json:"requestId,omitempty"`
}

N400BadRequest defines model for 400BadRequest.

type N403NotAllowed 

type N403NotAllowed struct {
	Error *struct {
		// Description A human-readable description of the error.
		Description *ErrorDescription `json:"description,omitempty"`
		Errors      *SubError         `json:"errors,omitempty"`

		// HttpStatusCode The HTTP status code.
		HttpStatusCode *HttpStatusCode `json:"httpStatusCode,omitempty"`
	} `json:"error,omitempty"`

	// RequestId The request identifier.
	RequestId *RequestId `json:"requestId,omitempty"`
}

N403NotAllowed defines model for 403NotAllowed.

type N404NotFound 

type N404NotFound struct {
	Error *struct {
		// Description A human-readable description of the error.
		Description *ErrorDescription `json:"description,omitempty"`
		Errors      *SubError         `json:"errors,omitempty"`

		// HttpStatusCode The HTTP status code.
		HttpStatusCode *HttpStatusCode `json:"httpStatusCode,omitempty"`
	} `json:"error,omitempty"`

	// RequestId The request identifier.
	RequestId *RequestId `json:"requestId,omitempty"`
}

N404NotFound defines model for 404NotFound.

type N429TooManyRequests 

type N429TooManyRequests struct {
	Error *struct {
		// Description A human-readable description of the error.
		Description *ErrorDescription `json:"description,omitempty"`
		Errors      *SubError         `json:"errors,omitempty"`

		// HttpStatusCode The HTTP status code.
		HttpStatusCode *HttpStatusCode `json:"httpStatusCode,omitempty"`
	} `json:"error,omitempty"`

	// RequestId The request identifier.
	RequestId *RequestId `json:"requestId,omitempty"`
}

N429TooManyRequests defines model for 429TooManyRequests.

type N500InternalError 

type N500InternalError struct {
	Error *struct {
		// Description A human-readable description of the error.
		Description *ErrorDescription `json:"description,omitempty"`
		Errors      *SubError         `json:"errors,omitempty"`

		// HttpStatusCode The HTTP status code.
		HttpStatusCode *HttpStatusCode `json:"httpStatusCode,omitempty"`
	} `json:"error,omitempty"`

	// RequestId The request identifier.
	RequestId *RequestId `json:"requestId,omitempty"`
}

N500InternalError defines model for 500InternalError.

type N503ServiceUnavailable 

type N503ServiceUnavailable struct {
	Error *struct {
		// Description A human-readable description of the error.
		Description *ErrorDescription `json:"description,omitempty"`
		Errors      *SubError         `json:"errors,omitempty"`

		// HttpStatusCode The HTTP status code.
		HttpStatusCode *HttpStatusCode `json:"httpStatusCode,omitempty"`
	} `json:"error,omitempty"`

	// RequestId The request identifier.
	RequestId *RequestId `json:"requestId,omitempty"`
}

N503ServiceUnavailable defines model for 503ServiceUnavailable.

type PatchV2DpAudienceJSONBody 

type PatchV2DpAudienceJSONBody struct {
	Patches *[]struct {
		// Op Specifies the type of operation. Valid operations are `add` or `remove`.
		Op *PatchV2DpAudienceJSONBodyPatchesOp `json:"op,omitempty"`

		// Path A formatted string that specifies the URL of the record. The format of the string is `/<recordIdType>-<recordIdValue>/audiences`, where 'recordIdType' specifies the record's origin and 'recordIdValue' specifies the record's Id. Valid 'recordIdType' values are `COOKIE`, a cookie Id sent from a data provider to Amazon by a cookie sync; `MAID`, a mobile advertising identifier; `EXTERNAL_USER_ID`, an external id defined by data providers.
		Path  *string  `json:"path,omitempty"`
		Value *[]int64 `json:"value,omitempty"`
	} `json:"patches,omitempty"`
}

PatchV2DpAudienceJSONBody defines parameters for PatchV2DpAudience.

type PatchV2DpAudienceJSONBodyPatchesOp 

type PatchV2DpAudienceJSONBodyPatchesOp string

PatchV2DpAudienceJSONBodyPatchesOp defines parameters for PatchV2DpAudience. 

const (
	Add    PatchV2DpAudienceJSONBodyPatchesOp = "add"
	Remove PatchV2DpAudienceJSONBodyPatchesOp = "remove"
)

Defines values for PatchV2DpAudienceJSONBodyPatchesOp.

type PatchV2DpAudienceJSONRequestBody 

type PatchV2DpAudienceJSONRequestBody PatchV2DpAudienceJSONBody

PatchV2DpAudienceJSONRequestBody defines body for PatchV2DpAudience for application/json ContentType.

type PatchV2DpAudienceParams 

type PatchV2DpAudienceParams struct {
	// Authorization A valid access token.
	Authorization AuthorizationHeader `json:"Authorization"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// ContentType The `Content-Type` is application/json.
	ContentType ContentTypeHeader `json:"Content-Type"`
}

PatchV2DpAudienceParams defines parameters for PatchV2DpAudience.

type PatchV2DpAudienceResp 

type PatchV2DpAudienceResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// JobId A unique identifier representing the workflow of the submitted request.
		JobId *string `json:"jobId,omitempty"`

		// RequestId A unique identifier representing the request.
		RequestId *string `json:"requestId,omitempty"`
	}
	JSON400 *N400BadRequest
	JSON413 *struct {
		// Error Detailed error messages associated with the request.
		Error *struct {
			// Description Description of the error.
			Description *string `json:"description,omitempty"`

			// Errors An array of property objects that include more information about the request.
			Errors *[]struct {
				// ErrorType Type of error.
				ErrorType *string `json:"errorType,omitempty"`

				// Message Error message
				Message *string `json:"message,omitempty"`
			} `json:"errors,omitempty"`

			// HttpStatusCode HTTP status code associated with the response.
			HttpStatusCode *string `json:"httpStatusCode,omitempty"`
		} `json:"error,omitempty"`

		// RequestId Identifier associated with the request.
		RequestId *string `json:"requestId,omitempty"`
	}
	JSON429 *N429TooManyRequests
	JSON500 *N500InternalError
	JSON503 *N503ServiceUnavailable
}

func ParsePatchV2DpAudienceResp 

func ParsePatchV2DpAudienceResp(rsp *http.Response) (*PatchV2DpAudienceResp, error)

ParsePatchV2DpAudienceResp parses an HTTP response from a PatchV2DpAudienceWithResponse call

func (PatchV2DpAudienceResp) Status 

func (r PatchV2DpAudienceResp) Status() string

Status returns HTTPResponse.Status

func (PatchV2DpAudienceResp) StatusCode 

func (r PatchV2DpAudienceResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PatchV2DpUsersJSONBody 

type PatchV2DpUsersJSONBody struct {
	Users *[]struct {
		// AdvertiserId The advertiser identifier. If present, the user data for the specified advertiser is deleted. Otherwise, all data about this user sourced from this client is deleted.
		AdvertiserId *string `json:"advertiserId,omitempty"`

		// ConsentTime User consent time in epoch milliseconds
		ConsentTime *int64 `json:"consentTime,omitempty"`
		UserId      *struct {
			// Id The user identifer.
			Id *string `json:"id,omitempty"`

			// IdType Specifies the type of the user identifier.
			IdType *PatchV2DpUsersJSONBodyUsersUserIdIdType `json:"idType,omitempty"`
		} `json:"userId,omitempty"`
	} `json:"users,omitempty"`
}

PatchV2DpUsersJSONBody defines parameters for PatchV2DpUsers.

type PatchV2DpUsersJSONBodyUsersUserIdIdType 

type PatchV2DpUsersJSONBodyUsersUserIdIdType string

PatchV2DpUsersJSONBodyUsersUserIdIdType defines parameters for PatchV2DpUsers. 

const (
	COOKIE         PatchV2DpUsersJSONBodyUsersUserIdIdType = "COOKIE"
	EXTERNALUSERID PatchV2DpUsersJSONBodyUsersUserIdIdType = "EXTERNAL_USER_ID"
	MAID           PatchV2DpUsersJSONBodyUsersUserIdIdType = "MAID"
)

Defines values for PatchV2DpUsersJSONBodyUsersUserIdIdType.

type PatchV2DpUsersJSONRequestBody 

type PatchV2DpUsersJSONRequestBody PatchV2DpUsersJSONBody

PatchV2DpUsersJSONRequestBody defines body for PatchV2DpUsers for application/json ContentType.

type PatchV2DpUsersParams 

type PatchV2DpUsersParams struct {
	// Authorization A valid access token.
	Authorization string `json:"Authorization"`

	// AmazonAdvertisingAPIClientID The client identifier.
	AmazonAdvertisingAPIClientID string `json:"Amazon-Advertising-API-ClientID"`

	// ContentType The Content-Type is `application/json`.
	ContentType string `json:"Content-Type"`
}

PatchV2DpUsersParams defines parameters for PatchV2DpUsers.

type PatchV2DpUsersResp 

type PatchV2DpUsersResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		// RequestId A unique identifier representing the request.
		RequestId *string `json:"requestId,omitempty"`
	}
	JSON400 *struct {
		// Error Detailed error messages associated with the request.
		Error *struct {
			// Description Description of the error.
			Description *string `json:"description,omitempty"`

			// Errors An array of property objects that include more information about the request.
			Errors *[]struct {
				// ErrorType Type of error.
				ErrorType *string `json:"errorType,omitempty"`

				// Message Error message
				Message *string `json:"message,omitempty"`
			} `json:"errors,omitempty"`

			// HttpStatusCode HTTP status code associated with the response.
			HttpStatusCode *string `json:"httpStatusCode,omitempty"`
		} `json:"error,omitempty"`

		// RequestId Identifier associated with the request.
		RequestId *string `json:"requestId,omitempty"`
	}
	JSON413 *struct {
		// Error Detailed error messages associated with the request.
		Error *struct {
			// Description Description of the error.
			Description *string `json:"description,omitempty"`

			// Errors An array of property objects that include more information about the request.
			Errors *[]struct {
				// ErrorType Type of error.
				ErrorType *string `json:"errorType,omitempty"`

				// Message Error message
				Message *string `json:"message,omitempty"`
			} `json:"errors,omitempty"`

			// HttpStatusCode HTTP status code associated with the response.
			HttpStatusCode *string `json:"httpStatusCode,omitempty"`
		} `json:"error,omitempty"`

		// RequestId Identifier associated with the request.
		RequestId *string `json:"requestId,omitempty"`
	}
	JSON429 *struct {
		// Error Detailed error messages associated with the request.
		Error *struct {
			// Description Description of the error.
			Description *string `json:"description,omitempty"`

			// Errors An array of property objects that include more information about the request.
			Errors *[]struct {
				// ErrorType Type of error.
				ErrorType *string `json:"errorType,omitempty"`

				// Message Error message
				Message *string `json:"message,omitempty"`
			} `json:"errors,omitempty"`

			// HttpStatusCode HTTP status code associated with the response.
			HttpStatusCode *string `json:"httpStatusCode,omitempty"`
		} `json:"error,omitempty"`

		// RequestId Identifier associated with the request.
		RequestId *string `json:"requestId,omitempty"`
	}
	JSON500 *struct {
		// Error Detailed error messages associated with the request.
		Error *struct {
			// Description Description of the error.
			Description *string `json:"description,omitempty"`

			// Errors An array of property objects that include more information about the request.
			Errors *[]struct {
				// ErrorType Type of error.
				ErrorType *string `json:"errorType,omitempty"`

				// Message Error message
				Message *string `json:"message,omitempty"`
			} `json:"errors,omitempty"`

			// HttpStatusCode HTTP status code associated with the response.
			HttpStatusCode *string `json:"httpStatusCode,omitempty"`
		} `json:"error,omitempty"`

		// RequestId Identifier associated with the request.
		RequestId *string `json:"requestId,omitempty"`
	}
	JSON503 *struct {
		// Error Detailed error messages associated with the request.
		Error *struct {
			// Description Description of the error.
			Description *string `json:"description,omitempty"`

			// Errors An array of property objects that include more information about the request.
			Errors *[]struct {
				// ErrorType Type of error.
				ErrorType *string `json:"errorType,omitempty"`

				// Message Error message
				Message *string `json:"message,omitempty"`
			} `json:"errors,omitempty"`

			// HttpStatusCode HTTP status code associated with the response.
			HttpStatusCode *string `json:"httpStatusCode,omitempty"`
		} `json:"error,omitempty"`

		// RequestId Identifier associated with the request.
		RequestId *string `json:"requestId,omitempty"`
	}
}

func ParsePatchV2DpUsersResp 

func ParsePatchV2DpUsersResp(rsp *http.Response) (*PatchV2DpUsersResp, error)

ParsePatchV2DpUsersResp parses an HTTP response from a PatchV2DpUsersWithResponse call

func (PatchV2DpUsersResp) Status 

func (r PatchV2DpUsersResp) Status() string

Status returns HTTPResponse.Status

func (PatchV2DpUsersResp) StatusCode 

func (r PatchV2DpUsersResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostV2DpAudiencemetadataJSONBody 

type PostV2DpAudiencemetadataJSONBody struct {
	// AdvertiserId The advertiser identifier.
	AdvertiserId AdvertiserId `json:"advertiserId"`

	// Description The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length.
	Description AudienceDescription `json:"description"`
	Metadata    struct {
		AudienceFees *AudienceFees `json:"audienceFees,omitempty"`

		// ExternalAudienceId The user-defined audience identifier.
		ExternalAudienceId ExternalAudienceId `json:"externalAudienceId"`

		// Ttl Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.
		Ttl *RecordTtl `json:"ttl,omitempty"`

		// Type The audience metadata type. Only 'DATA_PROVIDER' is currently supported.
		Type MetadataType `json:"type"`
	} `json:"metadata"`

	// Name The audience name. Must be an alphanumeric string between 10 to 128 characters in length.
	Name AudienceName `json:"name"`
}

PostV2DpAudiencemetadataJSONBody defines parameters for PostV2DpAudiencemetadata.

type PostV2DpAudiencemetadataJSONRequestBody 

type PostV2DpAudiencemetadataJSONRequestBody PostV2DpAudiencemetadataJSONBody

PostV2DpAudiencemetadataJSONRequestBody defines body for PostV2DpAudiencemetadata for application/json ContentType.

type PostV2DpAudiencemetadataParams 

type PostV2DpAudiencemetadataParams struct {
	// Authorization A valid access token.
	Authorization AuthorizationHeader `json:"Authorization"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// ContentType The `Content-Type` is application/json.
	ContentType ContentTypeHeader `json:"Content-Type"`
}

PostV2DpAudiencemetadataParams defines parameters for PostV2DpAudiencemetadata.

type PostV2DpAudiencemetadataResp 

type PostV2DpAudiencemetadataResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Audience *struct {
			// AdvertiserId The advertiser identifier.
			AdvertiserId *AdvertiserId `json:"advertiserId,omitempty"`

			// Description The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length.
			Description *AudienceDescription `json:"description,omitempty"`

			// Id The
			RenameAudienceId *RenameAudienceId `json:"id,omitempty"`
			Metadata         *struct {
				AudienceFees *AudienceFees `json:"audienceFees,omitempty"`

				// ExternalAudienceId The user-defined audience identifier.
				ExternalAudienceId *ExternalAudienceId `json:"externalAudienceId,omitempty"`

				// Ttl Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.
				Ttl *RecordTtl `json:"ttl,omitempty"`

				// Type The audience metadata type. Only 'DATA_PROVIDER' is currently supported.
				Type *MetadataType `json:"type,omitempty"`
			} `json:"metadata,omitempty"`

			// Name The audience name. Must be an alphanumeric string between 10 to 128 characters in length.
			Name *AudienceName `json:"name,omitempty"`
		} `json:"audience,omitempty"`

		// RequestId The request identifier.
		RequestId *RequestId `json:"requestId,omitempty"`
	}
	JSON400 *N400BadRequest
	JSON403 *N403NotAllowed
	JSON404 *N404NotFound
	JSON429 *N429TooManyRequests
	JSON500 *N500InternalError
	JSON503 *N503ServiceUnavailable
}

func ParsePostV2DpAudiencemetadataResp 

func ParsePostV2DpAudiencemetadataResp(rsp *http.Response) (*PostV2DpAudiencemetadataResp, error)

ParsePostV2DpAudiencemetadataResp parses an HTTP response from a PostV2DpAudiencemetadataWithResponse call

func (PostV2DpAudiencemetadataResp) Status 

func (r PostV2DpAudiencemetadataResp) Status() string

Status returns HTTPResponse.Status

func (PostV2DpAudiencemetadataResp) StatusCode 

func (r PostV2DpAudiencemetadataResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutV2DpAudiencemetadataAudienceIdJSONBody 

type PutV2DpAudiencemetadataAudienceIdJSONBody struct {
	// Description The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length.
	Description *AudienceDescription `json:"description,omitempty"`
	Metadata    *struct {
		AudienceFees *AudienceFees `json:"audienceFees,omitempty"`

		// Ttl Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.
		Ttl *RecordTtl `json:"ttl,omitempty"`
	} `json:"metadata,omitempty"`
}

PutV2DpAudiencemetadataAudienceIdJSONBody defines parameters for PutV2DpAudiencemetadataAudienceId.

type PutV2DpAudiencemetadataAudienceIdJSONRequestBody 

type PutV2DpAudiencemetadataAudienceIdJSONRequestBody PutV2DpAudiencemetadataAudienceIdJSONBody

PutV2DpAudiencemetadataAudienceIdJSONRequestBody defines body for PutV2DpAudiencemetadataAudienceId for application/json ContentType.

type PutV2DpAudiencemetadataAudienceIdParams 

type PutV2DpAudiencemetadataAudienceIdParams struct {
	// Authorization A valid access token.
	Authorization AuthorizationHeader `json:"Authorization"`

	// AmazonAdvertisingAPIClientId The identifier of a client associated with a "Login with Amazon" account.
	AmazonAdvertisingAPIClientId ClientHeader `json:"Amazon-Advertising-API-ClientId"`

	// ContentType The `Content-Type` is application/json.
	ContentType ContentTypeHeader `json:"Content-Type"`
}

PutV2DpAudiencemetadataAudienceIdParams defines parameters for PutV2DpAudiencemetadataAudienceId.

type PutV2DpAudiencemetadataAudienceIdResp 

type PutV2DpAudiencemetadataAudienceIdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Audience *struct {
			// AdvertiserId The advertiser identifier.
			AdvertiserId *AdvertiserId `json:"advertiserId,omitempty"`

			// Description The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length.
			Description *AudienceDescription `json:"description,omitempty"`

			// Id The
			RenameAudienceId *RenameAudienceId `json:"id,omitempty"`
			Metadata         *struct {
				AudienceFees *AudienceFees `json:"audienceFees,omitempty"`

				// ExternalAudienceId The user-defined audience identifier.
				ExternalAudienceId *ExternalAudienceId `json:"externalAudienceId,omitempty"`

				// Ttl Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.
				Ttl *RecordTtl `json:"ttl,omitempty"`

				// Type The audience metadata type. Only 'DATA_PROVIDER' is currently supported.
				Type *MetadataType `json:"type,omitempty"`
			} `json:"metadata,omitempty"`

			// Name The audience name. Must be an alphanumeric string between 10 to 128 characters in length.
			Name *AudienceName `json:"name,omitempty"`
		} `json:"audience,omitempty"`

		// RequestId The request identifier.
		RequestId *RequestId `json:"requestId,omitempty"`
	}
	JSON400 *N400BadRequest
	JSON403 *N403NotAllowed
	JSON404 *N404NotFound
	JSON429 *N429TooManyRequests
	JSON500 *N500InternalError
	JSON503 *N503ServiceUnavailable
}

func ParsePutV2DpAudiencemetadataAudienceIdResp 

func ParsePutV2DpAudiencemetadataAudienceIdResp(rsp *http.Response) (*PutV2DpAudiencemetadataAudienceIdResp, error)

ParsePutV2DpAudiencemetadataAudienceIdResp parses an HTTP response from a PutV2DpAudiencemetadataAudienceIdWithResponse call

func (PutV2DpAudiencemetadataAudienceIdResp) Status 

func (r PutV2DpAudiencemetadataAudienceIdResp) Status() string

Status returns HTTPResponse.Status

func (PutV2DpAudiencemetadataAudienceIdResp) StatusCode 

func (r PutV2DpAudiencemetadataAudienceIdResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RecordTtl 

type RecordTtl = int

RecordTtl Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.

type RenameAudienceId 

type RenameAudienceId = int64

RenameAudienceId The

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RequestId 

type RequestId = string

RequestId The request identifier.

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 SubError 

type SubError = []struct {
	// ErrorType The type of error.
	ErrorType *string `json:"errorType,omitempty"`

	// FieldName The field name.
	FieldName *string `json:"fieldName,omitempty"`

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

SubError defines model for subError.

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.