Documentation
¶
Overview ¶
Package doubleclickbidmanager provides access to the DoubleClick Bid Manager API.
See https://developers.google.com/bid-manager/
Usage example:
import "google.golang.org/api/doubleclickbidmanager/v1" ... doubleclickbidmanagerService, err := doubleclickbidmanager.New(oauthHttpClient)
Index ¶
- type DownloadLineItemsRequest
- type DownloadLineItemsResponse
- type FilterPair
- type LineitemsDownloadlineitemsCall
- type LineitemsService
- type LineitemsUploadlineitemsCall
- type ListQueriesResponse
- type ListReportsResponse
- type Parameters
- type QueriesCreatequeryCall
- type QueriesDeletequeryCall
- type QueriesGetqueryCall
- type QueriesListqueriesCall
- type QueriesRunqueryCall
- type QueriesService
- func (r *QueriesService) Createquery(query *Query) *QueriesCreatequeryCall
- func (r *QueriesService) Deletequery(queryId int64) *QueriesDeletequeryCall
- func (r *QueriesService) Getquery(queryId int64) *QueriesGetqueryCall
- func (r *QueriesService) Listqueries() *QueriesListqueriesCall
- func (r *QueriesService) Runquery(queryId int64, runqueryrequest *RunQueryRequest) *QueriesRunqueryCall
- type Query
- type QueryMetadata
- type QuerySchedule
- type Report
- type ReportFailure
- type ReportKey
- type ReportMetadata
- type ReportStatus
- type ReportsListreportsCall
- type ReportsService
- type RowStatus
- type RunQueryRequest
- type Service
- type UploadLineItemsRequest
- type UploadLineItemsResponse
- type UploadStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DownloadLineItemsRequest ¶
type DownloadLineItemsRequest struct {
// FilterIds: Ids of the specified filter type used to filter line items
// to fetch. If omitted, all the line items will be returned.
FilterIds googleapi.Int64s `json:"filterIds,omitempty"`
// FilterType: Filter type used to filter line items to fetch.
FilterType string `json:"filterType,omitempty"`
// Format: Format in which the line items will be returned. Default to
// CSV.
Format string `json:"format,omitempty"`
}
type DownloadLineItemsResponse ¶
type DownloadLineItemsResponse struct {
// LineItems: Retrieved line items in CSV format. Refer to Entity Write
// File Format for more information on file format.
LineItems string `json:"lineItems,omitempty"`
}
type FilterPair ¶
type LineitemsDownloadlineitemsCall ¶
type LineitemsDownloadlineitemsCall struct {
// contains filtered or unexported fields
}
func (*LineitemsDownloadlineitemsCall) Do ¶
func (c *LineitemsDownloadlineitemsCall) Do() (*DownloadLineItemsResponse, error)
func (*LineitemsDownloadlineitemsCall) Fields ¶
func (c *LineitemsDownloadlineitemsCall) Fields(s ...googleapi.Field) *LineitemsDownloadlineitemsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type LineitemsService ¶
type LineitemsService struct {
// contains filtered or unexported fields
}
func NewLineitemsService ¶
func NewLineitemsService(s *Service) *LineitemsService
func (*LineitemsService) Downloadlineitems ¶
func (r *LineitemsService) Downloadlineitems(downloadlineitemsrequest *DownloadLineItemsRequest) *LineitemsDownloadlineitemsCall
Downloadlineitems: Retrieves line items in CSV format.
func (*LineitemsService) Uploadlineitems ¶
func (r *LineitemsService) Uploadlineitems(uploadlineitemsrequest *UploadLineItemsRequest) *LineitemsUploadlineitemsCall
Uploadlineitems: Uploads line items in CSV format.
type LineitemsUploadlineitemsCall ¶
type LineitemsUploadlineitemsCall struct {
// contains filtered or unexported fields
}
func (*LineitemsUploadlineitemsCall) Do ¶
func (c *LineitemsUploadlineitemsCall) Do() (*UploadLineItemsResponse, error)
func (*LineitemsUploadlineitemsCall) Fields ¶
func (c *LineitemsUploadlineitemsCall) Fields(s ...googleapi.Field) *LineitemsUploadlineitemsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ListQueriesResponse ¶
type ListReportsResponse ¶
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"`
// IncludeInviteData: Whether to include data from Invite Media.
IncludeInviteData bool `json:"includeInviteData,omitempty"`
// Metrics: Metrics to include as columns in your report.
Metrics []string `json:"metrics,omitempty"`
// Type: Report type.
Type string `json:"type,omitempty"`
}
type QueriesCreatequeryCall ¶
type QueriesCreatequeryCall struct {
// contains filtered or unexported fields
}
func (*QueriesCreatequeryCall) Do ¶
func (c *QueriesCreatequeryCall) Do() (*Query, error)
func (*QueriesCreatequeryCall) Fields ¶
func (c *QueriesCreatequeryCall) Fields(s ...googleapi.Field) *QueriesCreatequeryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type QueriesDeletequeryCall ¶
type QueriesDeletequeryCall struct {
// contains filtered or unexported fields
}
func (*QueriesDeletequeryCall) Do ¶
func (c *QueriesDeletequeryCall) Do() error
func (*QueriesDeletequeryCall) Fields ¶
func (c *QueriesDeletequeryCall) Fields(s ...googleapi.Field) *QueriesDeletequeryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type QueriesGetqueryCall ¶
type QueriesGetqueryCall struct {
// contains filtered or unexported fields
}
func (*QueriesGetqueryCall) Do ¶
func (c *QueriesGetqueryCall) Do() (*Query, error)
func (*QueriesGetqueryCall) Fields ¶
func (c *QueriesGetqueryCall) Fields(s ...googleapi.Field) *QueriesGetqueryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type QueriesListqueriesCall ¶
type QueriesListqueriesCall struct {
// contains filtered or unexported fields
}
func (*QueriesListqueriesCall) Do ¶
func (c *QueriesListqueriesCall) Do() (*ListQueriesResponse, error)
func (*QueriesListqueriesCall) Fields ¶
func (c *QueriesListqueriesCall) Fields(s ...googleapi.Field) *QueriesListqueriesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type QueriesRunqueryCall ¶
type QueriesRunqueryCall struct {
// contains filtered or unexported fields
}
func (*QueriesRunqueryCall) Do ¶
func (c *QueriesRunqueryCall) Do() error
func (*QueriesRunqueryCall) Fields ¶
func (c *QueriesRunqueryCall) Fields(s ...googleapi.Field) *QueriesRunqueryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type QueriesService ¶
type QueriesService struct {
// contains filtered or unexported fields
}
func NewQueriesService ¶
func NewQueriesService(s *Service) *QueriesService
func (*QueriesService) Createquery ¶
func (r *QueriesService) Createquery(query *Query) *QueriesCreatequeryCall
Createquery: Creates a query.
func (*QueriesService) Deletequery ¶
func (r *QueriesService) Deletequery(queryId int64) *QueriesDeletequeryCall
Deletequery: Deletes a stored query as well as the associated stored reports.
func (*QueriesService) Getquery ¶
func (r *QueriesService) Getquery(queryId int64) *QueriesGetqueryCall
Getquery: Retrieves a stored query.
func (*QueriesService) Listqueries ¶
func (r *QueriesService) Listqueries() *QueriesListqueriesCall
Listqueries: Retrieves stored queries.
func (*QueriesService) Runquery ¶
func (r *QueriesService) Runquery(queryId int64, runqueryrequest *RunQueryRequest) *QueriesRunqueryCall
Runquery: Runs a stored query to generate a report.
type Query ¶
type Query struct {
// Kind: Identifies what kind of resource this is. Value: the fixed
// string "doubleclickbidmanager#query".
Kind string `json:"kind,omitempty"`
// Metadata: Query metadata.
Metadata *QueryMetadata `json:"metadata,omitempty"`
// Params: Query parameters.
Params *Parameters `json:"params,omitempty"`
// QueryId: Query ID.
QueryId int64 `json:"queryId,omitempty,string"`
// ReportDataEndTimeMs: The ending time for the data that is shown in
// the report. Note, reportDataEndTimeMs is required if
// metadata.dataRange is CUSTOM_DATES and ignored otherwise.
ReportDataEndTimeMs int64 `json:"reportDataEndTimeMs,omitempty,string"`
// ReportDataStartTimeMs: The starting time for the data that is shown
// in the report. Note, reportDataStartTimeMs is required if
// metadata.dataRange is CUSTOM_DATES and ignored otherwise.
ReportDataStartTimeMs int64 `json:"reportDataStartTimeMs,omitempty,string"`
// Schedule: Information on how often and when to run a query.
Schedule *QuerySchedule `json:"schedule,omitempty"`
// TimezoneCode: Canonical timezone code for report data time. Defaults
// to America/New_York.
TimezoneCode string `json:"timezoneCode,omitempty"`
}
type QueryMetadata ¶
type QueryMetadata struct {
// DataRange: Range of report data.
DataRange string `json:"dataRange,omitempty"`
// Format: Format of the generated report.
Format string `json:"format,omitempty"`
// GoogleCloudStoragePathForLatestReport: The path to the location in
// Google Cloud Storage where the latest report is stored.
GoogleCloudStoragePathForLatestReport string `json:"googleCloudStoragePathForLatestReport,omitempty"`
// GoogleDrivePathForLatestReport: The path in Google Drive for the
// latest report.
GoogleDrivePathForLatestReport string `json:"googleDrivePathForLatestReport,omitempty"`
// LatestReportRunTimeMs: The time when the latest report started to
// run.
LatestReportRunTimeMs int64 `json:"latestReportRunTimeMs,omitempty,string"`
// Locale: Locale of the generated reports. Valid values are cs CZECH de
// GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko
// KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk
// UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE
//
// An locale string
// not in the list above will generate reports in English.
Locale string `json:"locale,omitempty"`
// ReportCount: Number of reports that have been generated for the
// query.
ReportCount int64 `json:"reportCount,omitempty"`
// Running: Whether the latest report is currently running.
Running bool `json:"running,omitempty"`
// SendNotification: Whether to send an email notification when a report
// is ready. Default to false.
SendNotification bool `json:"sendNotification,omitempty"`
// 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"`
}
type QuerySchedule ¶
type QuerySchedule struct {
// EndTimeMs: Datetime to periodically run the query until.
EndTimeMs int64 `json:"endTimeMs,omitempty,string"`
// Frequency: How often the query is run.
Frequency string `json:"frequency,omitempty"`
// NextRunMinuteOfDay: Time of day at which a new report will be
// generated, represented as minutes past midnight. Range is 0 to 1439.
// Only applies to scheduled reports.
NextRunMinuteOfDay int64 `json:"nextRunMinuteOfDay,omitempty"`
// NextRunTimezoneCode: Canonical timezone code for report generation
// time. Defaults to America/New_York.
NextRunTimezoneCode string `json:"nextRunTimezoneCode,omitempty"`
}
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"`
}
type ReportFailure ¶
type ReportFailure struct {
// ErrorCode: Error code that shows why the report was not created.
ErrorCode string `json:"errorCode,omitempty"`
}
type ReportMetadata ¶
type ReportMetadata struct {
// GoogleCloudStoragePath: The path to the location in Google Cloud
// Storage where the report is stored.
GoogleCloudStoragePath string `json:"googleCloudStoragePath,omitempty"`
// ReportDataEndTimeMs: The ending time for the data that is shown in
// the report.
ReportDataEndTimeMs int64 `json:"reportDataEndTimeMs,omitempty,string"`
// ReportDataStartTimeMs: The starting time for the data that is shown
// in the report.
ReportDataStartTimeMs int64 `json:"reportDataStartTimeMs,omitempty,string"`
// Status: Report status.
Status *ReportStatus `json:"status,omitempty"`
}
type ReportStatus ¶
type ReportStatus struct {
// Failure: If the report failed, this records the cause.
Failure *ReportFailure `json:"failure,omitempty"`
// FinishTimeMs: The time when this report either completed successfully
// or failed.
FinishTimeMs int64 `json:"finishTimeMs,omitempty,string"`
// Format: The file type of the report.
Format string `json:"format,omitempty"`
// State: The state of the report.
State string `json:"state,omitempty"`
}
type ReportsListreportsCall ¶
type ReportsListreportsCall struct {
// contains filtered or unexported fields
}
func (*ReportsListreportsCall) Do ¶
func (c *ReportsListreportsCall) Do() (*ListReportsResponse, error)
func (*ReportsListreportsCall) Fields ¶
func (c *ReportsListreportsCall) Fields(s ...googleapi.Field) *ReportsListreportsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ReportsService ¶
type ReportsService struct {
// contains filtered or unexported fields
}
func NewReportsService ¶
func NewReportsService(s *Service) *ReportsService
func (*ReportsService) Listreports ¶
func (r *ReportsService) Listreports(queryId int64) *ReportsListreportsCall
Listreports: Retrieves stored reports.
type RowStatus ¶
type RowStatus struct {
// Changed: Whether the stored entity is changed as a result of upload.
Changed bool `json:"changed,omitempty"`
// EntityId: Entity Id.
EntityId int64 `json:"entityId,omitempty,string"`
// EntityName: Entity name.
EntityName string `json:"entityName,omitempty"`
// Errors: Reasons why the entity can't be uploaded.
Errors []string `json:"errors,omitempty"`
// Persisted: Whether the entity is persisted.
Persisted bool `json:"persisted,omitempty"`
// RowNumber: Row number.
RowNumber int64 `json:"rowNumber,omitempty"`
}
type RunQueryRequest ¶
type RunQueryRequest struct {
// DataRange: Report data range used to generate the report.
DataRange string `json:"dataRange,omitempty"`
// ReportDataEndTimeMs: The ending time for the data that is shown in
// the report. Note, reportDataEndTimeMs is required if dataRange is
// CUSTOM_DATES and ignored otherwise.
ReportDataEndTimeMs int64 `json:"reportDataEndTimeMs,omitempty,string"`
// ReportDataStartTimeMs: The starting time for the data that is shown
// in the report. Note, reportDataStartTimeMs is required if dataRange
// is CUSTOM_DATES and ignored otherwise.
ReportDataStartTimeMs int64 `json:"reportDataStartTimeMs,omitempty,string"`
// TimezoneCode: Canonical timezone code for report data time. Defaults
// to America/New_York.
TimezoneCode string `json:"timezoneCode,omitempty"`
}
type Service ¶
type Service struct {
BasePath string // API endpoint base URL
Lineitems *LineitemsService
Queries *QueriesService
Reports *ReportsService
// contains filtered or unexported fields
}
type UploadLineItemsRequest ¶
type UploadLineItemsRequest struct {
// DryRun: Set to true to get upload status without actually persisting
// the line items.
DryRun bool `json:"dryRun,omitempty"`
// Format: Format the line items are in. Default to CSV.
Format string `json:"format,omitempty"`
// LineItems: Line items in CSV to upload. Refer to Entity Write File
// Format for more information on file format.
LineItems string `json:"lineItems,omitempty"`
}
type UploadLineItemsResponse ¶
type UploadLineItemsResponse struct {
// UploadStatus: Status of upload.
UploadStatus *UploadStatus `json:"uploadStatus,omitempty"`
}