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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.dynamicFeeds.html">dynamicFeeds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(dynamicFeedId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a dynamic feed by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new dynamic feed.</p>
<p class="toc_element">
<code><a href="#retransform">retransform(dynamicFeedId, x__xgafv=None)</a></code></p>
<p class="firstline">Retransforms a dynamic feed.</p>
<p class="toc_element">
<code><a href="#update">update(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a new dynamic feed.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(dynamicFeedId, x__xgafv=None)</code>
<pre>Gets a dynamic feed by ID.
Args:
dynamicFeedId: string, Required. Dynamic feed ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
"charset": "A String", # Output only. The charset of the content source.
"fieldNames": [ # Output only. The list of column names in the content source.
"A String",
],
"rowNumber": 42, # Output only. The number of rows in the content source.
"separator": "A String", # Output only. The separator of the content source.
},
"resourceLink": "A String", # Required. The link to the file of the content source.
"resourceType": "A String", # Required. The resource type of the content source.
},
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
"dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
"element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
"activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
"elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
"endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
"externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
"feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
{ # Each field of the element. This is a required field.
"defaultValue": "A String", # Optional. The default value of the field.
"filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
"id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
"name": "A String", # Required. The name of the field.
"renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
"required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
"type": "A String", # Required. The type of the field.
},
],
"isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
"reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
"startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
},
"feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
"ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
{ # Contains the ingestion error record of the dynamic feed. limited to 100 records.
"errors": [ # Output only. The list of field errors of the ingestion error record.
{ # Contains the field error of the dynamic feed.
"fieldId": 42, # Output only. The ID of the field.
"fieldName": "A String", # Output only. The name of the field.
"fieldValues": [ # Output only. The list of values of the field.
"A String",
],
"ingestionError": "A String", # Output only. The ingestion error of the field.
"isError": True or False, # Output only. Incidcates whether the field has error or warning.
},
],
"recordId": "A String", # Output only. The record ID of the ingestion error record.
},
],
"ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
"numActiveRows": "A String", # Output only. The number of active rows in the feed.
"numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
"numRowsTotal": "A String", # Output only. The total number of rows in the feed.
"numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
"numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
},
"state": "A String", # Output only. The processing state of the feed.
},
"feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
"repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
"scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
"startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
},
"hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
<pre>Inserts a new dynamic feed.
Args:
body: object, The request body.
The object takes the form of:
{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See
"dynamicFeed": { # Contains dynamic feed information. # Required. Dynamic feed to insert.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
"charset": "A String", # Output only. The charset of the content source.
"fieldNames": [ # Output only. The list of column names in the content source.
"A String",
],
"rowNumber": 42, # Output only. The number of rows in the content source.
"separator": "A String", # Output only. The separator of the content source.
},
"resourceLink": "A String", # Required. The link to the file of the content source.
"resourceType": "A String", # Required. The resource type of the content source.
},
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
"dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
"element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
"activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
"elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
"endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
"externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
"feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
{ # Each field of the element. This is a required field.
"defaultValue": "A String", # Optional. The default value of the field.
"filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
"id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
"name": "A String", # Required. The name of the field.
"renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
"required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
"type": "A String", # Required. The type of the field.
},
],
"isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
"reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
"startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
},
"feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
"ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
{ # Contains the ingestion error record of the dynamic feed. limited to 100 records.
"errors": [ # Output only. The list of field errors of the ingestion error record.
{ # Contains the field error of the dynamic feed.
"fieldId": 42, # Output only. The ID of the field.
"fieldName": "A String", # Output only. The name of the field.
"fieldValues": [ # Output only. The list of values of the field.
"A String",
],
"ingestionError": "A String", # Output only. The ingestion error of the field.
"isError": True or False, # Output only. Incidcates whether the field has error or warning.
},
],
"recordId": "A String", # Output only. The record ID of the ingestion error record.
},
],
"ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
"numActiveRows": "A String", # Output only. The number of active rows in the feed.
"numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
"numRowsTotal": "A String", # Output only. The total number of rows in the feed.
"numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
"numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
},
"state": "A String", # Output only. The processing state of the feed.
},
"feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
"repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
"scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
"startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
},
"hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
},
"dynamicProfileId": "A String", # Required. Dynamic profile ID of the inserted dynamic feed.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
"charset": "A String", # Output only. The charset of the content source.
"fieldNames": [ # Output only. The list of column names in the content source.
"A String",
],
"rowNumber": 42, # Output only. The number of rows in the content source.
"separator": "A String", # Output only. The separator of the content source.
},
"resourceLink": "A String", # Required. The link to the file of the content source.
"resourceType": "A String", # Required. The resource type of the content source.
},
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
"dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
"element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
"activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
"elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
"endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
"externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
"feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
{ # Each field of the element. This is a required field.
"defaultValue": "A String", # Optional. The default value of the field.
"filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
"id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
"name": "A String", # Required. The name of the field.
"renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
"required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
"type": "A String", # Required. The type of the field.
},
],
"isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
"reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
"startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
},
"feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
"ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
{ # Contains the ingestion error record of the dynamic feed. limited to 100 records.
"errors": [ # Output only. The list of field errors of the ingestion error record.
{ # Contains the field error of the dynamic feed.
"fieldId": 42, # Output only. The ID of the field.
"fieldName": "A String", # Output only. The name of the field.
"fieldValues": [ # Output only. The list of values of the field.
"A String",
],
"ingestionError": "A String", # Output only. The ingestion error of the field.
"isError": True or False, # Output only. Incidcates whether the field has error or warning.
},
],
"recordId": "A String", # Output only. The record ID of the ingestion error record.
},
],
"ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
"numActiveRows": "A String", # Output only. The number of active rows in the feed.
"numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
"numRowsTotal": "A String", # Output only. The total number of rows in the feed.
"numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
"numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
},
"state": "A String", # Output only. The processing state of the feed.
},
"feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
"repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
"scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
"startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
},
"hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
}</pre>
</div>
<div class="method">
<code class="details" id="retransform">retransform(dynamicFeedId, x__xgafv=None)</code>
<pre>Retransforms a dynamic feed.
Args:
dynamicFeedId: string, Required. Dynamic feed ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
"charset": "A String", # Output only. The charset of the content source.
"fieldNames": [ # Output only. The list of column names in the content source.
"A String",
],
"rowNumber": 42, # Output only. The number of rows in the content source.
"separator": "A String", # Output only. The separator of the content source.
},
"resourceLink": "A String", # Required. The link to the file of the content source.
"resourceType": "A String", # Required. The resource type of the content source.
},
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
"dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
"element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
"activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
"elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
"endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
"externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
"feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
{ # Each field of the element. This is a required field.
"defaultValue": "A String", # Optional. The default value of the field.
"filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
"id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
"name": "A String", # Required. The name of the field.
"renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
"required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
"type": "A String", # Required. The type of the field.
},
],
"isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
"reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
"startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
},
"feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
"ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
{ # Contains the ingestion error record of the dynamic feed. limited to 100 records.
"errors": [ # Output only. The list of field errors of the ingestion error record.
{ # Contains the field error of the dynamic feed.
"fieldId": 42, # Output only. The ID of the field.
"fieldName": "A String", # Output only. The name of the field.
"fieldValues": [ # Output only. The list of values of the field.
"A String",
],
"ingestionError": "A String", # Output only. The ingestion error of the field.
"isError": True or False, # Output only. Incidcates whether the field has error or warning.
},
],
"recordId": "A String", # Output only. The record ID of the ingestion error record.
},
],
"ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
"numActiveRows": "A String", # Output only. The number of active rows in the feed.
"numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
"numRowsTotal": "A String", # Output only. The total number of rows in the feed.
"numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
"numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
},
"state": "A String", # Output only. The processing state of the feed.
},
"feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
"repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
"scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
"startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
},
"hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(body=None, x__xgafv=None)</code>
<pre>Updates a new dynamic feed.
Args:
body: object, The request body.
The object takes the form of:
{ # Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
"charset": "A String", # Output only. The charset of the content source.
"fieldNames": [ # Output only. The list of column names in the content source.
"A String",
],
"rowNumber": 42, # Output only. The number of rows in the content source.
"separator": "A String", # Output only. The separator of the content source.
},
"resourceLink": "A String", # Required. The link to the file of the content source.
"resourceType": "A String", # Required. The resource type of the content source.
},
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
"dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
"element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
"activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
"elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
"endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
"externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
"feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
{ # Each field of the element. This is a required field.
"defaultValue": "A String", # Optional. The default value of the field.
"filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
"id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
"name": "A String", # Required. The name of the field.
"renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
"required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
"type": "A String", # Required. The type of the field.
},
],
"isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
"reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
"startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
},
"feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
"ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
{ # Contains the ingestion error record of the dynamic feed. limited to 100 records.
"errors": [ # Output only. The list of field errors of the ingestion error record.
{ # Contains the field error of the dynamic feed.
"fieldId": 42, # Output only. The ID of the field.
"fieldName": "A String", # Output only. The name of the field.
"fieldValues": [ # Output only. The list of values of the field.
"A String",
],
"ingestionError": "A String", # Output only. The ingestion error of the field.
"isError": True or False, # Output only. Incidcates whether the field has error or warning.
},
],
"recordId": "A String", # Output only. The record ID of the ingestion error record.
},
],
"ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
"numActiveRows": "A String", # Output only. The number of active rows in the feed.
"numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
"numRowsTotal": "A String", # Output only. The total number of rows in the feed.
"numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
"numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
},
"state": "A String", # Output only. The processing state of the feed.
},
"feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
"repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
"scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
"startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
},
"hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the content source. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"metaData": { # Contains the meta data of the content source. This is a read-only field. # Output only. Metadata of the content source. It contains the number of rows and the column names from resource link. This is a read-only field.
"charset": "A String", # Output only. The charset of the content source.
"fieldNames": [ # Output only. The list of column names in the content source.
"A String",
],
"rowNumber": 42, # Output only. The number of rows in the content source.
"separator": "A String", # Output only. The separator of the content source.
},
"resourceLink": "A String", # Required. The link to the file of the content source.
"resourceType": "A String", # Required. The resource type of the content source.
},
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"dynamicFeedId": "A String", # Output only. Unique ID of this dynamic feed. This is a read-only, auto-generated field.
"dynamicFeedName": "A String", # Optional. Name of this dynamic feed. It is defaulted to content source file name if not provided.
"element": { # Contains the element of the dynamic feed. # Required. The element of the dynamic feed that is to specify the schema of the feed. This is a required field.
"activeFieldId": 42, # Optional. The field ID to specify the active field in the feed.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultFieldId": 42, # Optional. The field ID to specify the field that represents the default field in the feed.
"elementName": "A String", # Optional. The name of the element. It is defaulted to resource file name if not provided.
"endTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the end timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
"externalIdFieldId": 42, # Required. The field ID to specify the field used for uniquely identifying the feed row. This is a required field.
"feedFields": [ # Required. The list of fields of the element. The field order and name should match the meta data in the content source source.
{ # Each field of the element. This is a required field.
"defaultValue": "A String", # Optional. The default value of the field.
"filterable": True or False, # Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID
"id": 42, # Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link.
"name": "A String", # Required. The name of the field.
"renderable": True or False, # Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT
"required": True or False, # Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE
"type": "A String", # Required. The type of the field.
},
],
"isLocalTimestamp": True or False, # Optional. Whether the start and end timestamp is local timestamp. The default value is false which means start and end timestamp is in UTC.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the element. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"proximityTargetingFieldId": 42, # Optional. The field ID that specify field used for proximity targeting.
"reportingLabelFieldId": 42, # Required. The field ID to specify the field used for dynamic reporting in Campaign Manager 360.
"startTimestampFieldId": 42, # Optional. The field ID to specify the field that represents the start timestamp. Only applicable if you're planning to use scheduling in your dynamic creative.
},
"feedIngestionStatus": { # Contains the ingestion status of the dynamic feed. Feed ingestion is an asynchronous process. If the feed create request is successful, feed ingestion will be processed in the background, including validation, assets retrieval, and saving the data from the resource link. The processing time is dependent on the data size in the resource link. This read-only status field contains the current stage of that processing and its ingestion state. # Output only. The ingestion status of the dynamic feed. This is a read-only field.
"ingestionErrorRecords": [ # Output only. The ingestion error records of the feed.
{ # Contains the ingestion error record of the dynamic feed. limited to 100 records.
"errors": [ # Output only. The list of field errors of the ingestion error record.
{ # Contains the field error of the dynamic feed.
"fieldId": 42, # Output only. The ID of the field.
"fieldName": "A String", # Output only. The name of the field.
"fieldValues": [ # Output only. The list of values of the field.
"A String",
],
"ingestionError": "A String", # Output only. The ingestion error of the field.
"isError": True or False, # Output only. Incidcates whether the field has error or warning.
},
],
"recordId": "A String", # Output only. The record ID of the ingestion error record.
},
],
"ingestionStatus": { # Contains the ingestion status of the dynamic feed. # Output only. The ingestion status of the feed.
"numActiveRows": "A String", # Output only. The number of active rows in the feed.
"numRowsProcessed": "A String", # Output only. The number of rows processed in the feed.
"numRowsTotal": "A String", # Output only. The total number of rows in the feed.
"numRowsWithErrors": "A String", # Output only. The number of rows with errors in the feed.
"numWarningsTotal": "A String", # Output only. The total number of warnings in the feed.
},
"state": "A String", # Output only. The processing state of the feed.
},
"feedSchedule": { # Contains the schedule of the dynamic feed. # Optional. The schedule of the dynamic feed. It can be set if the feed is published.
"repeatValue": "A String", # Optional. The number of times the feed retransforms within one day. This is a required field if the schedule is enabled. Acceptable values are between 1 to 6, inclusive.
"scheduleEnabled": True or False, # Optional. Whether the schedule is enabled.
"startHour": "A String", # Optional. The hour of the day to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"startMinute": "A String", # Optional. The minute of the hour to start the feed. It is applicable if the repeat value is equal to 1. Default value is 0.
"timeZone": "A String", # Optional. The time zone to schedule the feed. It is applicable if the repeat value is equal to 1. Default value is "America/Los_Angeles".
},
"hasPublished": True or False, # Output only. Indicates whether the dynamic feed has a published version. This is a read-only field.
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic feed. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"status": "A String", # Output only. The status of the feed. It is a read-only field that depends on the the feed ingestion status. The default value is INACTIVE, and it will be updated to ACTIVE once the feed is ingested successfully.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic feed. This is a required field.
}</pre>
</div>
</body></html>
|
