doubleclicksearch
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package doubleclicksearch provides access to the Search Ads 360 API.
For product documentation, see:https://developers.google.com/search-ads
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/doubleclicksearch/v2"...ctx := context.Background()doubleclicksearchService, err := doubleclicksearch.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
doubleclicksearchService, err := doubleclicksearch.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)doubleclicksearchService, err := doubleclicksearch.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type Availability
- type Conversion
- type ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) AdGroupId(adGroupId int64) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) AdId(adId int64) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) AdvertiserId(advertiserId int64) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) AgencyId(agencyId int64) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) CampaignId(campaignId int64) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) Context(ctx context.Context) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) CriterionId(criterionId int64) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) Do(opts ...googleapi.CallOption) (*ConversionList, error)
- func (c *ConversionGetByCustomerIdCall) EngineAccountId(engineAccountId int64) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) Fields(s ...googleapi.Field) *ConversionGetByCustomerIdCall
- func (c *ConversionGetByCustomerIdCall) Header() http.Header
- func (c *ConversionGetByCustomerIdCall) IfNoneMatch(entityTag string) *ConversionGetByCustomerIdCall
- type ConversionGetCall
- func (c *ConversionGetCall) AdGroupId(adGroupId int64) *ConversionGetCall
- func (c *ConversionGetCall) AdId(adId int64) *ConversionGetCall
- func (c *ConversionGetCall) CampaignId(campaignId int64) *ConversionGetCall
- func (c *ConversionGetCall) Context(ctx context.Context) *ConversionGetCall
- func (c *ConversionGetCall) CriterionId(criterionId int64) *ConversionGetCall
- func (c *ConversionGetCall) CustomerId(customerId string) *ConversionGetCall
- func (c *ConversionGetCall) Do(opts ...googleapi.CallOption) (*ConversionList, error)
- func (c *ConversionGetCall) Fields(s ...googleapi.Field) *ConversionGetCall
- func (c *ConversionGetCall) Header() http.Header
- func (c *ConversionGetCall) IfNoneMatch(entityTag string) *ConversionGetCall
- type ConversionInsertCall
- func (c *ConversionInsertCall) Context(ctx context.Context) *ConversionInsertCall
- func (c *ConversionInsertCall) Do(opts ...googleapi.CallOption) (*ConversionList, error)
- func (c *ConversionInsertCall) Fields(s ...googleapi.Field) *ConversionInsertCall
- func (c *ConversionInsertCall) Header() http.Header
- type ConversionList
- type ConversionService
- func (r *ConversionService) Get(agencyId int64, advertiserId int64, engineAccountId int64, endDate int64, ...) *ConversionGetCall
- func (r *ConversionService) GetByCustomerId(customerId string, endDate int64, rowCount int64, startDate int64, ...) *ConversionGetByCustomerIdCall
- func (r *ConversionService) Insert(conversionlist *ConversionList) *ConversionInsertCall
- func (r *ConversionService) Update(conversionlist *ConversionList) *ConversionUpdateCall
- func (r *ConversionService) UpdateAvailability(updateavailabilityrequest *UpdateAvailabilityRequest) *ConversionUpdateAvailabilityCall
- type ConversionUpdateAvailabilityCall
- func (c *ConversionUpdateAvailabilityCall) Context(ctx context.Context) *ConversionUpdateAvailabilityCall
- func (c *ConversionUpdateAvailabilityCall) Do(opts ...googleapi.CallOption) (*UpdateAvailabilityResponse, error)
- func (c *ConversionUpdateAvailabilityCall) Fields(s ...googleapi.Field) *ConversionUpdateAvailabilityCall
- func (c *ConversionUpdateAvailabilityCall) Header() http.Header
- type ConversionUpdateCall
- func (c *ConversionUpdateCall) Context(ctx context.Context) *ConversionUpdateCall
- func (c *ConversionUpdateCall) Do(opts ...googleapi.CallOption) (*ConversionList, error)
- func (c *ConversionUpdateCall) Fields(s ...googleapi.Field) *ConversionUpdateCall
- func (c *ConversionUpdateCall) Header() http.Header
- type CustomDimension
- type CustomMetric
- type IdMappingFile
- type Report
- type ReportApiColumnSpec
- type ReportFiles
- type ReportRequest
- type ReportRequestFilters
- type ReportRequestOrderBy
- type ReportRequestReportScope
- type ReportRequestTimeRange
- type ReportsGenerateCall
- type ReportsGetCall
- func (c *ReportsGetCall) Context(ctx context.Context) *ReportsGetCall
- func (c *ReportsGetCall) Do(opts ...googleapi.CallOption) (*Report, error)
- func (c *ReportsGetCall) Fields(s ...googleapi.Field) *ReportsGetCall
- func (c *ReportsGetCall) Header() http.Header
- func (c *ReportsGetCall) IfNoneMatch(entityTag string) *ReportsGetCall
- type ReportsGetFileCall
- func (c *ReportsGetFileCall) Context(ctx context.Context) *ReportsGetFileCall
- func (c *ReportsGetFileCall) Do(opts ...googleapi.CallOption) error
- func (c *ReportsGetFileCall) Download(opts ...googleapi.CallOption) (*http.Response, error)
- func (c *ReportsGetFileCall) Fields(s ...googleapi.Field) *ReportsGetFileCall
- func (c *ReportsGetFileCall) Header() http.Header
- func (c *ReportsGetFileCall) IfNoneMatch(entityTag string) *ReportsGetFileCall
- type ReportsGetIdMappingFileCall
- func (c *ReportsGetIdMappingFileCall) Context(ctx context.Context) *ReportsGetIdMappingFileCall
- func (c *ReportsGetIdMappingFileCall) Do(opts ...googleapi.CallOption) (*IdMappingFile, error)
- func (c *ReportsGetIdMappingFileCall) Download(opts ...googleapi.CallOption) (*http.Response, error)
- func (c *ReportsGetIdMappingFileCall) Fields(s ...googleapi.Field) *ReportsGetIdMappingFileCall
- func (c *ReportsGetIdMappingFileCall) Header() http.Header
- func (c *ReportsGetIdMappingFileCall) IfNoneMatch(entityTag string) *ReportsGetIdMappingFileCall
- type ReportsRequestCall
- type ReportsService
- func (r *ReportsService) Generate(reportrequest *ReportRequest) *ReportsGenerateCall
- func (r *ReportsService) Get(reportId string) *ReportsGetCall
- func (r *ReportsService) GetFile(reportId string, reportFragment int64) *ReportsGetFileCall
- func (r *ReportsService) GetIdMappingFile(agencyId int64, advertiserId int64) *ReportsGetIdMappingFileCall
- func (r *ReportsService) Request(reportrequest *ReportRequest) *ReportsRequestCall
- type SavedColumn
- type SavedColumnList
- type SavedColumnsListCall
- func (c *SavedColumnsListCall) Context(ctx context.Context) *SavedColumnsListCall
- func (c *SavedColumnsListCall) Do(opts ...googleapi.CallOption) (*SavedColumnList, error)
- func (c *SavedColumnsListCall) Fields(s ...googleapi.Field) *SavedColumnsListCall
- func (c *SavedColumnsListCall) Header() http.Header
- func (c *SavedColumnsListCall) IfNoneMatch(entityTag string) *SavedColumnsListCall
- type SavedColumnsService
- type Service
- type UpdateAvailabilityRequest
- type UpdateAvailabilityResponse
Constants¶
const (// View and manage your advertising data in DoubleClick SearchDoubleclicksearchScope = "https://www.googleapis.com/auth/doubleclicksearch")OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAvailability¶
type Availability struct {// AdvertiserId: DS advertiser ID.AdvertiserIdint64 `json:"advertiserId,omitempty,string"`// AgencyId: DS agency ID.AgencyIdint64 `json:"agencyId,omitempty,string"`// AvailabilityTimestamp: The time by which all conversions have been uploaded,// in epoch millis UTC.AvailabilityTimestampint64 `json:"availabilityTimestamp,omitempty,string"`// CustomerId: Customer ID of a client account in the new Search Ads 360// experience.CustomerIdstring `json:"customerId,omitempty"`// SegmentationId: The numeric segmentation identifier (for example,// DoubleClick Search Floodlight activity ID).SegmentationIdint64 `json:"segmentationId,omitempty,string"`// SegmentationName: The friendly segmentation identifier (for example,// DoubleClick Search Floodlight activity name).SegmentationNamestring `json:"segmentationName,omitempty"`// SegmentationType: The segmentation type that this availability is for (its// default value is `FLOODLIGHT`).SegmentationTypestring `json:"segmentationType,omitempty"`// ForceSendFields is a list of field names (e.g. "AdvertiserId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdvertiserId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Availability: A message containing availability data relevant to DoubleClickSearch.
func (Availability)MarshalJSON¶
func (sAvailability) MarshalJSON() ([]byte,error)
typeConversion¶
type Conversion struct {// AdGroupId: DS ad group ID.AdGroupIdint64 `json:"adGroupId,omitempty,string"`// AdId: DS ad ID.AdIdint64 `json:"adId,omitempty,string"`// AdUserDataConsent: Represents consent for core platform services (CPS)// preferences in settings. No default value. Acceptable values are: GRANTED:// The desired consent status is to grant. Read the CPS preferences from GTE// settings. DENIED: The desired consent status is to deny; CPS list is empty.//// Possible values:// "UNKNOWN" - Not specified.// "GRANTED" - Granted.// "DENIED" - Denied.AdUserDataConsentstring `json:"adUserDataConsent,omitempty"`// AdvertiserId: DS advertiser ID.AdvertiserIdint64 `json:"advertiserId,omitempty,string"`// AgencyId: DS agency ID.AgencyIdint64 `json:"agencyId,omitempty,string"`// AttributionModel: Available to advertisers only after contacting DoubleClick// Search customer support.AttributionModelstring `json:"attributionModel,omitempty"`// CampaignId: DS campaign ID.CampaignIdint64 `json:"campaignId,omitempty,string"`// Channel: Sales channel for the product. Acceptable values are: - "local":// a physical store - "online": an online storeChannelstring `json:"channel,omitempty"`// ClickId: DS click ID for the conversion.ClickIdstring `json:"clickId,omitempty"`// ConversionId: For offline conversions, advertisers provide this ID.// Advertisers can specify any ID that is meaningful to them. Each conversion// in a request must specify a unique ID, and the combination of ID and// timestamp must be unique amongst all conversions within the advertiser. For// online conversions, DS copies the `dsConversionId` or `floodlightOrderId`// into this property depending on the advertiser's Floodlight instructions.ConversionIdstring `json:"conversionId,omitempty"`// ConversionModifiedTimestamp: The time at which the conversion was last// modified, in epoch millis UTC.ConversionModifiedTimestampint64 `json:"conversionModifiedTimestamp,omitempty,string"`// ConversionTimestamp: The time at which the conversion took place, in epoch// millis UTC.ConversionTimestampstring `json:"conversionTimestamp,omitempty"`// CountMillis: Available to advertisers only after contacting DoubleClick// Search customer support.CountMillisint64 `json:"countMillis,omitempty,string"`// CriterionId: DS criterion (keyword) ID.CriterionIdint64 `json:"criterionId,omitempty,string"`// CurrencyCode: The currency code for the conversion's revenue. Should be in// ISO 4217 alphabetic (3-char) format.CurrencyCodestring `json:"currencyCode,omitempty"`// CustomDimension: Custom dimensions for the conversion, which can be used to// filter data in a report.CustomDimension []*CustomDimension `json:"customDimension,omitempty"`// CustomMetric: Custom metrics for the conversion.CustomMetric []*CustomMetric `json:"customMetric,omitempty"`// CustomerId: Customer ID of a client account in the new Search Ads 360// experience.CustomerIdstring `json:"customerId,omitempty"`// DeviceType: The type of device on which the conversion occurred.DeviceTypestring `json:"deviceType,omitempty"`// DsConversionId: ID that DoubleClick Search generates for each conversion.DsConversionIdint64 `json:"dsConversionId,omitempty,string"`// EngineAccountId: DS engine account ID.EngineAccountIdint64 `json:"engineAccountId,omitempty,string"`// FloodlightOrderId: The Floodlight order ID provided by the advertiser for// the conversion.FloodlightOrderIdstring `json:"floodlightOrderId,omitempty"`// InventoryAccountId: ID that DS generates and uses to uniquely identify the// inventory account that contains the product.InventoryAccountIdint64 `json:"inventoryAccountId,omitempty,string"`// ProductCountry: The country registered for the Merchant Center feed that// contains the product. Use an ISO 3166 code to specify a country.ProductCountrystring `json:"productCountry,omitempty"`// ProductGroupId: DS product group ID.ProductGroupIdint64 `json:"productGroupId,omitempty,string"`// ProductId: The product ID (SKU).ProductIdstring `json:"productId,omitempty"`// ProductLanguage: The language registered for the Merchant Center feed that// contains the product. Use an ISO 639 code to specify a language.ProductLanguagestring `json:"productLanguage,omitempty"`// QuantityMillis: The quantity of this conversion, in millis.QuantityMillisint64 `json:"quantityMillis,omitempty,string"`// RevenueMicros: The revenue amount of this `TRANSACTION` conversion, in// micros (value multiplied by 1000000, no decimal). For example, to specify a// revenue value of "10" enter "10000000" (10 million) in your request.RevenueMicrosstring `json:"revenueMicros,omitempty"`// SegmentationId: The numeric segmentation identifier (for example,// DoubleClick Search Floodlight activity ID).SegmentationIdint64 `json:"segmentationId,omitempty,string"`// SegmentationName: The friendly segmentation identifier (for example,// DoubleClick Search Floodlight activity name).SegmentationNamestring `json:"segmentationName,omitempty"`// SegmentationType: The segmentation type of this conversion (for example,// `FLOODLIGHT`).SegmentationTypestring `json:"segmentationType,omitempty"`// State: The state of the conversion, that is, either `ACTIVE` or `REMOVED`.// Note: state DELETED is deprecated.Statestring `json:"state,omitempty"`// StoreId: The ID of the local store for which the product was advertised.// Applicable only when the channel is "local".StoreIdstring `json:"storeId,omitempty"`// Type: The type of the conversion, that is, either `ACTION` or `TRANSACTION`.// An `ACTION` conversion is an action by the user that has no monetarily// quantifiable value, while a `TRANSACTION` conversion is an action that does// have a monetarily quantifiable value. Examples are email list signups// (`ACTION`) versus ecommerce purchases (`TRANSACTION`).Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AdGroupId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdGroupId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Conversion: A conversion containing data relevant to DoubleClick Search.Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33
func (Conversion)MarshalJSON¶
func (sConversion) MarshalJSON() ([]byte,error)
typeConversionGetByCustomerIdCall¶added inv0.104.0
type ConversionGetByCustomerIdCall struct {// contains filtered or unexported fields}func (*ConversionGetByCustomerIdCall)AdGroupId¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) AdGroupId(adGroupIdint64) *ConversionGetByCustomerIdCall
AdGroupId sets the optional parameter "adGroupId": Numeric ID of the adgroup.
func (*ConversionGetByCustomerIdCall)AdId¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) AdId(adIdint64) *ConversionGetByCustomerIdCall
AdId sets the optional parameter "adId": Numeric ID of the ad.
func (*ConversionGetByCustomerIdCall)AdvertiserId¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) AdvertiserId(advertiserIdint64) *ConversionGetByCustomerIdCall
AdvertiserId sets the optional parameter "advertiserId": Numeric ID of theadvertiser.
func (*ConversionGetByCustomerIdCall)AgencyId¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) AgencyId(agencyIdint64) *ConversionGetByCustomerIdCall
AgencyId sets the optional parameter "agencyId": Numeric ID of the agency.
func (*ConversionGetByCustomerIdCall)CampaignId¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) CampaignId(campaignIdint64) *ConversionGetByCustomerIdCall
CampaignId sets the optional parameter "campaignId": Numeric ID of thecampaign.
func (*ConversionGetByCustomerIdCall)Context¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) Context(ctxcontext.Context) *ConversionGetByCustomerIdCall
Context sets the context to be used in this call's Do method.
func (*ConversionGetByCustomerIdCall)CriterionId¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) CriterionId(criterionIdint64) *ConversionGetByCustomerIdCall
CriterionId sets the optional parameter "criterionId": Numeric ID of thecriterion.
func (*ConversionGetByCustomerIdCall)Do¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) Do(opts ...googleapi.CallOption) (*ConversionList,error)
Do executes the "doubleclicksearch.conversion.getByCustomerId" call.Any non-2xx status code is an error. Response headers are in either*ConversionList.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ConversionGetByCustomerIdCall)EngineAccountId¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) EngineAccountId(engineAccountIdint64) *ConversionGetByCustomerIdCall
EngineAccountId sets the optional parameter "engineAccountId": Numeric ID ofthe engine account.
func (*ConversionGetByCustomerIdCall)Fields¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) Fields(s ...googleapi.Field) *ConversionGetByCustomerIdCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ConversionGetByCustomerIdCall)Header¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ConversionGetByCustomerIdCall)IfNoneMatch¶added inv0.104.0
func (c *ConversionGetByCustomerIdCall) IfNoneMatch(entityTagstring) *ConversionGetByCustomerIdCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeConversionGetCall¶
type ConversionGetCall struct {// contains filtered or unexported fields}func (*ConversionGetCall)AdGroupId¶
func (c *ConversionGetCall) AdGroupId(adGroupIdint64) *ConversionGetCall
AdGroupId sets the optional parameter "adGroupId": Numeric ID of the adgroup.
func (*ConversionGetCall)AdId¶
func (c *ConversionGetCall) AdId(adIdint64) *ConversionGetCall
AdId sets the optional parameter "adId": Numeric ID of the ad.
func (*ConversionGetCall)CampaignId¶
func (c *ConversionGetCall) CampaignId(campaignIdint64) *ConversionGetCall
CampaignId sets the optional parameter "campaignId": Numeric ID of thecampaign.
func (*ConversionGetCall)Context¶
func (c *ConversionGetCall) Context(ctxcontext.Context) *ConversionGetCall
Context sets the context to be used in this call's Do method.
func (*ConversionGetCall)CriterionId¶
func (c *ConversionGetCall) CriterionId(criterionIdint64) *ConversionGetCall
CriterionId sets the optional parameter "criterionId": Numeric ID of thecriterion.
func (*ConversionGetCall)CustomerId¶added inv0.102.0
func (c *ConversionGetCall) CustomerId(customerIdstring) *ConversionGetCall
CustomerId sets the optional parameter "customerId": Customer ID of a clientaccount in the new Search Ads 360 experience.
func (*ConversionGetCall)Do¶
func (c *ConversionGetCall) Do(opts ...googleapi.CallOption) (*ConversionList,error)
Do executes the "doubleclicksearch.conversion.get" call.Any non-2xx status code is an error. Response headers are in either*ConversionList.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ConversionGetCall)Fields¶
func (c *ConversionGetCall) Fields(s ...googleapi.Field) *ConversionGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ConversionGetCall)Header¶
func (c *ConversionGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ConversionGetCall)IfNoneMatch¶
func (c *ConversionGetCall) IfNoneMatch(entityTagstring) *ConversionGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeConversionInsertCall¶
type ConversionInsertCall struct {// contains filtered or unexported fields}func (*ConversionInsertCall)Context¶
func (c *ConversionInsertCall) Context(ctxcontext.Context) *ConversionInsertCall
Context sets the context to be used in this call's Do method.
func (*ConversionInsertCall)Do¶
func (c *ConversionInsertCall) Do(opts ...googleapi.CallOption) (*ConversionList,error)
Do executes the "doubleclicksearch.conversion.insert" call.Any non-2xx status code is an error. Response headers are in either*ConversionList.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ConversionInsertCall)Fields¶
func (c *ConversionInsertCall) Fields(s ...googleapi.Field) *ConversionInsertCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ConversionInsertCall)Header¶
func (c *ConversionInsertCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeConversionList¶
type ConversionList struct {// Conversion: The conversions being requested.Conversion []*Conversion `json:"conversion,omitempty"`// Kind: Identifies this as a ConversionList resource. Value: the fixed string// doubleclicksearch#conversionList.Kindstring `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. "Conversion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Conversion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ConversionList: A list of conversions.
func (ConversionList)MarshalJSON¶
func (sConversionList) MarshalJSON() ([]byte,error)
typeConversionService¶
type ConversionService struct {// contains filtered or unexported fields}funcNewConversionService¶
func NewConversionService(s *Service) *ConversionService
func (*ConversionService)Get¶
func (r *ConversionService) Get(agencyIdint64, advertiserIdint64, engineAccountIdint64, endDateint64, rowCountint64, startDateint64, startRowint64) *ConversionGetCall
Get: Retrieves a list of conversions from a DoubleClick Search engineaccount.
- advertiserId: Numeric ID of the advertiser.
- agencyId: Numeric ID of the agency.
- endDate: Last date (inclusive) on which to retrieve conversions. Format isyyyymmdd.
- engineAccountId: Numeric ID of the engine account.
- rowCount: The number of conversions to return per call.
- startDate: First date (inclusive) on which to retrieve conversions. Formatis yyyymmdd.
- startRow: The 0-based starting index for retrieving conversions results.
func (*ConversionService)GetByCustomerId¶added inv0.104.0
func (r *ConversionService) GetByCustomerId(customerIdstring, endDateint64, rowCountint64, startDateint64, startRowint64) *ConversionGetByCustomerIdCall
GetByCustomerId: Retrieves a list of conversions from a DoubleClick Searchengine account.
- customerId: Customer ID of a client account in the new Search Ads 360experience.
- endDate: Last date (inclusive) on which to retrieve conversions. Format isyyyymmdd.
- rowCount: The number of conversions to return per call.
- startDate: First date (inclusive) on which to retrieve conversions. Formatis yyyymmdd.
- startRow: The 0-based starting index for retrieving conversions results.
func (*ConversionService)Insert¶
func (r *ConversionService) Insert(conversionlist *ConversionList) *ConversionInsertCall
Insert: Inserts a batch of new conversions into DoubleClick Search.
func (*ConversionService)Update¶
func (r *ConversionService) Update(conversionlist *ConversionList) *ConversionUpdateCall
Update: Updates a batch of conversions in DoubleClick Search.
func (*ConversionService)UpdateAvailability¶
func (r *ConversionService) UpdateAvailability(updateavailabilityrequest *UpdateAvailabilityRequest) *ConversionUpdateAvailabilityCall
UpdateAvailability: Updates the availabilities of a batch of floodlightactivities in DoubleClick Search.
typeConversionUpdateAvailabilityCall¶
type ConversionUpdateAvailabilityCall struct {// contains filtered or unexported fields}func (*ConversionUpdateAvailabilityCall)Context¶
func (c *ConversionUpdateAvailabilityCall) Context(ctxcontext.Context) *ConversionUpdateAvailabilityCall
Context sets the context to be used in this call's Do method.
func (*ConversionUpdateAvailabilityCall)Do¶
func (c *ConversionUpdateAvailabilityCall) Do(opts ...googleapi.CallOption) (*UpdateAvailabilityResponse,error)
Do executes the "doubleclicksearch.conversion.updateAvailability" call.Any non-2xx status code is an error. Response headers are in either*UpdateAvailabilityResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*ConversionUpdateAvailabilityCall)Fields¶
func (c *ConversionUpdateAvailabilityCall) Fields(s ...googleapi.Field) *ConversionUpdateAvailabilityCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ConversionUpdateAvailabilityCall)Header¶
func (c *ConversionUpdateAvailabilityCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeConversionUpdateCall¶
type ConversionUpdateCall struct {// contains filtered or unexported fields}func (*ConversionUpdateCall)Context¶
func (c *ConversionUpdateCall) Context(ctxcontext.Context) *ConversionUpdateCall
Context sets the context to be used in this call's Do method.
func (*ConversionUpdateCall)Do¶
func (c *ConversionUpdateCall) Do(opts ...googleapi.CallOption) (*ConversionList,error)
Do executes the "doubleclicksearch.conversion.update" call.Any non-2xx status code is an error. Response headers are in either*ConversionList.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ConversionUpdateCall)Fields¶
func (c *ConversionUpdateCall) Fields(s ...googleapi.Field) *ConversionUpdateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ConversionUpdateCall)Header¶
func (c *ConversionUpdateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeCustomDimension¶
type CustomDimension struct {// Name: Custom dimension name.Namestring `json:"name,omitempty"`// Value: Custom dimension value.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CustomDimension: A message containing the custom dimension.
func (CustomDimension)MarshalJSON¶
func (sCustomDimension) MarshalJSON() ([]byte,error)
typeCustomMetric¶
type CustomMetric struct {// Name: Custom metric name.Namestring `json:"name,omitempty"`// Value: Custom metric numeric value.Valuefloat64 `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CustomMetric: A message containing the custom metric.
func (CustomMetric)MarshalJSON¶
func (sCustomMetric) MarshalJSON() ([]byte,error)
func (*CustomMetric)UnmarshalJSON¶
func (s *CustomMetric) UnmarshalJSON(data []byte)error
typeIdMappingFile¶added inv0.76.0
type IdMappingFile struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}IdMappingFile: File returned tohttps://developers.google.com/search-ads/v2/reference/reports/getIdMappingFile.
typeReport¶
type Report struct {// Files: Asynchronous report only. Contains a list of generated report files// once the report has successfully completed.Files []*ReportFiles `json:"files,omitempty"`// Id: Asynchronous report only. Id of the report.Idstring `json:"id,omitempty"`// IsReportReady: Asynchronous report only. True if and only if the report has// completed successfully and the report files are ready to be downloaded.IsReportReadybool `json:"isReportReady,omitempty"`// Kind: Identifies this as a Report resource. Value: the fixed string// `doubleclicksearch#report`.Kindstring `json:"kind,omitempty"`// Request: The request that created the report. Optional fields not specified// in the original request are filled with default values.Request *ReportRequest `json:"request,omitempty"`// RowCount: The number of report rows generated by the report, not including// headers.RowCountint64 `json:"rowCount,omitempty"`// Rows: Synchronous report only. Generated report rows.Rows []googleapi.RawMessage `json:"rows,omitempty"`// StatisticsCurrencyCode: The currency code of all monetary values produced in// the report, including values that are set by users (e.g., keyword bid// settings) and metrics (e.g., cost and revenue). The currency code of a// report is determined by the `statisticsCurrency` field of the report// request.StatisticsCurrencyCodestring `json:"statisticsCurrencyCode,omitempty"`// StatisticsTimeZone: If all statistics of the report are sourced from the// same time zone, this would be it. Otherwise the field is unset.StatisticsTimeZonestring `json:"statisticsTimeZone,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Files") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Files") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Report: A DoubleClick Search report. This object contains the reportrequest, some report metadata such as currency code, and the generatedreport rows or report files.
func (Report)MarshalJSON¶
typeReportApiColumnSpec¶
type ReportApiColumnSpec struct {// ColumnName: Name of a DoubleClick Search column to include in the report.ColumnNamestring `json:"columnName,omitempty"`// CustomDimensionName: Segments a report by a custom dimension. The report// must be scoped to an advertiser or lower, and the custom dimension must// already be set up in DoubleClick Search. The custom dimension name, which// appears in DoubleClick Search, is case sensitive.\ If used in a conversion// report, returns the value of the specified custom dimension for the given// conversion, if set. This column does not segment the conversion report.CustomDimensionNamestring `json:"customDimensionName,omitempty"`// CustomMetricName: Name of a custom metric to include in the report. The// report must be scoped to an advertiser or lower, and the custom metric must// already be set up in DoubleClick Search. The custom metric name, which// appears in DoubleClick Search, is case sensitive.CustomMetricNamestring `json:"customMetricName,omitempty"`// EndDate: Inclusive day in YYYY-MM-DD format. When provided, this overrides// the overall time range of the report for this column only. Must be provided// together with `startDate`.EndDatestring `json:"endDate,omitempty"`// GroupByColumn: Synchronous report only. Set to `true` to group by this// column. Defaults to `false`.GroupByColumnbool `json:"groupByColumn,omitempty"`// HeaderText: Text used to identify this column in the report output; defaults// to `columnName` or `savedColumnName` when not specified. This can be used to// prevent collisions between DoubleClick Search columns and saved columns with// the same name.HeaderTextstring `json:"headerText,omitempty"`// PlatformSource: The platform that is used to provide data for the custom// dimension. Acceptable values are "floodlight".PlatformSourcestring `json:"platformSource,omitempty"`// ProductReportPerspective: Returns metrics only for a specific type of// product activity. Accepted values are: - "sold": returns metrics only for// products that were sold - "advertised": returns metrics only for products// that were advertised in a Shopping campaign, and that might or might not// have been soldProductReportPerspectivestring `json:"productReportPerspective,omitempty"`// SavedColumnName: Name of a saved column to include in the report. The report// must be scoped at advertiser or lower, and this saved column must already be// created in the DoubleClick Search UI.SavedColumnNamestring `json:"savedColumnName,omitempty"`// StartDate: Inclusive date in YYYY-MM-DD format. When provided, this// overrides the overall time range of the report for this column only. Must be// provided together with `endDate`.StartDatestring `json:"startDate,omitempty"`// ForceSendFields is a list of field names (e.g. "ColumnName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ColumnName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReportApiColumnSpec: A request object used to create a DoubleClick Searchreport.
func (ReportApiColumnSpec)MarshalJSON¶
func (sReportApiColumnSpec) MarshalJSON() ([]byte,error)
typeReportFiles¶
type ReportFiles struct {// ByteCount: The size of this report file in bytes.ByteCountint64 `json:"byteCount,omitempty,string"`// Url: Use this url to download the report file.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "ByteCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ByteCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (ReportFiles)MarshalJSON¶
func (sReportFiles) MarshalJSON() ([]byte,error)
typeReportRequest¶
type ReportRequest struct {// Columns: The columns to include in the report. This includes both// DoubleClick Search columns and saved columns. For DoubleClick Search// columns, only the `columnName` parameter is required. For saved columns only// the `savedColumnName` parameter is required. Both `columnName` and// `savedColumnName` cannot be set in the same stanza.\ The maximum number of// columns per request is 300.Columns []*ReportApiColumnSpec `json:"columns,omitempty"`// DownloadFormat: Format that the report should be returned in. Currently// `csv` or `tsv` is supported.DownloadFormatstring `json:"downloadFormat,omitempty"`// Filters: A list of filters to be applied to the report.\ The maximum number// of filters per request is 300.Filters []*ReportRequestFilters `json:"filters,omitempty"`// IncludeDeletedEntities: Determines if removed entities should be included in// the report. Defaults to `false`. Deprecated, please use// `includeRemovedEntities` instead.IncludeDeletedEntitiesbool `json:"includeDeletedEntities,omitempty"`// IncludeRemovedEntities: Determines if removed entities should be included in// the report. Defaults to `false`.IncludeRemovedEntitiesbool `json:"includeRemovedEntities,omitempty"`// MaxRowsPerFile: Asynchronous report only. The maximum number of rows per// report file. A large report is split into many files based on this field.// Acceptable values are `1000000` to `100000000`, inclusive.MaxRowsPerFileint64 `json:"maxRowsPerFile,omitempty"`// OrderBy: Synchronous report only. A list of columns and directions defining// sorting to be performed on the report rows.\ The maximum number of orderings// per request is 300.OrderBy []*ReportRequestOrderBy `json:"orderBy,omitempty"`// ReportScope: The reportScope is a set of IDs that are used to determine// which subset of entities will be returned in the report. The full lineage of// IDs from the lowest scoped level desired up through agency is required.ReportScope *ReportRequestReportScope `json:"reportScope,omitempty"`// ReportType: Determines the type of rows that are returned in the report. For// example, if you specify `reportType: keyword`, each row in the report will// contain data about a keyword. See the Types of Reports// (/search-ads/v2/report-types/) reference for the columns that are available// for each type.ReportTypestring `json:"reportType,omitempty"`// RowCount: Synchronous report only. The maximum number of rows to return;// additional rows are dropped. Acceptable values are `0` to `10000`,// inclusive. Defaults to `10000`.RowCountint64 `json:"rowCount,omitempty"`// StartRow: Synchronous report only. Zero-based index of the first row to// return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.StartRowint64 `json:"startRow,omitempty"`// StatisticsCurrency: Specifies the currency in which monetary will be// returned. Possible values are: `usd`, `agency` (valid if the report is// scoped to agency or lower), `advertiser` (valid if the report is scoped to *// advertiser or lower), or `account` (valid if the report is scoped to engine// account or lower).StatisticsCurrencystring `json:"statisticsCurrency,omitempty"`// TimeRange: If metrics are requested in a report, this argument will be used// to restrict the metrics to a specific time range.TimeRange *ReportRequestTimeRange `json:"timeRange,omitempty"`// VerifySingleTimeZone: If `true`, the report would only be created if all the// requested stat data are sourced from a single timezone. Defaults to `false`.VerifySingleTimeZonebool `json:"verifySingleTimeZone,omitempty"`// ForceSendFields is a list of field names (e.g. "Columns") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Columns") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReportRequest: A request object used to create a DoubleClick Search report.
func (ReportRequest)MarshalJSON¶
func (sReportRequest) MarshalJSON() ([]byte,error)
typeReportRequestFilters¶
type ReportRequestFilters struct {// Column: Column to perform the filter on. This can be a DoubleClick Search// column or a saved column.Column *ReportApiColumnSpec `json:"column,omitempty"`// Operator: Operator to use in the filter. See the filter reference for a list// of available operators.Operatorstring `json:"operator,omitempty"`// Values: A list of values to filter the column value against.\ The maximum// number of filter values per request is 300.Values []interface{} `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Column") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Column") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (ReportRequestFilters)MarshalJSON¶
func (sReportRequestFilters) MarshalJSON() ([]byte,error)
typeReportRequestOrderBy¶
type ReportRequestOrderBy struct {// Column: Column to perform the sort on. This can be a DoubleClick// Search-defined column or a saved column.Column *ReportApiColumnSpec `json:"column,omitempty"`// SortOrder: The sort direction, which is either `ascending` or `descending`.SortOrderstring `json:"sortOrder,omitempty"`// ForceSendFields is a list of field names (e.g. "Column") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Column") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (ReportRequestOrderBy)MarshalJSON¶
func (sReportRequestOrderBy) MarshalJSON() ([]byte,error)
typeReportRequestReportScope¶
type ReportRequestReportScope struct {// AdGroupId: DS ad group ID.AdGroupIdint64 `json:"adGroupId,omitempty,string"`// AdId: DS ad ID.AdIdint64 `json:"adId,omitempty,string"`// AdvertiserId: DS advertiser ID.AdvertiserIdint64 `json:"advertiserId,omitempty,string"`// AgencyId: DS agency ID.AgencyIdint64 `json:"agencyId,omitempty,string"`// CampaignId: DS campaign ID.CampaignIdint64 `json:"campaignId,omitempty,string"`// EngineAccountId: DS engine account ID.EngineAccountIdint64 `json:"engineAccountId,omitempty,string"`// KeywordId: DS keyword ID.KeywordIdint64 `json:"keywordId,omitempty,string"`// ForceSendFields is a list of field names (e.g. "AdGroupId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdGroupId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReportRequestReportScope: The reportScope is a set of IDs that are used todetermine which subset of entities will be returned in the report. The fulllineage of IDs from the lowest scoped level desired up through agency isrequired.
func (ReportRequestReportScope)MarshalJSON¶
func (sReportRequestReportScope) MarshalJSON() ([]byte,error)
typeReportRequestTimeRange¶
type ReportRequestTimeRange struct {// ChangedAttributesSinceTimestamp: Inclusive UTC timestamp in RFC format,// e.g., `2013-07-16T10:16:23.555Z`. See additional references on how changed// attribute reports work.ChangedAttributesSinceTimestampstring `json:"changedAttributesSinceTimestamp,omitempty"`// ChangedMetricsSinceTimestamp: Inclusive UTC timestamp in RFC format, e.g.,// `2013-07-16T10:16:23.555Z`. See additional references on how changed metrics// reports work.ChangedMetricsSinceTimestampstring `json:"changedMetricsSinceTimestamp,omitempty"`// EndDate: Inclusive date in YYYY-MM-DD format.EndDatestring `json:"endDate,omitempty"`// StartDate: Inclusive date in YYYY-MM-DD format.StartDatestring `json:"startDate,omitempty"`// ForceSendFields is a list of field names (e.g.// "ChangedAttributesSinceTimestamp") to unconditionally include in API// requests. By default, fields with empty or default values are omitted from// API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChangedAttributesSinceTimestamp")// to include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReportRequestTimeRange: If metrics are requested in a report, this argumentwill be used to restrict the metrics to a specific time range.
func (ReportRequestTimeRange)MarshalJSON¶
func (sReportRequestTimeRange) MarshalJSON() ([]byte,error)
typeReportsGenerateCall¶
type ReportsGenerateCall struct {// contains filtered or unexported fields}func (*ReportsGenerateCall)Context¶
func (c *ReportsGenerateCall) Context(ctxcontext.Context) *ReportsGenerateCall
Context sets the context to be used in this call's Do method.
func (*ReportsGenerateCall)Do¶
func (c *ReportsGenerateCall) Do(opts ...googleapi.CallOption) (*Report,error)
Do executes the "doubleclicksearch.reports.generate" call.Any non-2xx status code is an error. Response headers are in either*Report.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ReportsGenerateCall)Fields¶
func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ReportsGenerateCall)Header¶
func (c *ReportsGenerateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeReportsGetCall¶
type ReportsGetCall struct {// contains filtered or unexported fields}func (*ReportsGetCall)Context¶
func (c *ReportsGetCall) Context(ctxcontext.Context) *ReportsGetCall
Context sets the context to be used in this call's Do method.
func (*ReportsGetCall)Do¶
func (c *ReportsGetCall) Do(opts ...googleapi.CallOption) (*Report,error)
Do executes the "doubleclicksearch.reports.get" call.Any non-2xx status code is an error. Response headers are in either*Report.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ReportsGetCall)Header¶
func (c *ReportsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ReportsGetCall)IfNoneMatch¶
func (c *ReportsGetCall) IfNoneMatch(entityTagstring) *ReportsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeReportsGetFileCall¶
type ReportsGetFileCall struct {// contains filtered or unexported fields}func (*ReportsGetFileCall)Context¶
func (c *ReportsGetFileCall) Context(ctxcontext.Context) *ReportsGetFileCall
Context sets the context to be used in this call's Do and Download methods.
func (*ReportsGetFileCall)Do¶
func (c *ReportsGetFileCall) Do(opts ...googleapi.CallOption)error
Do executes the "doubleclicksearch.reports.getFile" call.
func (*ReportsGetFileCall)Download¶
func (c *ReportsGetFileCall) Download(opts ...googleapi.CallOption) (*http.Response,error)
Download fetches the API endpoint's "media" value, instead of the normalAPI response value. If the returned error is nil, the Response is guaranteed tohave a 2xx status code. Callers must close the Response.Body as usual.
func (*ReportsGetFileCall)Fields¶
func (c *ReportsGetFileCall) Fields(s ...googleapi.Field) *ReportsGetFileCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ReportsGetFileCall)Header¶
func (c *ReportsGetFileCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ReportsGetFileCall)IfNoneMatch¶
func (c *ReportsGetFileCall) IfNoneMatch(entityTagstring) *ReportsGetFileCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeReportsGetIdMappingFileCall¶added inv0.76.0
type ReportsGetIdMappingFileCall struct {// contains filtered or unexported fields}func (*ReportsGetIdMappingFileCall)Context¶added inv0.76.0
func (c *ReportsGetIdMappingFileCall) Context(ctxcontext.Context) *ReportsGetIdMappingFileCall
Context sets the context to be used in this call's Do and Download methods.
func (*ReportsGetIdMappingFileCall)Do¶added inv0.76.0
func (c *ReportsGetIdMappingFileCall) Do(opts ...googleapi.CallOption) (*IdMappingFile,error)
Do executes the "doubleclicksearch.reports.getIdMappingFile" call.Any non-2xx status code is an error. Response headers are in either*IdMappingFile.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ReportsGetIdMappingFileCall)Download¶added inv0.76.0
func (c *ReportsGetIdMappingFileCall) Download(opts ...googleapi.CallOption) (*http.Response,error)
Download fetches the API endpoint's "media" value, instead of the normalAPI response value. If the returned error is nil, the Response is guaranteed tohave a 2xx status code. Callers must close the Response.Body as usual.
func (*ReportsGetIdMappingFileCall)Fields¶added inv0.76.0
func (c *ReportsGetIdMappingFileCall) Fields(s ...googleapi.Field) *ReportsGetIdMappingFileCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ReportsGetIdMappingFileCall)Header¶added inv0.76.0
func (c *ReportsGetIdMappingFileCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ReportsGetIdMappingFileCall)IfNoneMatch¶added inv0.76.0
func (c *ReportsGetIdMappingFileCall) IfNoneMatch(entityTagstring) *ReportsGetIdMappingFileCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeReportsRequestCall¶
type ReportsRequestCall struct {// contains filtered or unexported fields}func (*ReportsRequestCall)Context¶
func (c *ReportsRequestCall) Context(ctxcontext.Context) *ReportsRequestCall
Context sets the context to be used in this call's Do method.
func (*ReportsRequestCall)Do¶
func (c *ReportsRequestCall) Do(opts ...googleapi.CallOption) (*Report,error)
Do executes the "doubleclicksearch.reports.request" call.Any non-2xx status code is an error. Response headers are in either*Report.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ReportsRequestCall)Fields¶
func (c *ReportsRequestCall) Fields(s ...googleapi.Field) *ReportsRequestCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ReportsRequestCall)Header¶
func (c *ReportsRequestCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeReportsService¶
type ReportsService struct {// contains filtered or unexported fields}funcNewReportsService¶
func NewReportsService(s *Service) *ReportsService
func (*ReportsService)Generate¶
func (r *ReportsService) Generate(reportrequest *ReportRequest) *ReportsGenerateCall
Generate: Generates and returns a report immediately.
func (*ReportsService)Get¶
func (r *ReportsService) Get(reportIdstring) *ReportsGetCall
Get: Polls for the status of a report request.
- reportId: ID of the report request being polled.
func (*ReportsService)GetFile¶
func (r *ReportsService) GetFile(reportIdstring, reportFragmentint64) *ReportsGetFileCall
GetFile: Downloads a report file encoded in UTF-8.
- reportFragment: The index of the report fragment to download.- reportId: ID of the report.
func (*ReportsService)GetIdMappingFile¶added inv0.76.0
func (r *ReportsService) GetIdMappingFile(agencyIdint64, advertiserIdint64) *ReportsGetIdMappingFileCall
GetIdMappingFile: Downloads a csv file(encoded in UTF-8) that contains IDmappings between legacy SA360 and new SA360. The file includes all childrenentities of the given advertiser(e.g. engine accounts, campaigns, ad groups,etc.) that exist in both legacy SA360 and new SA360.
- advertiserId: Legacy SA360 advertiser ID.- agencyId: Legacy SA360 agency ID.
func (*ReportsService)Request¶
func (r *ReportsService) Request(reportrequest *ReportRequest) *ReportsRequestCall
Request: Inserts a report request into the reporting system.
typeSavedColumn¶
type SavedColumn struct {// Kind: Identifies this as a SavedColumn resource. Value: the fixed string// doubleclicksearch#savedColumn.Kindstring `json:"kind,omitempty"`// SavedColumnName: The name of the saved column.SavedColumnNamestring `json:"savedColumnName,omitempty"`// Type: The type of data this saved column will produce.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Kind") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SavedColumn: A saved column
func (SavedColumn)MarshalJSON¶
func (sSavedColumn) MarshalJSON() ([]byte,error)
typeSavedColumnList¶
type SavedColumnList struct {// Items: The saved columns being requested.Items []*SavedColumn `json:"items,omitempty"`// Kind: Identifies this as a SavedColumnList resource. Value: the fixed string// doubleclicksearch#savedColumnList.Kindstring `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. "Items") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Items") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SavedColumnList: A list of saved columns. Advertisers create saved columnsto report on Floodlight activities, Google Analytics goals, or custom KPIs.To request reports with saved columns, you'll need the saved column namesthat are available from this list.
func (SavedColumnList)MarshalJSON¶
func (sSavedColumnList) MarshalJSON() ([]byte,error)
typeSavedColumnsListCall¶
type SavedColumnsListCall struct {// contains filtered or unexported fields}func (*SavedColumnsListCall)Context¶
func (c *SavedColumnsListCall) Context(ctxcontext.Context) *SavedColumnsListCall
Context sets the context to be used in this call's Do method.
func (*SavedColumnsListCall)Do¶
func (c *SavedColumnsListCall) Do(opts ...googleapi.CallOption) (*SavedColumnList,error)
Do executes the "doubleclicksearch.savedColumns.list" call.Any non-2xx status code is an error. Response headers are in either*SavedColumnList.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*SavedColumnsListCall)Fields¶
func (c *SavedColumnsListCall) Fields(s ...googleapi.Field) *SavedColumnsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SavedColumnsListCall)Header¶
func (c *SavedColumnsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SavedColumnsListCall)IfNoneMatch¶
func (c *SavedColumnsListCall) IfNoneMatch(entityTagstring) *SavedColumnsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeSavedColumnsService¶
type SavedColumnsService struct {// contains filtered or unexported fields}funcNewSavedColumnsService¶
func NewSavedColumnsService(s *Service) *SavedColumnsService
func (*SavedColumnsService)List¶
func (r *SavedColumnsService) List(agencyIdint64, advertiserIdint64) *SavedColumnsListCall
List: Retrieve the list of saved columns for a specified advertiser.
- advertiserId: DS ID of the advertiser.- agencyId: DS ID of the agency.
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentConversion *ConversionServiceReports *ReportsServiceSavedColumns *SavedColumnsService// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶added inv0.3.0
NewService creates a new Service.
typeUpdateAvailabilityRequest¶
type UpdateAvailabilityRequest struct {// Availabilities: The availabilities being requested.Availabilities []*Availability `json:"availabilities,omitempty"`// ForceSendFields is a list of field names (e.g. "Availabilities") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Availabilities") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UpdateAvailabilityRequest: The request to update availability.
func (UpdateAvailabilityRequest)MarshalJSON¶
func (sUpdateAvailabilityRequest) MarshalJSON() ([]byte,error)
typeUpdateAvailabilityResponse¶
type UpdateAvailabilityResponse struct {// Availabilities: The availabilities being returned.Availabilities []*Availability `json:"availabilities,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Availabilities") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Availabilities") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UpdateAvailabilityResponse: The response to a update availability request.
func (UpdateAvailabilityResponse)MarshalJSON¶
func (sUpdateAvailabilityResponse) MarshalJSON() ([]byte,error)