This repository has been archived by the owner on Oct 3, 2019. It is now read-only.
forked from googleapis/google-api-go-client
/
doubleclicksearch-gen.go
1528 lines (1345 loc) · 48.1 KB
/
doubleclicksearch-gen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Package doubleclicksearch provides access to the DoubleClick Search API.
//
// See https://developers.google.com/doubleclick-search/
//
// Usage example:
//
// import "google.golang.org/api/doubleclicksearch/v2"
// ...
// doubleclicksearchService, err := doubleclicksearch.New(oauthHttpClient)
package doubleclicksearch
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"golang.org/x/net/context"
"google.golang.org/api/googleapi"
"io"
"net/http"
"net/url"
"strconv"
"strings"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Background
const apiId = "doubleclicksearch:v2"
const apiName = "doubleclicksearch"
const apiVersion = "v2"
const basePath = "https://www.googleapis.com/doubleclicksearch/v2/"
// OAuth2 scopes used by this API.
const (
// View and manage your advertising data in DoubleClick Search
DoubleclicksearchScope = "https://www.googleapis.com/auth/doubleclicksearch"
)
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Conversion = NewConversionService(s)
s.Reports = NewReportsService(s)
s.SavedColumns = NewSavedColumnsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Conversion *ConversionService
Reports *ReportsService
SavedColumns *SavedColumnsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewConversionService(s *Service) *ConversionService {
rs := &ConversionService{s: s}
return rs
}
type ConversionService struct {
s *Service
}
func NewReportsService(s *Service) *ReportsService {
rs := &ReportsService{s: s}
return rs
}
type ReportsService struct {
s *Service
}
func NewSavedColumnsService(s *Service) *SavedColumnsService {
rs := &SavedColumnsService{s: s}
return rs
}
type SavedColumnsService struct {
s *Service
}
type Availability struct {
// AdvertiserId: DS advertiser ID.
AdvertiserId int64 `json:"advertiserId,omitempty,string"`
// AgencyId: DS agency ID.
AgencyId int64 `json:"agencyId,omitempty,string"`
// AvailabilityTimestamp: The time by which all conversions have been
// uploaded, in epoch millis UTC.
AvailabilityTimestamp uint64 `json:"availabilityTimestamp,omitempty,string"`
// SegmentationId: The numeric segmentation identifier (for example,
// DoubleClick Search Floodlight activity ID).
SegmentationId int64 `json:"segmentationId,omitempty,string"`
// SegmentationName: The friendly segmentation identifier (for example,
// DoubleClick Search Floodlight activity name).
SegmentationName string `json:"segmentationName,omitempty"`
// SegmentationType: The segmentation type that this availability is for
// (its default value is FLOODLIGHT).
SegmentationType string `json:"segmentationType,omitempty"`
}
type Conversion struct {
// AdGroupId: DS ad group ID.
AdGroupId int64 `json:"adGroupId,omitempty,string"`
// AdId: DS ad ID.
AdId int64 `json:"adId,omitempty,string"`
// AdvertiserId: DS advertiser ID.
AdvertiserId int64 `json:"advertiserId,omitempty,string"`
// AgencyId: DS agency ID.
AgencyId int64 `json:"agencyId,omitempty,string"`
// AttributionModel: Attribution model name. This field is ignored.
AttributionModel string `json:"attributionModel,omitempty"`
// CampaignId: DS campaign ID.
CampaignId int64 `json:"campaignId,omitempty,string"`
// Channel: Channel of the product: local or online.
Channel string `json:"channel,omitempty"`
// ClickId: DS click ID for the conversion.
ClickId string `json:"clickId,omitempty"`
// ConversionId: Advertiser-provided ID for the conversion, also known
// as the order ID.
ConversionId string `json:"conversionId,omitempty"`
// ConversionModifiedTimestamp: The time at which the conversion was
// last modified, in epoch millis UTC.
ConversionModifiedTimestamp uint64 `json:"conversionModifiedTimestamp,omitempty,string"`
// ConversionTimestamp: The time at which the conversion took place, in
// epoch millis UTC.
ConversionTimestamp uint64 `json:"conversionTimestamp,omitempty,string"`
// CountMillis: The number of conversions, formatted in millis
// (conversions multiplied by 1000). This field is ignored.
CountMillis int64 `json:"countMillis,omitempty,string"`
// CriterionId: DS criterion (keyword) ID.
CriterionId int64 `json:"criterionId,omitempty,string"`
// CurrencyCode: The currency code for the conversion's revenue. Should
// be in ISO 4217 alphabetic (3-char) format.
CurrencyCode string `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"`
// DeviceType: The type of device on which the conversion occurred.
// Valid values are "DESKTOP", "TABLET", "HIGH_END_MOBILE",
// "OTHER_DEVICE".
DeviceType string `json:"deviceType,omitempty"`
// DsConversionId: DS conversion ID.
DsConversionId int64 `json:"dsConversionId,omitempty,string"`
// EngineAccountId: DS engine account ID.
EngineAccountId int64 `json:"engineAccountId,omitempty,string"`
// FeedId: DS inventory feed ID.
FeedId int64 `json:"feedId,omitempty,string"`
// FloodlightOrderId: The advertiser-provided order id for the
// conversion.
FloodlightOrderId string `json:"floodlightOrderId,omitempty"`
// ProductCountry: ISO 3166 code of the product country.
ProductCountry string `json:"productCountry,omitempty"`
// ProductGroupId: DS product group ID.
ProductGroupId int64 `json:"productGroupId,omitempty,string"`
// ProductId: The product ID (SKU).
ProductId string `json:"productId,omitempty"`
// ProductLanguage: ISO 639 code of the product language.
ProductLanguage string `json:"productLanguage,omitempty"`
// QuantityMillis: The quantity of this conversion, in millis.
QuantityMillis int64 `json:"quantityMillis,omitempty,string"`
// RevenueMicros: The revenue amount of this TRANSACTION conversion, in
// micros.
RevenueMicros int64 `json:"revenueMicros,omitempty,string"`
// SegmentationId: The numeric segmentation identifier (for example,
// DoubleClick Search Floodlight activity ID).
SegmentationId int64 `json:"segmentationId,omitempty,string"`
// SegmentationName: The friendly segmentation identifier (for example,
// DoubleClick Search Floodlight activity name).
SegmentationName string `json:"segmentationName,omitempty"`
// SegmentationType: The segmentation type of this conversion (for
// example, FLOODLIGHT).
SegmentationType string `json:"segmentationType,omitempty"`
// State: The state of the conversion, that is, either ACTIVE or
// REMOVED. Note: state DELETED is deprecated.
State string `json:"state,omitempty"`
// StoreId: The store id for which the product was advertised, when the
// channel is "local".
StoreId string `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).
Type string `json:"type,omitempty"`
}
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.
Kind string `json:"kind,omitempty"`
}
type CustomDimension struct {
// Name: Custom dimension name.
Name string `json:"name,omitempty"`
// Value: Custom dimension value.
Value string `json:"value,omitempty"`
}
type CustomMetric struct {
// Name: Custom metric name.
Name string `json:"name,omitempty"`
// Value: Custom metric numeric value.
Value float64 `json:"value,omitempty"`
}
type Report struct {
// Files: Asynchronous report only. Contains a list of generated report
// files once the report has succesfully completed.
Files []*ReportFiles `json:"files,omitempty"`
// Id: Asynchronous report only. Id of the report.
Id string `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.
IsReportReady *bool `json:"isReportReady,omitempty"`
// Kind: Identifies this as a Report resource. Value: the fixed string
// doubleclicksearch#report.
Kind string `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.
RowCount int64 `json:"rowCount,omitempty"`
// Rows: Synchronous report only. Generated report rows.
Rows []ReportRow `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.
StatisticsCurrencyCode string `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.
StatisticsTimeZone string `json:"statisticsTimeZone,omitempty"`
}
type ReportFiles struct {
// ByteCount: The size of this report file in bytes.
ByteCount int64 `json:"byteCount,omitempty,string"`
// Url: Use this url to download the report file.
Url string `json:"url,omitempty"`
}
type ReportApiColumnSpec struct {
// ColumnName: Name of a DoubleClick Search column to include in the
// report.
ColumnName string `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.
CustomDimensionName string `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.
CustomMetricName string `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.
EndDate string `json:"endDate,omitempty"`
// GroupByColumn: Synchronous report only. Set to true to group by this
// column. Defaults to false.
GroupByColumn *bool `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.
HeaderText string `json:"headerText,omitempty"`
// PlatformSource: The platform that is used to provide data for the
// custom dimension. Acceptable values are "Floodlight".
PlatformSource string `json:"platformSource,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.
SavedColumnName string `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.
StartDate string `json:"startDate,omitempty"`
}
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.
Columns []*ReportApiColumnSpec `json:"columns,omitempty"`
// DownloadFormat: Format that the report should be returned in.
// Currently csv or tsv is supported.
DownloadFormat string `json:"downloadFormat,omitempty"`
// Filters: A list of filters to be applied to the report.
Filters []*ReportRequestFilters `json:"filters,omitempty"`
// IncludeDeletedEntities: Determines if removed entities should be
// included in the report. Defaults to false. Deprecated, please use
// includeRemovedEntities instead.
IncludeDeletedEntities *bool `json:"includeDeletedEntities,omitempty"`
// IncludeRemovedEntities: Determines if removed entities should be
// included in the report. Defaults to false.
IncludeRemovedEntities *bool `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.
MaxRowsPerFile int64 `json:"maxRowsPerFile,omitempty"`
// OrderBy: Synchronous report only. A list of columns and directions
// defining sorting to be performed on the report rows.
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 reference for the columns that are available for each type.
ReportType string `json:"reportType,omitempty"`
// RowCount: Synchronous report only. The maxinum number of rows to
// return; additional rows are dropped. Acceptable values are 0 to
// 10000, inclusive. Defaults to 10000.
//
// Default: 10000
RowCount *int64 `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.
StartRow int64 `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).
StatisticsCurrency string `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.
VerifySingleTimeZone *bool `json:"verifySingleTimeZone,omitempty"`
}
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.
Operator string `json:"operator,omitempty"`
// Values: A list of values to filter the column value against.
Values []interface{} `json:"values,omitempty"`
}
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.
SortOrder string `json:"sortOrder,omitempty"`
}
type ReportRequestReportScope struct {
// AdGroupId: DS ad group ID.
AdGroupId int64 `json:"adGroupId,omitempty,string"`
// AdId: DS ad ID.
AdId int64 `json:"adId,omitempty,string"`
// AdvertiserId: DS advertiser ID.
AdvertiserId int64 `json:"advertiserId,omitempty,string"`
// AgencyId: DS agency ID.
AgencyId int64 `json:"agencyId,omitempty,string"`
// CampaignId: DS campaign ID.
CampaignId int64 `json:"campaignId,omitempty,string"`
// EngineAccountId: DS engine account ID.
EngineAccountId int64 `json:"engineAccountId,omitempty,string"`
// KeywordId: DS keyword ID.
KeywordId int64 `json:"keywordId,omitempty,string"`
}
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.
ChangedAttributesSinceTimestamp string `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.
ChangedMetricsSinceTimestamp string `json:"changedMetricsSinceTimestamp,omitempty"`
// EndDate: Inclusive date in YYYY-MM-DD format.
EndDate string `json:"endDate,omitempty"`
// StartDate: Inclusive date in YYYY-MM-DD format.
StartDate string `json:"startDate,omitempty"`
}
type ReportRow interface{}
type SavedColumn struct {
// Kind: Identifies this as a SavedColumn resource. Value: the fixed
// string doubleclicksearch#savedColumn.
Kind string `json:"kind,omitempty"`
// SavedColumnName: The name of the saved column.
SavedColumnName string `json:"savedColumnName,omitempty"`
// Type: The type of data this saved column will produce.
Type string `json:"type,omitempty"`
}
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.
Kind string `json:"kind,omitempty"`
}
type UpdateAvailabilityRequest struct {
// Availabilities: The availabilities being requested.
Availabilities []*Availability `json:"availabilities,omitempty"`
}
type UpdateAvailabilityResponse struct {
// Availabilities: The availabilities being returned.
Availabilities []*Availability `json:"availabilities,omitempty"`
}
// method id "doubleclicksearch.conversion.get":
type ConversionGetCall struct {
s *Service
agencyId int64
advertiserId int64
engineAccountId int64
endDate int64
rowCount int64
startDate int64
startRow int64
opt_ map[string]interface{}
}
// Get: Retrieves a list of conversions from a DoubleClick Search engine
// account.
func (r *ConversionService) Get(agencyId int64, advertiserId int64, engineAccountId int64, endDate int64, rowCount int64, startDate int64, startRow int64) *ConversionGetCall {
c := &ConversionGetCall{s: r.s, opt_: make(map[string]interface{})}
c.agencyId = agencyId
c.advertiserId = advertiserId
c.engineAccountId = engineAccountId
c.endDate = endDate
c.rowCount = rowCount
c.startDate = startDate
c.startRow = startRow
return c
}
// AdGroupId sets the optional parameter "adGroupId": Numeric ID of the
// ad group.
func (c *ConversionGetCall) AdGroupId(adGroupId int64) *ConversionGetCall {
c.opt_["adGroupId"] = adGroupId
return c
}
// AdId sets the optional parameter "adId": Numeric ID of the ad.
func (c *ConversionGetCall) AdId(adId int64) *ConversionGetCall {
c.opt_["adId"] = adId
return c
}
// CampaignId sets the optional parameter "campaignId": Numeric ID of
// the campaign.
func (c *ConversionGetCall) CampaignId(campaignId int64) *ConversionGetCall {
c.opt_["campaignId"] = campaignId
return c
}
// CriterionId sets the optional parameter "criterionId": Numeric ID of
// the criterion.
func (c *ConversionGetCall) CriterionId(criterionId int64) *ConversionGetCall {
c.opt_["criterionId"] = criterionId
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ConversionGetCall) Fields(s ...googleapi.Field) *ConversionGetCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ConversionGetCall) Do() (*ConversionList, error) {
var body io.Reader = nil
params := make(url.Values)
params.Set("alt", "json")
params.Set("endDate", fmt.Sprintf("%v", c.endDate))
params.Set("rowCount", fmt.Sprintf("%v", c.rowCount))
params.Set("startDate", fmt.Sprintf("%v", c.startDate))
params.Set("startRow", fmt.Sprintf("%v", c.startRow))
if v, ok := c.opt_["adGroupId"]; ok {
params.Set("adGroupId", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["adId"]; ok {
params.Set("adId", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["campaignId"]; ok {
params.Set("campaignId", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["criterionId"]; ok {
params.Set("criterionId", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion")
urls += "?" + params.Encode()
req, _ := http.NewRequest("GET", urls, body)
googleapi.Expand(req.URL, map[string]string{
"agencyId": strconv.FormatInt(c.agencyId, 10),
"advertiserId": strconv.FormatInt(c.advertiserId, 10),
"engineAccountId": strconv.FormatInt(c.engineAccountId, 10),
})
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *ConversionList
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Retrieves a list of conversions from a DoubleClick Search engine account.",
// "httpMethod": "GET",
// "id": "doubleclicksearch.conversion.get",
// "parameterOrder": [
// "agencyId",
// "advertiserId",
// "engineAccountId",
// "endDate",
// "rowCount",
// "startDate",
// "startRow"
// ],
// "parameters": {
// "adGroupId": {
// "description": "Numeric ID of the ad group.",
// "format": "int64",
// "location": "query",
// "type": "string"
// },
// "adId": {
// "description": "Numeric ID of the ad.",
// "format": "int64",
// "location": "query",
// "type": "string"
// },
// "advertiserId": {
// "description": "Numeric ID of the advertiser.",
// "format": "int64",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "agencyId": {
// "description": "Numeric ID of the agency.",
// "format": "int64",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "campaignId": {
// "description": "Numeric ID of the campaign.",
// "format": "int64",
// "location": "query",
// "type": "string"
// },
// "criterionId": {
// "description": "Numeric ID of the criterion.",
// "format": "int64",
// "location": "query",
// "type": "string"
// },
// "endDate": {
// "description": "Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
// "format": "int32",
// "location": "query",
// "maximum": "99991231",
// "minimum": "20091101",
// "required": true,
// "type": "integer"
// },
// "engineAccountId": {
// "description": "Numeric ID of the engine account.",
// "format": "int64",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "rowCount": {
// "description": "The number of conversions to return per call.",
// "format": "int32",
// "location": "query",
// "maximum": "1000",
// "minimum": "1",
// "required": true,
// "type": "integer"
// },
// "startDate": {
// "description": "First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
// "format": "int32",
// "location": "query",
// "maximum": "99991231",
// "minimum": "20091101",
// "required": true,
// "type": "integer"
// },
// "startRow": {
// "description": "The 0-based starting index for retrieving conversions results.",
// "format": "uint32",
// "location": "query",
// "required": true,
// "type": "integer"
// }
// },
// "path": "agency/{agencyId}/advertiser/{advertiserId}/engine/{engineAccountId}/conversion",
// "response": {
// "$ref": "ConversionList"
// },
// "scopes": [
// "https://www.googleapis.com/auth/doubleclicksearch"
// ]
// }
}
// method id "doubleclicksearch.conversion.insert":
type ConversionInsertCall struct {
s *Service
conversionlist *ConversionList
opt_ map[string]interface{}
}
// Insert: Inserts a batch of new conversions into DoubleClick Search.
func (r *ConversionService) Insert(conversionlist *ConversionList) *ConversionInsertCall {
c := &ConversionInsertCall{s: r.s, opt_: make(map[string]interface{})}
c.conversionlist = conversionlist
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ConversionInsertCall) Fields(s ...googleapi.Field) *ConversionInsertCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ConversionInsertCall) Do() (*ConversionList, error) {
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.conversionlist)
if err != nil {
return nil, err
}
ctype := "application/json"
params := make(url.Values)
params.Set("alt", "json")
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "conversion")
urls += "?" + params.Encode()
req, _ := http.NewRequest("POST", urls, body)
googleapi.SetOpaque(req.URL)
req.Header.Set("Content-Type", ctype)
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *ConversionList
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Inserts a batch of new conversions into DoubleClick Search.",
// "httpMethod": "POST",
// "id": "doubleclicksearch.conversion.insert",
// "path": "conversion",
// "request": {
// "$ref": "ConversionList"
// },
// "response": {
// "$ref": "ConversionList"
// },
// "scopes": [
// "https://www.googleapis.com/auth/doubleclicksearch"
// ]
// }
}
// method id "doubleclicksearch.conversion.patch":
type ConversionPatchCall struct {
s *Service
advertiserId int64
agencyId int64
endDate int64
engineAccountId int64
rowCount int64
startDate int64
startRow int64
conversionlist *ConversionList
opt_ map[string]interface{}
}
// Patch: Updates a batch of conversions in DoubleClick Search. This
// method supports patch semantics.
func (r *ConversionService) Patch(advertiserId int64, agencyId int64, endDate int64, engineAccountId int64, rowCount int64, startDate int64, startRow int64, conversionlist *ConversionList) *ConversionPatchCall {
c := &ConversionPatchCall{s: r.s, opt_: make(map[string]interface{})}
c.advertiserId = advertiserId
c.agencyId = agencyId
c.endDate = endDate
c.engineAccountId = engineAccountId
c.rowCount = rowCount
c.startDate = startDate
c.startRow = startRow
c.conversionlist = conversionlist
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ConversionPatchCall) Fields(s ...googleapi.Field) *ConversionPatchCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ConversionPatchCall) Do() (*ConversionList, error) {
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.conversionlist)
if err != nil {
return nil, err
}
ctype := "application/json"
params := make(url.Values)
params.Set("alt", "json")
params.Set("advertiserId", fmt.Sprintf("%v", c.advertiserId))
params.Set("agencyId", fmt.Sprintf("%v", c.agencyId))
params.Set("endDate", fmt.Sprintf("%v", c.endDate))
params.Set("engineAccountId", fmt.Sprintf("%v", c.engineAccountId))
params.Set("rowCount", fmt.Sprintf("%v", c.rowCount))
params.Set("startDate", fmt.Sprintf("%v", c.startDate))
params.Set("startRow", fmt.Sprintf("%v", c.startRow))
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "conversion")
urls += "?" + params.Encode()
req, _ := http.NewRequest("PATCH", urls, body)
googleapi.SetOpaque(req.URL)
req.Header.Set("Content-Type", ctype)
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *ConversionList
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.",
// "httpMethod": "PATCH",
// "id": "doubleclicksearch.conversion.patch",
// "parameterOrder": [
// "advertiserId",
// "agencyId",
// "endDate",
// "engineAccountId",
// "rowCount",
// "startDate",
// "startRow"
// ],
// "parameters": {
// "advertiserId": {
// "description": "Numeric ID of the advertiser.",
// "format": "int64",
// "location": "query",
// "required": true,
// "type": "string"
// },
// "agencyId": {
// "description": "Numeric ID of the agency.",
// "format": "int64",
// "location": "query",
// "required": true,
// "type": "string"
// },
// "endDate": {
// "description": "Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
// "format": "int32",
// "location": "query",
// "maximum": "99991231",
// "minimum": "20091101",
// "required": true,
// "type": "integer"
// },
// "engineAccountId": {
// "description": "Numeric ID of the engine account.",
// "format": "int64",
// "location": "query",
// "required": true,
// "type": "string"
// },
// "rowCount": {
// "description": "The number of conversions to return per call.",
// "format": "int32",
// "location": "query",
// "maximum": "1000",
// "minimum": "1",
// "required": true,
// "type": "integer"
// },
// "startDate": {
// "description": "First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.",
// "format": "int32",
// "location": "query",
// "maximum": "99991231",
// "minimum": "20091101",
// "required": true,
// "type": "integer"
// },
// "startRow": {
// "description": "The 0-based starting index for retrieving conversions results.",
// "format": "uint32",
// "location": "query",
// "required": true,
// "type": "integer"
// }
// },
// "path": "conversion",
// "request": {
// "$ref": "ConversionList"
// },
// "response": {
// "$ref": "ConversionList"
// },
// "scopes": [
// "https://www.googleapis.com/auth/doubleclicksearch"
// ]
// }
}
// method id "doubleclicksearch.conversion.update":
type ConversionUpdateCall struct {
s *Service
conversionlist *ConversionList
opt_ map[string]interface{}
}
// Update: Updates a batch of conversions in DoubleClick Search.