Documentation ¶
Overview ¶
Package dfareporting provides access to the DFA Reporting API.
See https://developers.google.com/doubleclick-advertisers/reporting/
Usage example:
import "google.golang.org/api/dfareporting/v1" ... dfareportingService, err := dfareporting.New(oauthHttpClient)
Index ¶
- Constants
- type DimensionFilter
- type DimensionValue
- type DimensionValueList
- type DimensionValueRequest
- type DimensionValuesQueryCall
- func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall
- func (c *DimensionValuesQueryCall) Do(opts ...googleapi.CallOption) (*DimensionValueList, error)
- func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall
- func (c *DimensionValuesQueryCall) MaxResults(maxResults int64) *DimensionValuesQueryCall
- func (c *DimensionValuesQueryCall) PageToken(pageToken string) *DimensionValuesQueryCall
- type DimensionValuesService
- type File
- type FileDateRange
- type FileList
- type FileUrls
- type FileUrlsCsv
- type FilesListCall
- func (c *FilesListCall) Context(ctx context.Context) *FilesListCall
- func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error)
- func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall
- func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall
- func (c *FilesListCall) MaxResults(maxResults int64) *FilesListCall
- func (c *FilesListCall) PageToken(pageToken string) *FilesListCall
- func (c *FilesListCall) Pages(ctx context.Context, f func(*FileList) error) error
- func (c *FilesListCall) SortField(sortField string) *FilesListCall
- func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall
- type FilesService
- type Report
- type ReportCriteria
- type ReportCriteriaActivities
- type ReportCriteriaCustomRichMediaEvents
- type ReportCriteriaDateRange
- type ReportList
- type ReportSchedule
- type ReportsDeleteCall
- type ReportsFilesGetCall
- func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall
- func (c *ReportsFilesGetCall) Do(opts ...googleapi.CallOption) (*File, error)
- func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall
- func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall
- type ReportsFilesListCall
- func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall
- func (c *ReportsFilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error)
- func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall
- func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall
- func (c *ReportsFilesListCall) MaxResults(maxResults int64) *ReportsFilesListCall
- func (c *ReportsFilesListCall) PageToken(pageToken string) *ReportsFilesListCall
- func (c *ReportsFilesListCall) Pages(ctx context.Context, f func(*FileList) error) error
- func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall
- func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall
- type ReportsFilesService
- type ReportsGetCall
- type ReportsInsertCall
- type ReportsListCall
- func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall
- func (c *ReportsListCall) Do(opts ...googleapi.CallOption) (*ReportList, error)
- func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall
- func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall
- func (c *ReportsListCall) MaxResults(maxResults int64) *ReportsListCall
- func (c *ReportsListCall) PageToken(pageToken string) *ReportsListCall
- func (c *ReportsListCall) Pages(ctx context.Context, f func(*ReportList) error) error
- func (c *ReportsListCall) SortField(sortField string) *ReportsListCall
- func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall
- type ReportsPatchCall
- type ReportsRunCall
- type ReportsService
- func (r *ReportsService) Delete(profileId int64, reportId int64) *ReportsDeleteCall
- func (r *ReportsService) Get(profileId int64, reportId int64) *ReportsGetCall
- func (r *ReportsService) Insert(profileId int64, report *Report) *ReportsInsertCall
- func (r *ReportsService) List(profileId int64) *ReportsListCall
- func (r *ReportsService) Patch(profileId int64, reportId int64, report *Report) *ReportsPatchCall
- func (r *ReportsService) Run(profileId int64, reportId int64) *ReportsRunCall
- func (r *ReportsService) Update(profileId int64, reportId int64, report *Report) *ReportsUpdateCall
- type ReportsUpdateCall
- type Service
- type SortedDimension
- type UserProfile
- type UserProfileList
- type UserProfilesGetCall
- func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall
- func (c *UserProfilesGetCall) Do(opts ...googleapi.CallOption) (*UserProfile, error)
- func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall
- func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall
- type UserProfilesListCall
- func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall
- func (c *UserProfilesListCall) Do(opts ...googleapi.CallOption) (*UserProfileList, error)
- func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall
- func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall
- type UserProfilesService
Constants ¶
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"` // ForceSendFields is a list of field names (e.g. "DimensionName") to // unconditionally include in API requests. By default, fields with // empty 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. "DimensionName") 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:"-"` }
DimensionFilter: Represents a dimension filter.
func (*DimensionFilter) MarshalJSON ¶
func (s *DimensionFilter) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "DimensionName") to // unconditionally include in API requests. By default, fields with // empty 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. "DimensionName") 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:"-"` }
DimensionValue: Represents a DimensionValue resource.
func (*DimensionValue) MarshalJSON ¶
func (s *DimensionValue) MarshalJSON() ([]byte, error)
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty 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. "Etag") 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:"-"` }
DimensionValueList: Represents the list of DimensionValue resources.
func (*DimensionValueList) MarshalJSON ¶
func (s *DimensionValueList) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "DimensionName") to // unconditionally include in API requests. By default, fields with // empty 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. "DimensionName") 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:"-"` }
DimensionValueRequest: Represents a DimensionValuesRequest.
func (*DimensionValueRequest) MarshalJSON ¶
func (s *DimensionValueRequest) MarshalJSON() ([]byte, error)
type DimensionValuesQueryCall ¶
type DimensionValuesQueryCall struct {
// contains filtered or unexported fields
}
func (*DimensionValuesQueryCall) Context ¶
func (c *DimensionValuesQueryCall) Context(ctx context.Context) *DimensionValuesQueryCall
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 (*DimensionValuesQueryCall) Do ¶
func (c *DimensionValuesQueryCall) Do(opts ...googleapi.CallOption) (*DimensionValueList, error)
Do executes the "dfareporting.dimensionValues.query" call. Exactly one of *DimensionValueList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DimensionValueList.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 (*DimensionValuesQueryCall) Fields ¶
func (c *DimensionValuesQueryCall) Fields(s ...googleapi.Field) *DimensionValuesQueryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DateRange") to // unconditionally include in API requests. By default, fields with // empty 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. "DateRange") 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:"-"` }
File: Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
func (*File) MarshalJSON ¶
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"` // ForceSendFields is a list of field names (e.g. "EndDate") to // unconditionally include in API requests. By default, fields with // empty 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:"-"` }
FileDateRange: The date range for which the file has report data.
func (*FileDateRange) MarshalJSON ¶
func (s *FileDateRange) MarshalJSON() ([]byte, error)
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty 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. "Etag") 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:"-"` }
FileList: Represents the list of File resources.
func (*FileList) MarshalJSON ¶
type FileUrls ¶
type FileUrls struct { // Csv: Urls for generated CSV data. Csv *FileUrlsCsv `json:"csv,omitempty"` // ForceSendFields is a list of field names (e.g. "Csv") to // unconditionally include in API requests. By default, fields with // empty 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. "Csv") 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:"-"` }
FileUrls: The urls where the completed report file can be downloaded.
func (*FileUrls) MarshalJSON ¶
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"` // ForceSendFields is a list of field names (e.g. "ApiUrl") to // unconditionally include in API requests. By default, fields with // empty 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. "ApiUrl") 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:"-"` }
FileUrlsCsv: Urls for generated CSV data.
func (*FileUrlsCsv) MarshalJSON ¶
func (s *FileUrlsCsv) MarshalJSON() ([]byte, error)
type FilesListCall ¶
type FilesListCall struct {
// contains filtered or unexported fields
}
func (*FilesListCall) Context ¶
func (c *FilesListCall) Context(ctx context.Context) *FilesListCall
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 (*FilesListCall) Do ¶
func (c *FilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error)
Do executes the "dfareporting.files.list" call. Exactly one of *FileList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FileList.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 (*FilesListCall) Fields ¶
func (c *FilesListCall) Fields(s ...googleapi.Field) *FilesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*FilesListCall) IfNoneMatch ¶
func (c *FilesListCall) IfNoneMatch(entityTag string) *FilesListCall
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 (*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) Pages ¶
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.
func (*FilesListCall) SortField ¶
func (c *FilesListCall) SortField(sortField string) *FilesListCall
SortField sets the optional parameter "sortField": The field to sort the list by.
Possible values:
"ID" - Sort by file id. "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
func (*FilesListCall) SortOrder ¶
func (c *FilesListCall) SortOrder(sortOrder string) *FilesListCall
SortOrder sets the optional parameter "sortOrder": Order of sorted results, default is 'DESCENDING'.
Possible values:
"ASCENDING" - Ascending order. "DESCENDING" (default) - Descending order.
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AccountId") to // unconditionally include in API requests. By default, fields with // empty 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. "AccountId") 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 resource.
func (*Report) MarshalJSON ¶
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"` // ForceSendFields is a list of field names (e.g. "Activities") to // unconditionally include in API requests. By default, fields with // empty 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. "Activities") 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:"-"` }
ReportCriteria: The report criteria.
func (*ReportCriteria) MarshalJSON ¶
func (s *ReportCriteria) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "Filters") to // unconditionally include in API requests. By default, fields with // empty 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:"-"` }
ReportCriteriaActivities: Activity group.
func (*ReportCriteriaActivities) MarshalJSON ¶
func (s *ReportCriteriaActivities) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "FilteredEventIds") to // unconditionally include in API requests. By default, fields with // empty 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. "FilteredEventIds") 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:"-"` }
ReportCriteriaCustomRichMediaEvents: Custom Rich Media Events group.
func (*ReportCriteriaCustomRichMediaEvents) MarshalJSON ¶
func (s *ReportCriteriaCustomRichMediaEvents) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "EndDate") to // unconditionally include in API requests. By default, fields with // empty 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:"-"` }
ReportCriteriaDateRange: The date range this report should be run for.
func (*ReportCriteriaDateRange) MarshalJSON ¶
func (s *ReportCriteriaDateRange) MarshalJSON() ([]byte, error)
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty 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. "Etag") 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:"-"` }
ReportList: Represents the list of reports.
func (*ReportList) MarshalJSON ¶
func (s *ReportList) MarshalJSON() ([]byte, error)
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"` // ForceSendFields is a list of field names (e.g. "Active") to // unconditionally include in API requests. By default, fields with // empty 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. "Active") 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:"-"` }
ReportSchedule: 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".
func (*ReportSchedule) MarshalJSON ¶
func (s *ReportSchedule) MarshalJSON() ([]byte, error)
type ReportsDeleteCall ¶
type ReportsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ReportsDeleteCall) Context ¶
func (c *ReportsDeleteCall) Context(ctx context.Context) *ReportsDeleteCall
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 (*ReportsDeleteCall) Do ¶
func (c *ReportsDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "dfareporting.reports.delete" call.
func (*ReportsDeleteCall) Fields ¶
func (c *ReportsDeleteCall) Fields(s ...googleapi.Field) *ReportsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ReportsFilesGetCall ¶
type ReportsFilesGetCall struct {
// contains filtered or unexported fields
}
func (*ReportsFilesGetCall) Context ¶
func (c *ReportsFilesGetCall) Context(ctx context.Context) *ReportsFilesGetCall
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 (*ReportsFilesGetCall) Do ¶
func (c *ReportsFilesGetCall) Do(opts ...googleapi.CallOption) (*File, error)
Do executes the "dfareporting.reports.files.get" call. Exactly one of *File or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *File.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 (*ReportsFilesGetCall) Fields ¶
func (c *ReportsFilesGetCall) Fields(s ...googleapi.Field) *ReportsFilesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ReportsFilesGetCall) IfNoneMatch ¶
func (c *ReportsFilesGetCall) IfNoneMatch(entityTag string) *ReportsFilesGetCall
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 ReportsFilesListCall ¶
type ReportsFilesListCall struct {
// contains filtered or unexported fields
}
func (*ReportsFilesListCall) Context ¶
func (c *ReportsFilesListCall) Context(ctx context.Context) *ReportsFilesListCall
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 (*ReportsFilesListCall) Do ¶
func (c *ReportsFilesListCall) Do(opts ...googleapi.CallOption) (*FileList, error)
Do executes the "dfareporting.reports.files.list" call. Exactly one of *FileList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FileList.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 (*ReportsFilesListCall) Fields ¶
func (c *ReportsFilesListCall) Fields(s ...googleapi.Field) *ReportsFilesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ReportsFilesListCall) IfNoneMatch ¶
func (c *ReportsFilesListCall) IfNoneMatch(entityTag string) *ReportsFilesListCall
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 (*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) Pages ¶
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.
func (*ReportsFilesListCall) SortField ¶
func (c *ReportsFilesListCall) SortField(sortField string) *ReportsFilesListCall
SortField sets the optional parameter "sortField": The field to sort the list by.
Possible values:
"ID" - Sort by file id. "LAST_MODIFIED_TIME" (default) - Sort by 'lastmodifiedAt' field.
func (*ReportsFilesListCall) SortOrder ¶
func (c *ReportsFilesListCall) SortOrder(sortOrder string) *ReportsFilesListCall
SortOrder sets the optional parameter "sortOrder": Order of sorted results, default is 'DESCENDING'.
Possible values:
"ASCENDING" - Ascending order. "DESCENDING" (default) - Descending order.
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) Context ¶
func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall
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 (*ReportsGetCall) Do ¶
func (c *ReportsGetCall) Do(opts ...googleapi.CallOption) (*Report, error)
Do executes the "dfareporting.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 (*ReportsGetCall) Fields ¶
func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ReportsGetCall) IfNoneMatch ¶
func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall
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 ReportsInsertCall ¶
type ReportsInsertCall struct {
// contains filtered or unexported fields
}
func (*ReportsInsertCall) Context ¶
func (c *ReportsInsertCall) Context(ctx context.Context) *ReportsInsertCall
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 (*ReportsInsertCall) Do ¶
func (c *ReportsInsertCall) Do(opts ...googleapi.CallOption) (*Report, error)
Do executes the "dfareporting.reports.insert" 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 (*ReportsInsertCall) Fields ¶
func (c *ReportsInsertCall) Fields(s ...googleapi.Field) *ReportsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ReportsListCall ¶
type ReportsListCall struct {
// contains filtered or unexported fields
}
func (*ReportsListCall) Context ¶
func (c *ReportsListCall) Context(ctx context.Context) *ReportsListCall
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 (*ReportsListCall) Do ¶
func (c *ReportsListCall) Do(opts ...googleapi.CallOption) (*ReportList, error)
Do executes the "dfareporting.reports.list" call. Exactly one of *ReportList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReportList.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 (*ReportsListCall) Fields ¶
func (c *ReportsListCall) Fields(s ...googleapi.Field) *ReportsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ReportsListCall) IfNoneMatch ¶
func (c *ReportsListCall) IfNoneMatch(entityTag string) *ReportsListCall
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 (*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) Pages ¶
func (c *ReportsListCall) Pages(ctx context.Context, f func(*ReportList) 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.
func (*ReportsListCall) SortField ¶
func (c *ReportsListCall) SortField(sortField string) *ReportsListCall
SortField sets the optional parameter "sortField": The field to sort the list by.
Possible values:
"ID" - Sort by report id. "LAST_MODIFIED_TIME" (default) - Sort by 'lastModifiedTime' field. "NAME" - Sort by display name of reports.
func (*ReportsListCall) SortOrder ¶
func (c *ReportsListCall) SortOrder(sortOrder string) *ReportsListCall
SortOrder sets the optional parameter "sortOrder": Order of sorted results, default is 'DESCENDING'.
Possible values:
"ASCENDING" - Ascending order. "DESCENDING" (default) - Descending order.
type ReportsPatchCall ¶
type ReportsPatchCall struct {
// contains filtered or unexported fields
}
func (*ReportsPatchCall) Context ¶
func (c *ReportsPatchCall) Context(ctx context.Context) *ReportsPatchCall
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 (*ReportsPatchCall) Do ¶
func (c *ReportsPatchCall) Do(opts ...googleapi.CallOption) (*Report, error)
Do executes the "dfareporting.reports.patch" 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 (*ReportsPatchCall) Fields ¶
func (c *ReportsPatchCall) Fields(s ...googleapi.Field) *ReportsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ReportsRunCall ¶
type ReportsRunCall struct {
// contains filtered or unexported fields
}
func (*ReportsRunCall) Context ¶
func (c *ReportsRunCall) Context(ctx context.Context) *ReportsRunCall
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 (*ReportsRunCall) Do ¶
func (c *ReportsRunCall) Do(opts ...googleapi.CallOption) (*File, error)
Do executes the "dfareporting.reports.run" call. Exactly one of *File or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *File.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 (*ReportsRunCall) Fields ¶
func (c *ReportsRunCall) Fields(s ...googleapi.Field) *ReportsRunCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
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) Context ¶
func (c *ReportsUpdateCall) Context(ctx context.Context) *ReportsUpdateCall
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 (*ReportsUpdateCall) Do ¶
func (c *ReportsUpdateCall) Do(opts ...googleapi.CallOption) (*Report, error)
Do executes the "dfareporting.reports.update" 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 (*ReportsUpdateCall) Fields ¶
func (c *ReportsUpdateCall) Fields(s ...googleapi.Field) *ReportsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment DimensionValues *DimensionValuesService Files *FilesService Reports *ReportsService UserProfiles *UserProfilesService // contains filtered or unexported fields }
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"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty 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. "Kind") 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:"-"` }
SortedDimension: Represents a sorted dimension.
func (*SortedDimension) MarshalJSON ¶
func (s *SortedDimension) MarshalJSON() ([]byte, error)
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AccountId") to // unconditionally include in API requests. By default, fields with // empty 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. "AccountId") 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:"-"` }
UserProfile: Represents a UserProfile resource.
func (*UserProfile) MarshalJSON ¶
func (s *UserProfile) MarshalJSON() ([]byte, error)
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"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty 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. "Etag") 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:"-"` }
UserProfileList: Represents the list of user profiles.
func (*UserProfileList) MarshalJSON ¶
func (s *UserProfileList) MarshalJSON() ([]byte, error)
type UserProfilesGetCall ¶
type UserProfilesGetCall struct {
// contains filtered or unexported fields
}
func (*UserProfilesGetCall) Context ¶
func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall
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 (*UserProfilesGetCall) Do ¶
func (c *UserProfilesGetCall) Do(opts ...googleapi.CallOption) (*UserProfile, error)
Do executes the "dfareporting.userProfiles.get" call. Exactly one of *UserProfile or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UserProfile.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 (*UserProfilesGetCall) Fields ¶
func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*UserProfilesGetCall) IfNoneMatch ¶
func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall
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 UserProfilesListCall ¶
type UserProfilesListCall struct {
// contains filtered or unexported fields
}
func (*UserProfilesListCall) Context ¶
func (c *UserProfilesListCall) Context(ctx context.Context) *UserProfilesListCall
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 (*UserProfilesListCall) Do ¶
func (c *UserProfilesListCall) Do(opts ...googleapi.CallOption) (*UserProfileList, error)
Do executes the "dfareporting.userProfiles.list" call. Exactly one of *UserProfileList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UserProfileList.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 (*UserProfilesListCall) Fields ¶
func (c *UserProfilesListCall) Fields(s ...googleapi.Field) *UserProfilesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*UserProfilesListCall) IfNoneMatch ¶
func (c *UserProfilesListCall) IfNoneMatch(entityTag string) *UserProfilesListCall
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 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.