dfareporting

package
v0.0.0-...-976d7dd Latest Latest
Warning

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

 Go to latest Published: Jul 25, 2014 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Overview

Package dfareporting provides access to the DFA Reporting API.

See https://developers.google.com/doubleclick-advertisers/reporting/

Usage example: 

import "code.google.com/p/google-api-go-client/dfareporting/v1"
...
dfareportingService, err := dfareporting.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage DoubleClick for Advertisers reports
	DfareportingScope = "https://www.googleapis.com/auth/dfareporting"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type DimensionFilter 

type DimensionFilter struct {
	// DimensionName: The name of the dimension to filter.
	DimensionName string `json:"dimensionName,omitempty"`

	// Kind: Kind of resource this is, in this case
	// dfareporting#dimensionFilter.
	Kind string `json:"kind,omitempty"`

	// Value: The value of the dimension to filter for.
	Value string `json:"value,omitempty"`
}

type DimensionValue 

type DimensionValue struct {
	// DimensionName: Name of the dimension.
	DimensionName string `json:"dimensionName,omitempty"`

	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// Id: The ID associated with the value if available.
	Id string `json:"id,omitempty"`

	// Kind: Kind of resource this is, in this case
	// dfareporting#dimensionValue.
	Kind string `json:"kind,omitempty"`

	// Value: The value of the dimension.
	Value string `json:"value,omitempty"`
}

type DimensionValueList 

type DimensionValueList struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// Items: The dimension values returned in this response.
	Items []*DimensionValue `json:"items,omitempty"`

	// Kind: Kind of list this is, in this case
	// dfareporting#dimensionValueList.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: Continuation token used to page through dimension
	// values. To retrieve the next page of results, set the next request's
	// "pageToken" to the value of this field. The page token is only valid
	// for a limited amount of time and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type DimensionValueRequest 

type DimensionValueRequest struct {
	// DimensionName: The name of the dimension values should be requested
	// for.
	DimensionName string `json:"dimensionName,omitempty"`

	// EndDate: The end date of the date range for which to retrieve
	// dimension values. A string of the format: "yyyy-MM-dd".
	EndDate string `json:"endDate,omitempty"`

	// Filters: List of filters to filter values by. The filters are ANDed.
	Filters []*DimensionFilter `json:"filters,omitempty"`

	// Kind: Kind of request this is, in this case
	// dfareporting#dimensionValueRequest.
	Kind string `json:"kind,omitempty"`

	// StartDate: The start date of the date range for which to retrieve
	// dimension values. A string of the format: "yyyy-MM-dd".
	StartDate string `json:"startDate,omitempty"`
}

type DimensionValuesQueryCall 

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

func (*DimensionValuesQueryCall) Do 

func (c *DimensionValuesQueryCall) Do() (*DimensionValueList, error)

func (*DimensionValuesQueryCall) MaxResults 

func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to return.

func (*DimensionValuesQueryCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The value of the nextToken from the previous result page.

type DimensionValuesService 

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

func NewDimensionValuesService 

func NewDimensionValuesService(s *Service) *DimensionValuesService

func (*DimensionValuesService) Query 

func (r *DimensionValuesService) Query(profileId int64, dimensionvaluerequest *DimensionValueRequest) *DimensionValuesQueryCall

Query: Retrieves list of report dimension values for a list of filters.

type File 

type File struct {
	// DateRange: The date range for which the file has report data.
	DateRange *FileDateRange `json:"dateRange,omitempty"`

	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// FileName: The file name of the file.
	FileName string `json:"fileName,omitempty"`

	// Id: The unique ID of this report file.
	Id int64 `json:"id,omitempty,string"`

	// Kind: Kind of resource this is, in this case dfareporting#file.
	Kind string `json:"kind,omitempty"`

	// LastModifiedTime: The timestamp in milliseconds since epoch when this
	// file was last modified.
	LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`

	// ReportId: The ID of the report this file was generated from.
	ReportId int64 `json:"reportId,omitempty,string"`

	// Status: The status of the report file, one of:
	// - "PROCESSING"
	// -
	// "REPORT_AVAILABLE"
	// - "FAILED"
	// - "CANCELLED"
	Status string `json:"status,omitempty"`

	// Urls: The urls where the completed report file can be downloaded.
	Urls *FileUrls `json:"urls,omitempty"`
}

type FileDateRange 

type FileDateRange struct {
	// EndDate: The end date of the date range, inclusive. A string of the
	// format: "yyyy-MM-dd".
	EndDate string `json:"endDate,omitempty"`

	// StartDate: The start date of the date range, inclusive. A string of
	// the format: "yyyy-MM-dd".
	StartDate string `json:"startDate,omitempty"`
}

type FileList 

type FileList struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// Items: The files returned in this response.
	Items []*File `json:"items,omitempty"`

	// Kind: Kind of list this is, in this case dfareporting#fileList.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: Continuation token used to page through files. To
	// retrieve the next page of results, set the next request's "pageToken"
	// to the value of this field. The page token is only valid for a
	// limited amount of time and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type FileUrls 

type FileUrls struct {
	// Csv: Urls for generated CSV data.
	Csv *FileUrlsCsv `json:"csv,omitempty"`
}

type FileUrlsCsv 

type FileUrlsCsv struct {
	// ApiUrl: The url for downloading the report data through the API.
	ApiUrl string `json:"apiUrl,omitempty"`

	// BrowserUrl: The url for downloading the report data through a
	// browser.
	BrowserUrl string `json:"browserUrl,omitempty"`
}

type FilesListCall 

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

func (*FilesListCall) Do 

func (c *FilesListCall) Do() (*FileList, error)

func (*FilesListCall) MaxResults 

func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to return.

func (*FilesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The value of the nextToken from the previous result page.

func (*FilesListCall) SortField 

func (c *FilesListCall) SortField(sortField string) *FilesListCall

SortField sets the optional parameter "sortField": The field to sort the list by.

func (*FilesListCall) SortOrder 

func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall

SortOrder sets the optional parameter "sortOrder": Order of sorted results, default is 'DESCENDING'.

type FilesService 

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

func NewFilesService 

func NewFilesService(s *Service) *FilesService

func (*FilesService) List 

func (r *FilesService) List(profileId int64) *FilesListCall

List: Lists files for a user profile.

type Report 

type Report struct {
	// AccountId: The account id this report belongs to.
	AccountId int64 `json:"accountId,omitempty,string"`

	// Criteria: The report criteria.
	Criteria *ReportCriteria `json:"criteria,omitempty"`

	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// FileName: The file name used when generating report files for this
	// report.
	FileName string `json:"fileName,omitempty"`

	// Id: The unique ID identifying this report resource.
	Id int64 `json:"id,omitempty,string"`

	// Kind: Kind of resource this is, in this case dfareporting#report.
	Kind string `json:"kind,omitempty"`

	// LastModifiedTime: The timestamp (in milliseconds since epoch) of when
	// this report was last modified.
	LastModifiedTime uint64 `json:"lastModifiedTime,omitempty,string"`

	// Name: The name of the report.
	Name string `json:"name,omitempty"`

	// OwnerProfileId: The user profile id of the owner of this report.
	OwnerProfileId int64 `json:"ownerProfileId,omitempty,string"`

	// Schedule: The report's schedule. Can only be set if the report's
	// 'dateRange' is a relative date range and the relative date range is
	// not "TODAY".
	Schedule *ReportSchedule `json:"schedule,omitempty"`

	// SubAccountId: The subbaccount id this report belongs to if
	// applicable.
	SubAccountId int64 `json:"subAccountId,omitempty,string"`

	// Type: The type of the report, currently only "STANDARD" is supported.
	Type string `json:"type,omitempty"`
}

type ReportCriteria 

type ReportCriteria struct {
	// Activities: Activity group.
	Activities *ReportCriteriaActivities `json:"activities,omitempty"`

	// CustomRichMediaEvents: Custom Rich Media Events group.
	CustomRichMediaEvents *ReportCriteriaCustomRichMediaEvents `json:"customRichMediaEvents,omitempty"`

	// DateRange: The date range this report should be run for.
	DateRange *ReportCriteriaDateRange `json:"dateRange,omitempty"`

	// DimensionFilters: The list of filters dimensions are filtered
	// on.
	// Filters for different dimensions are ANDed, filters for the same
	// dimension are grouped together and ORed.
	DimensionFilters []*DimensionValue `json:"dimensionFilters,omitempty"`

	// Dimensions: The list of dimensions the report should include.
	Dimensions []*SortedDimension `json:"dimensions,omitempty"`

	// MetricNames: The list of names of metrics the report should include.
	MetricNames []string `json:"metricNames,omitempty"`
}

type ReportCriteriaActivities 

type ReportCriteriaActivities struct {
	// Filters: List of activity filters. The dimension values need to be
	// all either of type "dfa:activity" or "dfa:activityGroup".
	Filters []*DimensionValue `json:"filters,omitempty"`

	// MetricNames: List of names of floodlight activity metrics.
	MetricNames []string `json:"metricNames,omitempty"`
}

type ReportCriteriaCustomRichMediaEvents 

type ReportCriteriaCustomRichMediaEvents struct {
	// FilteredEventIds: List of custom rich media event IDs. Dimension
	// values must be all of type dfa:richMediaEventTypeIdAndName.
	FilteredEventIds []*DimensionValue `json:"filteredEventIds,omitempty"`
}

type ReportCriteriaDateRange 

type ReportCriteriaDateRange struct {
	// EndDate: The end date of the date range, inclusive. A string of the
	// format: "yyyy-MM-dd".
	EndDate string `json:"endDate,omitempty"`

	// RelativeDateRange: The date range relative to the date of when the
	// report is run, one of:
	// - "TODAY"
	// - "YESTERDAY"
	// - "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"
	// - "LAST_24_MONTHS"
	RelativeDateRange string `json:"relativeDateRange,omitempty"`

	// StartDate: The start date of the date range, inclusive. A string of
	// the format: "yyyy-MM-dd".
	StartDate string `json:"startDate,omitempty"`
}

type ReportList 

type ReportList struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// Items: The reports returned in this response.
	Items []*Report `json:"items,omitempty"`

	// Kind: Kind of list this is, in this case dfareporting#reportList.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: Continuation token used to page through reports. To
	// retrieve the next page of results, set the next request's "pageToken"
	// to the value of this field. The page token is only valid for a
	// limited amount of time and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type ReportSchedule 

type ReportSchedule struct {
	// Active: Whether the schedule is active or not. Must be set to either
	// true or false.
	Active bool `json:"active,omitempty"`

	// Every: Defines every how many days, weeks or months the report should
	// be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or
	// "MONTHLY".
	Every int64 `json:"every,omitempty"`

	// ExpirationDate: The expiration date when the scheduled report stops
	// running.
	ExpirationDate string `json:"expirationDate,omitempty"`

	// Repeats: The interval the report is repeated for, one of:
	// -
	// "DAILY", also requires field "every" to be set.
	// - "WEEKLY", also
	// requires fields "every" and "repeatsOnWeekDays" to be set.
	// -
	// "TWICE_A_MONTH"
	// - "MONTHLY", also requires fields "every" and
	// "runsOnDayOfMonth" to be set.
	// - "QUARTERLY"
	// - "YEARLY"
	Repeats string `json:"repeats,omitempty"`

	// RepeatsOnWeekDays: List of week days "WEEKLY" scheduled reports
	// should run on.
	RepeatsOnWeekDays []string `json:"repeatsOnWeekDays,omitempty"`

	// RunsOnDayOfMonth: Enum to define for "MONTHLY" scheduled reports
	// whether reports should be repeated on the same day of the month as
	// "startDate" or the same day of the week of the month. Possible values
	// are:
	// - DAY_OF_MONTH
	// - WEEK_OF_MONTH
	// Example: If 'startDate' is
	// Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run
	// subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH"
	// would run subsequent reports on the first Monday of the month.
	RunsOnDayOfMonth string `json:"runsOnDayOfMonth,omitempty"`

	// StartDate: Start date of date range for which scheduled reports
	// should be run.
	StartDate string `json:"startDate,omitempty"`
}

type ReportsDeleteCall 

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

func (*ReportsDeleteCall) Do 

func (c *ReportsDeleteCall) Do() error

type ReportsFilesGetCall 

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

func (*ReportsFilesGetCall) Do 

func (c *ReportsFilesGetCall) Do() (*File, error)

type ReportsFilesListCall 

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

func (*ReportsFilesListCall) Do 

func (c *ReportsFilesListCall) Do() (*FileList, error)

func (*ReportsFilesListCall) MaxResults 

func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to return.

func (*ReportsFilesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The value of the nextToken from the previous result page.

func (*ReportsFilesListCall) SortField 

func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall

SortField sets the optional parameter "sortField": The field to sort the list by.

func (*ReportsFilesListCall) SortOrder 

func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall

SortOrder sets the optional parameter "sortOrder": Order of sorted results, default is 'DESCENDING'.

type ReportsFilesService 

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

func NewReportsFilesService 

func NewReportsFilesService(s *Service) *ReportsFilesService

func (*ReportsFilesService) Get 

func (r *ReportsFilesService) Get(profileId int64, reportId int64, fileId int64) *ReportsFilesGetCall

Get: Retrieves a report file.

func (*ReportsFilesService) List 

func (r *ReportsFilesService) List(profileId int64, reportId int64) *ReportsFilesListCall

List: Lists files for a report.

type ReportsGetCall 

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

func (*ReportsGetCall) Do 

func (c *ReportsGetCall) Do() (*Report, error)

type ReportsInsertCall 

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

func (*ReportsInsertCall) Do 

func (c *ReportsInsertCall) Do() (*Report, error)

type ReportsListCall 

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

func (*ReportsListCall) Do 

func (c *ReportsListCall) Do() (*ReportList, error)

func (*ReportsListCall) MaxResults 

func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to return.

func (*ReportsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The value of the nextToken from the previous result page.

func (*ReportsListCall) SortField 

func (c *ReportsListCall) SortField(sortField string) *ReportsListCall

SortField sets the optional parameter "sortField": The field to sort the list by.

func (*ReportsListCall) SortOrder 

func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall

SortOrder sets the optional parameter "sortOrder": Order of sorted results, default is 'DESCENDING'.

type ReportsPatchCall 

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

func (*ReportsPatchCall) Do 

func (c *ReportsPatchCall) Do() (*Report, error)

type ReportsRunCall 

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

func (*ReportsRunCall) Do 

func (c *ReportsRunCall) Do() (*File, error)

func (*ReportsRunCall) Synchronous 

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

Synchronous sets the optional parameter "synchronous": If set and true, tries to run the report synchronously.

type ReportsService 

type ReportsService struct {
	Files *ReportsFilesService
	// contains filtered or unexported fields
}

func NewReportsService 

func NewReportsService(s *Service) *ReportsService

func (*ReportsService) Delete 

func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall

Delete: Deletes a report by its id.

func (*ReportsService) Get 

func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall

Get: Retrieves a report by its id.

func (*ReportsService) Insert 

func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall

Insert: Creates a report.

func (*ReportsService) List 

func (r *ReportsService) List(profileId int64) *ReportsListCall

List: Retrieves list of reports.

func (*ReportsService) Patch 

func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall

Patch: Updates a report. This method supports patch semantics.

func (*ReportsService) Run 

func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall

Run: Runs a report.

func (*ReportsService) Update 

func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall

Update: Updates a report.

type ReportsUpdateCall 

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

func (*ReportsUpdateCall) Do 

func (c *ReportsUpdateCall) Do() (*Report, error)

type Service 

type Service struct {
	BasePath string // API endpoint base URL

	DimensionValues *DimensionValuesService

	Files *FilesService

	Reports *ReportsService

	UserProfiles *UserProfilesService
	// contains filtered or unexported fields
}

func New 

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

type SortedDimension 

type SortedDimension struct {
	// Kind: Kind of resource this is, in this case
	// dfareporting#sortedDimension.
	Kind string `json:"kind,omitempty"`

	// Name: The name of the dimension.
	Name string `json:"name,omitempty"`

	// SortOrder: An optional sort order for the dimension column, one of:
	//
	// - "ASCENDING"
	// - "DESCENDING"
	SortOrder string `json:"sortOrder,omitempty"`
}

type UserProfile 

type UserProfile struct {
	// AccountId: The account ID this profile belongs to.
	AccountId int64 `json:"accountId,omitempty,string"`

	// AccountName: The account name this profile belongs to.
	AccountName string `json:"accountName,omitempty"`

	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// Kind: Kind of resource this is, in this case
	// dfareporting#userProfile.
	Kind string `json:"kind,omitempty"`

	// ProfileId: The unique ID of the user profile.
	ProfileId int64 `json:"profileId,omitempty,string"`

	// SubAccountId: The sub account ID this profile belongs to if
	// applicable.
	SubAccountId int64 `json:"subAccountId,omitempty,string"`

	// SubAccountName: The sub account name this profile belongs to if
	// applicable.
	SubAccountName string `json:"subAccountName,omitempty"`

	// UserName: The user name.
	UserName string `json:"userName,omitempty"`
}

type UserProfileList 

type UserProfileList struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `json:"etag,omitempty"`

	// Items: The user profiles returned in this response.
	Items []*UserProfile `json:"items,omitempty"`

	// Kind: Kind of list this is, in this case
	// dfareporting#userProfileList.
	Kind string `json:"kind,omitempty"`
}

type UserProfilesGetCall 

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

func (*UserProfilesGetCall) Do 

func (c *UserProfilesGetCall) Do() (*UserProfile, error)

type UserProfilesListCall 

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

func (*UserProfilesListCall) Do 

func (c *UserProfilesListCall) Do() (*UserProfileList, error)

type UserProfilesService 

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

func NewUserProfilesService 

func NewUserProfilesService(s *Service) *UserProfilesService

func (*UserProfilesService) Get 

func (r *UserProfilesService) Get(profileId int64) *UserProfilesGetCall

Get: Gets one user profile by id.

func (*UserProfilesService) List 

func (r *UserProfilesService) List() *UserProfilesListCall

List: Retrieves list of user profiles for a user.

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.