doubleclickbidmanager

package
v0.87.0 Latest Latest
Warning

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

 Go to latest Published: Jul 12, 2022 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package doubleclickbidmanager provides access to the DoubleClick Bid Manager API.

For product documentation, see: https://developers.google.com/bid-manager/

Creating a client

Usage example: 

import "google.golang.org/api/doubleclickbidmanager/v2"
...
ctx := context.Background()
doubleclickbidmanagerService, err := doubleclickbidmanager.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey: 

doubleclickbidmanagerService, err := doubleclickbidmanager.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
doubleclickbidmanagerService, err := doubleclickbidmanager.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source 
const (
	// View and manage your reports in DoubleClick Bid Manager
	DoubleclickbidmanagerScope = "https://www.googleapis.com/auth/doubleclickbidmanager"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChannelGrouping 

type ChannelGrouping struct {
	// FallbackName: The name to apply to an event that does not match any
	// of the rules in the channel grouping.
	FallbackName string `json:"fallbackName,omitempty"`

	// Name: Channel Grouping name.
	Name string `json:"name,omitempty"`

	// Rules: Rules within Channel Grouping. There is a limit of 100 rules
	// that can be set per channel grouping.
	Rules []*Rule `json:"rules,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FallbackName") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "FallbackName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ChannelGrouping: A channel grouping defines a set of rules that can be used to categorize events in a path report.

func (*ChannelGrouping) MarshalJSON 

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

type DataRange 

type DataRange struct {
	// CustomEndDate: The ending date for the data that is shown in the
	// report. Note, `customEndDate` is required if `range` is
	// `CUSTOM_DATES` and ignored otherwise.
	CustomEndDate *Date `json:"customEndDate,omitempty"`

	// CustomStartDate: The starting data for the data that is shown in the
	// report. Note, `customStartDate` is required if `range` is
	// `CUSTOM_DATES` and ignored otherwise.
	CustomStartDate *Date `json:"customStartDate,omitempty"`

	// Range: Report data range used to generate the report.
	//
	// Possible values:
	//   "RANGE_UNSPECIFIED"
	//   "CUSTOM_DATES"
	//   "CURRENT_DAY"
	//   "PREVIOUS_DAY"
	//   "WEEK_TO_DATE"
	//   "MONTH_TO_DATE"
	//   "QUARTER_TO_DATE"
	//   "YEAR_TO_DATE"
	//   "PREVIOUS_WEEK"
	//   "PREVIOUS_MONTH"
	//   "PREVIOUS_QUARTER"
	//   "PREVIOUS_YEAR"
	//   "LAST_7_DAYS"
	//   "LAST_30_DAYS"
	//   "LAST_90_DAYS"
	//   "LAST_365_DAYS"
	//   "ALL_TIME"
	//   "LAST_14_DAYS"
	//   "LAST_60_DAYS"
	Range string `json:"range,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CustomEndDate") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "CustomEndDate") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DataRange: Report data range.

func (*DataRange) MarshalJSON 

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

type Date 

type Date struct {
	// Day: Day of a month. Must be from 1 to 31 and valid for the year and
	// month, or 0 to specify a year by itself or a year and month where the
	// day isn't significant.
	Day int64 `json:"day,omitempty"`

	// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year
	// without a month and day.
	Month int64 `json:"month,omitempty"`

	// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a
	// date without a year.
	Year int64 `json:"year,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Day") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "Day") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

func (*Date) MarshalJSON 

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

type DisjunctiveMatchStatement 

type DisjunctiveMatchStatement struct {
	// EventFilters: Filters. There is a limit of 100 filters that can be
	// set per disjunctive match statement.
	EventFilters []*EventFilter `json:"eventFilters,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EventFilters") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "EventFilters") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DisjunctiveMatchStatement: DisjunctiveMatchStatement that OR's all contained filters.

func (*DisjunctiveMatchStatement) MarshalJSON 

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

type EventFilter 

type EventFilter struct {
	// DimensionFilter: Filter on a dimension.
	DimensionFilter *PathQueryOptionsFilter `json:"dimensionFilter,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionFilter") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "DimensionFilter") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

EventFilter: Defines the type of filter to be applied to the path, a DV360 event dimension filter.

func (*EventFilter) MarshalJSON 

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

type FilterPair 

type FilterPair struct {
	// Type: Filter type.
	Type string `json:"type,omitempty"`

	// Value: Filter value.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Type") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "Type") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FilterPair: Filter used to match traffic data in your report.

func (*FilterPair) MarshalJSON 

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

type ListQueriesResponse 

type ListQueriesResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve
	// the next page of queries. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Queries: Retrieved queries.
	Queries []*Query `json:"queries,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 or default 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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListQueriesResponse: Represents a list of queries.

func (*ListQueriesResponse) MarshalJSON 

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

type ListReportsResponse 

type ListReportsResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve
	// the next page of reports. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Reports: Retrieved reports.
	Reports []*Report `json:"reports,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 or default 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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListReportsResponse: Represents a list of reports.

func (*ListReportsResponse) MarshalJSON 

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

type Options 

type Options struct {
	// IncludeOnlyTargetedUserLists: Set to true and filter your report by
	// `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for
	// audience lists specifically targeted by those items.
	IncludeOnlyTargetedUserLists bool `json:"includeOnlyTargetedUserLists,omitempty"`

	// PathQueryOptions: Options that contain Path Filters and Custom
	// Channel Groupings.
	PathQueryOptions *PathQueryOptions `json:"pathQueryOptions,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "IncludeOnlyTargetedUserLists") to unconditionally include in API
	// requests. By default, fields with empty or default 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:"-"`

	// NullFields is a list of field names (e.g.
	// "IncludeOnlyTargetedUserLists") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

Options: Additional query options.

func (*Options) MarshalJSON 

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

type Parameters 

type Parameters struct {
	// Filters: Filters used to match traffic data in your report.
	Filters []*FilterPair `json:"filters,omitempty"`

	// GroupBys: Data is grouped by the filters listed in this field.
	GroupBys []string `json:"groupBys,omitempty"`

	// Metrics: Metrics to include as columns in your report.
	Metrics []string `json:"metrics,omitempty"`

	// Options: Additional query options.
	Options *Options `json:"options,omitempty"`

	// Type: Report type.
	//
	// Possible values:
	//   "REPORT_TYPE_UNSPECIFIED"
	//   "STANDARD"
	//   "INVENTORY_AVAILABILITY"
	//   "AUDIENCE_COMPOSITION"
	//   "FLOODLIGHT"
	//   "YOUTUBE"
	//   "GRP"
	//   "YOUTUBE_PROGRAMMATIC_GUARANTEED"
	//   "REACH"
	//   "UNIQUE_REACH_AUDIENCE"
	//   "FULL_PATH"
	//   "PATH_ATTRIBUTION"
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Filters") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "Filters") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Parameters: Parameters of a query or report.

func (*Parameters) MarshalJSON 

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

type PathFilter 

type PathFilter struct {
	// EventFilters: Filter on an event to be applied to some part of the
	// path.
	EventFilters []*EventFilter `json:"eventFilters,omitempty"`

	// PathMatchPosition: Indicates the position of the path the filter
	// should match to (first, last, or any event in path).
	//
	// Possible values:
	//   "PATH_MATCH_POSITION_UNSPECIFIED"
	//   "ANY"
	//   "FIRST"
	//   "LAST"
	PathMatchPosition string `json:"pathMatchPosition,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EventFilters") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "EventFilters") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PathFilter: Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.

func (*PathFilter) MarshalJSON 

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

type PathQueryOptions 

type PathQueryOptions struct {
	// ChannelGrouping: Custom Channel Groupings.
	ChannelGrouping *ChannelGrouping `json:"channelGrouping,omitempty"`

	// PathFilters: Path Filters. There is a limit of 100 path filters that
	// can be set per report.
	PathFilters []*PathFilter `json:"pathFilters,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ChannelGrouping") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "ChannelGrouping") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

PathQueryOptions: Path Query Options for Report Options.

func (*PathQueryOptions) MarshalJSON 

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

type PathQueryOptionsFilter 

type PathQueryOptionsFilter struct {
	// Filter: Dimension the filter is applied to.
	Filter string `json:"filter,omitempty"`

	// Match: Indicates how the filter should be matched to the value.
	//
	// Possible values:
	//   "UNKNOWN"
	//   "EXACT"
	//   "PARTIAL"
	//   "BEGINS_WITH"
	//   "WILDCARD_EXPRESSION"
	Match string `json:"match,omitempty"`

	// Values: Value to filter on.
	Values []string `json:"values,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Filter") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "Filter") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PathQueryOptionsFilter: Dimension Filter on path events.

func (*PathQueryOptionsFilter) MarshalJSON 

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

type QueriesCreateCall 

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

func (*QueriesCreateCall) Context 

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

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 (*QueriesCreateCall) Do 

func (c *QueriesCreateCall) Do(opts ...googleapi.CallOption) (*Query, error)

Do executes the "doubleclickbidmanager.queries.create" call. Exactly one of *Query or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Query.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 (*QueriesCreateCall) Fields 

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

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

func (*QueriesCreateCall) Header 

func (c *QueriesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type QueriesDeleteCall 

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

func (*QueriesDeleteCall) Context 

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

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 (*QueriesDeleteCall) Do 

func (c *QueriesDeleteCall) Do(opts ...googleapi.CallOption) error

Do executes the "doubleclickbidmanager.queries.delete" call.

func (*QueriesDeleteCall) Fields 

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

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

func (*QueriesDeleteCall) Header 

func (c *QueriesDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type QueriesGetCall 

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

func (*QueriesGetCall) Context 

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

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 (*QueriesGetCall) Do 

func (c *QueriesGetCall) Do(opts ...googleapi.CallOption) (*Query, error)

Do executes the "doubleclickbidmanager.queries.get" call. Exactly one of *Query or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Query.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 (*QueriesGetCall) Fields 

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

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

func (*QueriesGetCall) Header 

func (c *QueriesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*QueriesGetCall) IfNoneMatch 

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

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 QueriesListCall 

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

func (*QueriesListCall) Context 

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

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 (*QueriesListCall) Do 

func (c *QueriesListCall) Do(opts ...googleapi.CallOption) (*ListQueriesResponse, error)

Do executes the "doubleclickbidmanager.queries.list" call. Exactly one of *ListQueriesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListQueriesResponse.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 (*QueriesListCall) Fields 

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

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

func (*QueriesListCall) Header 

func (c *QueriesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*QueriesListCall) IfNoneMatch 

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

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 (*QueriesListCall) OrderBy 

func (c *QueriesListCall) OrderBy(orderBy string) *QueriesListCall

OrderBy sets the optional parameter "orderBy": Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "metadata.title desc". Sorting is only supported for the following fields: * queryId * metadata.title

func (*QueriesListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified.

func (*QueriesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": A page token, received from a previous list call. Provide this to retrieve the subsequent page of queries.

func (*QueriesListCall) Pages 

func (c *QueriesListCall) Pages(ctx context.Context, f func(*ListQueriesResponse) 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 QueriesReportsGetCall 

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

func (*QueriesReportsGetCall) Context 

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

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 (*QueriesReportsGetCall) Do 

func (c *QueriesReportsGetCall) Do(opts ...googleapi.CallOption) (*Report, error)

Do executes the "doubleclickbidmanager.queries.reports.get" call. Exactly one of *Report or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Report.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 (*QueriesReportsGetCall) Fields 

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

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

func (*QueriesReportsGetCall) Header 

func (c *QueriesReportsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*QueriesReportsGetCall) IfNoneMatch 

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

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 QueriesReportsListCall 

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

func (*QueriesReportsListCall) Context 

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

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 (*QueriesReportsListCall) Do 

func (c *QueriesReportsListCall) Do(opts ...googleapi.CallOption) (*ListReportsResponse, error)

Do executes the "doubleclickbidmanager.queries.reports.list" call. Exactly one of *ListReportsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListReportsResponse.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 (*QueriesReportsListCall) Fields 

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

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

func (*QueriesReportsListCall) Header 

func (c *QueriesReportsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*QueriesReportsListCall) IfNoneMatch 

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

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 (*QueriesReportsListCall) OrderBy 

func (c *QueriesReportsListCall) OrderBy(orderBy string) *QueriesReportsListCall

OrderBy sets the optional parameter "orderBy": Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "key.reportId desc". Sorting is only supported for the following fields: * key.reportId

func (*QueriesReportsListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified.

func (*QueriesReportsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": A page token, received from a previous list call. Provide this to retrieve the subsequent page of reports.

func (*QueriesReportsListCall) Pages 

func (c *QueriesReportsListCall) Pages(ctx context.Context, f func(*ListReportsResponse) 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 QueriesReportsService 

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

func NewQueriesReportsService 

func NewQueriesReportsService(s *Service) *QueriesReportsService

func (*QueriesReportsService) Get 

func (r *QueriesReportsService) Get(queryId int64, reportId int64) *QueriesReportsGetCall

Get: Retrieves a stored report.

- queryId: ID of the query the report is associated with. - reportId: ID of the report to retrieve.

func (*QueriesReportsService) List 

func (r *QueriesReportsService) List(queryId int64) *QueriesReportsListCall

List: Lists reports.

- queryId: Query ID with which the reports are associated.

type QueriesRunCall 

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

func (*QueriesRunCall) Context 

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

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 (*QueriesRunCall) Do 

func (c *QueriesRunCall) Do(opts ...googleapi.CallOption) (*Report, error)

Do executes the "doubleclickbidmanager.queries.run" call. Exactly one of *Report or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Report.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 (*QueriesRunCall) Fields 

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

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

func (*QueriesRunCall) Header 

func (c *QueriesRunCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*QueriesRunCall) Synchronous 

func (c *QueriesRunCall) Synchronous(synchronous bool) *QueriesRunCall

Synchronous sets the optional parameter "synchronous": Whether the query should be run synchronously. When true, this method will not return until the query has finished running. When false or not specified, this method will return immediately.

type QueriesService 

type QueriesService struct {
	Reports *QueriesReportsService
	// contains filtered or unexported fields
}

func NewQueriesService 

func NewQueriesService(s *Service) *QueriesService

func (*QueriesService) Create 

func (r *QueriesService) Create(query *Query) *QueriesCreateCall

Create: Creates a query.

func (*QueriesService) Delete 

func (r *QueriesService) Delete(queryId int64) *QueriesDeleteCall

Delete: Deletes a stored query as well as the associated stored reports.

- queryId: Query ID to delete.

func (*QueriesService) Get 

func (r *QueriesService) Get(queryId int64) *QueriesGetCall

Get: Retrieves a stored query.

- queryId: Query ID to retrieve.

func (*QueriesService) List 

func (r *QueriesService) List() *QueriesListCall

List: Retrieves stored queries.

func (*QueriesService) Run 

func (r *QueriesService) Run(queryId int64, runqueryrequest *RunQueryRequest) *QueriesRunCall

Run: Runs a stored query to generate a report.

- queryId: Query ID to run.

type Query 

type Query struct {
	// Metadata: Query metadata.
	Metadata *QueryMetadata `json:"metadata,omitempty"`

	// Params: Query parameters.
	Params *Parameters `json:"params,omitempty"`

	// QueryId: Output only. Query ID.
	QueryId int64 `json:"queryId,omitempty,string"`

	// Schedule: Information on how often and when to run a query.
	Schedule *QuerySchedule `json:"schedule,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Metadata") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "Metadata") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Query: Represents a query.

func (*Query) MarshalJSON 

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

type QueryMetadata 

type QueryMetadata struct {
	// DataRange: Range of report data.
	DataRange *DataRange `json:"dataRange,omitempty"`

	// Format: Format of the generated report.
	//
	// Possible values:
	//   "FORMAT_UNSPECIFIED" - Default value when format is not specified
	// or is unknown in this version.
	//   "CSV" - CSV.
	//   "XLSX" - Excel.
	Format string `json:"format,omitempty"`

	// SendNotification: Whether to send an email notification when a report
	// is ready. Defaults to false.
	SendNotification bool `json:"sendNotification,omitempty"`

	// ShareEmailAddress: List of email addresses which are sent email
	// notifications when the report is finished. Separate from
	// `sendNotification`.
	ShareEmailAddress []string `json:"shareEmailAddress,omitempty"`

	// Title: Query title. It is used to name the reports generated from
	// this query.
	Title string `json:"title,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataRange") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "DataRange") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

QueryMetadata: Query metadata.

func (*QueryMetadata) MarshalJSON 

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

type QuerySchedule 

type QuerySchedule struct {
	// EndDate: Date to periodically run the query until. Not applicable to
	// `ONE_TIME` frequency.
	EndDate *Date `json:"endDate,omitempty"`

	// Frequency: How often the query is run.
	//
	// Possible values:
	//   "FREQUENCY_UNSPECIFIED"
	//   "ONE_TIME"
	//   "DAILY"
	//   "WEEKLY"
	//   "SEMI_MONTHLY"
	//   "MONTHLY"
	//   "QUARTERLY"
	//   "YEARLY"
	Frequency string `json:"frequency,omitempty"`

	// NextRunTimezoneCode: Canonical timezone code for report generation
	// time. Defaults to `America/New_York`.
	NextRunTimezoneCode string `json:"nextRunTimezoneCode,omitempty"`

	// StartDate: When to start running the query. Not applicable to
	// `ONE_TIME` frequency.
	StartDate *Date `json:"startDate,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndDate") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "EndDate") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

QuerySchedule: Information on how frequently and when to run a query.

func (*QuerySchedule) MarshalJSON 

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

type Report 

type Report struct {
	// Key: Key used to identify a report.
	Key *ReportKey `json:"key,omitempty"`

	// Metadata: Report metadata.
	Metadata *ReportMetadata `json:"metadata,omitempty"`

	// Params: Report parameters.
	Params *Parameters `json:"params,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Key") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "Key") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Report: Represents a report.

func (*Report) MarshalJSON 

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

type ReportKey 

type ReportKey struct {
	// QueryId: Output only. Query ID.
	QueryId int64 `json:"queryId,omitempty,string"`

	// ReportId: Output only. Report ID.
	ReportId int64 `json:"reportId,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "QueryId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "QueryId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReportKey: Key used to identify a report.

func (*ReportKey) MarshalJSON 

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

type ReportMetadata 

type ReportMetadata struct {
	// GoogleCloudStoragePath: Output only. The path to the location in
	// Google Cloud Storage where the report is stored.
	GoogleCloudStoragePath string `json:"googleCloudStoragePath,omitempty"`

	// ReportDataEndDate: The ending time for the data that is shown in the
	// report.
	ReportDataEndDate *Date `json:"reportDataEndDate,omitempty"`

	// ReportDataStartDate: The starting time for the data that is shown in
	// the report.
	ReportDataStartDate *Date `json:"reportDataStartDate,omitempty"`

	// Status: Report status.
	Status *ReportStatus `json:"status,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "GoogleCloudStoragePath") to unconditionally include in API requests.
	// By default, fields with empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "GoogleCloudStoragePath")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ReportMetadata: Report metadata.

func (*ReportMetadata) MarshalJSON 

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

type ReportStatus 

type ReportStatus struct {
	// FinishTime: Output only. The time when this report either completed
	// successfully or failed.
	FinishTime string `json:"finishTime,omitempty"`

	// Format: The file type of the report.
	//
	// Possible values:
	//   "FORMAT_UNSPECIFIED" - Default value when format is not specified
	// or is unknown in this version.
	//   "CSV" - CSV.
	//   "XLSX" - Excel.
	Format string `json:"format,omitempty"`

	// State: Output only. The state of the report.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED"
	//   "QUEUED"
	//   "RUNNING"
	//   "DONE"
	//   "FAILED"
	State string `json:"state,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "FinishTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReportStatus: Report status.

func (*ReportStatus) MarshalJSON 

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

type Rule 

type Rule struct {
	// DisjunctiveMatchStatements: DisjunctiveMatchStatements within a Rule.
	// DisjunctiveMatchStatement OR's all contained filters.
	DisjunctiveMatchStatements []*DisjunctiveMatchStatement `json:"disjunctiveMatchStatements,omitempty"`

	// Name: Rule name.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "DisjunctiveMatchStatements") to unconditionally include in API
	// requests. By default, fields with empty or default 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:"-"`

	// NullFields is a list of field names (e.g.
	// "DisjunctiveMatchStatements") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

Rule: A Rule defines a name, and a boolean expression in [conjunctive normal form] (http://mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be applied to a path event to determine if that name should be applied.

func (*Rule) MarshalJSON 

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

type RunQueryRequest 

type RunQueryRequest struct {
	// DataRange: Report data range used to generate the report. If
	// unspecified, the original parent query's data range is used.
	DataRange *DataRange `json:"dataRange,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataRange") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`

	// NullFields is a list of field names (e.g. "DataRange") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RunQueryRequest: Request to run a stored query to generate a report.

func (*RunQueryRequest) MarshalJSON 

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

type Service 

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

	Queries *QueriesService
	// contains filtered or unexported fields
}

func New deprecated 

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

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

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.