doubleclickbidmanager

package
v0.203.0 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 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/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

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 google.golang.org/api/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 google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption 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 DataRange 

type DataRange struct {
	// CustomEndDate: If `CUSTOM_DATES` is assigned to range, this field specifies
	// the end date for the date range that is reported on. This field is required
	// if using `CUSTOM_DATES` range and will be ignored otherwise.
	CustomEndDate *Date `json:"customEndDate,omitempty"`
	// CustomStartDate: If `CUSTOM_DATES` is assigned to range, this field
	// specifies the starting date for the date range that is reported on. This
	// field is required if using `CUSTOM_DATES` range and will be ignored
	// otherwise.
	CustomStartDate *Date `json:"customStartDate,omitempty"`
	// Range: The preset date range to be reported on. If `CUSTOM_DATES` is
	// assigned to this field, fields custom_start_date and custom_end_date must be
	// set to specify the custom date range.
	//
	// Possible values:
	//   "RANGE_UNSPECIFIED" - Default value when range is not specified or is
	// unknown in this version.
	//   "CUSTOM_DATES" - Custom date range.
	//   "CURRENT_DAY" - Current day.
	//   "PREVIOUS_DAY" - Previous day.
	//   "WEEK_TO_DATE" - All days, including the current day, since the most
	// recent Sunday.
	//   "MONTH_TO_DATE" - All days, including the current day, since the start of
	// the current month.
	//   "QUARTER_TO_DATE" - All days, including the current day, since the start
	// of the current quarter.
	//   "YEAR_TO_DATE" - All days, including the current day, since the start of
	// the current calendar year.
	//   "PREVIOUS_WEEK" - The previous completed week, beginning from Sunday.
	//   "PREVIOUS_MONTH" - The previous completed calendar month.
	//   "PREVIOUS_QUARTER" - The previous completed quarter.
	//   "PREVIOUS_YEAR" - The previous completed calendar year.
	//   "LAST_7_DAYS" - The previous 7 days, excluding the current day.
	//   "LAST_30_DAYS" - The previous 30 days, excluding the current day.
	//   "LAST_90_DAYS" - The previous 90 days, excluding the current day.
	//   "LAST_365_DAYS" - The previous 365 days, excluding the current day.
	//   "ALL_TIME" - All time for which data is available, excluding the current
	// day.
	//   "LAST_14_DAYS" - The previous 14 days, excluding the current day.
	//   "LAST_60_DAYS" - The previous 60 days, excluding the current day.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataRange: The date range to be reported on.

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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 FilterPair 

type FilterPair struct {
	// Type: The type of value to filter by. Defined by a Filter
	// (/bid-manager/reference/rest/v2/filters-metrics#filters) value.
	Type string `json:"type,omitempty"`
	// Value: The identifying value to filter by, such as a relevant resource ID.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FilterPair: Represents a single filter rule.

func (FilterPair) MarshalJSON 

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

type ListQueriesResponse 

type ListQueriesResponse struct {
	// NextPageToken: A token to retrieve the next page of results. Pass this value
	// in the page_token field in the subsequent call to `queries.list` method to
	// retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Queries: The list of queries. This field will be absent if empty.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListQueriesResponse) MarshalJSON 

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

type ListReportsResponse 

type ListReportsResponse struct {
	// NextPageToken: A token to retrieve the next page of results. Pass this value
	// in the page_token field in the subsequent call to `queries.reports.list`
	// method to retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Reports: The list of reports. This field will be absent if empty.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (ListReportsResponse) MarshalJSON 

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

type Options 

type Options struct {
	// IncludeOnlyTargetedUserLists: Whether to include data for audience lists
	// specifically targeted by filtered line items or insertion orders. Requires
	// the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters.
	IncludeOnlyTargetedUserLists bool `json:"includeOnlyTargetedUserLists,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. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Options: Report parameter options.

func (Options) MarshalJSON 

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

type Parameters 

type Parameters struct {
	// Filters: Filters to limit the scope of reported data.
	Filters []*FilterPair `json:"filters,omitempty"`
	// GroupBys: Dimensions by which to segment and group the data. Defined by
	// Filter (/bid-manager/reference/rest/v2/filters-metrics#filters) values.
	GroupBys []string `json:"groupBys,omitempty"`
	// Metrics: Metrics to define the data populating the report. Defined by Metric
	// (/bid-manager/reference/rest/v2/filters-metrics#metrics) values.
	Metrics []string `json:"metrics,omitempty"`
	// Options: Additional report parameter options.
	Options *Options `json:"options,omitempty"`
	// Type: The type of the report. The type of the report determines the
	// dimesions, filters, and metrics that can be used.
	//
	// Possible values:
	//   "REPORT_TYPE_UNSPECIFIED" - Default value when report type is not
	// specified or is unknown in this version.
	//   "STANDARD" - Standard report.
	//   "INVENTORY_AVAILABILITY" - Inventory Availability report.
	//   "AUDIENCE_COMPOSITION" - Audience Composition report.
	//   "FLOODLIGHT" - Floodlight report.
	//   "YOUTUBE" - YouTube report.
	//   "GRP" - GRP report.
	//   "YOUTUBE_PROGRAMMATIC_GUARANTEED" - YouTube Programmatic Guaranteed
	// report.
	//   "REACH" - Reach report.
	//   "UNIQUE_REACH_AUDIENCE" - Unique Reach Audience report.
	//   "FULL_PATH" - Full Path report.
	//   "PATH_ATTRIBUTION" - Path Attribution report.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Parameters: Parameters of a generated report.

func (Parameters) MarshalJSON 

func (s Parameters) 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.

func (*QueriesCreateCall) Do 

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

Do executes the "doubleclickbidmanager.queries.create" call. 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 details.

func (*QueriesCreateCall) Header 

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

Header returns a http.Header that can be modified by the caller to add 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.

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

func (*QueriesDeleteCall) Header 

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

Header returns a http.Header that can be modified by the caller to add 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.

func (*QueriesGetCall) Do 

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

Do executes the "doubleclickbidmanager.queries.get" call. 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 details.

func (*QueriesGetCall) Header 

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

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

func (*QueriesGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

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.

func (*QueriesListCall) Do 

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

Do executes the "doubleclickbidmanager.queries.list" call. 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 details.

func (*QueriesListCall) Header 

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

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

func (*QueriesListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*QueriesListCall) OrderBy 

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

OrderBy sets the optional parameter "orderBy": Field to sort the list by. Accepts the following values: * `queryId` (default) * `metadata.title` The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `queryId desc`.

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 token identifying which page of results the server should return. Typically, this is the value of nextPageToken, returned from the previous call to the `queries.list` method. If unspecified, the first page of results is returned.

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.

func (*QueriesReportsGetCall) Do 

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

Do executes the "doubleclickbidmanager.queries.reports.get" call. 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 details.

func (*QueriesReportsGetCall) Header 

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

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

func (*QueriesReportsGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

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.

func (*QueriesReportsListCall) Do 

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

Do executes the "doubleclickbidmanager.queries.reports.list" call. 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 details.

func (*QueriesReportsListCall) Header 

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

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

func (*QueriesReportsListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*QueriesReportsListCall) OrderBy 

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

OrderBy sets the optional parameter "orderBy": Field to sort the list by. Accepts the following values: * `key.reportId` (default) The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `key.reportId desc`.

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 token identifying which page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to the `queries.reports.list` method. If unspecified, the first page of results is returned.

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

- queryId: The ID of the query that generated the report. - reportId: The ID of the query to retrieve.

func (*QueriesReportsService) List 

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

List: Lists reports generated by the provided query.

- queryId: The ID of the query that generated the reports.

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.

func (*QueriesRunCall) Do 

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

Do executes the "doubleclickbidmanager.queries.run" call. 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 details.

func (*QueriesRunCall) Header 

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

Header returns a http.Header that can be modified by the caller to add 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`, the request won't return until the resulting report has finished running. This parameter is `false` by default. Setting this parameter to `true` is **not recommended**.

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 new query.

func (*QueriesService) Delete 

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

Delete: Deletes an existing query as well as its generated reports.

- queryId: The ID of the query to delete.

func (*QueriesService) Get 

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

Get: Retrieves a query.

- queryId: The ID of the query to retrieve.

func (*QueriesService) List 

func (r *QueriesService) List() *QueriesListCall

List: Lists queries created by the current user.

func (*QueriesService) Run 

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

Run: Runs an existing query to generate a report.

- queryId: The ID of the query to run.

type Query 

type Query struct {
	// Metadata: The metadata of the query.
	Metadata *QueryMetadata `json:"metadata,omitempty"`
	// Params: The parameters of the report generated by the query.
	Params *Parameters `json:"params,omitempty"`
	// QueryId: Output only. The unique ID of the query.
	QueryId int64 `json:"queryId,omitempty,string"`
	// Schedule: When and how often the query is scheduled to run. If the frequency
	// field is set to `ONE_TIME`, the query will only run when queries.run is
	// called.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Query: A single query used to generate a report.

func (Query) MarshalJSON 

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

type QueryMetadata 

type QueryMetadata struct {
	// DataRange: The date range the report generated by the query will report on.
	// This date range will be defined by the time zone as used by the advertiser.
	DataRange *DataRange `json:"dataRange,omitempty"`
	// Format: The format of the report generated by the query.
	//
	// 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 an email notification is sent to the query creator
	// when a report generated by the query is ready. This value is `false` by
	// default.
	SendNotification bool `json:"sendNotification,omitempty"`
	// ShareEmailAddress: List of additional email addresses with which to share
	// the query. If send_notification is `true`, these email addresses will
	// receive a notification when a report generated by the query is ready. If
	// these email addresses are connected to Display & Video 360 users, the query
	// will be available to them in the Display & Video 360 interface.
	ShareEmailAddress []string `json:"shareEmailAddress,omitempty"`
	// Title: The display name of the query. This value will be used in the file
	// name of reports generated by the 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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

QueryMetadata: The metadata of the query.

func (QueryMetadata) MarshalJSON 

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

type QuerySchedule 

type QuerySchedule struct {
	// EndDate: The date on which to end the scheduled runs. This field is required
	// if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored.
	EndDate *Date `json:"endDate,omitempty"`
	// Frequency: How frequently to run the query. If set to `ONE_TIME`, the query
	// will only be run when queries.run is called.
	//
	// Possible values:
	//   "FREQUENCY_UNSPECIFIED" - Default value when frequency is not specified or
	// is unknown in this version.
	//   "ONE_TIME" - Only when the query is run manually.
	//   "DAILY" - Once a day.
	//   "WEEKLY" - Once a week.
	//   "SEMI_MONTHLY" - Twice a month.
	//   "MONTHLY" - Once a month.
	//   "QUARTERLY" - Once a quarter.
	//   "YEARLY" - Once a year.
	Frequency string `json:"frequency,omitempty"`
	// NextRunTimezoneCode: The canonical code for the timezone the query schedule
	// is based on. Scheduled runs are usually conducted in the morning of a given
	// day. Defaults to `America/New_York`.
	NextRunTimezoneCode string `json:"nextRunTimezoneCode,omitempty"`
	// StartDate: The date on which to begin the scheduled runs. This field is
	// required if frequency is not set to `ONE_TIME`. Otherwise, it will be
	// ignored.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (QuerySchedule) MarshalJSON 

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

type Report 

type Report struct {
	// Key: The key information identifying the report.
	Key *ReportKey `json:"key,omitempty"`
	// Metadata: The metadata of the report.
	Metadata *ReportMetadata `json:"metadata,omitempty"`
	// Params: The parameters of the report.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Report: A single report generated by its parent report.

func (Report) MarshalJSON 

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

type ReportKey 

type ReportKey struct {
	// QueryId: Output only. The unique ID of the query that generated the report.
	QueryId int64 `json:"queryId,omitempty,string"`
	// ReportId: Output only. The unique ID of the report.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReportKey: Identifying information of a report.

func (ReportKey) MarshalJSON 

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

type ReportMetadata 

type ReportMetadata struct {
	// GoogleCloudStoragePath: Output only. The location of the generated report
	// file in Google Cloud Storage. This field will be absent if status.state is
	// not `DONE`.
	GoogleCloudStoragePath string `json:"googleCloudStoragePath,omitempty"`
	// ReportDataEndDate: The end date of the report data date range.
	ReportDataEndDate *Date `json:"reportDataEndDate,omitempty"`
	// ReportDataStartDate: The start date of the report data date range.
	ReportDataStartDate *Date `json:"reportDataStartDate,omitempty"`
	// Status: The status of the report.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReportMetadata: The metadata of a report.

func (ReportMetadata) MarshalJSON 

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

type ReportStatus 

type ReportStatus struct {
	// FinishTime: Output only. The timestamp of when report generation finished
	// successfully or in failure. This field will not be set unless state is
	// `DONE` or `FAILED`.
	FinishTime string `json:"finishTime,omitempty"`
	// Format: The format of the generated report file.
	//
	// 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 generation.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Default value when state is not specified or is
	// unknown in this version.
	//   "QUEUED" - The report is queued to run.
	//   "RUNNING" - The report is currently running.
	//   "DONE" - The report has finished running successfully.
	//   "FAILED" - The report has finished running in failure.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReportStatus: The status of a report.

func (ReportStatus) MarshalJSON 

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

type RunQueryRequest 

type RunQueryRequest struct {
	// DataRange: The date range used by the query to generate the report. If
	// unspecified, the query's original 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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RunQueryRequest: Details specifying how to run a query.

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.